TIMConvMarkConversation
Introduction
Mark conversation
Supported from the 6.5 version of the sdk
Only works with Ultimate edition
You can add custom markType, if the default types can not meet your needs, while needs to meet the following two requirements and conditions:
The value of the custom markType can not be the same as the default type value.
The custom markType value must be the displacement value of 0x1L << N (32 <= n <64, that N must be greater than or equal to 32 and less than 64), for example, the custom 0x1L << 32 mark value indicates 'Windows online'. The extended marking value cannot be set to 0x1 << 32, and it must be set to 0x1L << 32, and clearly tells the compiler is 64 -bit integer constant.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| markConvParam | MarkConversationParam | yes | Param of marking conversation |
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: MarkConversationParam = {
conversation_id_array: ["10043564"],
mark_type: 0x1,
enable_mark: true
}
timRenderInstance.TIMConvMarkConversation(param);