#import <IEMChatroomManager.h>
| - (void) addAdmin: |
|
(NSString *) |
aAdmin |
| toChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroomp, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Add chatroom admin, need Owner permissions
- Parameters
-
| aAdmin | Admin |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) addAdmin: |
|
(NSString *) |
aAdmin |
| toChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Add chatroom admin, need Owner permissions
Synchronization method will block the current thread
- Parameters
-
| aAdmin | Admin |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Group instance
| - (void) addDelegate: |
|
(3_1_0) |
|
|
|
(3_2_2) |
|
|
|
("Use -") |
EM_DEPRECATED_IOS[IEMChatroomManager addDelegate:delegateQueue:] |
|
|
| |
|
required |
Add delegate
- Parameters
-
| aDelegate | Delegate |
| aQueue | The queue of call delegate method |
Fetch chatroom's specification
- Parameters
-
| aChatroomId | Chatroom id |
| aIncludeMembersList | Whether get member list |
| aSuccessBlock | The callback block of success |
| aFailureBlock | The callback block of failure |
Get all the chatrooms from server
- Parameters
-
| aSuccessBlock | The callback block of success |
| aFailureBlock | The callback block of failure |
Join a chatroom
- Parameters
-
| aChatroomId | Chatroom id |
| aSuccessBlock | The callback block of success |
| aFailureBlock | The callback block of failure |
Leave a chatroom
- Parameters
-
| aChatroomId | Chatroom id |
| aSuccessBlock | The callback block of success |
| aFailureBlock | The callback block of failure |
- Returns
- Leaved chatroom
| - (void) blockMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Add users to chatroom blacklist, owner‘s authority is required
- Parameters
-
| aMembers | Users to be added |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) blockMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Add users to chatroom blacklist, required owner‘s authority
Synchronization method will block the current thread
- Parameters
-
| aMembers | Users to be added |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
| - (void) createChatroomWithSubject: |
|
(NSString *) |
aSubject |
| description: |
|
(NSString *) |
aDescription |
| invitees: |
|
(NSArray *) |
aInvitees |
| message: |
|
(NSString *) |
aMessage |
| maxMembersCount: |
|
(NSInteger) |
aMaxMembersCount |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Create a group
- Parameters
-
| aSubject | Group subject |
| aDescription | Group description |
| aInvitees | Group members, without creater |
| aMessage | Invitation message |
| aSetting | Group options |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) createChatroomWithSubject: |
|
(NSString *) |
aSubject |
| description: |
|
(NSString *) |
aDescription |
| invitees: |
|
(NSArray *) |
aInvitees |
| message: |
|
(NSString *) |
aMessage |
| maxMembersCount: |
|
(NSInteger) |
aMaxMembersCount |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Create a chatroom
Synchronization method will block the current thread
- Parameters
-
| aSubject | Subject |
| aDescription | Description |
| aInvitees | Members, without creater |
| aMessage | Invitation message |
| aSetting | Setting |
| pError | Error |
- Returns
- Created chatroom
| - (EMError *) destroyChatroom: |
|
(NSString *) |
aChatroomId |
|
|
required |
Destroy a group, owner‘s authority is required
Synchronization method will block the current thread
- Parameters
-
- Returns
- Error, return nil if success
Destroy a group, owner‘s authority is required
- Parameters
-
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) fetchChatroomInfo: |
|
(NSString *) |
aChatroomId |
| includeMembersList: |
|
(BOOL) |
aIncludeMembersList |
| error: |
|
(3_1_0) |
|
|
|
(3_3_0) |
|
|
|
("Use -") |
EM_DEPRECATED_IOS[IEMChatroomManager getChatroomSpecificationFromServerWithId:error:] |
|
|
| |
|
required |
Fetch chatroom's specification
Synchronization method, will block the current thread
- Parameters
-
| aChatroomId | Chatroom id |
| aIncludeMembersList | Whether to get member list,When YES, returns 200 members |
| pError | Error |
- Returns
- Chatroom instance
| - (void) getAllChatroomsFromServerWithCompletion: |
|
("Use -getChatroomsFromServerWithPage") |
__deprecated_msg |
|
|
required |
Get all the chatrooms from server
- Parameters
-
| aCompletionBlock | The callback block of completion |
| - (NSArray *) getAllChatroomsFromServerWithError: |
|
("Use -getChatroomsFromServerWithPage") |
__deprecated_msg |
|
|
required |
Get all the chatrooms from server
Synchronization method will block the current thread
- Parameters
-
- Returns
- Chat room list<EMChatroom>
| - (void) getChatroomBlacklistFromServerWithId: |
|
(NSString *) |
aChatroomId |
| pageNumber: |
|
(NSInteger) |
aPageNum |
| pageSize: |
|
(NSInteger) |
aPageSize |
| completion: |
|
(void(^)(NSArray *aList, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Get chatroom's blacklist, need owner / admin permissions
- Parameters
-
| aChatroomId | Chatroom id |
| aPageNum | Page number |
| aPageSize | Page size |
| aCompletionBlock | The callback block of completion |
| - (NSArray *) getChatroomBlacklistFromServerWithId: |
|
(NSString *) |
aChatroomId |
| pageNumber: |
|
(NSInteger) |
aPageNum |
| pageSize: |
|
(NSInteger) |
aPageSize |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Get the blacklist of chatroom from the server, need owner / admin permissions
- Parameters
-
| aChatroomId | Chatroom id |
| aPageNum | Page number |
| aPageSize | Page size |
| pError | Error |
| - (void) getChatroomMemberListFromServerWithId: |
|
(NSString *) |
aChatroomId |
| cursor: |
|
(NSString *) |
aCursor |
| pageSize: |
|
(NSInteger) |
aPageSize |
| completion: |
|
(void(^)(EMCursorResult *aResult, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Get the list of chatroom members from the server
- Parameters
-
| aChatroomId | Chatroom id |
| aCursor | Cursor, input nil the first time |
| aPageSize | Page size |
| aCompletionBlock | The callback block of completion |
| - (EMCursorResult *) getChatroomMemberListFromServerWithId: |
|
(NSString *) |
aChatroomId |
| cursor: |
|
(NSString *) |
aCursor |
| pageSize: |
|
(NSInteger) |
aPageSize |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Get the list of chatroom members from the server
- Parameters
-
| aChatroomId | Chatroom id |
| aCursor | Cursor, input nil the first time |
| aPageSize | Page size |
| pError | Error |
- Returns
- List and cursor
| - (void) getChatroomMuteListFromServerWithId: |
|
(NSString *) |
aChatroomId |
| pageNumber: |
|
(NSInteger) |
aPageNum |
| pageSize: |
|
(NSInteger) |
aPageSize |
| completion: |
|
(void(^)(NSArray *aList, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Get the mutes of chatroom from the server
- Parameters
-
| aChatroomId | Chatroom id |
| aPageNum | Page number |
| aPageSize | Page size |
| aCompletionBlock | The callback block of completion |
| - (NSArray *) getChatroomMuteListFromServerWithId: |
|
(NSString *) |
aChatroomId |
| pageNumber: |
|
(NSInteger) |
aPageNum |
| pageSize: |
|
(NSInteger) |
aPageSize |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Get the mutes of chatroom from the server
- Parameters
-
| aChatroomId | Chatroom id |
| aPageNum | Page number |
| aPageSize | Page size |
| pError | Error |
| - (void) getChatroomsFromServerWithPage: |
|
(NSInteger) |
aPageNum |
| pageSize: |
|
(NSInteger) |
aPageSize |
| completion: |
|
(void(^)(EMPageResult *aResult, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Get all the chatrooms from server
- Parameters
-
| aPageNum | Page number |
| aPageSize | Page size |
| aCompletionBlock | The callback block of completion |
| - (EMPageResult *) getChatroomsFromServerWithPage: |
|
(NSInteger) |
aPageNum |
| pageSize: |
|
(NSInteger) |
aPageSize |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Get pagesize number chatroom from server.
Synchronization method will block the current thread
- Parameters
-
| aPageNum | Page number |
| aPageSize | Page size |
| pError | Error |
- Returns
- Chat room list<EMChatroom>
| - (void) getChatroomSpecificationFromServerByID: |
|
(NSString *) |
aChatroomId |
| includeMembersList: |
|
(BOOL) |
aIncludeMembersList |
| completion: |
|
(3_1_0) |
|
|
|
(3_3_0) |
|
|
|
("Use -") |
EM_DEPRECATED_IOS[IEMChatroomManager getChatroomSpecificationFromServerWithId:completion:] |
|
|
| |
|
required |
Fetch chat room specifications
- Parameters
-
| aChatroomId | Chatroom id |
| aIncludeMembersList | Whether to get member list,When YES, returns 200 members |
| aCompletionBlock | The callback block of completion |
| - (void) getChatroomSpecificationFromServerWithId: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Fetch chat room specifications
- Parameters
-
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) getChatroomSpecificationFromServerWithId: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Fetch chatroom's specification
Synchronization method, will block the current thread
- Parameters
-
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
| - (void) joinChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Join a chatroom
- Parameters
-
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
Join a chatroom
Synchronization method will block the current thread
- Parameters
-
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Joined chatroom
| - (void) leaveChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Leave a chatroom
- Parameters
-
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (void) leaveChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Leave a chatroom
Synchronization method will block the current thread
- Parameters
-
| aChatroomId | Chatroom id |
| pError | Error |
| - (void) muteMembers: |
|
(NSArray *) |
aMuteMembers |
| muteMilliseconds: |
|
(NSInteger) |
aMuteMilliseconds |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Mute chatroom members, need Owner / Admin permissions
Synchronization method will block the current thread
- Parameters
-
| aMuteMembers | The list of mute, type is <NSString> |
| aMuteMilliseconds | Muted time duration in millisecond |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) muteMembers: |
|
(NSArray *) |
aMuteMembers |
| muteMilliseconds: |
|
(NSInteger) |
aMuteMilliseconds |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Mute chatroom members, need Owner / Admin permissions
Synchronization method will block the current thread
- Parameters
-
| aMuteMembers | The list of mute, type is <NSString> |
| aMuteMilliseconds | Muted time duration in millisecond |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
| - (void) removeAdmin: |
|
(NSString *) |
aAdmin |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Remove chatroom admin, need Owner permissions
- Parameters
-
| aAdmin | Admin |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) removeAdmin: |
|
(NSString *) |
aAdmin |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Remove chatroom admin, need Owner permissions
Synchronization method will block the current thread
- Parameters
-
| aAdmin | Admin |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
Remove delegate
- Parameters
-
| - (void) removeMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Remove members from a group, owner‘s authority is required
- Parameters
-
| aMembers | Users to be removed |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) removeMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Remove members from a chatroom, required owner‘s authority
Synchronization method will block the current thread
- Parameters
-
| aMembers | Users to be removed |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
| - (void) unblockMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Remove users from chatroom blacklist, owner‘s authority is required
- Parameters
-
| aMembers | Users to be removed |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) unblockMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Remove users from chatroom blacklist, required owner‘s authority
Synchronization method will block the current thread
- Parameters
-
| aMembers | Users to be removed |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
| - (void) unmuteMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Unmute chatroom members, need Owner / Admin permissions
Synchronization method will block the current thread
- Parameters
-
| aMembers | The list of unmute, type is <NSString> |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) unmuteMembers: |
|
(NSArray *) |
aMembers |
| fromChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Unmute chatroom members, need Owner / Admin permissions
Synchronization method will block the current thread
- Parameters
-
| aMembers | The list of unmute, type is <NSString> |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
| - (void) updateChatroomOwner: |
|
(NSString *) |
aChatroomId |
| newOwner: |
|
(NSString *) |
aNewOwner |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Change chatroom owner, need Owner permissions
- Parameters
-
| aChatroomId | Chatroom id |
| aNewOwner | New owner |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) updateChatroomOwner: |
|
(NSString *) |
aChatroomId |
| newOwner: |
|
(NSString *) |
aNewOwner |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Change chatroom owner, need Owner permissions
Synchronization method will block the current thread
- Parameters
-
| aChatroomId | Chatroom id |
| aNewOwner | New owner |
| pError | Error |
- Returns
- Chatroom instance
| - (void) updateDescription: |
|
(NSString *) |
aDescription |
| forChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Change the chatroom description, owner‘s authority is required
- Parameters
-
| aDescription | New description |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) updateDescription: |
|
(NSString *) |
aDescription |
| forChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Change chatroom description, owner‘s authority is required
Synchronization method will block the current thread
- Parameters
-
| aDescription | New description |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom
| - (void) updateSubject: |
|
(NSString *) |
aSubject |
| forChatroom: |
|
(NSString *) |
aChatroomId |
| completion: |
|
(void(^)(EMChatroom *aChatroom, EMError *aError)) |
aCompletionBlock |
|
|
| |
|
required |
Change the chatroom subject, owner‘s authority is required
- Parameters
-
| aSubject | New subject |
| aChatroomId | Chatroom id |
| aCompletionBlock | The callback block of completion |
| - (EMChatroom *) updateSubject: |
|
(NSString *) |
aSubject |
| forChatroom: |
|
(NSString *) |
aChatroomId |
| error: |
|
(EMError **) |
pError |
|
|
| |
|
required |
Change chatroom subject, owner‘s authority is required
Synchronization method will block the current thread
- Parameters
-
| aSubject | New subject |
| aChatroomId | Chatroom id |
| pError | Error |
- Returns
- Chatroom instance
The documentation for this protocol was generated from the following file: