NIM Unity SDK  V2.4.2
静态 Public 成员函数 | 所有成员列表
NIM.Signaling.NIMSignalingAPI类 参考

静态 Public 成员函数

static void RegOnlineNotifyCb (NimSignalingNotifyHandler cb)
 注册独立信令的在线通知回调接口 更多...
 
static void RegMutilClientSyncNotifyCb (NimSignalingNotifyHandler cb)
 注册独立信令的多端同步通知回调接口,用于通知信令相关的多端同步通知。比如自己在手机端接受邀请,PC端会同步收到这个通知 更多...
 
static void RegOfflineNotifyCb (NimSignalingNotifyListHandler cb)
 注册独立信令的离线通知回调接口 需要用户在调用相关接口时,打开存离线的开关。如果用户已经接收消息,该通知会在服务器标记已读,之后不会再收到该消息。 更多...
 
static void RegChannelsSyncCb (NimSignalingChannelsSyncHandler cb)
 注册独立信令的频道列表同步回调接口 在login或者relogin后,会通知该设备账号还未退出的频道列表,用于同步;如果没有在任何频道中,也会返回该同步通知,list为空 更多...
 
static void RegMembersSyncCb (NimSignalingMembersSyncHandler cb)
 注册独立信令的频道成员变更同步回调接口 用于同步频道内的成员列表变更,当前该接口为定时接口,2分钟同步一次,成员有变化时才上报。 更多...
 
static void CreateChannel (NIMSignalingCreateParam param, NimSignalingOptCreateHandler cb)
 独立信令 创建频道 该接口用户创建频道,同一时刻频道名互斥,不能重复创建。但如果频道名缺省,服务器会自动分配频道id。 对于频道在创建后如果没人加入,有效期2小时,当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。 更多...
 
static void CreateChannel2 (NIMSignalingCreateParam param, NimSignalingOptCreateHandler cb)
 
static void SignalingClose (NIMSignalingCloseParam param, NimSignalingOptCloseOrLeaveHandler cb)
 独立信令 关闭销毁频道 整个通话结束,如果只单人退出请调用NimSignalingLeave接口 该接口可以由创建者和频道内所有成员调用,无权限限制 调用该接口成功后,其他所有频道内的成员都回收到频道结束的通知,被动离开频道。此时其他成员不需要调用离开接口,也不会收到别人的离开通知。 更多...
 
static void Join (NIMSignalingJoinParam param, NimSignalingOptJoinHandler cb)
 独立信令 加入频道接口 更多...
 
static void Leave (NIMSignalingLeaveParam param, LeaveChannelDelegate cb)
 独立信令 离开频道接口 更多...
 
static void Call (NIMSignalingCallParam param, CallDelegate cb)
 独立信令 呼叫接口 用于用户新开一个频道并邀请对方加入频道,如果返回码不是200、10201、10202时,sdk会主动关闭频道,标记接口调用失败 该接口为组合接口,等同于用户先创建频道,成功后加入频道并邀请对方 更多...
 
static void Invite (NIMSignalingInviteParam param, InviteDelegate cb)
 独立信令 邀请接口 该接口用于邀请对方加入频道,邀请者必须是创建者或者是频道中成员。 如果需要对离线成员邀请,可以打开离线邀请开关并填写推送信息。被邀请者在线后通过离线通知接收到该邀请,并通过频道信息中的invalid_字段判断频道的有效性,也可以对所有离线消息处理后判断该邀请是否被取消。 更多...
 
static void CancelInvite (NIMSignalingCancelInviteParam param, InviteDelegate cb)
 独立信令 取消邀请接口 更多...
 
static void Reject (NIMSignalingRejectParam param, InviteDelegate cb)
 独立信令 拒绝邀请接口 拒绝邀请后用户也可以通过加入频道接口加入频道,接口的使用由用户的业务决定 更多...
 
static void Accept (NIMSignalingAcceptParam param, InviteDelegate cb)
 独立信令 接受邀请接口 不开自动加入开关:该接口只接受邀请并告知邀请者,并同步通知自己的其他在线设备,但不会主动加入频道,需要单独调用加入接口 打开自动加入开关:该接口为组合接口,等同于先调用接受邀请,成功后再加入频道。 该接口在打开自动加入开关后是组合接口,对应的通知会有2个,接收邀请通知和加入通知 更多...
 
static void Control (NIMSignalingControlParam param, NimSignalingOptControlHandler cb)
 独立信令 用户自定义控制指令接口 该接口用于在频道中透传一些自定义指令,协助频道管理 更多...
 

成员函数说明

◆ RegOnlineNotifyCb()

static void NIM.Signaling.NIMSignalingAPI.RegOnlineNotifyCb ( NimSignalingNotifyHandler  cb)
inlinestatic

注册独立信令的在线通知回调接口

参数
cbcb 结果回调见NimSignalingDef.cs

◆ RegMutilClientSyncNotifyCb()

static void NIM.Signaling.NIMSignalingAPI.RegMutilClientSyncNotifyCb ( NimSignalingNotifyHandler  cb)
inlinestatic

注册独立信令的多端同步通知回调接口,用于通知信令相关的多端同步通知。比如自己在手机端接受邀请,PC端会同步收到这个通知

参数
cb结果回调见NimSignalingDef.cs

◆ RegOfflineNotifyCb()

static void NIM.Signaling.NIMSignalingAPI.RegOfflineNotifyCb ( NimSignalingNotifyListHandler  cb)
inlinestatic

注册独立信令的离线通知回调接口 需要用户在调用相关接口时,打开存离线的开关。如果用户已经接收消息,该通知会在服务器标记已读,之后不会再收到该消息。

参数
cb结果回调见NimSignalingDef.cs

◆ RegChannelsSyncCb()

