zcash-android-wallet-sdk/docs/-sdk-synchronizer/start.md

[zcash-android-wallet-sdk](../../index.md) / [cash.z.wallet.sdk](../index.md) / [SdkSynchronizer](index.md) / [start](./start.md)

# start

`fun start(parentScope: CoroutineScope?): `[`Synchronizer`](../-synchronizer/index.md)

Overrides [Synchronizer.start](../-synchronizer/start.md)

Starts this synchronizer within the given scope. For simplicity, attempting to start an
instance that has already been started will throw a [SynchronizerException.FalseStart](../../cash.z.wallet.sdk.exception/-synchronizer-exception/-false-start.md)
exception. This reduces the complexity of managing resources that must be recycled. Instead,
each synchronizer is designed to have a long lifespan and should be started from an activity,
application or session.

### Parameters

`parentScope` - the scope to use for this synchronizer, typically something with a
lifecycle such as an Activity for single-activity apps or a logged in user session. This
scope is only used for launching this synchronzer's job as a child. If no scope is provided,
then this synchronizer and all of its coroutines will run until stop is called, which is not
recommended since it can leak resources. That type of behavior is more useful for tests.
Regenerate key docs. 2020-01-15 05:07:00 -08:00			`[zcash-android-wallet-sdk](../../index.md) / [cash.z.wallet.sdk](../index.md) / [SdkSynchronizer](index.md) / [start](./start.md)`
Add docs folder with Synchronizer documentation 2019-03-28 23:31:25 -07:00
			`# start`

Regenerate key docs. 2020-01-15 05:07:00 -08:00			`fun start(parentScope: CoroutineScope?): `[`Synchronizer`](../-synchronizer/index.md)
Add docs folder with Synchronizer documentation 2019-03-28 23:31:25 -07:00
			`Overrides [Synchronizer.start](../-synchronizer/start.md)`

Regenerate key docs. 2020-01-15 05:07:00 -08:00			`Starts this synchronizer within the given scope. For simplicity, attempting to start an`
			`instance that has already been started will throw a [SynchronizerException.FalseStart](../../cash.z.wallet.sdk.exception/-synchronizer-exception/-false-start.md)`
			`exception. This reduces the complexity of managing resources that must be recycled. Instead,`
			`each synchronizer is designed to have a long lifespan and should be started from an activity,`
			`application or session.`
Add docs folder with Synchronizer documentation 2019-03-28 23:31:25 -07:00
			`### Parameters`

Regenerate key docs. 2020-01-15 05:07:00 -08:00			`parentScope` - the scope to use for this synchronizer, typically something with a
			`lifecycle such as an Activity for single-activity apps or a logged in user session. This`
			`scope is only used for launching this synchronzer's job as a child. If no scope is provided,`
			`then this synchronizer and all of its coroutines will run until stop is called, which is not`
			`recommended since it can leak resources. That type of behavior is more useful for tests.`