Setup
Before services can be started a user object must be setup to use the SDK and a services configuration must be provided (see iOS Quick Start).
Setup Auth/Config
Authenticates a user to be used with the SDK.
func setup(authCode: String, config: MoveConfig, options: MoveOptions, callback: @escaping MoveAuthCallback)
Parameters
authCode
String
Auth code.
Setup with auth tokens:
func setup(auth: MoveAuth, config: MoveConfig, options: MoveOptions)
Parameters
Deprecated, use setup(authCode: ...) instead
Update Config
Change the config originally passed in setup.
func update(config: MoveConfig, options: MoveOptions? = nil)
Parameters
Occasionally this functionality is needed for deployed apps when a projects configuration is updated on the backend.
Precondition: SDK user/config should be setup.
Update authentication
Updates SDK MoveAuth. The host app was expected to fetch a new MoveAuth using its project API key and pass it to the MoveSDK using the following API:
func update(auth: MoveAuth, completion: ((MoveAuthError?) -> Void)? = nil)
Deprecated: Token expiry is no longer a valid auth state forwarded to the app and does not need to be handled.
Get SDK Auth State
Gets the current MoveAuthState.
func getAuthState() -> MoveAuthState
Return
Latest SDK State
Set SDK Auth State Listener
Provide a block to be invoked every time MoveAuthState changes.
func setAuthStateUpdateListener(_ listener: AuthStateCallback)
Callback
Block that gets invoked every time MoveAuthState is updated.
Authentication Expiry
The host app is expected to monitor MoveAuthState updates viaauthStateUpdateListener
API and handle those changes accordingly.
Check Authentication updates and expiry for more details about authentication expiry and renewal.
Set SDK Initialization Listener
Provide a block to be invoked when configuration fetch failed.
func setInitializationListener(_ listener: MoveInitializationCallback)
Callback
Block that gets invoked every time configuration fetch from the server failed.
Shutdown
Shutdown SDK shared instance.
Stops SDK services, send the queued user data, and de-initializes the SDK. After that is executed, the MoveSDKState will transit to .uninitialized
.
func shutDown(force: Bool, _ callback: ((MoveShutdownResult) -> Void)?)
Parameters
Default
force
true
If true, shutdown executes immediately. Pending Data may be lost.
Precondition: SDK user/config should be setup.
Last updated