Connection

Before the application client can use the RC IM SDK to send and receive messages, it must successfully connect to the RC server.

Upon receiving a connection request from the client, the RC server will determine whether to allow the user to connect based on the user authentication token (Token parameter) carried in the connection request.

Prerequisites

• Register a user (obtain a Token) via the server API. The RC client SDK does not provide a method to obtain a Token. The application can call its own server to obtain a Token from the RC server.
  • Once the Token is obtained, the client can save it as needed for subsequent connections. The specific storage location depends on the application client design. If the Token has not expired, there is no need to request a new Token from RC.
  • The Token's validity period can be configured in the Console, with the default being permanently valid. Even if a new Token is generated, the old Token that has not expired remains valid. Once the Token expires, a new Token must be obtained. If necessary, you can actively call the server API Invalidate Token.
• It is recommended that the application sets up a connection status listener before connecting.
• The SDK has been initialized.

tip

Do not call the server API directly from the client to obtain a Token. Obtaining a Token requires providing the App Key and App Secret. If these credentials are stored on the client, they could be exposed if the app is decompiled. Therefore, always ensure that the Token is obtained from the application server.

Connecting to the IM Server

Depending on the application's business requirements and design, decide the appropriate time (login, registration, or other occasions to avoid being unable to access the application homepage) to initiate a connection request to the RC chat server.

Method

connect(
  token: string, 
  timeout: number, 
  callback: RCIMIWConnectCallback
): Promise<number>;

Parameter Description

Parameter	Type	Description
token	string	The token obtained by calling the server API
timeout	number	Connection timeout time, in seconds.
callback	RCIMIWConnectCallback	Callback for the interface call result.

Return Value

Return Value	Description
number	The status code of the current interface operation. 0 indicates a successful call. Specific results need to be implemented in the interface callback. Non-zero indicates that the current interface call operation failed, and the interface callback will not be triggered. For detailed errors, refer to the error codes.

Code Example

const callback = {
    onDatabaseOpened: (code: number) => {
        //...
    },
    onConnected: (code: number, userId: string) => {
        //...
    },
};
let code = await engine.connect(token, timeout, callback);

Note:

1. The SDK itself has a reconnection mechanism, so there is no need to call connect() multiple times within an application lifecycle. Otherwise, multiple callbacks may be triggered, leading to the callbacks being cleared.

2. In the case where code is 31004, you need to request your server to obtain a new Token and establish a connection, but be careful to avoid infinite loops to prevent affecting the user experience of the App.

Token Invalid (31004) Troubleshooting

Cause	Troubleshooting
Token Error	Check if the app key used for client initialization is consistent with the app key used by your server to obtain the Token
Token Expired	Check if the developer has set a Token expiration time in the Console. After expiration, you need to request your server to obtain a new Token and establish a connection again with the new Token

Error Codes

Connection error codes refer to the native platform error code definitions Android Error Codes and iOS Error Codes