#import <AgoraChatroom.h>
◆ __deprecated_msg
| - (NSArray< NSString * > *_Nullable muteList) __deprecated_msg |
|
("Use muteMembers instead") |
|
|
The list of muted members.
Only the chatroom owner can call the method. Returns nil if the user is not the chatroom owner.
◆ chatroomWithId:
| + (instancetype _Nullable) chatroomWithId: |
|
(NSString *_Nonnull) |
aChatroomId |
|
Constructs a chatroom instance with chatroom ID.
- 参数
-
| aChatroomId | The chatroom ID. |
- 返回
- The chatroom instance.
◆ adminList
| - (NSArray<NSString *>* _Nullable) adminList |
|
readnonatomiccopy |
The admins of the chatroom.
◆ announcement
| - (NSString* _Nullable) announcement |
|
readnonatomiccopy |
The announcement of the chat room.
◆ blacklist
| - (NSArray<NSString *>* _Nullable) blacklist |
|
readnonatomicstrong |
The blocklist of the chatroom.
Only the chatroom owner can call the method. Returns nil if the user is not the chatroom owner.
◆ chatroomId
| - (NSString* _Nullable) chatroomId |
|
readnonatomiccopy |
◆ createTimestamp
| - (NSInteger) createTimestamp |
|
readnonatomicassign |
Gets the timestamp(ms) when the chat room was created. This property is available once join the chat room.
◆ description
| - (NSString* _Nullable) description |
|
readnonatomiccopy |
The description of chat room.
◆ isInWhitelist
Current user is in allow list or not. This property is available once join the chat room. This property will be updated when current user is added or removed from the white list.
true: In white list.false: Not in white list.
◆ isMuteAllMembers
| - (BOOL) isMuteAllMembers |
|
readnonatomicassign |
Checks whether all members are muted,This propery is available once join the chat room. After joining the chat room, when you receive a callback for muting or unmuting all members, this property will be updated.
◆ maxOccupantsCount
| - (NSInteger) maxOccupantsCount |
|
readnonatomicassign |
The maximum member number of the chat room.
◆ memberList
| - (NSArray<NSString *>* _Nullable) memberList |
|
readnonatomiccopy |
The list of members in the chat room.
◆ muteExpireTimestamp
| - (NSInteger) muteExpireTimestamp |
|
readnonatomicassign |
Gets the timestamp(ms) when Current user will be unmuted.
This property is available once join the chat room. This property will be updated when current use is muted or unmuted.
- Current use is not muted if it is zero.
- Means cannot get MuteUntilTimeStamp correctly if it is be set with -1;
◆ muteMembers
| - (NSDictionary<NSString *, NSNumber*>* _Nullable) muteMembers |
|
readnonatomicstrong |
The list of muted members.
Only the chatroom owner can call the method. Returns nil if the user is not the chatroom owner.Return a key-value pairs, where the key is the user ID of the muted user and the value is the mute expiration timestamp in millisecond.Value == -1 means muted forever.
◆ occupantsCount
| - (NSInteger) occupantsCount |
|
readnonatomicassign |
The current number of members in the chat room. This includes the chat room owner, administrators, and regular members. You can get this information after joining the chat room. This property is updated when members join or leave the chat room.
◆ owner
| - (NSString* _Nullable) owner |
|
readnonatomiccopy |
The owner of the chat room. There is only one owner per chat room.
◆ permissionType
| - (AgoraChatroomPermissionType) permissionType |
|
readnonatomicassign |
The chatroom membership type of the current login account.
◆ subject
| - (NSString* _Nullable) subject |
|
readnonatomiccopy |
The subject of the chat room.
◆ whitelist
| - (NSArray<NSString *>* _Nullable) whitelist |
|
readnonatomicstrong |
The allowlist members <NSString>
Only the chatroom owner can call the method. Returns nil if the user is not the chatroom owner.
该类的文档由以下文件生成:
