版本記錄
| 版本號 | 時間 |
|---|---|
| V1.0 | 2017.06.10 |
前言
很多app種都集成環信做第三方信息通訊工具，這里我們就看一下環信的主要功能和集成方法。先給出環信3.0的地址。
感興趣的可以參考：
1. 環信ios客戶端的集成（一）
2. 環信ios客戶端的集成（二）
3. 環信ios客戶端的集成（三）
4. 環信ios客戶端的集成（四）
5. 環信ios客戶端的集成（五）
6. 環信ios客戶端的集成（六）
7. 環信ios客戶端的集成（七）
這一篇主要說一下環信的 聊天室管理。
一、聊天室
??環信聊天室模型支持最大成員數為5000，和群組不同，聊天室內成員離線后，服務器當監聽到此成員不在線后不再會給此成員再發推送。
- 支持最大成員5000；
- 環信的聊天室內有所有者，管理員和游客三種身份；
- 支持禁言，黑名單，踢人等操作；
- 不支持客戶端邀請；
- 不支持 REST 邀請。
- 聊天室API通常是同步操作，需要在單獨的線程中執行，如 - 需使用異步API，請使用async前綴對應的API。
二、服務器端
三、客戶端
注冊聊天室模塊回調：
//EMChatroomManagerDelegate
//注冊聊天室回調
[[EMClient sharedClient].roomManager addDelegate:self delegateQueue:nil];
//移除；聊天室回調
[[EMClient sharedClient].roomManager removeDelegate:self];
1. 分頁獲取聊天室列表
/*!
* 從服務器獲取指定數目的聊天室
*
* 同步方法，會阻塞當前線程
*
* @param aPageNum 獲取第幾頁
* @param aPageSize 獲取多少條
* @param pError 出錯信息
*
* @return 聊天室列表<EMChatroom>
*/
- (EMPageResult *)getChatroomsFromServerWithPage:(NSInteger)aPageNum
pageSize:(NSInteger)aPageSize
error:(EMError **)pError;
/*!
* 從服務器獲取指定數目的聊天室
*
* @param aPageNum 獲取第幾頁
* @param aPageSize 獲取多少條
* @param aCompletionBlock 完成的回調
*/
- (void)getChatroomsFromServerWithPage:(NSInteger)aPageNum
pageSize:(NSInteger)aPageSize
completion:(void (^)(EMPageResult *aResult, EMError *aError))aCompletionBlock;
//調用:
//EMError *error = nil;
//NSArray *list = [[EMClient sharedClient].roomManager getChatroomsFromServerWithPage:0 pageSize：50 error:&error];
2. 加入聊天室
/*!
* 加入聊天室
*
* 同步方法，會阻塞當前線程
*
* @param aChatroomId 聊天室的ID
* @param pError 錯誤信息
*
* @result 所加入的聊天室
*/
- (EMChatroom *)joinChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 加入聊天室
*
* @param aChatroomId 聊天室的ID
* @param aCompletionBlock 完成的回調
*/
- (void)joinChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用:
//EMError *error = nil;
//EMChatroom *chatroom = [[EMClient sharedClient].roomManager joinChatroom:@"chatroomId" error:&error];
3. 離開聊天室
/*!
* 退出聊天室
*
* 同步方法，會阻塞當前線程
*
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 退出的聊天室，失敗返回nil
*/
- (EMChatroom *)leaveChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 退出聊天室
*
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)leaveChatroom:(NSString *)aChatroomId
completion:(void (^)(EMError *aError))aCompletionBlock;
//調用:
//EMError *error = nil;
//[[EMClient sharedClient].roomManager leaveChatroom:@"chatroomId" error:&error];
4. 獲取聊天室詳情
/*!
* 獲取聊天室詳情
*
* 同步方法，會阻塞當前線程
*
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @return 聊天室
*/
- (EMChatroom *)getChatroomSpecificationFromServerWithId:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 獲取聊天室詳情
*
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*
*/
- (void)getChatroomSpecificationFromServerWithId:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager getChatroomSpecificationFromServerWithId:@"roomId"error:&error];
5. 分頁獲取聊天室成員列表
/*!
* 獲取聊天室成員列表
*
* @param aChatroomId 聊天室ID
* @param aCursor 游標
* @param aPageSize 獲取多少條
* @param pError 錯誤信息
*
* @return 列表和游標
*/
- (EMCursorResult *)getChatroomMemberListFromServerWithId:(NSString *)aChatroomId
cursor:(NSString *)aCursor
pageSize:(NSInteger)aPageSize
error:(EMError **)pError;
/*!
* 獲取聊天室成員列表
*
* @param aChatroomId 聊天室ID
* @param aCursor 游標
* @param aPageSize 獲取多少條
* @param aCompletionBlock 完成的回調
*/
- (void)getChatroomMemberListFromServerWithId:(NSString *)aChatroomId
cursor:(NSString *)aCursor
pageSize:(NSInteger)aPageSize
completion:(void (^)(EMCursorResult *aResult, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMCursorResult *result = [[EMClient sharedClient].roomManager getChatroomMemberListFromServerWithId:@"roomId" cursor:@"cursor" pageSize:50 error:&error];
6. 分頁獲取聊天室黑名單列表
需要Owner或Admin權限
/*!
* 獲取聊天室黑名單列表, 需要owner/admin權限
*
* @param aChatroomId 聊天室ID
* @param aPageNum 獲取第幾頁
* @param aPageSize 獲取多少條
* @param pError 錯誤信息
*/
- (NSArray *)getChatroomBlacklistFromServerWithId:(NSString *)aChatroomId
pageNumber:(NSInteger)aPageNum
pageSize:(NSInteger)aPageSize
error:(EMError **)pError;
/*!
* 獲取聊天室黑名單列表, 需要owner/admin權限
*
* @param aChatroomId 聊天室ID
* @param aPageNum 獲取第幾頁
* @param aPageSize 獲取多少條
* @param aCompletionBlock 完成的回調
*/
- (void)getChatroomBlacklistFromServerWithId:(NSString *)aChatroomId
pageNumber:(NSInteger)aPageNum
pageSize:(NSInteger)aPageSize
completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
NSArray *list = [[EMClient sharedClient].roomManager getChatroomBlacklistFromServerWithId:@"roomId" pageNumber:1 pageSize:50 error:&error];
7. 分頁獲取聊天室禁言列表
/*!
* 獲取聊天室被禁言列表
*
* @param aChatroomId 聊天室ID
* @param aPageNum 獲取第幾頁
* @param aPageSize 獲取多少條
* @param pError 錯誤信息
*/
- (NSArray *)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
pageNumber:(NSInteger)aPageNum
pageSize:(NSInteger)aPageSize
error:(EMError **)pError;
/*!
* 獲取聊天室被禁言列表
*
* @param aChatroomId 聊天室ID
* @param aPageNum 獲取第幾頁
* @param aPageSize 獲取多少條
* @param aCompletionBlock 完成的回調
*/
- (void)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
pageNumber:(NSInteger)aPageNum
pageSize:(NSInteger)aPageSize
completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
NSArray *list = [[EMClient sharedClient].roomManager getChatroomMuteListFromServerWithId:@"roomId" pageNumber:1 pageSize:50 error:&error];
8. 更新聊天室名稱
需要Owner權限
/*!
* 更改聊天室主題, 需要owner權限
*
* 同步方法，會阻塞當前線程
*
* @param aSubject 新主題
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室對象
*/
- (EMChatroom *)updateSubject:(NSString *)aSubject
forChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 更改聊天室主題, 需要owner權限
*
* @param aSubject 新主題
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)updateSubject:(NSString *)aSubject
forChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager updateSubject:@"newSubject" forChatroom:@"roomId" error:&error];
9. 更新聊天室說明
需要Owner權限
/*!
* 更改聊天室說明信息, 需要owner權限
*
* 同步方法，會阻塞當前線程
*
* @param aDescription 說明信息
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室對象
*/
- (EMChatroom *)updateDescription:(NSString *)aDescription
forChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 更改聊天室說明信息, 需要owner權限
*
* @param aDescription 說明信息
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)updateDescription:(NSString *)aDescription
forChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager updateDescription:@"newDes" forChatroom:@"roomId" error:&error];
10.獲取聊天室公告
/*!
* 獲取聊天室公告
*
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @return 聊天室公告
*/
- (NSString *)getChatroomAnnouncementWithId:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 獲取聊天室公告
*
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)getChatroomAnnouncementWithId:(NSString *)aChatroomId
completion:(void (^)(NSString *aAnnouncement, EMError *aError))aCompletionBlock;
//調用
[[EMClient sharedClient].roomManager getChatroomAnnouncementWithId:@"chatroomId"
completion:^(NSString *aAnnouncement, EMError *aError) {
if (!aError) {
NSLog(@"獲取成功");
}
}];
11. 更新聊天室公告
/*!
* 修改聊天室公告，需要Owner / Admin權限
*
* @param aChatroomId 聊天室ID
* @param aAnnouncement 群公告
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)updateChatroomAnnouncementWithId:(NSString *)aChatroomId
announcement:(NSString *)aAnnouncement
error:(EMError **)pError;
/*!
* 修改聊天室公告，需要Owner / Admin權限
*
* @param aChatroomId 聊天室ID
* @param aAnnouncement 群公告
* @param aCompletionBlock 完成的回調
*/
- (void)updateChatroomAnnouncementWithId:(NSString *)aChatroomId
announcement:(NSString *)aAnnouncement
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
[[EMClient sharedClient].roomManager updateChatroomAnnouncementWithId:@"chatroomId"
announcement:@"announcement"
completion:^(EMChatroom *aChatroom, EMError *aError) {
if (!aError) {
NSLog(@"修改成功");
}
}];
聊天室owner/Admin修改聊天室公告時，其它成員會收到聊天室公告有更新的通知。
/*!
* 聊天室公告有更新
*
* @param aChatroom 聊天室
* @param aAnnouncement 公告
*/
- (void)chatroomAnnouncementDidUpdate:(EMChatroom *)aChatroom
announcement:(NSString *)aAnnouncement;
12.將成員移出聊天室
需要Owner或Admin權限
/*!
* 將成員移出聊天室, 需要owner/admin權限
*
* 同步方法，會阻塞當前線程
*
* @param aMembers 要移出的用戶列表
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)removeMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 將成員移出聊天室, 需要owner/admin權限
*
* @param aMembers 要移出的用戶列表
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)removeMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager removeMembers:@[@"username"] fromChatroom:@"roomId" error:&error];
13. 將用戶加到聊天室黑名單
需要Owner或Admin權限
/*!
* 加人到聊天室黑名單
*
* 同步方法，會阻塞當前線程
*
* @param aMembers 要加入黑名單的用戶
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)blockMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 加人到聊天室黑名單
*
* @param aMembers 要加入黑名單的用戶
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)blockMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager blockMembers:@[@"username"] fromChatroom:@"roomId" error:&error];
14. 將用戶移出聊天室黑名單
需要Owner或Admin權限
/*!
* 從聊天室黑名單中減人
*
* 同步方法，會阻塞當前線程
*
* @param aMembers 要從黑名單中移除的用戶名列表
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室對象
*/
- (EMChatroom *)unblockMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 從聊天室黑名單中減人
*
* @param aMembers 要從黑名單中移除的用戶名列表
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)unblockMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager unblockMembers:@[@"username"] fromChatroom:@"roomId" error:&error];
15. 改變聊天室創建者
需要Owner權限
/*!
* 改變聊天室創建者，需要Owner權限
*
* 同步方法，會阻塞當前線程
*
* @param aChatroomId 聊天室ID
* @param aNewOwner 新Owner
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)updateChatroomOwner:(NSString *)aChatroomId
newOwner:(NSString *)aNewOwner
error:(EMError **)pError;
/*!
* 改變聊天室創建者，需要Owner權限
*
* @param aChatroomId 聊天室ID
* @param aNewOwner 新Owner
* @param aCompletionBlock 完成的回調
*/
- (void)updateChatroomOwner:(NSString *)aChatroomId
newOwner:(NSString *)aNewOwner
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager updateChatroomOwner:@"roomId" newOwner:@"newOwner" error:&error];
16. 添加聊天室管理員
需要Owner權限
/*!
* 添加聊天室管理員，需要Owner權限
*
* 同步方法，會阻塞當前線程
*
* @param aAdmin 要添加的管理員
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)addAdmin:(NSString *)aAdmin
toChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 添加聊天室管理員，需要Owner權限
*
* @param aAdmin 要添加的群組管理員
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)addAdmin:(NSString *)aAdmin
toChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroomp, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager addAdmin:@"adminName" toChatroom:@"roomId" error:&error];
17. 移除聊天室管理員
需要Owner權限
/*!
* 移除聊天室管理員，需要Owner權限
*
* 同步方法，會阻塞當前線程
*
* @param aAdmin 要移除的群組管理員
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)removeAdmin:(NSString *)aAdmin
fromChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 移除聊天室管理員，需要Owner權限
*
* @param aAdmin 要添加的群組管理員
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)removeAdmin:(NSString *)aAdmin
fromChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager removeAdmin:@"adminName" fromChatroom:@"roomId" error:&error];
18.禁言聊天室成員
權限高者可禁言權限低者，反之不允許
/*!
* 將一組成員禁言，需要Owner / Admin權限
*
* 同步方法，會阻塞當前線程
*
* @param aMuteMembers 要禁言的成員列表<NSString>
* @param aMuteMilliseconds 禁言時長
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)muteMembers:(NSArray *)aMuteMembers
muteMilliseconds:(NSInteger)aMuteMilliseconds
fromChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 將一組成員禁言，需要Owner / Admin權限
*
* @param aMuteMembers 要禁言的成員列表<NSString>
* @param aMuteMilliseconds 禁言時長
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)muteMembers:(NSArray *)aMuteMembers
muteMilliseconds:(NSInteger)aMuteMilliseconds
fromChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager muteMembers:@[@"userName"] muteMilliseconds:100 aChatroomId:@"roomId" error:&error];
19. 解除禁言
權限高者可禁言權限低者，反之不允許
/*!
* 解除禁言，需要Owner / Admin權限
*
* 同步方法，會阻塞當前線程
*
* @param aMuteMembers 被解除的列表<NSString>
* @param aChatroomId 聊天室ID
* @param pError 錯誤信息
*
* @result 聊天室實例
*/
- (EMChatroom *)unmuteMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
error:(EMError **)pError;
/*!
* 解除禁言，需要Owner / Admin權限
*
* @param aMuteMembers 被解除的列表<NSString>
* @param aChatroomId 聊天室ID
* @param aCompletionBlock 完成的回調
*/
- (void)unmuteMembers:(NSArray *)aMembers
fromChatroom:(NSString *)aChatroomId
completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
//調用
EMError *error = nil;
EMChatroom *room = [[EMClient sharedClient].roomManager unmuteMembers:@[@"userName"] fromChatroom:@"roomId" error:&error];
20. 聊天室相關的回調
注冊聊天室回調
//注冊聊天室回調
[[EMClient sharedClient].roomManager addDelegate:self delegateQueue:nil];
//移除聊天室回調
[[EMClient sharedClient].roomManager removeDelegate:self];
/*!
* 有用戶加入聊天室
*
* @param aChatroom 加入的聊天室
* @param aUsername 加入者
*/
- (void)userDidJoinChatroom:(EMChatroom *)aChatroom
user:(NSString *)aUsername;
/*!
* 有用戶離開聊天室
*
* @param aChatroom 離開的聊天室
* @param aUsername 離開者
*/
- (void)userDidLeaveChatroom:(EMChatroom *)aChatroom
user:(NSString *)aUsername;
/*!
* 被踢出聊天室
*
* @param aChatroom 被踢出的聊天室
* @param aReason 被踢出聊天室的原因
*/
- (void)didDismissFromChatroom:(EMChatroom *)aChatroom
reason:(EMChatroomBeKickedReason)aReason;
/*!
* 有成員被加入禁言列表
*
* @param aChatroom 聊天室
* @param aMutedMembers 被禁言的成員
* @param aMuteExpire 禁言失效時間，暫時不可用
*/
- (void)chatroomMuteListDidUpdate:(EMChatroom *)aChatroom
addedMutedMembers:(NSArray *)aMutes
muteExpire:(NSInteger)aMuteExpire;
/*!
* 有成員被移出禁言列表
*
* @param aChatroom 聊天室
* @param aMutedMembers 移出禁言列表的成員
*/
- (void)chatroomMuteListDidUpdate:(EMChatroom *)aChatroom
removedMutedMembers:(NSArray *)aMutes;
/*!
* 有成員被加入管理員列表
*
* @param aChatroom 聊天室
* @param aAdmin 加入管理員列表的成員
*/
- (void)chatroomAdminListDidUpdate:(EMChatroom *)aChatroom
addedAdmin:(NSString *)aAdmin;
/*!
* 有成員被移出管理員列表
*
* @param aChatroom 聊天室
* @param aAdmin 移出管理員列表的成員
*/
- (void)chatroomAdminListDidUpdate:(EMChatroom *)aChatroom
removedAdmin:(NSString *)aAdmin;
/*!
* 聊天室創建者有更新
*
* @param aChatroom 聊天室
* @param aNewOwner 新群主
* @param aOldOwner 舊群主
*/
- (void)chatroomOwnerDidUpdate:(EMChatroom *)aChatroom
newOwner:(NSString *)aNewOwner
oldOwner:(NSString *)aOldOwner;
后記
未完，待續~~~
風景
