NIM C# SDK  6.3.0
Namespaces | Classes | Enumerations | Functions
NIM.Signaling Namespace Reference

Namespaces

namespace  Native
 

Classes

class  NIMSignalingAcceptParam
 接受邀请接口nim_signaling_accept的传入参数 More...
 
class  NIMSignalingAcceptResParam
 
class  NIMSignalingAPI
 
class  NIMSignalingCallParam
 呼叫接口nim_signaling_call的传入参数 More...
 
class  NIMSignalingCallResParam
 
class  NIMSignalingCancelInviteParam
 取消邀请接口nim_signaling_cancel_invite的传入参数 More...
 
class  NIMSignalingChannelDetailedinfo
 频道的详细信息，包含频道信息及成员列表 More...
 
class  NIMSignalingChannelInfo
 频道属性 More...
 
class  NIMSignalingCloseParam
 关闭频道接口nim_signaling_close的传入参数 More...
 
class  NIMSignalingControlParam
 控制通知接口nim_signaling_control的传入参数 More...
 
class  NIMSignalingCreateParam
 创建频道接口nim_signaling_create的传入参数 More...
 
class  NIMSignalingCreateResParam
 创建频道结果回调信息 More...
 
class  NIMSignalingInviteParam
 邀请接口nim_signaling_invite的传入参数 More...
 
class  NIMSignalingJoinParam
 加入频道接口nim_signaling_join的传入参数 More...
 
class  NIMSignalingJoinResParam
 加入频道结果回调信息 More...
 
class  NIMSignalingLeaveParam
 离开频道接口nim_signaling_leave的传入参数 More...
 
class  NIMSignalingMemberInfo
 成员属性 More...
 
class  NIMSignalingNotityInfo
 事件通知信息基类 More...
 
class  NIMSignalingNotityInfoAccept
 接收邀请事件通知信息，event_type_=kNIMSignalingEventTypeAccept More...
 
class  NIMSignalingNotityInfoCancelInvite
 取消邀请事件通知信息，event_type_=kNIMSignalingEventTypeCancelInvite More...
 
class  NIMSignalingNotityInfoClose
 频道关闭事件通知信息，event_type_=kNIMSignalingEventTypeClose More...
 
class  NIMSignalingNotityInfoControl
 控制事件通知信息，event_type_=kNIMSignalingEventTypeCtrl More...
 
class  NIMSignalingNotityInfoInvite
 邀请事件通知信息，event_type_=kNIMSignalingEventTypeInvite More...
 
class  NIMSignalingNotityInfoJoin
 加入频道事件通知信息，event_type_=kNIMSignalingEventTypeJoin More...
 
class  NIMSignalingNotityInfoLeave
 退出频道事件通知信息，event_type_=kNIMSignalingEventTypeLeave More...
 
class  NIMSignalingNotityInfoReject
 拒绝邀请事件通知信息，event_type_=kNIMSignalingEventTypeReject More...
 
class  NIMSignalingPushInfo
 推送属性 More...
 
class  NIMSignalingRejectParam
 拒绝接口nim_signaling_reject的传入参数 More...
 

Enumerations

enum  NIMSignalingType { NIMSignalingType.kNIMSignalingTypeAudio = 1, NIMSignalingType.kNIMSignalingTypeVideo = 2, NIMSignalingType.kNIMSignalingTypeCustom = 3 }
 频道类型 More...
 
enum  NIMSignalingCreateResCode {
  NIMSignalingCreateResCode.kSucess = 200, NIMSignalingCreateResCode.kAbnormal = 0, NIMSignalingCreateResCode.kTimeout = 408, NIMSignalingCreateResCode.kChannelAlreadyExist = 10405,
  NIMSignalingCreateResCode.kUnknown =20000
}
 创建信令接口的返回码 More...
 
