NIMSignalingResponse.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. //
  2. // NIMSignalingResponse.h
  3. // NIMLib
  4. //
  5. // Created by taojinliang on 2018/10/25.
  6. // Copyright © 2018 Netease. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "NIMSignalManagerProtocol.h"
  10. @class NIMSignalingMemberInfo;
  11. NS_ASSUME_NONNULL_BEGIN
  12. #pragma mark - 频道相关对象
  13. /**
  14. 频道相关对象
  15. */
  16. @interface NIMSignalingChannelInfo : NSObject
  17. /**
  18. 频道类型(通话类型)
  19. */
  20. @property(nonatomic, assign) NIMSignalingChannelType channelType;
  21. /**
  22. 频道名称(创建时传入的频道名)
  23. */
  24. @property(nonatomic, copy) NSString *channelName;
  25. /**
  26. 频道服务器名称,服务器生成,确保唯一(服务器生成的频道id)
  27. */
  28. @property(nonatomic, copy) NSString *channelId;
  29. /**
  30. 频道创建时间(创建时间点)
  31. */
  32. @property(nonatomic, assign) uint64_t createTimeStamp;
  33. /**
  34. 频道过期时间(失效时间点)
  35. */
  36. @property(nonatomic, assign) uint64_t expireTimeStamp;
  37. /**
  38. 创建者(创建者的accid)
  39. */
  40. @property(nonatomic, copy) NSString *creatorId;
  41. /**
  42. 额外字段 (创建时传入的扩展字段)
  43. */
  44. @property(nonatomic, copy) NSString *channelExt;
  45. /**
  46. 频道是否有效,NO表示有效,YES表示无效,默认有效
  47. */
  48. @property(nonatomic, assign) BOOL invalid;
  49. @end
  50. #pragma mark - 频道成员相关对象
  51. /**
  52. 频道成员相关对象
  53. */
  54. @interface NIMSignalingChannelDetailedInfo : NIMSignalingChannelInfo
  55. /**
  56. 频道成员列表
  57. */
  58. @property(nonatomic, strong) NSArray<NIMSignalingMemberInfo *> *members;
  59. @end
  60. #pragma mark - 推送相关对象
  61. /**
  62. 推送相关对象
  63. */
  64. @interface NIMSignalingPushInfo : NSObject
  65. /**
  66. 是否需要推送,YES表示推送,NO表示不推送,默认NO
  67. */
  68. @property(nonatomic, assign) BOOL needPush;
  69. /**
  70. 推送标题
  71. */
  72. @property(nonatomic, copy) NSString *pushTitle;
  73. /**
  74. 推送内容
  75. */
  76. @property(nonatomic, copy) NSString *pushContent;
  77. /**
  78. 推送自定义字段
  79. */
  80. @property(nonatomic, strong) NSDictionary *pushPayload;
  81. /**
  82. 是否计入未读计数,默认YES
  83. */
  84. @property(nonatomic, assign) BOOL needBadge;
  85. @end
  86. #pragma mark - 通知回调基类对象
  87. /**
  88. 通知回调基类对象
  89. */
  90. @interface NIMSignalingNotifyInfo : NSObject
  91. /**
  92. 通知事件类型
  93. */
  94. @property(nonatomic, assign) NIMSignalingEventType eventType;
  95. /**
  96. 频道对象
  97. */
  98. @property(nonatomic, strong) NIMSignalingChannelInfo *channelInfo;
  99. /**
  100. 操作者(如邀请者、关闭频道者)
  101. */
  102. @property(nonatomic, copy) NSString *fromAccountId;
  103. /**
  104. 通知事件拓展字段
  105. */
  106. @property(nonatomic, copy) NSString *customInfo;
  107. /**
  108. 通知时间戳
  109. */
  110. @property(nonatomic, assign) int64_t time;
  111. @end
  112. #pragma mark - 关闭频道通知对象
  113. /**
  114. 关闭频道通知对象
  115. */
  116. @interface NIMSignalingCloseNotifyInfo : NIMSignalingNotifyInfo
  117. @end
  118. #pragma mark - 加入频道通知对象
  119. /**
  120. 加入频道通知对象
  121. */
  122. @interface NIMSignalingJoinNotifyInfo : NIMSignalingNotifyInfo
  123. /**
  124. 频道成员
  125. */
  126. @property(nonatomic, strong) NIMSignalingMemberInfo *member;
  127. @end
  128. #pragma mark - 离开频道通知对象
  129. /**
  130. 离开频道通知对象
  131. */
  132. @interface NIMSignalingLeaveNotifyInfo : NIMSignalingNotifyInfo
  133. @end
  134. #pragma mark - 邀请加入频道通知对象
  135. /**
  136. * 邀请加入频道通知对象
  137. */
  138. @interface NIMSignalingInviteNotifyInfo : NIMSignalingNotifyInfo
  139. /**
  140. 被操作者(如被邀请者)
  141. */
  142. @property(nonatomic, copy) NSString *toAccountId;
  143. /**
  144. 推送对象
  145. */
  146. @property(nonatomic, strong) NIMSignalingPushInfo *push;
  147. /**
  148. 邀请唯一标识(用于标识持续呼叫)
  149. */
  150. @property(nonatomic, copy) NSString *requestId;
  151. @end
  152. #pragma mark - 取消邀请通知对象
  153. /**
  154. * 取消邀请通知对象
  155. */
  156. @interface NIMSignalingCancelInviteNotifyInfo : NIMSignalingNotifyInfo
  157. /**
  158. 被操作者(如被邀请者)
  159. */
  160. @property(nonatomic, copy) NSString *toAccountId;
  161. /**
  162. 邀请唯一标识(用于标识持续呼叫)
  163. */
  164. @property(nonatomic, copy) NSString *requestId;
  165. @end
  166. #pragma mark - 拒绝邀请通知对象
  167. /**
  168. * 拒绝邀请通知对象
  169. */
  170. @interface NIMSignalingRejectNotifyInfo : NIMSignalingNotifyInfo
  171. /**
  172. 被操作者(如被邀请者)
  173. */
  174. @property(nonatomic, copy) NSString *toAccountId;
  175. /**
  176. 邀请唯一标识(用于标识持续呼叫)
  177. */
  178. @property(nonatomic, copy) NSString *requestId;
  179. @end
  180. #pragma mark - 接受邀请通知对象
  181. /**
  182. * 接受邀请通知对象
  183. */
  184. @interface NIMSignalingAcceptNotifyInfo : NIMSignalingNotifyInfo
  185. /**
  186. 被操作者(如被邀请者)
  187. */
  188. @property(nonatomic, copy) NSString *toAccountId;
  189. /**
  190. 邀请唯一标识(用于标识持续呼叫)
  191. */
  192. @property(nonatomic, copy) NSString *requestId;
  193. @end
  194. #pragma mark - 自定义控制通知对象
  195. /**
  196. * 自定义控制通知对象
  197. */
  198. @interface NIMSignalingControlNotifyInfo : NIMSignalingNotifyInfo
  199. @end
  200. NS_ASSUME_NONNULL_END