NIMSDK-iOS
载入中...
搜索中...
未找到
NIMQChatSystemNotificationAttachmentProtocol.h
浏览该文件的文档.
1//
2// Created by Netease on 2022/2/5.
3// Copyright (c) 2022 Netease. All rights reserved.
4//
5
6#import <Foundation/Foundation.h>
7#import "NIMQChatDefs.h"
8
9@class NIMQChatServer;
11@class NIMQChatChannel;
22NS_ASSUME_NONNULL_BEGIN
23
24// 参考:http://doc.hz.netease.com/display/MMC/QChatSystemMsgType
25
26/**
27 * 圈组系统通知附件协议
28 */
29@protocol NIMQChatSystemNotificationAttachment <NSObject, NSCopying>
30@property (nullable, nonatomic, copy, readonly) NSDictionary *attachDict;
31@property(nonatomic, assign, readonly) NIMQChatSystemNotificationType type;
32+ (id<NIMQChatSystemNotificationAttachment>)initWithDict:(NSDictionary *)attachDict
34@end
35
36/**
37 * 圈组申请加入服务器接受的通知的附件
38 */
39@protocol NIMQChatApplyJoinServerMemberAcceptAttachment <NIMQChatSystemNotificationAttachment>
40@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
41@property(nullable, nonatomic, copy, readonly) NSString *applyAccid;
42@property(nonatomic, assign, readonly) long requestId;
43@end
44
45@protocol NIMQChatApplyJoinServerMemberAttachment <NIMQChatSystemNotificationAttachment>
46@property(nonatomic, assign, readonly) long requestId;
47@end
48
49/**
50 * 圈组申请加入服务器完成的通知的附件
51 */
52@protocol NIMQChatApplyJoinServerMemberDoneAttachment <NIMQChatSystemNotificationAttachment>
53@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
54@property(nonatomic, assign, readonly) long requestId;
55@end
56
57/**
58 * 圈组创建频道的通知的附件
59 */
60@protocol NIMQChatCreateChannelNotificationAttachment <NIMQChatSystemNotificationAttachment>
61@property(nullable, nonatomic, copy, readonly) NIMQChatChannel *channel;
62@end
63
64@protocol NIMQChatCreateServerAttachment <NIMQChatSystemNotificationAttachment>
65@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
66@end
67
68/**
69 * 圈组删除频道的通知的附件
70 */
71@protocol NIMQChatDeleteChannelNotificationAttachment <NIMQChatSystemNotificationAttachment>
72@end
73
74/**
75 * 圈组邀请服务器成员已接受的通知的附件
76 */
77@protocol NIMQChatInviteServerMemberAcceptAttachment <NIMQChatSystemNotificationAttachment>
78@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
79@property(nullable, nonatomic, copy, readonly) NSString *inviteAccid;
80@property(nonatomic, assign, readonly) long requestId;
81@end
82
83@protocol NIMQChatInviteServerMemberAttachment <NIMQChatSystemNotificationAttachment>
84@property(nonatomic, assign, readonly) long requestId;
85@end
86
87/**
88 * 圈组邀请服务器成员的通知的附件
89 */
90@protocol NIMQChatInviteServerMembersDoneAttachment <NIMQChatSystemNotificationAttachment>
91@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
92@property(nullable, nonatomic, copy, readonly) NSArray<NSString *> *invitedAccids;
93@property(nonatomic, assign, readonly) long requestId;
94@end
95
96/**
97 * 圈组踢出服务器成员的通知的附件
98 */
99@protocol NIMQChatKickServerMembersDoneAttachment <NIMQChatSystemNotificationAttachment>
100@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
101@property(nullable, nonatomic, copy, readonly) NSArray<NSString *> *kickedAccids;
102@end
103
104/**
105 * 圈组成员离开服务器的通知的附件
106 */
107@protocol NIMQChatLeaveServerAttachment <NIMQChatSystemNotificationAttachment>
108@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
109@end
110
111@protocol NIMQChatRejectApplyServerMemberAttachment <NIMQChatSystemNotificationAttachment>
112@property(nonatomic, assign, readonly) long requestId;
113@end
114
115@protocol NIMQChatRejectInviteServerMemberAttachment <NIMQChatSystemNotificationAttachment>
116@property(nonatomic, assign, readonly) long requestId;
117@end
118
119@protocol NIMQChatRemoveServerAttachment <NIMQChatSystemNotificationAttachment>
120@end
121
122/**
123 * 圈组更新频道的通知的附件
124 */
125@protocol NIMQChatUpdateChannelNotificationAttachment <NIMQChatSystemNotificationAttachment>
126@property(nullable, nonatomic, copy, readonly) NIMQChatChannel *channel;
127@end
128/**
129 * 圈组更新服务器的通知的附件
130 */
131@protocol NIMQChatUpdateServerAttachment <NIMQChatSystemNotificationAttachment>
132@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
133@end
134/**
135 * 圈组更新服务器成员的通知的附件
136 */
137@protocol NIMQChatUpdateServerMemberAttachment <NIMQChatSystemNotificationAttachment>
138@property(nullable, nonatomic, copy, readonly) NIMQChatServer *server;
139@property(nullable, nonatomic, copy, readonly) NIMQChatServerMember *serverMember;
140@end
141
142/**
143 * 圈组更新频道身份组黑白名单的通知的附件
144 */
145@protocol NIMQChatUpdateChannelBlackWhiteRoleAttachment <NIMQChatSystemNotificationAttachment>
146@property(nullable, nonatomic, copy, readonly) NIMQChatUpdateChannelBlackWhiteRoleInfo *updateBlackWhiteRoleInfo;
147@end
148
149/**
150 * 圈组更新频道成员黑白名单的通知的附件
151 */
152@protocol NIMQChatUpdateChannelBlackWhiteMemberAttachment <NIMQChatSystemNotificationAttachment>
153@property(nullable, nonatomic, copy, readonly) NIMQChatUpdateChannelBlackWhiteMembersInfo *updateBlackWhiteMembersInfo;
154@end
155
156/**
157 * 圈组更新快捷评论的通知的附件
158 */
159@protocol NIMQChatUpdateQuickCommentAttachment <NIMQChatSystemNotificationAttachment>
160@property(nullable, nonatomic, copy, readonly) NIMQChatUpdateQuickCommentInfo *updateQuickCommentInfo;
161@end
162
163/**
164 * 圈组创建频道分组的通知的附件
165 */
166@protocol NIMQChatCreateChannelCategoryNotificationAttachment <NIMQChatSystemNotificationAttachment>
167@property(nullable, nonatomic, copy, readonly) NIMQChatChannelCategory *channelCategory;
168@end
169
170/**
171 * 圈组更新频道分组的通知的附件
172 */
173@protocol NIMQChatUpdateChannelCategoryNotificationAttachment <NIMQChatSystemNotificationAttachment>
174@property(nullable, nonatomic, copy, readonly) NIMQChatChannelCategory *channelCategory;
175@end
176
177/**
178 * 圈组删除频道分组的通知的附件
179 */
180@protocol NIMQChatDeleteChannelCategoryNotificationAttachment <NIMQChatSystemNotificationAttachment>
181@property(nonatomic, assign, readonly) unsigned long long categoryId;
182@end
183
184/**
185 * 圈组更新频道分组身份组黑白名单的通知的附件
186 */
187@protocol NIMQChatUpdateChannelCategoryBlackWhiteRoleAttachment <NIMQChatSystemNotificationAttachment>
188@property(nullable, nonatomic, copy, readonly) NIMQChatUpdateChannelCategoryBlackWhiteRoleInfo *updateChannelCategoryBlackWhiteRoleInfo;
189@end
190
191/**
192 * 圈组更新频道分组成员黑白名单的通知的附件
193 */
194@protocol NIMQChatUpdateChannelCategoryBlackWhiteMemberAttachment <NIMQChatSystemNotificationAttachment>
195@property(nullable, nonatomic, copy, readonly) NIMQChatUpdateChannelCategoryBlackWhiteMemberInfo *updateChannelCategoryBlackWhiteMemberInfo;
196@end
197
198/**
199 * 服务器身份组加入成员通知的附件
200 */
201@protocol NIMQChatAddServerRoleMembersNotificationAttachment <NIMQChatSystemNotificationAttachment>
202/**
203 * 添加的成员
204 */
205@property(nullable, nonatomic, copy, readonly) NSArray <NSString *> *addServerRoleAccIds;
206
207/**
208 * 服务器id
209 */
210@property(nonatomic, assign, readonly) unsigned long long serverId;
211/**
212 * 身份组id
213 */
214@property(nonatomic, assign, readonly) unsigned long long roleId;
215
216@end
217
218/**
219 * 移除服务器身份组成员通知的附件
220 */
221@protocol NIMQChatRemoveServerRoleMembersNotificationAttachment <NIMQChatSystemNotificationAttachment>
222/**
223 * 移除的成员
224 */
225@property(nullable, nonatomic, copy, readonly) NSArray <NSString *> *removeServerRoleAccIds;
226
227/**
228 * 服务器id
229 */
230@property(nonatomic, assign, readonly) unsigned long long serverId;
231/**
232 * 身份组id
233 */
234@property(nonatomic, assign, readonly) unsigned long long roleId;
235
236@end
237
238/**
239 * 更新服务器身份组权限的通知的附件
240 */
241@protocol NIMQChatUpdateServerRoleAuthNotificationAttachment <NIMQChatSystemNotificationAttachment>
242
243/**
244 * 服务器id
245 */
246@property(nonatomic, assign, readonly) unsigned long long serverId;
247/**
248 * 身份组id
249 */
250@property(nonatomic, assign, readonly) unsigned long long roleId;
251
252/**
253 * 操作的权限状态列表
254 */
255@property (nonatomic, copy) NSArray <NIMQChatPermissionStatusInfo *> *updateAuths;
256
257@end
258
259/**
260 * 更新频道身份组权限的通知的附件
261 */
262@protocol NIMQChatUpdateChannelRoleAuthNotificationAttachment <NIMQChatSystemNotificationAttachment>
263/**
264 * 服务器id
265 */
266@property(nonatomic, assign, readonly) unsigned long long serverId;
267/**
268 * 频道身份组id
269 */
270@property(nonatomic, assign, readonly) unsigned long long roleId;
271/**
272 * 频道id
273 */
274@property(nonatomic, assign, readonly) unsigned long long channelId;
275/**
276 * 服务器身份组id
277 */
278@property(nonatomic, assign, readonly) unsigned long long parentRoleId;
279
280/**
281 * 操作的权限状态列表
282 */
283@property (nonatomic, copy) NSArray <NIMQChatPermissionStatusInfo *> *updateAuths;
284
285@end
286
287/**
288 * 更新个人定制权限的通知的附件
289 */
290@protocol NIMQChatUpdateMemberRoleAuthNotificationAttachment <NIMQChatSystemNotificationAttachment>
291/**
292 * 服务器id
293 */
294@property(nonatomic, assign, readonly) unsigned long long serverId;
295/**
296 * 频道id
297 */
298@property(nonatomic, assign, readonly) unsigned long long channelId;
299/**
300 * 个人id
301 */
302@property(nullable, nonatomic, copy, readonly) NSString *accId;
303
304/**
305 * 操作的权限状态列表
306 */
307@property (nonatomic, copy) NSArray <NIMQChatPermissionStatusInfo *> *updateAuths;
308
309
310@end
311
312/*
313 * 圈组频道可见性更新的通知的附件
314 */
315@protocol NIMQChatChannelVisibilityUpdateNotificationAttachment <NIMQChatSystemNotificationAttachment>
316// 进入或者退出频道
317@property (nonatomic, assign, readonly) NIMQChatInoutType inoutType;
318
319@end
320
321/*
322 * 圈组进出服务器的通知的附件
323 */
324@protocol NIMQChatServerEnterLeaveNotificationAttachment <NIMQChatSystemNotificationAttachment>
325// 进入或者退出频道
326@property (nonatomic, assign, readonly) NIMQChatInoutType inoutType;
327
328@end
329
330/**
331 * 圈组用户通过邀请码加入服务器的通知的附件
332 */
333@protocol NIMQChatServerJoinByInviteCodeNotificationAttachment <NIMQChatSystemNotificationAttachment>
334@property (nullable, nonatomic, copy, readonly) NIMQChatServer *server;
335@property (nonatomic, assign, readonly) long requestId;
336@property (nullable, nonatomic, copy, readonly) NSString *inviteCode;
337
338@end
339
340/**
341 * 频道对游客可见性变更的附件
342 */
343@protocol NIMQChatVisitorChannelVisibilityUpdateNotificationAttachment <NIMQChatSystemNotificationAttachment>
344// 进出事件
345@property (nonatomic, assign, readonly) NIMQChatInoutType inoutType;
346@end
347
348
349/**
350 * 当前用户服务器成员信息与IM资料的联动变更的附件
351 */
352@protocol NIMQChatMyMemberInfoUpdatedNotificationAttachment <NIMQChatSystemNotificationAttachment>
353
354/**
355 * 当前用户成员信息发生变更的信息列表
356 */
357@property (nonatomic, copy) NSArray<NIMQChatUpdatedMyMemberInfo *> *updatedInfos;
358
359@end
360
361@protocol NIMQChatMuteNotificationAttachment <NIMQChatSystemNotificationAttachment>
362
363/**
364 * 操作类型
365 */
366@property (nonatomic, assign) NIMQChatMuteOperateType operateType;
367
368/**
369 * 服务器id
370 */
371@property (nonatomic, assign) unsigned long long serverId;
372
373/**
374 * 频道id
375 */
376@property (nonatomic, assign) unsigned long long channelId;
377
378/**
379 * 禁言操作者的账号
380 */
381@property (nonatomic, copy) NSString *muteOperatorAccountId;
382
383/**
384 * 禁言成员列表
385 */
386@property (nonatomic, strong) NSArray<NSString *> *muteAccountIds;
387
388/**
389 * 禁言持续时长,单位:秒
390 */
391@property (nonatomic, assign) NSInteger duration;
392
393/**
394 * 预期解除禁言时间
395 */
396@property (nonatomic, assign) NSTimeInterval beReleaseTime;
397
398/**
399 * 禁言级别。包括服务器级别和频道级别
400 */
401@property (nonatomic, assign) NIMQChatMuteLevel muteLevel;
402
403/**
404 * 附言
405 */
406@property (nonatomic, strong, nullable) NSString *postscript;
407
408@end
409
410@protocol NIMQChatManualUnmuteAttachment <NIMQChatSystemNotificationAttachment>
411
412/**
413 * 操作类型
414 */
415@property (nonatomic, assign) NIMQChatMuteOperateType operateType;
416
417/**
418 * 服务器id
419 */
420@property (nonatomic, assign) unsigned long long serverId;
421
422/**
423 * 频道id
424 */
425@property (nonatomic, assign) unsigned long long channelId;
426
427/**
428 * 解除禁言操作者的账号
429 */
430@property (nonatomic, copy) NSString *releaseOperatorAccountId;
431
432/**
433 * 被解除禁言成员列表
434 */
435@property (nonatomic, strong) NSArray<NSString *> *releaseAccountIds;
436
437/**
438 * 禁言持续时长,单位:秒
439 */
440@property (nonatomic, assign) NSInteger duration;
441
442/**
443 * 实际解除禁言时间
444 */
445@property (nonatomic, assign) NSTimeInterval realReleaseTime;
446
447/**
448 * 禁言级别。包括服务器级别和频道级别
449 */
450@property (nonatomic, assign) NIMQChatMuteLevel muteLevel;
451
452/**
453 * 附言
454 */
455@property (nonatomic, strong, nullable) NSString *postscript;
456
457@end
458
459@protocol NIMQChatAutoUnmuteAttachment <NIMQChatSystemNotificationAttachment>
460
461/**
462 * 操作类型
463 */
464@property (nonatomic, assign) NIMQChatMuteOperateType operateType;
465
466/**
467 * 服务器id
468 */
469@property (nonatomic, assign) unsigned long long serverId;
470
471/**
472 * 频道id
473 */
474@property (nonatomic, assign) unsigned long long channelId;
475
476/**
477 * 解除禁言操作者的账号
478 */
479@property (nonatomic, copy) NSString *releaseOperatorAccountId;
480
481/**
482 * 禁言操作者的账号
483 */
484@property (nonatomic, copy) NSString *muteOperatorAccountId;
485
486/**
487 * 被解除禁言成员列表
488 */
489@property (nonatomic, strong) NSArray<NSString *> *releaseAccountIds;
490
491/**
492 * 禁言持续时长,单位:秒
493 */
494@property (nonatomic, assign) NSInteger duration;
495
496/**
497 * 实际解除禁言时间
498 */
499@property (nonatomic, assign) NSTimeInterval realReleaseTime;
500
501/**
502 * 禁言级别。包括服务器级别和频道级别
503 */
504@property (nonatomic, assign) NIMQChatMuteLevel muteLevel;
505
506@end
507
508NS_ASSUME_NONNULL_END
NIMQChatInoutType
Definition: NIMQChatDefs.h:483
NIMQChatMuteLevel
Definition: NIMQChatDefs.h:578
NIMQChatMuteOperateType
Definition: NIMQChatDefs.h:561
NIMQChatSystemNotificationType
Definition: NIMQChatDefs.h:68
Definition: NIMQChatChannelCategory.h:16
Definition: NIMQChatChannel.h:16
Definition: NIMQChatChannelIdInfo.h:15
Definition: NIMQChatPermissionStatusInfo.h:15
Definition: NIMQChatServer.h:15
Definition: NIMQChatServerMember.h:15
Definition: NIMQChatServerRole.h:20
Definition: NIMQChatUpdateChannelBlackWhiteMembersInfo.h:19
Definition: NIMQChatUpdateChannelBlackWhiteRoleInfo.h:9
Definition: NIMQChatUpdateChannelCategoryBlackWhiteMemberInfo.h:18
Definition: NIMQChatUpdateChannelCategoryBlackWhiteRoleInfo.h:13
Definition: NIMQChatUpdateQuickCommentInfo.h:16
Definition: NIMQChatUpdatedMyMemberInfo.h:18