enum  NIMSignalingCloseOrLeaveResCode {
  NIMSignalingCloseOrLeaveResCode.kSucess = 200, NIMSignalingCloseOrLeaveResCode.kAbnormal = 0, NIMSignalingCloseOrLeaveResCode.kTimeout = 408, NIMSignalingCloseOrLeaveResCode.kChannelNotExist = 10404,
  NIMSignalingCloseOrLeaveResCode.kUserNotInChannel =10406, NIMSignalingCloseOrLeaveResCode.kUnknown = 20000
}
 关闭或者离开接口的返回码 More...
 
enum  NIMSignalingJoinResCode {
  NIMSignalingJoinResCode.kSucess = 200, NIMSignalingJoinResCode.kAbnormal = 0, NIMSignalingJoinResCode.kTimeout = 408, NIMSignalingJoinResCode.kChannelNotExist = 10404,
  NIMSignalingJoinResCode.kUserInChannel = 10407, NIMSignalingJoinResCode.kUidConflict = 10417, NIMSignalingJoinResCode.kUserNumberLimited = 10419, NIMSignalingJoinResCode.kInChannelByOtherDevice = 10420,
  NIMSignalingJoinResCode.kUnknown = 20000
}
 加入接口的返回码 More...
 
enum  NIMSignalingCallResCode {
  NIMSignalingCallResCode.kSucess = 200, NIMSignalingCallResCode.kAbnormal = 0, NIMSignalingCallResCode.kTimeout = 408, NIMSignalingCallResCode.kChannelAlreadyExist = 10405,
  NIMSignalingCallResCode.kPeerOffline = 10201, NIMSignalingCallResCode.kPeerPushNotReach = 10202, NIMSignalingCallResCode.kUnknown = 20000
}
 呼叫接口的返回码 More...
 
enum  NIMSignalingInviteResCode {
  NIMSignalingInviteResCode.kSucess = 200, NIMSignalingInviteResCode.kAbnormal = 0, NIMSignalingInviteResCode.kTimeout = 408, NIMSignalingInviteResCode.kChannelNotExist = 10404,
  NIMSignalingInviteResCode.kUserNotInChannel = 10406, NIMSignalingInviteResCode.kPeerAlreadyInChannel = 10407, NIMSignalingInviteResCode.kUserNumberLimited = 10419, NIMSignalingInviteResCode.kPeerOffline = 10201,
  NIMSignalingInviteResCode.kPeerPushNotReach = 10202, NIMSignalingInviteResCode.kUnknown = 20000
}
 邀请信令接口的返回码 More...
 
enum  NIMSignalingCancelInviteResCode {
  NIMSignalingCancelInviteResCode.kSucess = 200, NIMSignalingCancelInviteResCode.kAbnormal = 0, NIMSignalingCancelInviteResCode.kTimeout = 408, NIMSignalingCancelInviteResCode.kChannelNotExist = 10404,
  NIMSignalingCancelInviteResCode.kInviteNotExistOrExpire = 10408, NIMSignalingCancelInviteResCode.kInviteAlreadyReject = 10409, NIMSignalingCancelInviteResCode.kInviteAlreadyAccept = 10410, NIMSignalingCancelInviteResCode.kUnknown = 20000
}
 取消邀请接口的返回码 More...
 
enum  NIMSignalingRejectOrAcceptResCode {
  NIMSignalingRejectOrAcceptResCode.kSucess = 200, NIMSignalingRejectOrAcceptResCode.kAbnormal = 0, NIMSignalingRejectOrAcceptResCode.kTimeout = 408, NIMSignalingRejectOrAcceptResCode.kChannelNotExist = 10404,
  NIMSignalingRejectOrAcceptResCode.kInviteNotExistOrExpire = 10408, NIMSignalingRejectOrAcceptResCode.kInviteAlreadyReject = 10409, NIMSignalingRejectOrAcceptResCode.kInviteAlreadyAccept = 10410, NIMSignalingRejectOrAcceptResCode.kPeerOffline = 10201,
  NIMSignalingRejectOrAcceptResCode.kUnknown = 20000
}
 拒绝或者接受邀请接口的返回码 More...
 
