NIM Unity SDK V2.6.0
载入中...
搜索中...
未找到
| 枚举 | 函数
NIM.Signaling 命名空间参考

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

枚举

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

函数

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

枚举类型说明

◆ NIMSignalingType

频道类型

枚举值
kNIMSignalingTypeAudio 

音频类型

kNIMSignalingTypeVideo 

视频类型

kNIMSignalingTypeCustom 

自定义

◆ NIMSignalingCreateResCode

创建信令接口的返回码

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelAlreadyExist 

频道已存在

kUnknown 

未知错误

◆ NIMSignalingCloseOrLeaveResCode

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

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserNotInChannel 

不在频道内

kUnknown 

未知错误

◆ NIMSignalingJoinResCode

加入接口的返回码

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserInChannel 

已经在频道内

kUidConflict 

uid冲突

kUserNumberLimited 

频道人数超限

kInChannelByOtherDevice 

已经在频道内(自己的其他端)

kUnknown 

未知错误

◆ NIMSignalingCallResCode

呼叫接口的返回码

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelAlreadyExist 

频道已存在

kPeerOffline 

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

kPeerPushNotReach 

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

kUnknown 

未知错误

◆ NIMSignalingInviteResCode

邀请信令接口的返回码

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserNotInChannel 

不在频道内(自己)

kPeerAlreadyInChannel 

已经在频道内(对方)

kUserNumberLimited 

频道人数超限

kPeerOffline 

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

kPeerPushNotReach 

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

kUnknown 

未知错误

◆ NIMSignalingCancelInviteResCode

取消邀请接口的返回码

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kInviteNotExistOrExpire 

邀请不存在或已过期

kInviteAlreadyReject 

邀请已经拒绝

kInviteAlreadyAccept 

邀请已经接受了

kUnknown 

未知错误

◆ NIMSignalingRejectOrAcceptResCode

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

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kInviteNotExistOrExpire 

邀请不存在或已过期

kInviteAlreadyReject 

邀请已经拒绝

kInviteAlreadyAccept 

邀请已经接受了

kPeerOffline 

对方云信不在线

kUnknown 

未知错误

◆ NIMSignalingControlResCode

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

枚举值
kSucess 

成功

kAbnormal 

接口服务异常

kTimeout 

超时

kChannelNotExist 

频道不存在

kUserNotInChannel 

不在频道内

kPeerOffline 

对方云信不在线

kUnknown 

未知错误

◆ NIMSignalingEventType

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

枚举值
kNIMSignalingEventTypeClose 

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

kNIMSignalingEventTypeJoin 

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

kNIMSignalingEventTypeInvite 

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

kNIMSignalingEventTypeCancelInvite 

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

kNIMSignalingEventTypeReject 

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

kNIMSignalingEventTypeAccept 

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

kNIMSignalingEventTypeLeave 

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

kNIMSignalingEventTypeCtrl 

返回NIMSignalingNotityInfoControl,支持在线通知

函数说明

◆ NimSignalingNotifyHandler()

delegate void NIM.Signaling.NimSignalingNotifyHandler ( NIMSignalingNotityInfo  notify_info)

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

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

◆ NimSignalingNotifyListHandler()

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

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

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

◆ NimSignalingChannelsSyncHandler()

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

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

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

◆ NimSignalingMembersSyncHandler()

delegate void NIM.Signaling.NimSignalingMembersSyncHandler ( NIMSignalingChannelDetailedinfo  detailed_info)

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

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

◆ NimSignalingOptControlHandler()

delegate void NIM.Signaling.NimSignalingOptControlHandler ( NIMSignalingControlResCode  code)

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

参数
code操作返回码NIMResCode,见NIMResponseCode.cs

◆ NimSignalingOptCancelInviteHandler()

delegate void NIM.Signaling.NimSignalingOptCancelInviteHandler ( NIMSignalingCancelInviteResCode  code)

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

参数
code操作返回码NIMResCode,见NIMResponseCode.cs

◆ NimSignalingOptInviteHandler()

delegate void NIM.Signaling.NimSignalingOptInviteHandler ( NIMSignalingInviteResCode  code)

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

参数
code操作返回码NIMResCode,见NIMResponseCode.cs

◆ NimSignalingOptRejectHandler()

delegate void NIM.Signaling.NimSignalingOptRejectHandler ( NIMSignalingRejectOrAcceptResCode  code)

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

参数
code操作返回码NIMResCode,见NIMResponseCode.cs

◆ NimSignalingOptCloseOrLeaveHandler()

delegate void NIM.Signaling.NimSignalingOptCloseOrLeaveHandler ( NIMSignalingCloseOrLeaveResCode  code,
NIMSignalingCloseParam  res 
)

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

参数
code操作返回码NIMResCode,见NIMResponseCode.cs

◆ NimSignalingOptCallHandler()

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

呼叫操作回调

参数
code操作返回码NIMResCode,见NIMResponseCode.cs
opt_res_param结果回调信息

◆ NimSignalingOptAcceptHandler()

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

接受操作回调

参数
code操作返回码NIMResCode,见NIMResponseCode.cs
opt_res_param结果回调信息

◆ NimSignalingOptJoinHandler()

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

加入操作回调

参数
code操作返回码NIMResCode,见NIMResponseCode.cs
opt_res_param结果回调信息

◆ NimSignalingOptCreateHandler()

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

创建操作回调

参数
code操作返回码NIMResCode,见NIMResponseCode.cs
opt_res_param结果回调信息