NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
Public 类型 | 静态 Public 成员函数 | 所有成员列表
nim::Signaling类 参考

namespace nim 更多...

#include <nim_cpp_signaling.h>

Public 类型

typedef std::function< void(std::shared_ptr< SignalingNotifyInfo >)> SignalingNotifyCallback
 单条通知回调
 
typedef std::function< void(std::list< std::shared_ptr< SignalingNotifyInfo > >)> SignalingNotifyListCallback
 多条通知回调
 
typedef std::function< void(SignalingChannelDetailedinfo)> SignalingChannelCallback
 频道信息回调
 
typedef std::function< void(std::list< SignalingChannelDetailedinfo >)> SignalingChannelListCallback
 频道列表通知回调
 
typedef std::function< void(int, std::shared_ptr< SignalingResParam >)> SignalingOptCallback
 信令操作回调
 

静态 Public 成员函数

static void RegOnlineNotifyCb (SignalingNotifyCallback cb)
 注册独立信令的在线通知回调接口
 
static void RegMutilClientSyncNotifyCb (SignalingNotifyCallback cb)
 注册独立信令的多端同步通知回调接口，用于通知信令相关的多端同步通知。比如自己在手机端接受邀请，PC端会同步收到这个通知
 
static void RegOfflineNotifyCb (SignalingNotifyListCallback cb)
 注册独立信令的离线通知回调接口
 
static void RegChannelsSyncCb (SignalingChannelListCallback cb)
 注册独立信令的频道列表同步回调接口
 
static void RegMembersSyncCb (SignalingChannelCallback cb)
 注册独立信令的频道成员变更同步回调接口
 
static void SignalingCreate (SignalingCreateParam param, SignalingOptCallback cb)
 独立信令 创建频道
 
static void SignalingClose (SignalingCloseParam param, SignalingOptCallback cb)
 独立信令 关闭销毁频道
 
static void Join (SignalingJoinParam param, SignalingOptCallback cb)
 独立信令 加入频道接口
 
static void Leave (SignalingLeaveParam param, SignalingOptCallback cb)
 独立信令 离开频道接口
 
static void QueryChannelInfo (SignalingQueryChannelInfoParam param, SignalingOptCallback cb)
 独立信令 查询频道接口
 
static void Call (SignalingCallParam param, SignalingOptCallback cb)
 独立信令 呼叫接口
 
static void CallEx (SignalingCallParam param, SignalingOptCallback cb)
 独立信令 呼叫接口
 
static void JoinAndAccept (SignalingJoinAndAcceptParam param, SignalingOptCallback cb)
 独立信令 加入并接受接口
 
static void Invite (SignalingInviteParam param, SignalingOptCallback cb)
 独立信令 邀请接口
 
static void CancelInvite (SignalingCancelInviteParam param, SignalingOptCallback cb)
 独立信令 取消邀请接口
 
static void Reject (SignalingRejectParam param, SignalingOptCallback cb)
 独立信令 拒绝邀请接口
 
static void Accept (SignalingAcceptParam param, SignalingOptCallback cb)
 独立信令 接受邀请接口
 
static void Control (SignalingControlParam param, SignalingOptCallback cb)
 独立信令 用户自定义控制指令接口
 

详细描述

namespace nim

成员类型定义说明

◆ SignalingChannelCallback

typedef std::function<void(SignalingChannelDetailedinfo)> nim::Signaling::SignalingChannelCallback

频道信息回调

◆ SignalingChannelListCallback

typedef std::function<void(std::list<SignalingChannelDetailedinfo>)> nim::Signaling::SignalingChannelListCallback

频道列表通知回调

◆ SignalingNotifyCallback

typedef std::function<void(std::shared_ptr<SignalingNotifyInfo>)> nim::Signaling::SignalingNotifyCallback

单条通知回调

◆ SignalingNotifyListCallback

typedef std::function<void(std::list<std::shared_ptr<SignalingNotifyInfo>>)> nim::Signaling::SignalingNotifyListCallback

多条通知回调

◆ SignalingOptCallback

typedef std::function<void(int, std::shared_ptr<SignalingResParam>)> nim::Signaling::SignalingOptCallback

信令操作回调

成员函数说明

◆ Accept()

static void nim::Signaling::Accept ( SignalingAcceptParam param,
SignalingOptCallback cb )
static

独立信令 接受邀请接口