enum  NIMSignalingControlResCode {
  NIMSignalingControlResCode.kSucess = 200, NIMSignalingControlResCode.kAbnormal = 0, NIMSignalingControlResCode.kTimeout = 408, NIMSignalingControlResCode.kChannelNotExist = 10404,
  NIMSignalingControlResCode.kUserNotInChannel = 10406, NIMSignalingControlResCode.kPeerOffline = 10201, NIMSignalingControlResCode.kUnknown = 20000
}
 用户自定义控制指令接口的返回码 More...
 
enum  NIMSignalingEventType {
  NIMSignalingEventType.kNIMSignalingEventTypeClose = 1, NIMSignalingEventType.kNIMSignalingEventTypeJoin = 2, NIMSignalingEventType.kNIMSignalingEventTypeInvite = 3, NIMSignalingEventType.kNIMSignalingEventTypeCancelInvite = 4,
  NIMSignalingEventType.kNIMSignalingEventTypeReject = 5, NIMSignalingEventType.kNIMSignalingEventTypeAccept = 6, NIMSignalingEventType.kNIMSignalingEventTypeLeave = 7, NIMSignalingEventType.kNIMSignalingEventTypeCtrl = 8
}
 频道事件，包含在线，同步，离线等 More...
 

Functions

delegate void NimSignalingNotifyHandler (NIMSignalingNotityInfo notify_info)
 事件回调函数，用于在线通知和多端同步通知 More...
 
delegate void NimSignalingNotifyListHandler (List< NIMSignalingNotityInfo > notifys)
 事件回调函数，用于离线通知 More...
 
delegate void NimSignalingChannelsSyncHandler (List< NIMSignalingChannelDetailedinfo > channels)
 频道列表同步回调函数 在login或者relogin后，会通知该设备账号还未退出的频道列表，用于同步；如果没有在任何频道中，也会返回该同步通知，list为空 More...
 
delegate void NimSignalingMembersSyncHandler (NIMSignalingChannelDetailedinfo detailed_info)
 频道成员变更同步回调函数 用于同步频道内的成员列表变更，当前该接口为定时接口，2分钟同步一次，成员有变化时才上报。 由于一些特殊情况，导致成员在离开或掉线前没有主动调用离开频道接口，使得该成员的离开没有对应的离开通知事件，由该回调接口【频道成员变更同步通知】告知用户。 More...
 
delegate void NimSignalingOptControlHandler (NIMSignalingControlResCode code)
 操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close More...
 
delegate void NimSignalingOptCancelInviteHandler (NIMSignalingCancelInviteResCode code)
 操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close More...
 
delegate void NimSignalingOptInviteHandler (NIMSignalingInviteResCode code)
 操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close More...
 
delegate void NimSignalingOptRejectHandler (NIMSignalingRejectOrAcceptResCode code)
 操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close More...
 
delegate void NimSignalingOptCloseOrLeaveHandler (NIMSignalingCloseOrLeaveResCode code)
 操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close More...
 
delegate void NimSignalingOptCallHandler (NIMSignalingCallResCode code, NIMSignalingCallResParam opt_res_param)
 呼叫操作回调 More...
 
delegate void NimSignalingOptAcceptHandler (NIMSignalingRejectOrAcceptResCode code, NIMSignalingAcceptResParam opt_res_param)
 接受操作回调 More...
 
delegate void NimSignalingOptJoinHandler (NIMSignalingJoinResCode code, NIMSignalingJoinResParam opt_res_param)
 加入操作回调 More...
 
delegate void NimSignalingOptCreateHandler (NIMSignalingCreateResCode code, NIMSignalingCreateResParam opt_res_param)
 创建操作回调 More...
 

Enumeration Type Documentation

◆ NIMSignalingCallResCode

enum NIM.Signaling.NIMSignalingCallResCode
strong

呼叫接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelAlreadyExist 

频道已存在

