Skip to content

Commit 1995458

Browse files
BloominggBloomingg
committed
fix: link path update
1 parent 47f2dfc commit 1995458

5 files changed

Lines changed: 83 additions & 957 deletions

File tree

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

Lines changed: 20 additions & 241 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ toc_max_heading_level: 2
1919
**相关回调**：
2020
[onConversationChanged](docs/sdks/callback/onConversationChanged.mdx)
2121

22+
2223
:::
2324

2425
<Tabs
@@ -36,283 +37,61 @@ values={[
3637

3738
<TabItem value="Flutter">
3839

39-
### 函数原型
40-
41-
```dart showLineNumbers
42-
Future pinConversation({
43-
required String conversationID,
44-
required bool isPinned,
45-
String? operationID,
46-
})
47-
```
48-
49-
### 输入参数
50-
51-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
52-
| -------------- | -------- | -------- | -------- |
53-
| conversationID | String | 是 | 会话 ID |
54-
| isPinned | bool | 是 | 是否置顶 |
55-
56-
### 返回结果
57-
58-
| 名称 | 类型 | 描述 |
59-
| ---- | ---- | -------------------- |
60-
| ~ | ~ | 无异常抛出则操作成功 |
61-
62-
### 代码示例
63-
64-
```dart showLineNumbers
65-
await OpenIM.iMManager.conversationManager.pinConversation(conversationID: conversationID, isPinned: isPinned);
66-
//todo
67-
```
68-
69-
</TabItem>
70-
71-
<TabItem value="iOS">
72-
73-
### 函数原型
74-
75-
```swift showLineNumbers
76-
77-
- (void)pinConversation:(NSString *)conversationID
78-
isPinned:(BOOL)isPinned
79-
onSuccess:(nullable OIMSuccessCallback)onSuccess
80-
onFailure:(nullable OIMFailureCallback)onFailure;
81-
82-
```
83-
84-
### 输入参数
85-
86-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
87-
| -------------- | -------- | -------- | -------- |
88-
| conversationID | NSString | 是 | 会话 ID |
89-
| isPinned | BOOL | 是 | 是否置顶 |
90-
91-
### 返回结果
92-
93-
| 名称 | 类型 | 描述 |
94-
| --------- | ------------------------------------------------------ | -------- |
95-
| onSuccess | OIMSuccessCallback | 成功返回 |
96-
| onFailure | OIMFailureCallback | 失败返回 |
97-
98-
### 代码示例
99-
100-
```swift showLineNumbers
101-
102-
[OIMManager.manager pinConversation:@""
103-
isPinned:YES
104-
onSuccess:^(NSString * _Nullable data) {
105-
106-
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
40+
:::info 说明
10741

108-
}];
42+
待更新
10943

110-
```
44+
:::
11145

11246
</TabItem>
11347

11448
<TabItem value="Android">
11549

116-
### 函数原型
117-
118-
```java showLineNumbers
119-
public void pinConversation(OnBase<String> callBack, String conversationID, boolean isPinned)
120-
```
121-
122-
### 输入参数
123-
124-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
125-
| -------------- | ------------------------------------------------ | -------- | -------- |
126-
| callBack | [OnBase<String\>](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 |
127-
| conversationID | String | 是 | 会话 ID |
128-
| isPinned | bool | 是 | 是否置顶 |
129-
130-
### 代码示例
131-
132-
```java showLineNumbers
133-
OpenIMClient.getInstance().conversationManager.pinConversation(new OnBase<String>() {
134-
@Override
135-
public void onError(int code, String error) {
136-
137-
}
50+
:::info 说明
13851

139-
@Override
140-
public void onSuccess(String data) {
52+
待更新
14153

142-
}
143-
},conversationID,isPinned);
144-
```
54+
:::
14555

14656
</TabItem>
14757

14858
<TabItem value="Web">
14959

150-
### 函数原型
151-
152-
```ts showLineNumbers
153-
IMSDK.pinConversation({
154-
conversationID: string;
155-
isPinned: boolean;
156-
},operationID?: string): Promise<WsResponse>
157-
```
158-
159-
### 输入参数
160-
161-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
162-
| -------------- | -------- | -------- | -------- |
163-
| conversationID | string | 是 | 会话 ID |
164-
| isPinned | boolean | 是 | 是否置顶 |
165-
166-
### 返回结果
167-
168-
| 参数名称 | 参数类型 | 描述 |
169-
| --------------- | ---------------------------------------------------- | ------------ |
170-
| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用成功回调 |
171-
| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
172-
173-
### 代码示例
174-
175-
```js showLineNumbers
176-
import { getSDK } from 'open-im-sdk-wasm';
177-
const IMSDK = getSDK();
178-
179-
// use in electron with ffi
180-
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
181-
// const { instance: IMSDK } = getWithRenderProcess();
60+
:::info 说明
18261

183-
// use in mini program
184-
// import { OpenIMSDK } from 'open-im-sdk';
185-
// const IMSDK = new OpenIMSDK();
62+
待更新
18663

187-
IMSDK.pinConversation({
188-
conversationID: 'conversationID',
189-
isPinned: true,
190-
})
191-
.then(({ data }) => {
192-
// 调用成功
193-
})
194-
.catch(({ errCode, errMsg }) => {
195-
// 调用失败
196-
});
197-
```
64+
:::
19865

19966
</TabItem>
20067

20168
<TabItem value="uni-app">
20269

203-
### 函数原型
204-
205-
```ts showLineNumbers
206-
IMSDK.asyncApi('pinConversation', operationID: string, {
207-
conversationID: string;
208-
isPinned: boolean;
209-
}): Promise<void>
210-
```
211-
212-
### 输入参数
213-
214-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
215-
| -------------- | -------- | -------- | ------------------------------------------------------- |
216-
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
217-
| conversationID | string | 是 | 会话 ID |
218-
| isPinned | boolean | 是 | 是否置顶 |
219-
220-
### 返回结果
221-
222-
> 通过`openim-uniapp-polyfill`包将函数 Promise 化，调用时需要使用`then`和`catch`判断并处理成功和失败回调。
223-
224-
| 参数名称 | 参数类型 | 描述 |
225-
| --------------- | ------------------------------------------------------- | ------------ |
226-
| Promise.then() | Promise<void\> | 调用成功回调 |
227-
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
228-
229-
### 代码示例
70+
:::info 说明
23071

231-
```js showLineNumbers
232-
import IMSDK from 'openim-uniapp-polyfill';
72+
待更新
23373

234-
IMSDK.asyncApi('pinConversation', IMSDK.uuid(), {
235-
conversationID: 'conversationID',
236-
isPinned: true,
237-
})
238-
.then(() => {
239-
// 调用成功
240-
})
241-
.catch(({ errCode, errMsg }) => {
242-
// 调用失败
243-
});
244-
```
74+
:::
24575

24676
</TabItem>
247-
<TabItem value="React-Native">
248-
249-
### 函数原型
250-
251-
```ts showLineNumbers
252-
OpenIMSDKRN.pinConversation({
253-
conversationID: string,
254-
isPinned: boolean,
255-
},operationID: string): Promise<void>
256-
```
257-
258-
### 输入参数
25977

260-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
261-
| -------------- | -------- | -------- | ------------------------------------------------------- |
262-
| conversationID | string | 是 | 会话 ID |
263-
| isPinned | boolean | 是 | 是否置顶 |
264-
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
265-
266-
### 返回结果
267-
268-
| 参数名称 | 参数类型 | 描述 |
269-
| --------------- | ------------------------------------------------------- | ------------ |
270-
| Promise.then() | Promise<void\> | 调用成功回调 |
271-
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
78+
<TabItem value="React-Native">
27279

273-
### 代码示例
80+
:::info 说明
27481

275-
```js showLineNumbers
276-
import OpenIMSDKRN from "open-im-sdk-rn";
82+
待更新
27783

278-
OpenIMSDKRN.pinConversation({
279-
conversationID: 'conversationID',
280-
isPinned: true,
281-
}, 'operationID')
282-
.then(() => {
283-
// 调用成功
284-
})
285-
.catch(({ errCode, errMsg }) => {
286-
// 调用失败
287-
});
288-
```
84+
:::
28985

29086
</TabItem>
29187

29288
<TabItem value="Unity">
29389

294-
### 函数原型
295-
296-
```C# showLineNumbers
297-
public static void PinConversation(OnSucOrError cb, string conversationID, bool isPinned)
298-
```
299-
300-
301-
### 输入参数
302-
303-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
304-
| -------------- | ------------------------------------------------ | -------- | -------- |
305-
| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | 是 | 回调接口 |
306-
| conversationID | string | 是 | 会话 ID |
307-
| isPinned | bool | 是 | 是否置顶 |
308-
309-
### 代码示例
90+
:::info 说明
31091

311-
```C# showLineNumbers
312-
IMSDK.((suc,errCode,errMsg)=>{
92+
待更新
31393

314-
},conversationID,isPinned);
315-
```
94+
:::
31695

31796
</TabItem>
31897

0 commit comments

Comments
 (0)