Initialization

Before using other features of the SDK, initialization must be performed. This article will detail the methods for initializing the IMLib SDK.

For first-time users of RC, we recommend reading the IMLib SDK Quick Start Guide to complete tasks such as developer account registration.

Push Notification

Push notification is a common basic feature. The IMLib SDK has integrated RC's own push notification and multiple third-party push services, which will be triggered after the SDK is initialized. Therefore, the push notification configuration on the client must be provided before initialization. For detailed instructions, refer to Enable Push Notification.

Global Data Center

• If you are using a global data center and a development version (dev) SDK of version 5.4.2 or later, please ensure that the correct area code (AreaCode) is passed in the initialization configuration.
• If you are using a global data center and a stable version (stable) SDK, or a development version (dev) SDK earlier than 5.4.2, you must modify the service address that the IMLib SDK connects to the global data center address before initialization. Otherwise, the SDK will default to connecting to the service address of the China (Beijing) Data Center. For detailed instructions, refer to Configure Global Data Center Service Address.

Process

tip

Starting from version 5.3.0, the IMLib SDK supports single-process.

The SDK supports both multi-process and single-process mechanisms.

If the SDK version is < 5.3.3 or ≥ 5.3.5, the multi-process mechanism is used by default. After initialization, the application will start the following processes:

1. The main process of the application
2. <application package name>:ipc. This process is the core process for IM communication and is isolated from the tasks of the main process.
3. io.rong.push: The default push notification process of RC. Whether this process starts is determined by the push channel's enablement policy. For detailed instructions, refer to Enable Push Notification.

If the SDK version is ≥ 5.3.3 and < 5.3.5, the single-process mechanism is used by default.

Starting from version 5.3.0, you can enable or disable single-process before initialization using the enableSingleProcess interface of RongCoreClient. Note that enabling single-process will consume part of the main process's memory.

//Enable single-process
RongCoreClient.getInstance().enableSingleProcess(true);

Initialize the SDK

tip

The following initialization method requires SDK version ≥ 5.4.2.

Initialize the SDK in the onCreate() method of the Application, passing in the App Key for either the production or development environment.

String appKey = "YourAppKey"; // example: bos9p5rlcm2ba
InitOption initOption = new InitOption.Builder().build();

RongCoreClient.init(this, appKey, initOption);

The initialization configuration (InitOption) encapsulates the area code (AreaCode) configuration. The SDK will use the area code to obtain valid navigation service addresses, file service addresses, data statistics service addresses, and log service addresses.

• If the App Key belongs to the China (Beijing) Data Center, you do not need to pass any configuration; the SDK will use the default configuration.
• If the App Key belongs to a global data center, you must pass a valid area code (AreaCode) configuration. Please verify the global data center to which the current App Key belongs in the Console, and then find the corresponding enumeration value in AreaCode for configuration.

For example, for an application using the Singapore data center's production or development environment App Key:

String appKey = "Singapore_dev_AppKey";
AreaCode areaCode = AreaCode.SG;

InitOption initOption = new InitOption.Builder()
    .setAreaCode(areaCode)
    .build();

RongCoreClient.init(context, appKey, initOption);

In addition to the area code, the initialization configuration (InitOption) also encapsulates the following configurations:

• Push notification enablement switch (enablePush): Whether to disable push notification globally.
• Main process switch (isMainProcess): Whether it is the main process. By default, the SDK determines the process.
• Navigation service address (naviServer): Generally, it is not recommended to configure this separately. The SDK internally defaults to using the address corresponding to the area code.
• File service address (fileServer): Only for private cloud use.
• Data statistics service address (statisticServer): Generally, it is not recommended to configure this separately. The SDK internally defaults to using the address corresponding to the area code.

String appKey = "Your_AppKey";
AreaCode areaCode = AreaCode.BJ;

InitOption initOption = new InitOption.Builder()
    .setAreaCode(areaCode)
    .enablePush(true)
    .setFileServer("http(s)://fileServer")
    .setNaviServer("http(s)://naviServer")
    .setStatisticServer("http(s)://StatisticServer")
    .build();

RongCoreClient.init(context, appKey, initOption);

Initialize the SDK (Legacy Version)

tip

If you are using a development version SDK with a version number less than 5.4.2, or a stable version SDK with a version number less than or equal to 5.3.8, you can only use the following method for initialization. It is recommended to upgrade the SDK to the latest version as soon as possible.

Initialize the SDK in the onCreate() method of the Application, passing in the App Key for either the production or development environment. You can use the initialization methods of RongCoreClient or RongIMClient.

RongCoreClient.init(context, appKey, enablePush);

Parameter	Type	Description
context	Context	Application context.
appKey	String	The development or production environment AppKey of the application. Do not confuse them. If you choose to set the appKey in AndroidManifest.xml, you do not need to pass it here.
enablePush	boolean	Whether to Enable Push Notification. Default is true, which means push notification is enabled. Note that the first setting of enablePush is effective. If you have already set enablePush to true and have successfully reported the push token, setting enablePush to false later will not take effect.

For backward compatibility, IMLib SDK 5x still supports configuring the App Key in AndroidManifest.xml. However, considering the security of the App Key, RC no longer recommends this configuration method.

It is recommended to initialize only after the user has accepted the privacy agreement.

/**
 * When the application starts, determine whether the user has accepted the privacy agreement. If accepted, initialize normally; otherwise, redirect to the privacy authorization page to request user authorization.
 */
public class App extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        //Pseudo code, read from sp whether the user has accepted the privacy agreement
        boolean isPrivacyAccepted = getPrivacyStateFromSp();
        //User has accepted the privacy agreement, initialize
        if (isPrivacyAccepted) {
            String appKey = "The AppKey of the application created in the RC Console";
            //The first parameter must pass the application context
            RongIMClient.init(this.getApplicationContext(), appKey);
        } else {
            //User has not accepted the privacy agreement, redirect to the privacy authorization page.
            goToPrivacyActivity();
        }
        ...
    }
}

/**
 * This class is the privacy authorization page, demonstrating how to initialize IM after the user accepts the privacy agreement.
 */
public class PrivacyActivity extends Activity implements View.OnClickListener {
    ...
    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.accept_privacy:
                //Pseudo code, save to sp
                savePrivacyStateToSp();

                String appKey = "The AppKey of the application created in the RC Console";
                //The first parameter must pass the application context
                RongIMClient.init(this.getApplicationContext(), appKey);
                break;
            default:
                ...
        }
    }
}