setConversationBurnDuration
功能介绍
说明
设置单个会话上“阅后即焚”的时间。在开启阅后即焚的状态下发送的消息体上AttachedInfoElem的burnDuration
会被设置为这个时间。
注意
相关回调:
onConversationChanged
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<dynamic> setOneConversationBurnDuration({
required String conversationID,
int burnDuration = 30,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | String | 是 | 会话 ID |
burnDuration | int | 是 | 阅后即焚时间(秒) |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则操作成功 |
代码示例
await OpenIM.iMManager.conversationManager.setConversationBurnDuration(conversationID: conversationID);
//todo
函数原型
- (void)setConversationBurnDuration:(NSString *)conversationID
duration:(NSInteger)burnDuration
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | NSString | 是 | 会话 ID |
burnDuration | NSInteger | 是 | 阅后即焚时间(秒) |
返回结果
名称 | 类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager setConversationBurnDuration:@""
duration:30
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
public void setConversationBurnDuration(OnBase<String> base, String conversationID, int burnDuration)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
base | OnBase<String> | 是 | 回调接口 |
conversationID | String | 是 | 会话 ID |
burnDuration | int | 是 | 时长 |
代码示例
OpenIMClient.getInstance().conversationManager.setConversationBurnDuration(new OnBase<String>() {
@Override
public void onError(int code, String error) {
}
@Override
public void onSuccess(String data) {
}
},conversationID,burnDuration);
函数原型
IMSDK.setConversationBurnDuration({
conversationID: string;
burnDuration: number;
},operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
burnDuration | number | 是 | 阅后即焚时间(秒) |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from 'open-im-sdk-wasm';
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.setConversationBurnDuration({
conversationID: 'conversationID',
burnDuration: 60,
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('setConversationBurnDuration', operationID: string, {
conversationID: string;
burnDuration: number;
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
conversationID | string | 是 | 会话 ID |
burnDuration | number | 是 | 阅后即焚时间(秒) |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('setConversationBurnDuration', IMSDK.uuid(), {
conversationID: 'conversationID',
burnDuration: 60,
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.setConversationBurnDuration({
conversationID: string,
burnDuration: number,
}, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
burnDuration | number | 是 | 阅后即焚时间(秒) |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.setConversationBurnDuration({
conversationID: 'conversationID',
burnDuration: 60,
}, 'operationID')
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
public static void SetConversationBurnDuration(OnSucOrError cb, string conversationID, int duration)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
cb | OnSucOrError | 是 | 回调接口 |
conversationID | string | 是 | 会话 ID |
duration | int | 是 | 阅后即焚时间(秒) |
代码示例
IMSDK.SetConversationBurnDuration((suc,errCode,errMsg)=>{
},conversationID,duration);