WhiteEvent.h 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. //
  2. // WhiteEvent.h
  3. // WhiteSDK
  4. //
  5. // Created by yleaf on 2018/10/9.
  6. //
  7. #import "WhiteObject.h"
  8. NS_ASSUME_NONNULL_BEGIN
  9. /** SDK 可以触发的自定义事件回调。 */
  10. @interface WhiteEvent : WhiteObject
  11. /** 指定回调事件名称和内容并初始化一个 `WhiteEvent` 对象。
  12. @param eventName 回调事件名称。
  13. @param payload 回调事件内容。
  14. @return 初始化的 `WhiteEvent` 对象。
  15. */
  16. - (instancetype)initWithName:(NSString *)eventName payload:(id)payload;
  17. /** 回调事件名称。 */
  18. @property (nonatomic, strong) NSString *eventName;
  19. /**
  20. 回调事件内容。
  21. 消息格式取决于发送方,可以为 NSArray(内部元素也需要可以被转换成 JSON ),NSString,NSDictionary,NSNumber(with Boolean,NSInteger,CGFloat)等可以在 JSON 中正常展示的类型。
  22. */
  23. @property (nonatomic, strong, nullable) id payload;
  24. /** 白板房间号。 */
  25. @property (nonatomic, strong, readonly) NSString *uuid;
  26. /**
  27. 发送事件的用户角色。包括 `system`,`app`,`custom`,`magix`,自定义事件为 `custom`。
  28. */
  29. @property (nonatomic, strong, readonly) NSString *scope;
  30. /**
  31. 发送事件的用户。
  32. */
  33. @property (nonatomic, strong, readonly) NSString *authorId;
  34. @end
  35. NS_ASSUME_NONNULL_END