kPeerOffline 

对方云信不在线，如果打开存离线开关，可认为发送成功，对方可收到离线消息

kPeerPushNotReach 

对方推送亦不可达，如果打开存离线开关，可认为发送成功，对方可收到离线消息;

kUnknown 

未知错误

◆ NIMSignalingCancelInviteResCode

enum NIM.Signaling.NIMSignalingCancelInviteResCode
strong

取消邀请接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kInviteNotExistOrExpire 

邀请不存在或已过期

kInviteAlreadyReject 

邀请已经拒绝

kInviteAlreadyAccept 

邀请已经接受了

kUnknown 

未知错误

◆ NIMSignalingCloseOrLeaveResCode

enum NIM.Signaling.NIMSignalingCloseOrLeaveResCode
strong

关闭或者离开接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserNotInChannel 

不在频道内

kUnknown 

未知错误

◆ NIMSignalingControlResCode

enum NIM.Signaling.NIMSignalingControlResCode
strong

用户自定义控制指令接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserNotInChannel 

不在频道内

kPeerOffline 

对方云信不在线

kUnknown 

未知错误

◆ NIMSignalingCreateResCode

enum NIM.Signaling.NIMSignalingCreateResCode
strong

创建信令接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelAlreadyExist 

频道已存在

kUnknown 

未知错误

◆ NIMSignalingEventType

enum NIM.Signaling.NIMSignalingEventType
strong

频道事件，包含在线，同步，离线等

Enumerator
kNIMSignalingEventTypeClose 

返回NIMSignalingNotityInfoClose，支持在线、离线通知

kNIMSignalingEventTypeJoin 

返回NIMSignalingNotityInfoJoin，支持在线、离线通知

kNIMSignalingEventTypeInvite 

返回NIMSignalingNotityInfoInvite，支持在线、离线通知

kNIMSignalingEventTypeCancelInvite 

返回NIMSignalingNotityInfoCancelInvite，支持在线、离线通知

kNIMSignalingEventTypeReject 

返回NIMSignalingNotityInfoReject，支持在线、多端同步、离线通知

kNIMSignalingEventTypeAccept 

返回NIMSignalingNotityInfoAccept，支持在线、多端同步、离线通知

kNIMSignalingEventTypeLeave 

返回NIMSignalingNotityInfoLeave，支持在线、离线通知

kNIMSignalingEventTypeCtrl 

返回NIMSignalingNotityInfoControl，支持在线通知

◆ NIMSignalingInviteResCode

enum NIM.Signaling.NIMSignalingInviteResCode
strong

邀请信令接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserNotInChannel 

不在频道内（自己）

kPeerAlreadyInChannel 

已经在频道内（对方）

kUserNumberLimited 

频道人数超限

kPeerOffline 

对方云信不在线，如果打开存离线开关，可认为发送成功，对方可收到离线消息

kPeerPushNotReach 

对方推送亦不可达，如果打开存离线开关，可认为发送成功，对方可收到离线消息;

kUnknown 

未知错误

◆ NIMSignalingJoinResCode

enum NIM.Signaling.NIMSignalingJoinResCode
strong

加入接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserInChannel 

已经在频道内

kUidConflict 

uid冲突

kUserNumberLimited 

频道人数超限

kInChannelByOtherDevice 

已经在频道内（自己的其他端）

kUnknown 

未知错误

◆ NIMSignalingRejectOrAcceptResCode

enum NIM.Signaling.NIMSignalingRejectOrAcceptResCode
strong

拒绝或者接受邀请接口的返回码

Enumerator
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kInviteNotExistOrExpire 

邀请不存在或已过期

kInviteAlreadyReject 

邀请已经拒绝

kInviteAlreadyAccept 

邀请已经接受了

kPeerOffline 

对方云信不在线

kUnknown 

未知错误

◆ NIMSignalingType

enum NIM.Signaling.NIMSignalingType
strong

频道类型

Enumerator
kNIMSignalingTypeAudio 

