setConversationBurnDuration

Feature Introduction

Description

Set the "burn after reading" duration for a single conversation.

Note

Related Callback:
onConversationChanged

iOS

Function Prototype

Future<dynamic> setOneConversationBurnDuration({
    required String conversationID,
    int burnDuration = 30,
    String? operationID,
  })

Input Parameters

Parameter Name	Data Type	Mandatory	Description
conversationID	String	Yes	Conversation ID
burnDuration	int	Yes	Duration for "burn after reading" in seconds

Return Result

Name	Type	Description
~	~	Successful if no exception thrown

Code Example

    await OpenIM.iMManager.conversationManager.setConversationBurnDuration(conversationID: conversationID);
    //todo

Android

Function Prototype

- (void)setConversationBurnDuration:(NSString *)conversationID
                              duration:(NSInteger)burnDuration
                             onSuccess:(nullable OIMSuccessCallback)onSuccess
                             onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Data Type	Mandatory	Description
conversationID	NSString	Yes	Conversation ID
burnDuration	NSInteger	Yes	Duration for "burn after reading" in seconds

Return Result

Name	Type	Description
onSuccess	OIMSuccessCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

[OIMManager.manager setConversationBurnDuration:@""
                                          duration:30
                                         onSuccess:^(NSString * _Nullable data) {

} onFailure:^(NSInteger code, NSString * _Nullable msg) {

}];

Flutter

public void setConversationBurnDuration(OnBase<String> base, String conversationID, int burnDuration)

Input Parameters

Parameter Name	Data Type	Mandatory	Description
base	OnBase<String>	Yes	Callback interface
conversationID	String	Yes	Conversation ID
burnDuration	int	Yes	Duration for "burn after reading" in seconds

Code Example

       OpenIMClient.getInstance().conversationManager.setConversationBurnDuration(new OnBase<String>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(String data) {

            }
        },conversationID,burnDuration);

uni-app

Function Prototype

IMSDK.setConversationBurnDuration({
    conversationID: string;
    burnDuration: number;
},operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Data Type	Mandatory	Description
conversationID	string	Yes	Conversation ID
burnDuration	number	Yes	Duration for "burn after reading" in seconds

Return Result

Parameter Name	Data Type	Description
Promise.then()	Promise<WsResponse>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

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 }) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('setConversationBurnDuration', operationID: string, {
  conversationID: string;
  burnDuration: number;
}): Promise<void>

Input Parameters

Parameter Name	Data Type	Mandatory	Description
operationID	string	Yes	Operation ID, suggested to use current timestamp combined with a random number
conversationID	string	Yes	Conversation ID
burnDuration	number	Yes	Duration for "burn after reading" in seconds

Return Result

Through the openim-uniapp-polyfill package, the function is promisified, so use then and catch to check and handle the success and failure callbacks respectively.

Parameter Name	Data Type	Description
Promise.then()	Promise<void>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('setConversationBurnDuration', IMSDK.uuid(), {
  conversationID: 'conversationID',
  burnDuration: 60,
})
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

React-Native

Function Prototype

OpenIMSDKRN.setConversationBurnDuration({
  conversationID: string,
  burnDuration: number,
}, operationID: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	string	Yes	Conversation ID
burnDuration	number	Yes	Duration for "burn after reading" in seconds
operationID	string	Yes	Operation ID, used for problem location, keep unique, suggest using current time and random number

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Callback on successful call
Promise.catch()	Promise<CatchResponse>	Callback on successful call

Code Example

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.setConversationBurnDuration({
  conversationID: 'conversationID',
  burnDuration: 60,
}, 'operationID')
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Unity

public static void SetConversationBurnDuration(OnSucOrError cb, string conversationID, int duration)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnSucOrError	Yes	Callback
conversationID	string	Yes	Conversation ID
duration	int	Yes	Duration for "burn after reading" in seconds

Code Example

IMSDK.SetConversationBurnDuration((suc,errCode,errMsg)=>{

},conversationID,duration);