注解
不开自动加入开关：该接口只接受邀请并告知邀请者，并同步通知自己的其他在线设备，但不会主动加入频道，需要单独调用加入接口
打开自动加入开关：该接口为组合接口，等同于先调用接受邀请，成功后再加入频道。
该接口在打开自动加入开关后是组合接口，对应的通知会有2个，接收邀请通知和加入通知
参数
[in]param接受邀请的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingAcceptResParam，在不自动加入时SignalingAcceptResParam无效
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10408:邀请不存在或已过期; 10409:邀请已经拒绝; 10410:邀请已经接受了; 10201:对方不在线;

◆ Call()

static void nim::Signaling::Call ( SignalingCallParam param,
SignalingOptCallback cb )
static

独立信令 呼叫接口

注解
用于用户新开一个频道并邀请对方加入频道，如果返回码不是200、10201、10202时，sdk会主动关闭频道，标记接口调用失败
该接口为组合接口，等同于用户先创建频道，成功后加入频道并邀请对方
参数
[in]param呼叫的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingCallResParam
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时; 10405:频道已存在; 10201:对方云信不在线，如果打开存离线开关，可认为发送成功，对方可收到离线消息; 10202:对方推送亦不可达，如果打开存离线开关，可认为发送成功，对方可收到离线消息;

◆ CallEx()

static void nim::Signaling::CallEx ( SignalingCallParam param,
SignalingOptCallback cb )
static

独立信令 呼叫接口

注解
用于用户新开一个频道并邀请对方加入频道，如果返回码不是200、10201、10202时，sdk会主动关闭频道，标记接口调用失败
该接口为组合接口，等同于用户先创建频道，成功后加入频道并邀请对方
参数
[in]param呼叫的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingCallResParam
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时; 10405:频道已存在; 10201:对方云信不在线，如果打开存离线开关，可认为发送成功，对方可收到离线消息; 10202:对方推送亦不可达，如果打开存离线开关，可认为发送成功，对方可收到离线消息;

◆ CancelInvite()

static void nim::Signaling::CancelInvite ( SignalingCancelInviteParam param,
SignalingOptCallback cb )
static

独立信令 取消邀请接口

参数
[in]param取消邀请的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingCancelInviteResParam
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10408:邀请不存在或已过期; 10409:邀请已经拒绝; 10410:邀请已经接受了;

◆ Control()

static void nim::Signaling::Control ( SignalingControlParam param,
SignalingOptCallback cb )
static

独立信令 用户自定义控制指令接口

注解
该接口用于在频道中透传一些自定义指令，协助频道管理。该接口允许非频道内成员调用，但接收者必须是频道内成员或创建者
参数
[in]param控制通知的传入参数，接收方to_填空为群发，只支持在线通知
[in]cb结果回调见nim_signaling_helper.h，返回SignalingControlResParam
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10406:不在频道内; 10201:对方不在线;

◆ Invite()

static void nim::Signaling::Invite ( SignalingInviteParam param,
SignalingOptCallback cb )
static

独立信令 邀请接口

注解
该接口用于邀请对方加入频道，邀请者必须是创建者或者是频道中成员。
如果需要对离线成员邀请，可以打开离线邀请开关并填写推送信息。被邀请者在线后通过离线通知接收到该邀请，并通过频道信息中的invalid_字段判断频道的有效性，也可以对所有离线消息处理后判断该邀请是否被取消。
参数
[in]param邀请的传入参数，其中邀请标识由用户生成，在取消邀请和邀请通知及接受拒绝时做对应
[in]cb结果回调见nim_signaling_helper.h，返回SignalingInviteResParam
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10406:不在频道内（自己）; 10407:已经在频道内（对方）; 10419:频道人数超限; 10201:对方云信不在线，如果打开存离线开关，可认为发送成功，对方可收到离线消息; 10202:对方推送亦不可达，如果打开存离线开关，可认为发送成功，对方可收到离线消息;

◆ Join()

static void nim::Signaling::Join ( SignalingJoinParam param,
SignalingOptCallback cb )
static

独立信令 加入频道接口

参数
[in]param加入频道的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingJoinResParam
返回
void 无返回值
错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10407:已经在频道内; 10417:uid冲突; 10419:频道人数超限; 10420:已经在频道内（自己的其他端）;

◆ JoinAndAccept()

static void nim::Signaling::JoinAndAccept ( SignalingJoinAndAcceptParam param,
SignalingOptCallback cb )
static

