Skip to main content

Initialization

Before using other features of the SDK, initialization must be performed. This document details 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.

Preparing the App Key​

You must have the correct App Key to proceed with initialization.

You can log in to the RC Console and view the App Keys for your created applications from the Service Management page.

If you have multiple applications, please select the correct application name (labeled as 1 in the image below). Additionally, each RC application provides two independent sets of App Key / Secret for isolating production and development environments. When obtaining the App Key, please distinguish between the environments (Production / Development, labeled as 2 in the image below).

tip
  • If you are not the application creator, we recommend confirming that the Data Center displayed on the page meets your expectations when obtaining the App Key.
  • If you have not yet applied for application launch with RC, you can only use the development environment.

appkey

Global Data Center​

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

Initializing the SDK​

tip

The following initialization methods require SDK version ≧ 5.4.2.

Import the SDK header file

#import <RongIMLib/RongIMLib.h>

Pass the App Key for the Production or Development environment in the initialization method.

NSString *appKey = @"Your_AppKey"; // example: bos9p5rlcm2ba
RCInitOption *initOption = nil;

[[RCCoreClient sharedCoreClient] initWithAppKey:appKey option:initOption];

The initialization configuration (RCInitOption) encapsulates the area code (RCAreaCode) configuration. The SDK will obtain valid navigation service addresses, file service addresses, data statistics service addresses, and log service addresses based on the area code.

  • If the App Key belongs to the China (Beijing) Data Center, you do not need to configure additional RCInitOption settings, as the SDK will use all default configurations.
  • Please verify the global data center to which the current App Key belongs in the console, and then find the corresponding enumeration value in RCAreaCode for configuration.

For example, if using the Singapore Data Center, configure as follows:

NSString *appKey = @"Your_AppKey"; // example: bos9p5rlcm2ba
RCInitOption *initOption = [[RCInitOption alloc] init];
initOption.areaCode = RCAreaCodeSG;

[[RCCoreClient sharedCoreClient] initWithAppKey:appKey option:initOption];

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

  • Navigation service address (naviServer): Generally not recommended for separate configuration. The SDK internally defaults to using the address corresponding to the area code.
  • File service address (fileServer): Only for use with dedicated cloud.
  • Data statistics service address (statisticServer): Generally not recommended for separate configuration. The SDK internally defaults to using the address corresponding to the area code.
NSString *appKey = @"Your_AppKey"; // example: bos9p5rlcm2ba
RCInitOption *initOption = [[RCInitOption alloc] init];
initOption.areaCode = RCAreaCodeSG;
initOption.naviServer = @"http(s)://naviServer";
initOption.fileServer = @"http(s)://fileServer";
initOption.statisticServer = @"http(s)://statsServer";
[[RCCoreClient sharedCoreClient] initWithAppKey:appKey option:initOption];

Initializing the SDK​

tip

If you are using a development version SDK with a version earilier than 5.4.2, or a stable version SDK with a version earlier than or equal to 5.3.8, you can only use the following method for initialization. We recommend upgrading to the latest SDK version as soon as possible.

Import the SDK header file

#import <RongIMLib/RongIMLib.h>

Pass the App Key for the Production or Development environment when initializing the SDK. You can use the initialization methods of RCCoreClient or RCIMClient.

[[RCIMClient sharedRCIMClient] initWithAppKey:@"RC AppKey"];
Last updated on