NIMChatroomQueueRequest.h 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. //
  2. // NIMChatroomQueueRequest.h
  3. // NIMLib
  4. //
  5. // Created by Netease.
  6. // Copyright © 2016年 Netease. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. NS_ASSUME_NONNULL_BEGIN
  10. /**
  11. * 聊天室通用队列更新请求
  12. */
  13. @interface NIMChatroomQueueUpdateRequest : NSObject
  14. /**
  15. * 聊天室 ID
  16. */
  17. @property (nonatomic,copy) NSString *roomId;
  18. /**
  19. * 更新元素的 Key 值,如果 key 在队列中存在则更新,不存在则放到队列尾部 ,长度限制为 32 字节
  20. */
  21. @property (nonatomic,copy) NSString *key;
  22. /**
  23. * 更新元素的 Value 值,长度限制为 4096 字节
  24. */
  25. @property (nonatomic,copy) NSString *value;
  26. /**
  27. * 当提交这个新元素的用户从聊天室掉线或退出的时候,是否需要删除这个元素,默认为 NO 不删除。
  28. */
  29. @property (nonatomic,assign) BOOL transient;
  30. @end
  31. /**
  32. * 聊天室通用队列取出请求
  33. */
  34. @interface NIMChatroomQueueRemoveRequest : NSObject
  35. /**
  36. * 聊天室ID
  37. */
  38. @property (nonatomic,copy) NSString *roomId;
  39. /**
  40. * 拉去元素的Key值,如果要拉取第一个元素,则传空
  41. */
  42. @property (nullable,nonatomic,copy) NSString *key;
  43. @end
  44. /**
  45. * 聊天室通用队列批量更新请求
  46. */
  47. @interface NIMChatroomQueueBatchUpdateRequest : NSObject
  48. /**
  49. * 聊天室 ID
  50. */
  51. @property (nonatomic,copy) NSString *roomId;
  52. /**
  53. * 批量更新元素的key-value对,key/value分别是elementKey和elementValue(elementKey限制128字节,elementValue限制4096字节),一次最多更新100个
  54. */
  55. @property (nonatomic,copy) NSDictionary *elements;
  56. /**
  57. * 是否需要发送广播通知
  58. */
  59. @property (nonatomic,assign) BOOL needNotify;
  60. /**
  61. * 通知中的自定义字段,长度限制2048
  62. */
  63. @property (nonatomic,copy) NSString* notifyExt;
  64. @end
  65. NS_ASSUME_NONNULL_END