invite

功能介绍

邀请某个人

参数详解

参数名称 参数类型 是否必填 描述
invitee string 被邀请人id
data string 邀请时附带的定义消息
timeout number 邀请超时时间(单位 秒) 默认为30秒,若传0则表示永不失效。
onlineUserOnly boolean 是否只发给在线用户
offlinePushInfo V2TimOfflinePushInfo 离线推送设置

返回模板

V2TimValueCallback<string>

{
    code : number
    desc : string
    data : string//创建的邀请id
}

返回值详解

名称 数值类型 描述
code number 请求结果错误码
desc string 请求结果描述符
data string 创建的邀请id

代码示例

import { TencentImSDKPlugin } from 'react-native-tim-js';

//设置信令监听器
const listener = {
    onInvitationCancelled: (inviteID, inviter, data) => {
        //邀请被取消的回调
        //inviteID 邀请消息信令id
        //inviter 邀请人id
        //data 邀请被取消时的自定义data
    },
    onInvitationTimeout: (inviteID, inviteeList) => {
        //邀请超时的回调
        //inviteID 邀请消息信令id
        //inviteeList 被邀请人的列表
    },
    onInviteeAccepted: (inviteID, invitee, data) => {
        //邀请被接受的回调
        //inviteID 邀请消息信令id
        //invitee 被邀请人id
        //data 接受邀请时的自定义data
    },
    onInviteeRejected: (inviteID, invitee, data) => {
        //邀请被拒绝的回调
        //inviteID 邀请消息信令id
        //invitee 被邀请人id
        //data 拒绝邀请时的自定义data
    },
    onReceiveNewInvitation: (inviteID, inviter, groupID, inviteeList, data) => {
        //获取新的邀请的回调
        //inviteID 邀请消息信令id
        //inviter 邀请人id
        //groupID 发出邀请的群组id
        //inviteeList 被邀请人的列表
        //data 邀请时的自定义data
    },
};
TencentImSDKPlugin.v2TIMManager
    .getSignalingManager()
    .addSignalingListener(listener);

const inviteRes = await TencentImSDKPlugin.v2TIMManager
    .getSignalingManager()
    .invite(
        '', //被邀请人id
        'data', //邀请时附带的定义消息
        30, //邀请超时时间
        false, //是否只发给在线用户
        {}
    );
if (inviteRes.code === 0) {
    //创建邀请成功
    inviteRes.data; //创建的邀请id
}

results matching ""

    No results matching ""