TIMMsgCancelSend

Introduction

Cancel sending message

Parameter details

Parameter name Parameter type Required Description
msgCancelSendParams MsgCancelSendParams yes Param of canceling sending messages

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 { MsgCancelSendParams } from "im_electron_sdk/dist/interfaces";
let convId = ''
let convType = 0
let messageId = ''
let param: MsgCancelSendParams = {
    conv_id: convId,    // required
    conv_type: convType,    // required
    message_id: messageId,    // required
    user_data: ''    // optional
}

const { code } = await timRenderInstance.TIMMsgCancelSend(param);
if (code == 0) {
    // success
}

results matching ""

    No results matching ""