Authenticate and manage a session

Before configuring authentication and managing sessions, complete the setup described in Before you start and Environment-specific implementation. Initialize the OpenIM React Native SDK using initSDK(), then authenticate the current user and establish the WebSocket connection with login().

The complete integration workflow is:

1. Invoke initSDK() to configure service endpoints, local storage, and logging parameters.
2. Register event listeners for onConnecting, onConnectSuccess, and onConnectFailed.
3. Invoke login() with user credentials to authenticate.
4. Await the onConnectSuccess event to verify that the long-lived connection is ready.
5. Invoke logout() when actively signing out or switching accounts.

Initialize the SDK

Call initSDK() with the server addresses, application-writable data directory, and logging options. Both dataDir and logFilePath must point to persistent directories that the application has permission to write to.

React Native CLI

import OpenIMSDK, { LogLevel } from '@openim/rn-client-sdk';
import RNFS from 'react-native-fs';

const dataDir = RNFS.DocumentDirectoryPath;

await OpenIMSDK.initSDK({
  apiAddr: 'http://your-server-ip:10002',
  wsAddr: 'ws://your-server-ip:10001',
  dataDir,
  logFilePath: dataDir,
  logLevel: LogLevel.Info,
  isLogStandardOutput: true,
});

Expo

Expo projects retrieve the application document directory using expo-file-system. The URI returned by documentDirectory contains a file:// scheme prefix that must be stripped before passing the path to the SDK:

import OpenIMSDK, { LogLevel } from '@openim/rn-client-sdk';
import * as FileSystem from "expo-file-system/legacy";

const dataDir = FileSystem.documentDirectory.replace(/^file:\/\//, '').replace(/\/$/, '');

await OpenIMSDK.initSDK({
  apiAddr: 'http://your-server-ip:10002',
  wsAddr: 'ws://your-server-ip:10001',
  dataDir,
  logFilePath: dataDir,
  logLevel: LogLevel.Info,
  isLogStandardOutput: true,
});

Parameters

Core configuration parameters accepted by initSDK():

Register connection events

Register connection listeners before calling login(). Event names can use string literals matching the callback names:

const handleConnecting = () => {
  console.log("onConnecting");
};

const handleConnectSuccess = () => {
  console.log("onConnectSuccess");
};

const handleConnectFailed = (error: OpenIMEventBaseErrorType) => {
  console.log("onConnectFailed", error.errCode, error.errMsg);
};

// Register listeners
OpenIMSDK.on('onConnecting', handleConnecting);
OpenIMSDK.on('onConnectSuccess', handleConnectSuccess);
OpenIMSDK.on('onConnectFailed', handleConnectFailed);

Sign in the current user

Pass the userID and session token provided by your application backend to login():

await OpenIMSDK.login({
  userID,
  token,
});

Return value

When the Promise resolves, the sign-in request has been accepted. Wait for the onConnectSuccess event before invoking business data operations (such as loading conversations or messages).

Check login status

Query the current session state using getLoginStatus():

const loginStatus = await OpenIMSDK.getLoginStatus();

The returned LoginStatus indicates one of the following states:

Log out and switch accounts

Invoke logout() when the user signs out or switches accounts, and clear all local application-level cache for the current session:

await OpenIMSDK.logout();

When switching accounts, wait for logout() to complete before calling login() with the new account's credentials. There is no need to re-invoke initSDK(). Never sign into a second account while the current session remains active.

Remove event listeners

When logging out, switching accounts, or unmounting associated screens, call off() with the exact event name and function reference used during registration:

// Unregister listeners
OpenIMSDK.off('onConnecting', handleConnecting);
OpenIMSDK.off('onConnectSuccess', handleConnectSuccess);
OpenIMSDK.off('onConnectFailed', handleConnectFailed);

Next steps

• Send your first message