React Native Client SDK for OpenIM 👨‍💻💬

Use this SDK to add instant messaging capabilities to your application. By connecting to a self-hosted OpenIM server, you can quickly integrate instant messaging capabilities into your app with just a few lines of code.

The iOS SDK core is implemented in OpenIM SDK Core. Using gomobile, it can be compiled into an XCFramework for iOS integration. iOS interacts with the OpenIM SDK Core through JSON, and the SDK exposes a re-encapsulated API for easy usage. In terms of data storage, iOS utilizes the SQLite layer provided internally by the OpenIM SDK Core.

The Android SDK core is implemented in OpenIM SDK Core. Using gomobile, it can be compiled into an AAR file for Android integration. Android interacts with the OpenIM SDK Core through JSON, and the SDK exposes a re-encapsulated API for easy usage. In terms of data storage, Android utilizes the SQLite layer provided internally by the OpenIM SDK Core.

The React Native Client SDK uses the NativeModule system to expose instances of Java/Objective-C classes to JavaScript (JS) as JS objects, thereby allowing you to execute arbitrary native code from within JS.

Tips 🔔

1. Expo support: Expo custom dev client workflow is supported from v3.8.3-patch.10.3 and later.

2. Event Binding API: Starting from v3.8.3-patch.10.2, you can use OpenIMSDK.on() to listen for events with better TypeScript type hints. Earlier versions must use the OpenIMEmitter object. Both approaches remain compatible with the latest version.

3. operationID Parameter: This parameter is used for backend log querying. Starting from v3.8.3-patch.10.2, the operationID parameter is optional for all APIs (the SDK will auto-generate one if not provided). For earlier versions, this parameter is required and must be passed explicitly.

4. Starting from v3.8.3-patch.10, the package name has been changed from open-im-sdk-rn to @openim/rn-client-sdk.

5. The v3.5.1 contains significant disruptive updates. If you need to upgrade, please check the incoming data and the returned data.

Documentation 📚

Visit https://docs.openim.io for detailed documentation and guides.

For the SDK reference, see https://docs.openim.io/sdks/quickstart/reactNative.

Installation 💻

$3

``sh


install the SDK

npm install @openim/rn-client-sdk

iOS native dependencies

cd ios && pod install && cd ..
`

$3

v3.8.3-patch.10.3 and later support Expo via the custom development client (prebuild) workflow. This package bridges native modules, so Expo projects must run in a prebuild/custom development client workflow rather than Expo Go.

`sh


install the SDK

npm install @openim/rn-client-sdk

generate native projects and run

npx expo prebuild
npx expo run:android
npx expo run:ios

optional: Expo Go–like dev client experience

npx expo install expo-dev-client
`

Usage 🚀

The following examples demonstrate how to use the SDK. TypeScript is used, providing complete type hints.

$3

`typescript
import OpenIMSDK from '@openim/rn-client-sdk';
import RNFS from 'react-native-fs';

RNFS.mkdir(RNFS.DocumentDirectoryPath + '/tmp');

OpenIMSDK.initSDK({
apiAddr: 'http://your-server-ip:10002',
wsAddr: 'ws://your-server-ip:10001',
dataDir: RNFS.DocumentDirectoryPath + '/tmp',
logFilePath: RNFS.DocumentDirectoryPath + '/tmp',
logLevel: 5,
isLogStandardOutput: true,
});
`

$3

`typescript
import OpenIMSDK from '@openim/rn-client-sdk';

OpenIMSDK.login({
userID: 'IM user ID',
token: 'IM user token',
});

OpenIMSDK.on('onConnecting', () => {
console.log('onConnecting');
});

OpenIMSDK.on('onConnectSuccess', () => {
console.log('onConnectSuccess');
});

OpenIMSDK.on('onConnectFailed', ({ errCode, errMsg }) => {
console.log('onConnectFailed', errCode, errMsg);
});
`

For versions prior to v3.8.3-patch.10.2:

`typescript
import OpenIMSDKRN, { OpenIMEmitter } from '@openim/rn-client-sdk';

OpenIMSDKRN.login({
userID: 'IM user ID',
token: 'IM user token',
}, 'opid');

OpenIMEmitter.addListener('onConnecting', () => {
console.log('onConnecting');
});

OpenIMEmitter.addListener('onConnectSuccess', () => {
console.log('onConnectSuccess');
});

OpenIMEmitter.addListener('onConnectFailed', ({ errCode, errMsg }) => {
console.log('onConnectFailed', errCode, errMsg);
});
`

To log into the IM server, you need to create an account and obtain a user ID and token. Refer to the access token documentation for details.

$3

OpenIM makes it easy to send and receive messages. By default, there is no restriction on having a friend relationship to send messages (although you can configure other policies on the server). If you know the user ID of the recipient, you can conveniently send a message to them.

`typescript
import OpenIMSDK from '@openim/rn-client-sdk';
import type { MessageItem } from '@openim/rn-client-sdk';

OpenIMSDK.on('onRecvNewMessages', (messages: MessageItem[]) => {
console.log('onRecvNewMessages', messages);
});

const message = await OpenIMSDK.createTextMessage('hello openim');

OpenIMSDK.sendMessage({
recvID: 'recipient user ID',
groupID: '',
message,
})
.then(() => {
// Message sent successfully ✉️
})
.catch(err => {
// Failed to send message ❌
console.log(err);
});
`

For versions prior to v3.8.3-patch.10.2:

`typescript
import OpenIMSDKRN, { OpenIMEmitter } from '@openim/rn-client-sdk';

OpenIMEmitter.addListener('onRecvNewMessages', (messages) => {
console.log('onRecvNewMessages', messages);
});

const message = await OpenIMSDKRN.createTextMessage('hello openim', 'opid');

OpenIMSDKRN.sendMessage({
recvID: 'recipient user ID',
groupID: '',
message,
}, 'opid')
.then(() => {
// Message sent successfully ✉️
})
.catch(err => {
// Failed to send message ❌
console.log(err);
});
`

Examples 🌟

You can find a demo React-Native app that use the SDK in the openim-reactnative-demo repository.

or:

Use the examples(only the simplest SDK calls) under this project to try it out:

`sh
yarn

yarn example android

yarn example ios
``

> Note for iOS: When running the iOS example project, you may encounter dependency installation errors or build failures. Please refer to iOS Example Project Running Notes for detailed solutions.

Community :busts_in_silhouette:

- 📚 OpenIM Community
- 💕 OpenIM Interest Group
- 🚀 Join our Slack community
- :eyes: Join our wechat (微信群)

Community Meetings :calendar:

We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.

Our conference is in the OpenIM Slack 🎯, then you can search the Open-IM-Server pipeline to join

We take notes of each biweekly meeting in GitHub discussions, Our historical meeting notes, as well as replays of the meetings are available at Google Docs :bookmark_tabs:.

Who are using OpenIM :eyes:

Check out our user case studies page for a list of the project users. Don't hesitate to leave a 📝comment and share your use case.

License :page_facing_up:

OpenIM is licensed under the Apache 2.0 license. See LICENSE for the full license text.