TIMUnsubscribeUserStatus
Introduction
unsubscribe user's status
When userIDList is empty or null, cancel all current subscriptions
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| userStatusParam | userStatusParam | yes | user status param |
Returned template
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | 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 | string ｜ undefined | Return value of calling API |
| json_params | string ｜ 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();
import {userStatusParam} from "im_electron_sdk/dist/interfaces"
let userID = ''
let param:userStatusParam = {
id_array:[userID],
user_data:""
}
let {code} = timRenderInstance.TIMUnsubscribeUserStatus(param)
if(code == 0){
//success
}