JMSGEventContent.h 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. /*
  2. * | | | | \ \ / / | | | | / _______|
  3. * | |____| | \ \/ / | |____| | / /
  4. * | |____| | \ / | |____| | | | _____
  5. * | | | | / \ | | | | | | |____ |
  6. * | | | | / /\ \ | | | | \ \______| |
  7. * | | | | /_/ \_\ | | | | \_________|
  8. *
  9. * Copyright (c) 2011 ~ 2015 Shenzhen HXHG. All rights reserved.
  10. */
  11. #import <Foundation/Foundation.h>
  12. #import <JMessage/JMSGAbstractContent.h>
  13. /*!
  14. * 事件类型的消息内容
  15. *
  16. * 服务器端下发的事件通知, 比如用户被踢下线,群组里加了人, SDK 作为一个特殊的消息类型处理.
  17. * SDK 以消息的形式通知到 App. 详情参见 JMessageDelegate.
  18. */
  19. @interface JMSGEventContent : JMSGAbstractContent <NSCopying>
  20. /*!
  21. * @abstract 事件类型
  22. * @discussion 参考事件类型的定义 JMSGEventNotificationType
  23. */
  24. @property(nonatomic, assign, readonly) JMSGEventNotificationType eventType;
  25. // 不支持使用的初始化方法
  26. - (nullable instancetype)init NS_UNAVAILABLE;
  27. /*!
  28. * @abstract 获取事件发起者的用户名
  29. * @return 正常返回事件发起者的用户名,如果是调用后台 API 产生的事件,则返回:管理员
  30. *
  31. * @discussion 如果设置了nickname,则返回nickname,否则返回username
  32. * 可以用于定制 event message,拼接成完整的事件描述信息。
  33. */
  34. - (NSString *JMSG_NULLABLE)getEventFromUsername;
  35. /*!
  36. * @abstract 获取事件作用对象用户名列表
  37. * @return 返回类型为 NSArray,数组成员为事件作用对象的用户名
  38. *
  39. * @discussion 如果设置了nickname,则返回nickname,否则返回username
  40. * 可以用于定制 event message,拼接成完整的事件描述信息。
  41. */
  42. - (NSArray *JMSG_NULLABLE)getEventToUsernameList;
  43. /*!
  44. @abstract 展示此事件的文本描述
  45. @discussion SDK 根据事件类型,拼接成完整的事件描述信息。
  46. */
  47. - (NSString * JMSG_NONNULL)showEventNotification;
  48. @end