NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
nim_signaling.h 文件参考

独立信令 接口头文件 更多...

浏览源代码.

函数

NIM_SDK_DLL_API void nim_signaling_reg_online_notify_cb (nim_signaling_notify_cb_func cb, const void *user_data)
 注册独立信令的在线通知回调接口
 
NIM_SDK_DLL_API void nim_signaling_reg_mutil_client_sync_notify_cb (nim_signaling_notify_cb_func cb, const void *user_data)
 注册独立信令的多端同步通知回调接口,用于通知信令相关的多端同步通知。比如自己在手机端接受邀请,PC端会同步收到这个通知
 
NIM_SDK_DLL_API void nim_signaling_reg_offline_notify_cb (nim_signaling_notify_list_cb_func cb, const void *user_data)
 注册独立信令的离线通知回调接口
 
NIM_SDK_DLL_API void nim_signaling_reg_channels_sync_cb (nim_signaling_channels_sync_cb_func cb, const void *user_data)
 注册独立信令的频道列表同步回调接口
 
NIM_SDK_DLL_API void nim_signaling_reg_members_sync_cb (nim_signaling_members_sync_cb_func cb, const void *user_data)
 注册独立信令的频道成员变更同步回调接口
 
NIM_SDK_DLL_API void nim_signaling_create (struct NIMSignalingCreateParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 创建频道
 
NIM_SDK_DLL_API void nim_signaling_close (struct NIMSignalingCloseParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 关闭销毁频道
 
NIM_SDK_DLL_API void nim_signaling_join (struct NIMSignalingJoinParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 加入频道接口
 
NIM_SDK_DLL_API void nim_signaling_leave (struct NIMSignalingLeaveParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 离开频道接口
 
NIM_SDK_DLL_API void nim_signaling_query_channel_info (struct NIMSignalingQueryChannelInfoParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 查询频道接口
 
NIM_SDK_DLL_API void nim_signaling_call (struct NIMSignalingCallParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 呼叫接口
 
NIM_SDK_DLL_API void nim_signaling_call_ex (struct NIMSignalingCallParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 呼叫接口
 
NIM_SDK_DLL_API void nim_signaling_join_and_accept (struct NIMSignalingJoinAndAcceptParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 加入并接受接口
 
NIM_SDK_DLL_API void nim_signaling_invite (struct NIMSignalingInviteParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 邀请接口
 
NIM_SDK_DLL_API void nim_signaling_cancel_invite (struct NIMSignalingCancelInviteParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 取消邀请接口
 
NIM_SDK_DLL_API void nim_signaling_reject (struct NIMSignalingRejectParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 拒绝邀请接口
 
NIM_SDK_DLL_API void nim_signaling_accept (struct NIMSignalingAcceptParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 接受邀请接口
 
NIM_SDK_DLL_API void nim_signaling_control (struct NIMSignalingControlParam *param, nim_signaling_opt_cb_func cb, const void *user_data)
 独立信令 用户自定义控制指令接口
 

详细描述

独立信令 接口头文件

作者
gq
日期
2018/10/31

函数说明

◆ nim_signaling_accept()

void nim_signaling_accept ( struct NIMSignalingAcceptParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 接受邀请接口

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

◆ nim_signaling_call()

void nim_signaling_call ( struct NIMSignalingCallParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 呼叫接口

注解
用于用户新开一个频道并邀请对方加入频道,如果返回码不是200、10201、10202时,sdk会主动关闭频道,标记接口调用失败
该接口为组合接口,等同于用户先创建频道,成功后加入频道并邀请对方
参数
[in]param呼叫的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param指向NIMSignalingCallResParam
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值 错误码: 200:成功; 0:接口服务异常; 408:超时; 10405:频道已存在; 10201:对方云信不在线,如果打开存离线开关,可认为发送成功,对方可收到离线消息; 10202:对方推送亦不可达,如果打开存离线开关,可认为发送成功,对方可收到离线消息;

◆ nim_signaling_call_ex()

void nim_signaling_call_ex ( struct NIMSignalingCallParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 呼叫接口

注解
用于用户新开一个频道并邀请对方加入频道,如果返回码不是200、10201、10202时,sdk会主动关闭频道,标记接口调用失败
该接口为组合接口,等同于用户先创建频道,成功后加入频道并邀请对方
参数
[in]param呼叫的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param指向NIMSignalingCallResParam
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值 错误码: 200:成功; 0:接口服务异常; 408:超时; 10405:频道已存在; 10201:对方云信不在线,如果打开存离线开关,可认为发送成功,对方可收到离线消息; 10202:对方推送亦不可达,如果打开存离线开关,可认为发送成功,对方可收到离线消息;

◆ nim_signaling_cancel_invite()

void nim_signaling_cancel_invite ( struct NIMSignalingCancelInviteParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 取消邀请接口

参数
[in]param取消邀请的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param无效
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值 错误码: 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10408:邀请不存在或已过期; 10409:邀请已经拒绝; 10410:邀请已经接受了;

◆ nim_signaling_close()

void nim_signaling_close ( struct NIMSignalingCloseParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 关闭销毁频道

注解
整个通话结束,如果只单人退出请调用nim_signaling_leave接口
该接口可以由创建者和频道内所有成员调用,无权限限制。
调用该接口成功后,其他所有频道内的成员都回收到频道结束的通知,被动离开频道。此时其他成员不需要调用离开接口,也不会收到别人的离开通知。
参数
[in]param关闭频道的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param无效
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值
错误码: 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10406:不在频道内;

◆ nim_signaling_control()

void nim_signaling_control ( struct NIMSignalingControlParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

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

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

◆ nim_signaling_create()

void nim_signaling_create ( struct NIMSignalingCreateParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 创建频道

注解
该接口用户创建频道,同一时刻频道名互斥,不能重复创建。但如果频道名缺省,服务器会自动分配频道ID。
对于频道在创建后如果没人加入,有效期2小时,当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。
参数
[in]param创建频道的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param指向NIMSignalingCreateResParam
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值
错误码: 200:成功; 0:接口服务异常; 408:超时; 10405:频道已存在;

◆ nim_signaling_invite()

void nim_signaling_invite ( struct NIMSignalingInviteParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 邀请接口

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

◆ nim_signaling_join()

void nim_signaling_join ( struct NIMSignalingJoinParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 加入频道接口

参数
[in]param加入频道的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param指向NIMSignalingJoinResParam
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值
错误码: 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10407:已经在频道内; 10417:uid冲突; 10419:频道人数超限; 10420:已经在频道内(自己的其他端);

◆ nim_signaling_join_and_accept()

void nim_signaling_join_and_accept ( struct NIMSignalingJoinAndAcceptParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 加入并接受接口

注解
用于用户加入频道并接受邀请,如果返回码不是200、10201、10202时,sdk会主动关闭频道,标记接口调用失败
该接口为组合接口,等同于用户先加入频道,成功后接受邀请
参数
[in]param加入并接受的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param指向NIMSignalingJoinAndAcceptResParam
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值 错误码: 200:成功; 0:接口服务异常; 408:超时;

◆ nim_signaling_leave()

void nim_signaling_leave ( struct NIMSignalingLeaveParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 离开频道接口

参数
[in]param离开频道的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param无效
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值
错误码: 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10406:不在频道内;

◆ nim_signaling_query_channel_info()

void nim_signaling_query_channel_info ( struct NIMSignalingQueryChannelInfoParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 查询频道接口

参数
[in]param查询频道频道的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param指向NIMSignalingQueryChannelInfoResParam
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值
错误码: 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在;

◆ nim_signaling_reg_channels_sync_cb()

void nim_signaling_reg_channels_sync_cb ( nim_signaling_channels_sync_cb_func  cb,
const void *  user_data 
)

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

注解
在login或者relogin后,会通知该设备账号还未退出的频道列表,用于同步;如果没有在任何频道中,也会返回该同步通知,list为空
参数
[in]cb结果回调见nim_signaling_def.h
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

◆ nim_signaling_reg_members_sync_cb()

void nim_signaling_reg_members_sync_cb ( nim_signaling_members_sync_cb_func  cb,
const void *  user_data 
)

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

注解
用于同步频道内的成员列表变更,当前该接口为定时接口,2分钟同步一次,成员有变化时才上报。
由于一些特殊情况,导致成员在离开或掉线前没有主动调用离开频道接口,使得该成员的离开没有对应的离开通知事件,由该回调接口【频道成员变更同步通知】告知用户。
参数
[in]cb结果回调见nim_signaling_def.h
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

◆ nim_signaling_reg_mutil_client_sync_notify_cb()

void nim_signaling_reg_mutil_client_sync_notify_cb ( nim_signaling_notify_cb_func  cb,
const void *  user_data 
)

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

参数
[in]cb结果回调见nim_signaling_def.h
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

◆ nim_signaling_reg_offline_notify_cb()

void nim_signaling_reg_offline_notify_cb ( nim_signaling_notify_list_cb_func  cb,
const void *  user_data 
)

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

注解
需要用户在调用相关接口时,打开存离线的开关。如果用户已经接收消息,该通知会在服务器标记已读,之后不会再收到该消息。
参数
[in]cb结果回调见nim_signaling_def.h
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

◆ nim_signaling_reg_online_notify_cb()

void nim_signaling_reg_online_notify_cb ( nim_signaling_notify_cb_func  cb,
const void *  user_data 
)

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

参数
[in]cb结果回调见nim_signaling_def.h
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值

◆ nim_signaling_reject()

void nim_signaling_reject ( struct NIMSignalingRejectParam param,
nim_signaling_opt_cb_func  cb,
const void *  user_data 
)

独立信令 拒绝邀请接口

注解
拒绝邀请后用户也可以通过加入频道接口加入频道,接口的使用由用户的业务决定
参数
[in]param拒绝邀请的传入参数
[in]cb结果回调见nim_signaling_def.h,其中opt_res_param无效
[in]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
返回
void 无返回值 错误码: 200:成功; 0:接口服务异常; 408:超时; 10404:频道不存在; 10408:邀请不存在或已过期; 10409:邀请已经拒绝; 10410:邀请已经接受了; 10201:对方不在线;