HyphenateChatSDK  3.8.4
Instance Methods | Class Methods | Properties | List of all members
EMChatroom Class Reference

#import <EMChatroom.h>

Inheritance diagram for EMChatroom:

Instance Methods

(NSArray *members) - EM_DEPRECATED_IOS
 
(NSInteger membersCount) - EM_DEPRECATED_IOS
 
(NSInteger maxMembersCount) - EM_DEPRECATED_IOS
 
(NSArray *occupants) - __deprecated_msg
 
("Use +chatroomWithId: instead") - __deprecated_msg
 

Class Methods

(instancetype) + chatroomWithId:
 

Properties

NSString * chatroomId
 
NSString * subject
 
NSString * description
 
NSString * owner
 
NSString * announcement
 
NSArray * adminList
 
NSArray * memberList
 
NSArray * blacklist
 
NSArray * muteList
 
NSArray * whiteList
 
EMChatroomPermissionType permissionType
 
NSInteger maxOccupantsCount
 
NSInteger occupantsCount
 
BOOL isMuteAllMembers
 

Detailed Description

Chat room object

Method Documentation

◆ __deprecated_msg [1/2]

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

List of members in the chat room

◆ __deprecated_msg [2/2]

- ("Use +)chatroomWithId:

Initialize chatroom instance

Please use [+chatroomWithId:]

Returns
nil

◆ chatroomWithId:

+ (instancetype) chatroomWithId: (NSString *)  aChatroomId

Construct a chatroom instance with chatroom id

Parameters
aChatroomIdChatroom id
Returns
Chatroom instance

◆ EM_DEPRECATED_IOS [1/3]

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

The capacity of the chat room

◆ EM_DEPRECATED_IOS [2/3]

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

List of members in the chat room

◆ EM_DEPRECATED_IOS [3/3]

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

The total number of members in the chat room

Property Documentation

◆ adminList

- (NSArray*) adminList
readnonatomiccopy

Admins of the chatroom

◆ announcement

- (NSString*) announcement
readnonatomiccopy

Announcement of chat room

◆ blacklist

- (NSArray*) blacklist
readnonatomicstrong

Chatroom‘s blacklist of blocked users

Need owner's authority to access, return nil if user is not the chatroom owner.

◆ chatroomId

- (NSString*) chatroomId
readnonatomiccopy

Chat room id

◆ description

- (NSString*) description
readnonatomiccopy

Description of chat room

◆ isMuteAllMembers

- (BOOL) isMuteAllMembers
readnonatomicassign

The chat room is all members muted.

◆ maxOccupantsCount

- (NSInteger) maxOccupantsCount
readnonatomicassign

The capacity of the chat room

◆ memberList

- (NSArray*) memberList
readnonatomiccopy

List of members in the chat room

◆ muteList

- (NSArray*) muteList
readnonatomicstrong

List of muted members<NSString>

Need owner's authority to access, return nil if user is not the chatroom owner.

◆ occupantsCount

- (NSInteger) occupantsCount
readnonatomicassign

The total number of members in the chat room

◆ owner

- (NSString*) owner
readnonatomiccopy

Owner of the chat room. Only one owner per chat room.

◆ permissionType

- (EMChatroomPermissionType) permissionType
readnonatomicassign

The chatroom membership type of the current login account

◆ subject

- (NSString*) subject
readnonatomiccopy

Subject of chat room

◆ whiteList

- (NSArray*) whiteList
readnonatomicstrong

List of whitelist members<NSString>

Need owner's authority to access, return nil if user is not the chatroom owner.


The documentation for this class was generated from the following file: