NIMSubscribeEvent Class Reference

Inherits from NSObject
Declared in NIMSubscribeEvent.h

Overview

订阅事件

  eventId

事件 Id, 发布时无需填写

@property (nonatomic, copy, readonly) NSString *eventId

Discussion

事件 Id, 发布时无需填写

Declared In

NIMSubscribeEvent.h

  from

事件发布者，发布时无须填写

@property (nullable, nonatomic, copy, readonly) NSString *from

Discussion

事件发布者，发布时无须填写

Declared In

NIMSubscribeEvent.h

  timestamp

事件发布的时间，发布时无须填写

@property (nonatomic, assign, readonly) NSTimeInterval timestamp

Discussion

事件发布的时间，发布时无须填写

Declared In

NIMSubscribeEvent.h

  type

事件类型，1～99999 为云信保留类型，目前只支持预定义事件, 见 NIMSubscribeSystemEventType

@property (nonatomic, assign) NSInteger type

Discussion

事件类型，1～99999 为云信保留类型，目前只支持预定义事件, 见 NIMSubscribeSystemEventType

Declared In

NIMSubscribeEvent.h

  value

事件的状态值,预定义事件值可以是内置 NIMSubscribeEventOnlineValue 枚举, 也可以是用户自定义

@property (nonatomic, assign) NSInteger value

Discussion

事件的状态值,预定义事件值可以是内置 NIMSubscribeEventOnlineValue 枚举, 也可以是用户自定义

Declared In

NIMSubscribeEvent.h

  expiry

事件的有效期，范围为 60 秒到 7 天， 数值单位为秒，默认为 7 天

@property (nonatomic, assign) NSTimeInterval expiry

Discussion

事件的有效期，范围为 60 秒到 7 天， 数值单位为秒，默认为 7 天

Declared In

NIMSubscribeEvent.h

  sendToOnlineUsersOnly

事件是否只广播给在线用户

@property (nonatomic, assign) BOOL sendToOnlineUsersOnly

Discussion

事件是否只广播给在线用户

默认为YES 如果这个值为NO,事件会在订阅者登录后同步

Declared In

NIMSubscribeEvent.h

  syncEnabled

事件是否支持多端同步

@property (nonatomic, assign) BOOL syncEnabled

Discussion

事件是否支持多端同步

默认为YES。

Declared In

NIMSubscribeEvent.h

  subscribeInfo

订阅事件的额外信息，当订阅事件为 NIMSubscribeSystemEventTypeOnline 时，为 NIMSubscribeOnlineInfo

@property (nonatomic, strong, readonly) id subscribeInfo

Discussion

订阅事件的额外信息，当订阅事件为 NIMSubscribeSystemEventTypeOnline 时，为 NIMSubscribeOnlineInfo

Declared In

NIMSubscribeEvent.h

– setExt:

事件扩展字段，最大长度为 4K, 写方法

- (void)setExt:(NSString *)ext

Parameters

ext

扩展字符串

Discussion

事件扩展字段，最大长度为 4K, 写方法

Declared In

NIMSubscribeEvent.h

– ext:

事件扩展字段，读取方法

- (nullable NSString *)ext:(NIMLoginClientType)type

Parameters

type

客户端类型

Return Value

扩展字段

Discussion

事件扩展字段，读取方法

Declared In

NIMSubscribeEvent.h