HyphenateChatSDK 4.12.0
构造函数 | 类方法 | 属性 | 所有成员列表
EMChatroom类 参考

#import <EMChatroom.h>

类 EMChatroom 继承关系图:

构造函数

(NSArray< NSString * > *_Nullable muteList) - __deprecated_msg
 

类方法

(instancetype _Nullable) + chatroomWithId:
 

属性

NSString *_Nullable chatroomId
 
NSString *_Nullable subject
 
NSString *_Nullable description
 
NSString *_Nullable owner
 
NSString *_Nullable announcement
 
NSArray< NSString * > *_Nullable adminList
 
NSArray< NSString * > *_Nullable memberList
 
NSArray< NSString * > *_Nullable blacklist
 
NSDictionary< NSString *, NSNumber * > *_Nullable muteMembers
 
NSArray< NSString * > *_Nullable whitelist
 
EMChatroomPermissionType permissionType
 
NSInteger maxOccupantsCount
 
NSInteger occupantsCount
 
BOOL isMuteAllMembers
 
NSInteger createTimestamp
 
BOOL isInWhitelist
 
NSInteger muteExpireTimestamp
 

详细描述

聊天室实例,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。

函数文档

◆ __deprecated_msg

- (NSArray< NSString * > *_Nullable muteList) __deprecated_msg ("Use muteMembers instead") 

聊天室的被禁言列表。

只有聊天室所有者有权限调用该方法,非聊天室所有者返回 nil。

◆ chatroomWithId:

+ (instancetype _Nullable) chatroomWithId: (NSString *_Nonnull)  aChatroomId

获取聊天室实例。

参数
aChatroomId聊天室 ID
返回
聊天室实例

属性说明

◆ adminList

- (NSArray<NSString *>* _Nullable) adminList
readnonatomiccopy

聊天室的管理者,拥有聊天室的最高权限,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。

◆ announcement

- (NSString* _Nullable) announcement
readnonatomiccopy

聊天室的公告,需要先调用 getChatroomAnnouncementWithId 方法获取该聊天室详情。

◆ blacklist

- (NSArray<NSString *>* _Nullable) blacklist
readnonatomicstrong

聊天室的黑名单,需要先调用获取聊天室黑名单方法。

只有聊天室所有者有权限调用该方法,非聊天室所有者返回 nil。

◆ chatroomId

- (NSString* _Nullable) chatroomId
readnonatomiccopy

聊天室 ID,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。

◆ createTimestamp

- (NSInteger) createTimestamp
readnonatomicassign

获取聊天室创建时间戳(毫秒)。 只有加入聊天室后可获取。

◆ description

- (NSString* _Nullable) description
readnonatomiccopy

聊天室的描述,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。

◆ isInWhitelist

- (BOOL) isInWhitelist
readnonatomicassign

当前登录用户是否在白名单中。 加入聊天室后可获取。 当前用户被加入或者被移除白名单时,此属性会发生变化。

  • true: 在白名单中。
  • false: 不在白名单中。

◆ isMuteAllMembers

- (BOOL) isMuteAllMembers
readnonatomicassign

聊天室成员是否全部被禁言,加入聊天室即可获取。 加入聊天室后,收到一键禁言/取消禁言的回调时,该状态会更新。

◆ maxOccupantsCount

- (NSInteger) maxOccupantsCount
readnonatomicassign

聊天室的最大人数,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。如果没有获取聊天室详情将返回 0。

◆ memberList

- (NSArray<NSString *>* _Nullable) memberList
readnonatomiccopy

聊天室的成员列表,通过分页获取聊天室成员列表接口加载。

◆ muteExpireTimestamp

- (NSInteger) muteExpireTimestamp
readnonatomicassign

获取当前被禁言截止时间戳(毫秒)。

加入聊天室后可获取。 当前用户被禁言或者被解除禁言时,此属性会被更新。

  • 当取值为0,表示当前用户未被禁言。
  • 当取值为-1,表示未能获取到用户被禁言时间戳。

◆ muteMembers

- (NSDictionary<NSString *, NSNumber*>* _Nullable) muteMembers
readnonatomicstrong

聊天室的被禁言列表。

只有聊天室所有者有权限调用该方法,非聊天室所有者返回 nil。返回的字典中key为被禁言用户Id,value为禁言到期时间,单位毫秒,-1 代表永久禁言。

◆ occupantsCount

- (NSInteger) occupantsCount
readnonatomicassign

聊天室的当前人数 包括聊天室所有者、管理员与普通成员 加入聊天室即可获取 当聊天室有成员进出时,此属性会更新。

◆ owner

- (NSString* _Nullable) owner
readnonatomiccopy

聊天室的所有者,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。

聊天室的所有者只有一人。

◆ permissionType

- (EMChatroomPermissionType) permissionType
readnonatomicassign

当前登录账号的聊天室成员类型。

◆ subject

- (NSString* _Nullable) subject
readnonatomiccopy

聊天室的主题,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。

◆ whitelist

- (NSArray<NSString *>* _Nullable) whitelist
readnonatomicstrong

聊天室的白名单列表。

只有聊天室所有者有权限调用该方法,非聊天室所有者返回 nil。


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