You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# React Native Client SDK for OpenIM 👨💻💬
2
2
3
+
> **📢 Important Notice:** Starting from version 3.8.3-patch.10, the package name has been changed from `open-im-sdk-rn` to `@openim/rn-client-sdk`. Please update your dependency installation and import statements.
4
+
3
5
Use this SDK to add instant messaging capabilities to your application. By connecting to a self-hosted [OpenIM](https://www.openim.io) server, you can quickly integrate instant messaging capabilities into your app with just a few lines of code.
4
6
5
7
The iOS SDK core is implemented in [OpenIM SDK Core](https://github.com/openimsdk/openim-sdk-core). Using [gomobile](https://github.com/golang/mobile), it can be compiled into an XCFramework for iOS integration. iOS interacts with the [OpenIM SDK Core](https://github.com/openimsdk/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](https://github.com/openimsdk/openim-sdk-core).
@@ -10,7 +12,7 @@ The React Native Client SDK use [NativeModule](https://reactnative.dev/docs/nati
10
12
11
13
## Tips 🔔
12
14
13
-
1. The [email protected] has contains ***significant disruptive updates***. If you need to upgrade, please check the incoming data and the returned data.
15
+
1. The [email protected] has contains ***significant disruptive updates***. If you need to upgrade, please check the incoming data and the returned data.**Note: Package name has been changed to `@openim/rn-client-sdk` starting from version 3.8.3-patch.10.**
14
16
15
17
2. Unlike other SDKS, React Native SDK operationID is not optional, but required.
16
18
@@ -25,7 +27,7 @@ For the SDK reference, see [https://doc.rentsoft.cn/sdks/quickstart/reactnative]
25
27
### Adding Dependencies
26
28
27
29
```sh
28
-
yarn add open-im-sdk-rn
30
+
yarn add @openim/rn-client-sdk
29
31
```
30
32
31
33
## Usage 🚀
@@ -35,7 +37,7 @@ The following examples demonstrate how to use the SDK. TypeScript is used, provi
35
37
### Importing the SDK and init
36
38
37
39
```typescript
38
-
importOpenIMSDKRNfrom'open-im-sdk-rn';
40
+
importOpenIMSDKRNfrom'@openim/rn-client-sdk';
39
41
importRNFSfrom'react-native-fs';
40
42
41
43
RNFS.mkdir(RNFS.DocumentDirectoryPath+'/tmp');
@@ -53,7 +55,7 @@ OpenIMSDKRN.initSDK({
53
55
### Logging In and Listening for Connection Status
@@ -80,8 +82,8 @@ To log into the IM server, you need to create an account and obtain a user ID an
80
82
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.
0 commit comments