音频类型

kNIMSignalingTypeVideo 

视频类型

kNIMSignalingTypeCustom 

自定义

Function Documentation

◆ NimSignalingChannelsSyncHandler()

delegate void NIM.Signaling.NimSignalingChannelsSyncHandler ( List< NIMSignalingChannelDetailedinfo >  channels)

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

Parameters
info_list频道的详细信息NIMSignalingChannelDetailedinfo指针的数组，可能为空
sizeinfo_list数组的长度
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理

◆ NimSignalingMembersSyncHandler()

delegate void NIM.Signaling.NimSignalingMembersSyncHandler ( NIMSignalingChannelDetailedinfo  detailed_info)

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

Parameters
detailed_info频道的详细信息
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理

◆ NimSignalingNotifyHandler()

delegate void NIM.Signaling.NimSignalingNotifyHandler ( NIMSignalingNotityInfo  notify_info)

事件回调函数，用于在线通知和多端同步通知

Parameters
notify_info事件回调的信息指针，根据NIMSignalingNotityInfo.event_type_指向对应NIMSignalingNotityInfo扩展，如NIMSignalingNotityInfoAccept
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理

◆ NimSignalingNotifyListHandler()

delegate void NIM.Signaling.NimSignalingNotifyListHandler ( List< NIMSignalingNotityInfo >  notifys)

事件回调函数，用于离线通知

Parameters
info_list事件回调的信息NIMSignalingNotityInfo指针的数组，根据NIMSignalingNotityInfo.event_type_指向对应NIMSignalingNotityInfo扩展，如NIMSignalingNotityInfoAccept
sizeinfo_list数组的长度
user_dataAPP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理

◆ NimSignalingOptAcceptHandler()

delegate void NIM.Signaling.NimSignalingOptAcceptHandler ( NIMSignalingRejectOrAcceptResCode  code,
NIMSignalingAcceptResParam  opt_res_param 
)

接受操作回调

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs
opt_res_param结果回调信息

◆ NimSignalingOptCallHandler()

delegate void NIM.Signaling.NimSignalingOptCallHandler ( NIMSignalingCallResCode  code,
NIMSignalingCallResParam  opt_res_param 
)

呼叫操作回调

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs
opt_res_param结果回调信息

◆ NimSignalingOptCancelInviteHandler()

delegate void NIM.Signaling.NimSignalingOptCancelInviteHandler ( NIMSignalingCancelInviteResCode  code)

操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs

◆ NimSignalingOptCloseOrLeaveHandler()

delegate void NIM.Signaling.NimSignalingOptCloseOrLeaveHandler ( NIMSignalingCloseOrLeaveResCode  code)

操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs

◆ NimSignalingOptControlHandler()

delegate void NIM.Signaling.NimSignalingOptControlHandler ( NIMSignalingControlResCode  code)

操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs

◆ NimSignalingOptCreateHandler()

delegate void NIM.Signaling.NimSignalingOptCreateHandler ( NIMSignalingCreateResCode  code,
NIMSignalingCreateResParam  opt_res_param 
)

创建操作回调

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs
opt_res_param结果回调信息

◆ NimSignalingOptInviteHandler()

delegate void NIM.Signaling.NimSignalingOptInviteHandler ( NIMSignalingInviteResCode  code)

操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs

◆ NimSignalingOptJoinHandler()

delegate void NIM.Signaling.NimSignalingOptJoinHandler ( NIMSignalingJoinResCode  code,
NIMSignalingJoinResParam  opt_res_param 
)

加入操作回调

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs
opt_res_param结果回调信息

◆ NimSignalingOptRejectHandler()

delegate void NIM.Signaling.NimSignalingOptRejectHandler ( NIMSignalingRejectOrAcceptResCode  code)

操作回调，通用的操作回调接口 eg.control ,cancel_invite reject,invite,leave,close

Parameters
code操作返回码NIMResCode，见NIMResponseCode.cs