独立信令 加入并接受接口

参数
[in]param加入并接受的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingJoinAndAcceptResParam
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时;

◆ Leave()

static void nim::Signaling::Leave ( SignalingLeaveParam param,
SignalingOptCallback cb )
static

独立信令 离开频道接口

参数
[in]param离开频道的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingLeaveResParam
返回
void 无返回值
错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10406:不在频道内;

◆ QueryChannelInfo()

static void nim::Signaling::QueryChannelInfo ( SignalingQueryChannelInfoParam param,
SignalingOptCallback cb )
static

独立信令 查询频道接口

参数
[in]param查询频道的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingQueryChannelInfoResParam
返回
void 无返回值
错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在;

◆ RegChannelsSyncCb()

static void nim::Signaling::RegChannelsSyncCb ( SignalingChannelListCallback cb)
static

注册独立信令的频道列表同步回调接口

注解
在login或者relogin后，会通知该设备账号还未退出的频道列表，用于同步；如果没有在任何频道中，也会返回该同步通知，list为空
参数
[in]cb通知回调
返回
void 无返回值

◆ RegMembersSyncCb()

static void nim::Signaling::RegMembersSyncCb ( SignalingChannelCallback cb)
static

注册独立信令的频道成员变更同步回调接口

注解
用于同步频道内的成员列表变更，当前该接口为定时接口，2分钟同步一次，成员有变化时才上报。
由于一些特殊情况，导致成员在离开或掉线前没有主动调用离开频道接口，使得该成员的离开没有对应的离开通知事件，由该回调接口【频道成员变更同步通知】告知用户。
参数
[in]cb通知回调
返回
void 无返回值

◆ RegMutilClientSyncNotifyCb()

static void nim::Signaling::RegMutilClientSyncNotifyCb ( SignalingNotifyCallback cb)
static

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

参数
[in]cb通知回调，返回SignalingNotifyInfo的子类
返回
void 无返回值

◆ RegOfflineNotifyCb()

static void nim::Signaling::RegOfflineNotifyCb ( SignalingNotifyListCallback cb)
static

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

注解
需要用户在调用相关接口时，打开存离线的开关。如果用户已经接收消息，该通知会在服务器标记已读，之后不会再收到该消息。
参数
[in]cb通知回调，返回SignalingNotifyInfo子类的list
返回
void 无返回值

◆ RegOnlineNotifyCb()

static void nim::Signaling::RegOnlineNotifyCb ( SignalingNotifyCallback cb)
static

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

参数
[in]cb通知回调，返回SignalingNotifyInfo的子类
返回
void 无返回值

◆ Reject()

static void nim::Signaling::Reject ( SignalingRejectParam param,
SignalingOptCallback cb )
static

独立信令 拒绝邀请接口

注解
拒绝邀请后用户也可以通过加入频道接口加入频道，接口的使用由用户的业务决定
参数
[in]param拒绝邀请的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingRejectResParam
返回
void 无返回值 错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10408:邀请不存在或已过期; 10409:邀请已经拒绝; 10410:邀请已经接受了; 10201:对方不在线;

◆ SignalingClose()

static void nim::Signaling::SignalingClose ( SignalingCloseParam param,
SignalingOptCallback cb )
static

独立信令 关闭销毁频道

注解
整个通话结束，如果只单人退出请调用Leave接口
该接口可以由创建者和频道内所有成员调用，无权限限制。
调用该接口成功后，其他所有频道内的成员都回收到频道结束的通知，被动离开频道。此时其他成员不需要调用离开接口，也不会收到别人的离开通知。
参数
[in]param创建频道的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingCloseResParam
返回
void 无返回值
错误码： 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10406:不在频道内;

◆ SignalingCreate()

static void nim::Signaling::SignalingCreate ( SignalingCreateParam param,
SignalingOptCallback cb )
static

独立信令 创建频道

注解
该接口用户创建频道，同一时刻频道名互斥，不能重复创建。但如果频道名缺省，服务器会自动分配频道ID。
对于频道在创建后如果没人加入，有效期2小时，当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。
参数
[in]param创建频道的传入参数
[in]cb结果回调见nim_signaling_helper.h，返回SignalingCreateResParam
返回
void 无返回值
错误码： 200:成功; 0:接口服务异常; 408:超时; 10405:频道已存在;
该类的文档由以下文件生成: