invite
功能介绍
邀请某个人
参数详解
参数名称 |
参数类型 |
是否必填 |
描述 |
invitee |
string |
是 |
被邀请人id |
data |
string |
是 |
邀请时附带的定义消息 |
timeout |
number |
否 |
邀请超时时间(单位 秒) 默认为30秒,若传0则表示永不失效。 |
onlineUserOnly |
boolean |
否 |
是否只发给在线用户 |
offlinePushInfo |
V2TimOfflinePushInfo |
否 |
离线推送设置 |
返回模板
V2TimValueCallback<string>
{
code : number
desc : string
data : string
}
返回值详解
名称 |
数值类型 |
描述 |
code |
number |
请求结果错误码 |
desc |
string |
请求结果描述符 |
data |
string |
创建的邀请id |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
const listener = {
onInvitationCancelled: (inviteID, inviter, data) => {
},
onInvitationTimeout: (inviteID, inviteeList) => {
},
onInviteeAccepted: (inviteID, invitee, data) => {
},
onInviteeRejected: (inviteID, invitee, data) => {
},
onReceiveNewInvitation: (inviteID, inviter, groupID, inviteeList, data) => {
},
};
TencentImSDKPlugin.v2TIMManager
.getSignalingManager()
.addSignalingListener(listener);
const inviteRes = await TencentImSDKPlugin.v2TIMManager
.getSignalingManager()
.invite(
'',
'data',
30,
false,
{}
);
if (inviteRes.code === 0) {
inviteRes.data;
}