static void NIM.Signaling.NIMSignalingAPI.RegChannelsSyncCb ( NimSignalingChannelsSyncHandler  cb)
inlinestatic

注册独立信令的频道列表同步回调接口 在login或者relogin后,会通知该设备账号还未退出的频道列表,用于同步;如果没有在任何频道中,也会返回该同步通知,list为空

参数
cb结果回调见NimSignalingDef.cs

◆ RegMembersSyncCb()

static void NIM.Signaling.NIMSignalingAPI.RegMembersSyncCb ( NimSignalingMembersSyncHandler  cb)
inlinestatic

注册独立信令的频道成员变更同步回调接口 用于同步频道内的成员列表变更,当前该接口为定时接口,2分钟同步一次,成员有变化时才上报。

参数
cbcb 结果回调见NimSignalingDef.cs

◆ CreateChannel()

static void NIM.Signaling.NIMSignalingAPI.CreateChannel ( NIMSignalingCreateParam  param,
NimSignalingOptCreateHandler  cb 
)
inlinestatic

独立信令 创建频道 该接口用户创建频道,同一时刻频道名互斥,不能重复创建。但如果频道名缺省,服务器会自动分配频道id。 对于频道在创建后如果没人加入,有效期2小时,当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。

参数
param创建频道的传入参数
cb结果回调见NimSignalingDef.cs

◆ SignalingClose()

static void NIM.Signaling.NIMSignalingAPI.SignalingClose ( NIMSignalingCloseParam  param,
NimSignalingOptCloseOrLeaveHandler  cb 
)
inlinestatic

独立信令 关闭销毁频道 整个通话结束,如果只单人退出请调用NimSignalingLeave接口 该接口可以由创建者和频道内所有成员调用,无权限限制 调用该接口成功后,其他所有频道内的成员都回收到频道结束的通知,被动离开频道。此时其他成员不需要调用离开接口,也不会收到别人的离开通知。

参数
param关闭频道的传入参数
cb结果回调见NimSignalingDef.cs

◆ Join()

static void NIM.Signaling.NIMSignalingAPI.Join ( NIMSignalingJoinParam  param,
NimSignalingOptJoinHandler  cb 
)
inlinestatic

独立信令 加入频道接口

参数
param加入频道的传入参数
cb结果回调见NimSignalingDef.cs

◆ Leave()

static void NIM.Signaling.NIMSignalingAPI.Leave ( NIMSignalingLeaveParam  param,
LeaveChannelDelegate  cb 
)
inlinestatic

独立信令 离开频道接口

参数
param离开频道的传入参数
cb结果回调见NimSignalingDef.cs

◆ Call()

static void NIM.Signaling.NIMSignalingAPI.Call ( NIMSignalingCallParam  param,
CallDelegate  cb 
)
inlinestatic

独立信令 呼叫接口 用于用户新开一个频道并邀请对方加入频道,如果返回码不是200、10201、10202时,sdk会主动关闭频道,标记接口调用失败 该接口为组合接口,等同于用户先创建频道,成功后加入频道并邀请对方

参数
param呼叫的传入参数
cb结果回调见NimSignalingDef.cs

◆ Invite()

static void NIM.Signaling.NIMSignalingAPI.Invite ( NIMSignalingInviteParam  param,
InviteDelegate  cb 
)
inlinestatic

独立信令 邀请接口 该接口用于邀请对方加入频道,邀请者必须是创建者或者是频道中成员。 如果需要对离线成员邀请,可以打开离线邀请开关并填写推送信息。被邀请者在线后通过离线通知接收到该邀请,并通过频道信息中的invalid_字段判断频道的有效性,也可以对所有离线消息处理后判断该邀请是否被取消。

参数
param邀请的传入参数,其中邀请标识由用户生成,在取消邀请和邀请通知及接受拒绝时做对应
cb结果回调见NimSignalingDef.cs,其中opt_res_param无效

◆ CancelInvite()

static void NIM.Signaling.NIMSignalingAPI.CancelInvite ( NIMSignalingCancelInviteParam  param,
InviteDelegate  cb 
)
inlinestatic

独立信令 取消邀请接口

参数
param取消邀请的传入参数
cb结果回调见NimSignalingDef.cs
user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理

◆ Reject()

static void NIM.Signaling.NIMSignalingAPI.Reject ( NIMSignalingRejectParam  param,
InviteDelegate  cb 
)
inlinestatic

独立信令 拒绝邀请接口 拒绝邀请后用户也可以通过加入频道接口加入频道,接口的使用由用户的业务决定

参数
param拒绝邀请的传入参数
cb结果回调见NimSignalingDef.cs

◆ Accept()

static void NIM.Signaling.NIMSignalingAPI.Accept ( NIMSignalingAcceptParam  param,
InviteDelegate  cb 
)
inlinestatic

独立信令 接受邀请接口 不开自动加入开关:该接口只接受邀请并告知邀请者,并同步通知自己的其他在线设备,但不会主动加入频道,需要单独调用加入接口 打开自动加入开关:该接口为组合接口,等同于先调用接受邀请,成功后再加入频道。 该接口在打开自动加入开关后是组合接口,对应的通知会有2个,接收邀请通知和加入通知

参数
param接受邀请的传入参数
cb结果回调见NimSignalingDef.cs,其中opt_res_param在打开自动加入开关,并成功后有效

◆ Control()

static void NIM.Signaling.NIMSignalingAPI.Control ( NIMSignalingControlParam  param,
NimSignalingOptControlHandler  cb 
)
inlinestatic

独立信令 用户自定义控制指令接口 该接口用于在频道中透传一些自定义指令,协助频道管理

参数
param控制通知的传入参数,接收方to_填空为群发,只支持在线通知
cb结果回调见NimSignalingDef.cs

该类的文档由以下文件生成: