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

#import <EMChatroom.h>

类 EMChatroom 继承关系图:

构造函数

(NSArray *whiteList) - __deprecated_msg
 
(NSArray *members) - EM_DEPRECATED_IOS
 
(NSInteger membersCount) - EM_DEPRECATED_IOS
 
(NSInteger maxMembersCount) - EM_DEPRECATED_IOS
 
(NSArray *occupants) - __deprecated_msg
 
("Use +chatroomWithId: instead") - __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
 
NSArray< NSString * > *_Nullable muteList
 
NSArray< NSString * > *_Nullable whitelist
 
EMChatroomPermissionType permissionType
 
NSInteger maxOccupantsCount
 
NSInteger occupantsCount
 
BOOL isMuteAllMembers
 

详细描述

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

函数文档

◆ __deprecated_msg [1/3]

- (NSArray *occupants) __deprecated_msg ("Use -members instead") 

该方法已废弃,请用 -members 代替。聊天室的成员列表。

◆ __deprecated_msg [2/3]

- (NSArray *whiteList) __deprecated_msg ("Use whitelist instead") 

聊天室的白名单列表。

需要owner权限才能查看,非owner返回nil

◆ __deprecated_msg [3/3]

- ("Use +)chatroomWithId:

该方法已废弃,请使用 +chatroomWithId: 方法代替。初始化聊天室实例。

返回
nil

◆ chatroomWithId:

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

获取聊天室实例。

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

◆ EM_DEPRECATED_IOS [1/3]

- (NSInteger maxMembersCount) EM_DEPRECATED_IOS (3_1_0) 
(3_3_0) 
("Use -maxOccupantsCount instead")   

该方法已废弃,用 -maxOccupantsCount 代替。聊天室的最大人数,如果没有获取聊天室详情将返回 0。

◆ EM_DEPRECATED_IOS [2/3]

- (NSArray *members) EM_DEPRECATED_IOS (3_1_0) 
(3_3_0) 
("Use -memberList instead")   

该方法已废弃,用 -memberList 代替。聊天室的成员列表,需要先调用 getChatroomSpecificationFromServerWithId 方法获取该聊天室详情。

◆ EM_DEPRECATED_IOS [3/3]

- (NSInteger membersCount) EM_DEPRECATED_IOS (3_1_0) 
(3_3_0) 
("Use -occupantsCount instead")   

该方法已废弃,用 -occupantsCount 代替。聊天室的当前人数,如果没有获取聊天室详情将返回 0。

属性说明

◆ 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 方法获取该聊天室详情。

◆ description

- (NSString* _Nullable) description
readnonatomiccopy

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

◆ isMuteAllMembers

- (BOOL) isMuteAllMembers
readnonatomicassign

聊天室成员是否全部被禁言。

◆ maxOccupantsCount

- (NSInteger) maxOccupantsCount
readnonatomicassign

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

◆ memberList

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

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

◆ muteList

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

聊天室的被禁言列表。

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

◆ occupantsCount

- (NSInteger) occupantsCount
readnonatomicassign

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

◆ owner

- (NSString* _Nullable) owner
readnonatomiccopy

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

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

◆ permissionType

- (EMChatroomPermissionType) permissionType
readnonatomicassign

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

◆ subject

- (NSString* _Nullable) subject
readnonatomiccopy

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

◆ whitelist

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

聊天室的白名单列表。

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


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