Skip to content

Commit b0fe6f7

Browse files
OnYourMark-1995OnYourMark-1995
committed
feat(rn-sdk): update code examples and function prototype
1 parent d82f7db commit b0fe6f7

File tree

105 files changed

+504
-487
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+504
-487
lines changed

‎docs/sdks/api/conversation/changeInputStates.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ IMSDK.asyncApi('changeInputStates', IMSDK.uuid(), {
249249
### 函数原型
250250

251251
```ts showLineNumbers
252-
OpenIMSDKRN.changeInputStates({
252+
OpenIMSDK.changeInputStates({
253253
conversationID: string,
254254
focus: boolean,
255255
}, operationID?: string): Promise<void>
@@ -272,16 +272,16 @@ OpenIMSDKRN.changeInputStates({
272272
### 代码示例
273273

274274
```js showLineNumbers
275-
import OpenIMSDKRN from "open-im-sdk-rn";
275+
import OpenIMSDK from "@openim/rn-client-sdk";
276276

277-
OpenIMSDKRN.changeInputStates({
277+
OpenIMSDK.changeInputStates({
278278
conversationID: 'conversationID',
279279
focus: true,
280-
}, 'operationID')
280+
})
281281
.then(() => {
282282
// 调用成功
283283
})
284-
.catch(({ errCode, errMsg }) => {
284+
.catch((error) => {
285285
// 调用失败
286286
});
287287
```

‎docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ IMSDK.asyncApi(
229229
### 函数原型
230230

231231
```ts showLineNumbers
232-
OpenIMSDKRN.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<void>
232+
OpenIMSDK.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<void>
233233
```
234234

235235
### 输入参数
@@ -248,13 +248,13 @@ OpenIMSDKRN.clearConversationAndDeleteAllMsg(conversationID: string, operationID
248248
### 代码示例
249249

250250
```js showLineNumbers
251-
import OpenIMSDKRN from "open-im-sdk-rn";
251+
import OpenIMSDK from "@openim/rn-client-sdk";
252252

253-
OpenIMSDKRN.clearConversationAndDeleteAllMsg("conversationID", 'operationID')
253+
OpenIMSDK.clearConversationAndDeleteAllMsg("conversationID")
254254
.then(() => {
255255
// 调用成功
256256
})
257-
.catch(({ errCode, errMsg }) => {
257+
.catch((error) => {
258258
// 调用失败
259259
});
260260
```

‎docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ IMSDK.asyncApi(
223223
### 函数原型
224224

225225
```ts showLineNumbers
226-
OpenIMSDKRN.deleteConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<void>
226+
OpenIMSDK.deleteConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<void>
227227
```
228228

229229
### 输入参数
@@ -242,13 +242,13 @@ OpenIMSDKRN.deleteConversationAndDeleteAllMsg(conversationID: string, operationI
242242
### 代码示例
243243

244244
```js showLineNumbers
245-
import OpenIMSDKRN from "open-im-sdk-rn";
245+
import OpenIMSDK from "@openim/rn-client-sdk";
246246

247-
OpenIMSDKRN.deleteConversationAndDeleteAllMsg("conversationID", 'operationID')
247+
OpenIMSDK.deleteConversationAndDeleteAllMsg("conversationID")
248248
.then(() => {
249249
// 调用成功
250250
})
251-
.catch(({ errCode, errMsg }) => {
251+
.catch((error) => {
252252
// 调用失败
253253
});
254254
```

‎docs/sdks/api/conversation/getAllConversationList.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ IMSDK.asyncApi('getAllConversationList', IMSDK.uuid())
218218
### 函数原型
219219

220220
```ts showLineNumbers
221-
OpenIMSDKRN.getAllConversationList(operationID?: string): Promise<ConversationItem[]>
221+
OpenIMSDK.getAllConversationList(operationID?: string): Promise<ConversationItem[]>
222222
```
223223

224224
### 输入参数
@@ -237,13 +237,13 @@ OpenIMSDKRN.getAllConversationList(operationID?: string): Promise<ConversationIt
237237
### 代码示例
238238

239239
```js showLineNumbers
240-
import OpenIMSDKRN from "open-im-sdk-rn";
240+
import OpenIMSDK from "@openim/rn-client-sdk";
241241

242-
OpenIMSDKRN.getAllConversationList('operationID')
242+
OpenIMSDK.getAllConversationList()
243243
.then((data) => {
244244
// 调用成功
245245
})
246-
.catch(({ errCode, errMsg }) => {
246+
.catch((error) => {
247247
// 调用失败
248248
});
249249
```

‎docs/sdks/api/conversation/getConversationIDBySessionType.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ IMSDK.asyncApi('getConversationIDBySessionType', IMSDK.uuid(), {
227227
### 函数原型
228228

229229
```ts showLineNumbers
230-
OpenIMSDKRN.getConversationIDBySessionType({
230+
OpenIMSDK.getConversationIDBySessionType({
231231
sourceID: string,
232232
sessionType: number,
233233
}, operationID?: string): Promise<string>
@@ -252,16 +252,16 @@ OpenIMSDKRN.getConversationIDBySessionType({
252252
### 代码示例
253253

254254
```js showLineNumbers
255-
import OpenIMSDKRN from "open-im-sdk-rn";
255+
import OpenIMSDK from "@openim/rn-client-sdk";
256256

257-
OpenIMSDKRN.getConversationIDBySessionType({
257+
OpenIMSDK.getConversationIDBySessionType({
258258
sourceID: 'user1',
259259
sessionType: 1,
260-
}, 'operationID')
260+
}
261261
.then((data) => {
262262
// 调用成功
263263
})
264-
.catch(({ errCode, errMsg }) => {
264+
.catch((error) => {
265265
// 调用失败
266266
});
267267
```

‎docs/sdks/api/conversation/getConversationListSplit.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ IMSDK.asyncApi('getConversationListSplit', IMSDK.uuid(), {
245245
### 函数原型
246246

247247
```ts showLineNumbers
248-
OpenIMSDKRN.getConversationListSplit({
248+
OpenIMSDK.getConversationListSplit({
249249
offset: number,
250250
count: number,
251251
}, operationID?: string): Promise<ConversationItem[]>
@@ -270,16 +270,16 @@ OpenIMSDKRN.getConversationListSplit({
270270
### 代码示例
271271

272272
```js showLineNumbers
273-
import OpenIMSDKRN from "open-im-sdk-rn";
273+
import OpenIMSDK from "@openim/rn-client-sdk";
274274

275-
OpenIMSDKRN.getConversationListSplit({
275+
OpenIMSDK.getConversationListSplit({
276276
offset: 0,
277277
count: 20,
278-
}, 'operationID')
278+
})
279279
.then((data) => {
280280
// 调用成功
281281
})
282-
.catch(({ errCode, errMsg }) => {
282+
.catch((error) => {
283283
// 调用失败
284284
});
285285
```

‎docs/sdks/api/conversation/getInputStates.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ IMSDK.asyncApi('getInputstates', IMSDK.uuid(), {
247247
### 函数原型
248248

249249
```ts showLineNumbers
250-
OpenIMSDKRN.getInputstates({
250+
OpenIMSDK.getInputstates({
251251
conversationID: string,
252252
userID: string,
253253
}, operationID?: string): Promise<number[]>
@@ -270,16 +270,16 @@ OpenIMSDKRN.getInputstates({
270270
### 代码示例
271271

272272
```js showLineNumbers
273-
import OpenIMSDKRN from "open-im-sdk-rn";
273+
import OpenIMSDK from "@openim/rn-client-sdk";
274274

275-
OpenIMSDKRN.getInputstates({
275+
OpenIMSDK.getInputstates({
276276
conversationID: 'conversationID',
277277
userID: 'userID',
278-
}, 'operationID')
278+
})
279279
.then(() => {
280280
// 调用成功
281281
})
282-
.catch(({ errCode, errMsg }) => {
282+
.catch((error) => {
283283
// 调用失败
284284
});
285285
```

‎docs/sdks/api/conversation/getMultipleConversation.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ IMSDK.asyncApi('getMultipleConversation', IMSDK.uuid(), ['conversationID'])
218218
### 函数原型
219219

220220
```ts showLineNumbers
221-
OpenIMSDKRN.getMultipleConversation({
221+
OpenIMSDK.getMultipleConversation({
222222
conversationIDList: string[],
223223
}, operationID?: string): Promise<ConversationItem[]>
224224
```
@@ -240,13 +240,13 @@ OpenIMSDKRN.getMultipleConversation({
240240
### 代码示例
241241

242242
```js showLineNumbers
243-
import OpenIMSDKRN from "open-im-sdk-rn";
243+
import OpenIMSDK from "@openim/rn-client-sdk";
244244

245-
OpenIMSDKRN.getMultipleConversation(['conversationID'], 'operationID')
245+
OpenIMSDK.getMultipleConversation(['conversationID'])
246246
.then((data) => {
247247
// 调用成功
248248
})
249-
.catch(({ errCode, errMsg }) => {
249+
.catch((error) => {
250250
// 调用失败
251251
});
252252
```

‎docs/sdks/api/conversation/getOneConversation.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ IMSDK.asyncApi('getOneConversation', IMSDK.uuid(), {
240240
### 函数原型
241241

242242
```ts showLineNumbers
243-
OpenIMSDKRN.getOneConversation({
243+
OpenIMSDK.getOneConversation({
244244
sessionType: number,
245245
sourceID: string,
246246
}, operationID?: string): Promise<ConversationItem>
@@ -264,16 +264,16 @@ OpenIMSDKRN.getOneConversation({
264264
### 代码示例
265265

266266
```js showLineNumbers
267-
import OpenIMSDKRN from "open-im-sdk-rn";
267+
import OpenIMSDK from "@openim/rn-client-sdk";
268268

269-
OpenIMSDKRN.getOneConversation({
269+
OpenIMSDK.getOneConversation({
270270
sourceID: 'user1',
271271
sessionType: 1,
272-
}, 'operationID')
272+
})
273273
.then((data) => {
274274
// 调用成功
275275
})
276-
.catch(({ errCode, errMsg }) => {
276+
.catch((error) => {
277277
// 调用失败
278278
});
279279
```

‎docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ IMSDK.asyncApi('getTotalUnreadMsgCount', IMSDK.uuid())
211211
### 函数原型
212212

213213
```ts showLineNumbers
214-
OpenIMSDKRN.getTotalUnreadMsgCount(operationID?: string): Promise<number>
214+
OpenIMSDK.getTotalUnreadMsgCount(operationID?: string): Promise<number>
215215
```
216216

217217
### 输入参数
@@ -230,13 +230,13 @@ OpenIMSDKRN.getTotalUnreadMsgCount(operationID?: string): Promise<number>
230230
### 代码示例
231231

232232
```js showLineNumbers
233-
import OpenIMSDKRN from "open-im-sdk-rn";
233+
import OpenIMSDK from "@openim/rn-client-sdk";
234234

235-
OpenIMSDKRN.getTotalUnreadMsgCount('operationID')
235+
OpenIMSDK.getTotalUnreadMsgCount()
236236
.then((data) => {
237237
// 调用成功
238238
})
239-
.catch(({ errCode, errMsg }) => {
239+
.catch((error) => {
240240
// 调用失败
241241
});
242242
```

0 commit comments

Comments
 (0)