HyphenateSDK  3.3.0
Instance Methods | Class Methods | Properties | List of all members
EMGroup Class Reference

#import <EMGroup.h>

Inheritance diagram for EMGroup:

Instance Methods

(NSArray *members) - EM_DEPRECATED_IOS
 
(NSArray *blackList) - EM_DEPRECATED_IOS
 
(NSInteger membersCount) - EM_DEPRECATED_IOS
 
("Use +groupWithId:") - __deprecated_msg
 
(NSArray *bans) - __deprecated_msg
 

Class Methods

(instancetype) + groupWithId:
 

Properties

NSString * groupId
 
NSString * subject
 
NSString * description
 
EMGroupOptionssetting
 
NSString * owner
 
NSArray * adminList
 
NSArray * memberList
 
NSArray * blacklist
 
NSArray * muteList
 
BOOL isPushNotificationEnabled
 
BOOL isPublic
 
BOOL isBlocked
 
EMGroupPermissionType permissionType
 
NSArray * occupants
 
NSInteger occupantsCount
 

Detailed Description

Group

Method Documentation

- ("Use +)groupWithId:

Initialize a group instance

Please use [+groupWithId:]

Returns
nil
- (NSArray* bans) __deprecated_msg ("Use - blackList") 

Group‘s blacklist of blocked users

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

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

Member list of the group

- (NSArray* blackList) EM_DEPRECATED_IOS (3_1_0) 
(3_3_0) 
("Use -blacklist")   

Group‘s blacklist of blocked users

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

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

The total number of group members, include owner, admins, members

+ (instancetype) groupWithId: (NSString *)  aGroupId

Get group instance, create a instance if it does not exist

Parameters
aGroupIdGroup id
Returns
Group instance

Property Documentation

- (NSArray*) adminList
readnonatomiccopy

Admins of the group

- (NSArray*) blacklist
readnonatomicstrong

Group‘s blacklist of blocked users

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

- (NSString*) description
readnonatomiccopy

Description of the group

- (NSString*) groupId
readnonatomiccopy

Group id

- (BOOL) isBlocked
readnonatomicassign

Whether block the current group‘s messages

- (BOOL) isPublic
readnonatomicassign

Whether is a public group

- (BOOL) isPushNotificationEnabled
readnonatomicassign

Is Apple Push Notification Service enabled for group

- (NSArray*) memberList
readnonatomiccopy

Member list of the group

- (NSArray*) muteList
readnonatomicstrong

List of muted members

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

- (NSArray*) occupants
readnonatomicstrong

All occupants of the group, includes the group owner and admins and all other group members

- (NSInteger) occupantsCount
readnonatomicassign

The total number of group occupants, include owner, admins, members

- (NSString*) owner
readnonatomiccopy

Owner of the group

Each group only has one owner

- (EMGroupPermissionType) permissionType
readnonatomicassign

The group membership type of the current login account

- (EMGroupOptions*) setting
readnonatomicstrong

Setting options of group

- (NSString*) subject
readnonatomiccopy

Subject of the group


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