NIMSDK-iOS
载入中...
搜索中...
未找到
NIMSubscribeEvent类 参考

#import <NIMSubscribeEvent.h>

类 NIMSubscribeEvent 继承关系图:

构造函数

(void) - setExt:
 
(nullable NSString *) - ext:
 

属性

NSString * eventId
 
NSString * from
 
NSTimeInterval timestamp
 
NSInteger type
 
NSInteger value
 
NSTimeInterval expiry
 
BOOL sendToOnlineUsersOnly
 
BOOL syncEnabled
 
id subscribeInfo
 

详细描述

订阅事件

函数文档

◆ ext:

- (nullable NSString *) ext: (NIMLoginClientType type

事件扩展字段,读取方法

参数
type客户端类型
返回
扩展字段

◆ setExt:

- (void) setExt: (NSString *)  ext

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

参数
ext扩展字符串

属性说明

◆ eventId

- (NSString*) eventId
readnonatomiccopy

事件 Id, 发布时无需填写

◆ expiry

- (NSTimeInterval) expiry
readwritenonatomicassign

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

◆ from

- (NSString*) from
readnonatomiccopy

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

◆ sendToOnlineUsersOnly

- (BOOL) sendToOnlineUsersOnly
readwritenonatomicassign

事件是否只广播给在线用户 @discussion 默认为YES 如果这个值为NO,事件会在订阅者登录后同步

◆ subscribeInfo

- (id) subscribeInfo
readnonatomicstrong

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

◆ syncEnabled

- (BOOL) syncEnabled
readwritenonatomicassign

事件是否支持多端同步 @discussion 默认为YES。

◆ timestamp

- (NSTimeInterval) timestamp
readnonatomicassign

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

◆ type

- (NSInteger) type
readwritenonatomicassign

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

◆ value

- (NSInteger) value
readwritenonatomicassign

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


该类的文档由以下文件生成: