setConversation
功能介绍
说明
设置会话信息,包括置顶,消息免打扰,ex 等字段。
注意
相关回调:
onConversationChanged
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
### 函数原型
Future setConversation(
String conversationID,
ConversationReq req, {
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | String | 是 | 会话 ID |
conversationReq | ConversationReq | 是 | 变更的结构体 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则操作成功 |
代码示例
await OpenIM.iMManager.conversationManager.setConversation(conversationID, req);
//todo
函数原型
- (void)setConversation:(NSString *)conversationID
req:(OIMConversationReq *)req
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | NSString | 是 | 会话 ID |
req | OIMConversationReq | 是 | 变更的结构体 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager setConversation:@""
req: req
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void setConversation(OnBase<String> base, String conversationID, ConversationReq conversationReq)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | String | 是 | 会话 ID |
conversationReq | ConversationReq | 是 | 变更的结构体 |
返回结果
代码示例
OpenIMClient.getInstance().conversationManager.setConversation(new OnBase<String>() {
@Override
public void onError(int code, String error) {
// todo: 处理错误信息
}
@Override
public void onSuccess(String data) {
// todo: 请求成功
}
}, conversationID , conversationReq);
函数原型
IMSDK.setConversation({
conversationID: string;
recvMsgOpt?: MessageReceiveOptType;
groupAtType?: GroupAtType;
burnDuration?: number;
isPinned?: boolean;
isPrivateChat?: boolean;
ex?: string;
},operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
recvMsgOpt | MessageReceiveOptType | 否 | 会话消息免打扰状态 |
groupAtType | GroupAtType | 否 | 会话强提醒类型 |
isPinned | boolean | 否 | 会话是否置顶 |
isPrivateChat | boolean | 否 | 会话是否开启了阅后即焚 |
burnDuration | number | 否 | 阅后即焚时间(秒) |
ex | string | 否 | 扩展字段 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise\<WsResponse> | 调用成功回调 |
Promise.catch() | Promise\<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.setConversation({
conversationID: 'conversationID',
isPinned: true,
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('setConversation', operationID: string, {
conversationID: string;
recvMsgOpt?: MessageReceiveOptType;
groupAtType?: GroupAtType;
burnDuration?: number;
isPinned?: boolean;
isPrivateChat?: boolean;
ex?: string;
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
recvMsgOpt | MessageReceiveOptType | 否 | 会话消息免打扰状态 |
groupAtType | GroupAtType | 否 | 会话强提醒类型 |
isPinned | boolean | 否 | 会话是否置顶 |
isPrivateChat | boolean | 否 | 会话是否开启了阅后即焚 |
burnDuration | number | 否 | 阅后即焚时间(秒) |
ex | string | 否 | 扩展字段 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise\<void> | 调用成功回调 |
Promise.catch() | Promise\<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('setConversation', IMSDK.uuid(), {
conversationID: '',
isPinned: true,
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.setConversation({
conversationID: string;
recvMsgOpt?: MessageReceiveOptType;
groupAtType?: GroupAtType;
burnDuration?: number;
isPinned?: boolean;
isPrivateChat?: boolean;
ex?: string;
}, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
recvMsgOpt | MessageReceiveOptType | 否 | 会话消息免打扰状态 |
groupAtType | GroupAtType | 否 | 会话强提醒类型 |
isPinned | boolean | 否 | 会话是否置顶 |
isPrivateChat | boolean | 否 | 会话是否开启了阅后即焚 |
burnDuration | number | 否 | 阅后即焚时间(秒) |
ex | string | 否 | 扩展字段 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise\<void> | 调用成功回调 |
Promise.catch() | Promise\<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from 'open-im-sdk-rn';
OpenIMSDKRN.setConversation(
{
conversationID: '',
isPinned: true,
},
'operationID'
)
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
public static void SetConversation(OnBase<bool> cb, string conversationId, ConversationReq req)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationId | string | 是 | 会话 ID |
conversationReq | ConversationReq | 是 | 变更的结构体 |
返回结果
代码示例
IMSDK.SetConversation((suc,errCode,errMsg)=> {
}, conversationId , conversationReq);