TIMConvSetConversationCustomData
Introduction
Set conversation custom data
Supported from the 6.5 version of the sdk
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| setConvCustomDataParam | setConvCustomDataParam | yes | Param of setting conversation custom data |
Returned template
Promise<commonResult<Array<TIMConversationOperationResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<TIMConversationOperationResult> | undefined;
json_params?: Array<TIMConversationOperationResult> | undefined;
user_data?: string | undefined;
}
Return value details
| name | type | description |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | Request result: Error codes. 0 means success. |
| desc | string ｜ undefined | The description of the error. It will be empty if success. |
| json_param | TIMConversationOperationResult[] ｜ undefined | Return value of calling API |
| json_params | TIMConversationOperationResult[] ｜ undefined | Return value of calling API. Compatible field, which is returned in some cases. |
| user_data | string ｜ undefined | ImSDK is responsible for transporting user-defined data without any processing |
Code example
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
let param: setConvCustomDataParam = {
conversation_id_array: ["group_@TGS#2B6MQRSHD"],
custom_data: "nihao"
}
timRenderInstance.TIMConvSetConversationCustomData(param);