MsgClearHistoryMessage
introduction
Clear history message
When messages in a conversation are cleared, all the messages in the conversation will be cleared both locally and from the cloud, but the conversation itself will not be deleted.
Do not use this API if you do not want to clear messages from the cloud.
Parameter details
overload1
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| conv_id | string | Required | Conversation ID |
| conv_type | TIMConvType | Required | Conversation type |
| callback | NullValueCallback | Required | Asynchronous callback |
overload2
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| conv_id | string | Required | Conversation ID |
| conv_type | TIMConvType | Required | Conversation type |
| callback | ValueCallback< string > | Required | Asynchronous callback The format of json_param in the return value is string |
Returned template
TIMResult
The parameters of the callback function after successfully calling the API：
code:int
desc:string
json_param:'' // json_ Params is an empty string ""
user_data:string
Return value details
| name | type | description |
|---|---|---|
| TIMResult | TIMResult | Return value of calling API |
| code | int | Result error code: Error Codes |
| desc | string | The description of the error. |
| json_param | string | Json string. Calling different API will get different Json strings. |
| user_data | string | User-defined data transfered by ImSDK without any processing |