Basics of the improved Sendbird ChatSDK initialization.

[tezpark]

Basics of the improved Sendbird ChatSDK initialization.

Now, initialize the Chat SDK in the app to allow the Chat SDK to respond to changes according to the connection status in iOS client apps. Initialization requires your Sendbird application's APP_ID, which can be found on Sendbird Dashboard.

Before calling the initialize(params:migrationStartHandler:completionHandler:) method, create an InitParams object with your Sendbird application ID. In the params, you can also determine whether to enable local caching or not and whether to make initialization synchronously.

let initParams = InitParams(
    applicationId: APP_ID,
    isLocalCachingEnabled: true,
    logLevel: .info,
    needsSynchronous: false
)
SendbirdChat.initialize(
    params: params,
    migrationStartHandler: {
        // Migration starts.    
    },
    completionHandler: { error in
        // Migration completed.    
    }
)

The completionHandler method gets the initialization status through different event handlers. The migrationStartHandler method is called when there's an upgrade in the local database. Meanwhile, the completionHandler method informs the client app whether the initialization is complete.

If the initialization fails when you set isLocalCachingEnabled to true, the SDK will operate normally and change the value of isLocalCachingEnabled to false. If you still wish to use local caching, clear the database using clearCachedData(completionHandler:) and try the initialization again with isLocalCachingEnabled set to true.

If you are using local caching but don't need to use Sendbird's features immediately after launching your app, you can make the migration process of local caching asynchronous by setting the needsSynchronous parameter of the InitParams object to false. This will reduce the initialization time when the app is launched to minimize runtime. (If you don't use local caching, there's no difference in app launching time because there's no migration process).

Note: The initialize(params:migrationStartHandler:completionHandler:) method of a SendbirdChat instance must be called across a client app at least once. We recommend that you initialize Sendbird Chat SDK through the application:didFinishLaunchingWithOptions: method of the AppDelegate instance.

Also, if you have a situation where a SendbirdChat function is called asynchronously from another class or method, independent of SendbirdChat's initialization, use the SendbirdChat class's executeOrWaitForInitialization(executeHandler:) feature.
You can set it to execute immediately if it's initialized, or wait for initialization if it's not.

SendbirdChat.executeOrWaitForInitialization {
    // Implement logic to perform once initialization is complete
}

Note: The executeOrWaitForInitialization(executeHandler:) method of a SendbirdChat instance must be set after calling Chat initialization method.

Sequence diagram

Below is a sequence diagram to help you understand.

Synchronous

Asynchronous