1、聊天室接口開發(fā)說明
從v5.3.2開始、sdk增加直播聊天室功能、推出直播領(lǐng)域消息解決方案。
聊天室跟普通的IM群（微信群，QQ群等）相比最大的不同點在于它是一個比較開放的虛擬組織。我們可以將直播聊天室比喻成一個廣場，廣場是開放無邊界的，所有的人都可以隨進隨出，而群就像一個房間，是一個有邊界有容量上限的私密組織，并且進入這個房間需要一定條件，一般是主動申請加入或被邀請加入。
1.1、相關(guān)接口：
直播sdk相關(guān)接口分2大類別：
1.1.1 后臺Rest提供接口。具體參考文檔地址：//www.fsoutstanding.cn/doc/sdk/server/2_5_1_8.html
(1) 創(chuàng)建聊天室
(2) 切換聊天室狀態(tài)（開啟/關(guān)閉）
1.1.2 SDK接口文檔（本頁面提供）
IOS SDK內(nèi)部提供的接口: 進入聊天室、聊天室內(nèi)發(fā)送消息、獲取聊天室信息、獲取聊天室成員列表、獲取成員信息、對成員進行禁言/拉黑、踢出、修改個人信息、修改聊天室信息、退出聊天室等接口。
1.2、直播聊天室三種成員角色：創(chuàng)建者(權(quán)限最高)>管理員>普通成員(權(quán)限高的能對權(quán)限低的做相應(yīng)處理)。
(1) 創(chuàng)建者:可以對所有成員進行管理，禁言/解除禁言/拉黑/從黑名單移除/踢出/修改聊天室信息。
(2) 管理員:只能對成員進行管理，禁言/解除禁言/拉黑/從黑名單移除/踢出。
(3) 普通成員:無權(quán)限
2、聊天室操作代碼示例：
? 進入聊天室 — 用戶要在聊天室內(nèi)說話，必須先調(diào)用接口進入此聊天室。用戶進入聊天室后，不會收到此聊天室的歷史消息推送。如有歷史消息需求，可以調(diào)用消息查詢接口進行顯示。代碼如下：
- (void)joinLiveChatRoom:(ECJoinLiveChatRoomRequest *)request completion:(void(^)(ECError *error,
ECLiveChatRoomInfo *roomInfo,ECLiveChatRoomMember *member))completion;
ECJoinLiveChatRoomRequest *request = [[ECJoinLiveChatRoomRequest alloc] init];
request.roomId = @"聊天室房間id";
request.nickName = @”昵稱”;
[[ECDevice sharedInstance].liveChatRoomManager joinLiveChatRoom:request completion:^(ECError *error,
ECLiveChatRoomInfo *roomInfo, ECLiveChatRoomMember *member) {
if (error.errorCode ==ECErrorType_NoError) {// 加入成功之后做跳轉(zhuǎn)邏輯
} else {
// 加入的錯誤碼,詳見錯誤碼介紹
}];
? 聊天室內(nèi)發(fā)送消息和接收聊天室消息 — 目前只支持發(fā)送文本消息,其他消息暫不支持,用戶如果想發(fā)送其他消息,可以用userdata發(fā)送自定義消息。代碼如下：
（1）聊天室內(nèi)發(fā)送消息，代碼如下：
[[ECDevice sharedInstance].liveChatRoomManager sendLiveChatRoomMessage:message progress:
self completion:^(ECError *error, ECMessage *amessage) {
if (error.errorCode == ECErrorType_LiveChatRoom_Forbid) {
}
return message;
}
（2）接收消息 — 詳見DeviceDelegateHelper+LiveChatRoom.h。代碼如下：
- (void)onReceiveLiveChatRoomMessage:(ECMessage *)message {
if (message.from.length==0) return;
if (message.timestamp) {
NSDate* date = [NSDate dateWithTimeIntervalSinceNow:0];
NSTimeInterval tmp =[date timeIntervalSince1970]*1000;
message.timestamp = [NSString stringWithFormat:@"%lld", (long long)tmp];}
[[NSNotificationCenter defaultCenter] postNotificationName:
KNOTIFICATION_onLiveChatRoomMesssageChanged object:message];
}
? 獲取聊天室信息 — 此接口可以遠程獲取聊天室信息,SDK不會緩存聊天室信息，開發(fā)者需要根據(jù)業(yè)務(wù)自己做好緩存。代碼如下：
[[ECDevice sharedInstance].liveChatRoomManager queryLiveChatRoomInfo:@”聊天室房間id”
completion:^(ECError *error, ECLiveChatRoomInfo *roomInfo) {
if (error.errorCode == ECErrorType_NoError) {
}
}];
? 修改聊天室信息 — 只有創(chuàng)建者才能修改房間信息,創(chuàng)建者可以修改公告,房間昵稱,是否全員禁言等功能。代碼如下：
ECModifyLiveChatRoomInfoRequest *request = [[ECModifyLiveChatRoomInfoRequest alloc] init];
request.roomId =@”聊天室房間id”;
request.roomName = @”房間名稱”;
request.announcement = @”公告”;
request.isAllMuteMode = 是否全員禁言;
request.roomExt = @"透傳字段";
[[ECDevice sharedInstance].liveChatRoomManager modifyLiveChatRoomInfo:request
completion:^(ECError *error, ECLiveChatRoomInfo *roomInfo) {
if (error.errorCode == ECErrorType_NoError) {
} else {}
}];
? 獲取聊天室成員列表 — 此接口可以遠程獲取聊天室成員列表,SDK不會緩存聊天室成員列表和查詢單個成員信息,開發(fā)者需要根據(jù)業(yè)務(wù)自己做好緩存。代碼如下：
NSString *userId = self.listArray.lastObject;(為空第一頁) [[ECDevice sharedInstance].liveChatRoomManager queryLiveChatRoomMembers:@”聊天室房間id” userId:nil pageSize:10 completion:^(ECError *error, NSArray*userArray) { if (error.errorCode == ECErrorType_NoError) { [self.listArray removeAllObjects]; [self.listArray addObjectsFromArray:userArray]; [self.collectionView reloadData]; } }];
? 獲取成員信息 — 當用戶需要查看自己或者其他成員信息時,可以調(diào)用此接口,訪問其他人的信息。代碼如下：
NSString *roomId = @”聊天室房間id”;
NSString *userId = @”用戶id”;
[[ECDevice sharedInstance].liveChatRoomManager queryLiveChatRoomMember:roomId userId:
useId completion:^(ECError *error, ECLiveChatRoomMember *amember) {
if (error.errorCode == ECErrorType_NoError) {
}
}];
? 修改個人信息 — 在當前聊天室房間中設(shè)置昵稱、透傳信息。代碼如下：
ECModifyLiveChatRoomMemberInfoRequest *request = [[ECModifyLiveChatRoomMemberInfoRequest alloc] init];
request.roomId =@”聊天室房間id”;
request.nickName = @”昵稱”;
request.infoExt = @"透傳字段(可以是頭像信息等)";
[[ECDevice sharedInstance].liveChatRoomManager modifyLiveChatRoomSelfInfo:
request completion:^(ECError *error, ECLiveChatRoomMember *member) {
if (error.errorCode == ECErrorType_NoError) {
} else {}
}];
? 禁言 — 角色權(quán)限高的用戶可以對角色權(quán)限低的用戶設(shè)置禁言狀態(tài),設(shè)置禁言后的用戶將不能發(fā)送消息,但可以接收消息。代碼如下：
ECForbidLiveChatRoomMemberRequest *request =
[[ECForbidLiveChatRoomMemberRequest alloc] init];
request.roomId = @”聊天室房間id”;
request.userId = @”用戶id”;
request.isMute = @”是否禁言”;
request.muteDuration = @”禁言時長”;
[[ECDevice sharedInstance].liveChatRoomManager forbidLiveChatRoomMember:
request completion:^(ECError *error, ECLiveChatRoomMember *member) {
if (error.errorCode == ECErrorType_NoError) {}
}];
? 拉黑 — 角色權(quán)限高的用戶可以對角色權(quán)限低的用戶設(shè)置拉黑狀態(tài),設(shè)置拉黑后的用戶將不能發(fā)送消息,不能接收消息,并且若被移除聊天室,被拉黑的用戶將不能加入此房間。代碼如下：
ECDefriendLiveChatRoomMemberRequest *request =
[[ECDefriendLiveChatRoomMemberRequest alloc] init];
request.roomId =@”房間id”;
request.userId =@”將要拉黑的用戶id”;
request.isBlack = @”是否拉黑”;
[[ECDevice sharedInstance].liveChatRoomManager dfriendLiveChatRoomMember:
request completion:^(ECError *error, ECLiveChatRoomMember *member) {
if (error.errorCode == ECErrorType_NoError) {}
}];
? 踢出 — 創(chuàng)建者/管理員可以將成員從該聊天室中進行踢出。代碼如下：
ECKickLiveChatRoomMemberRequest *request = [[ECKickLiveChatRoomMemberRequest alloc] init];
request.roomId = @”聊天室id”;
request.userId = @”用戶id”;
[[ECDevice sharedInstance].liveChatRoomManager kickLiveChatRoomMember:
request completion:^(ECError *error, NSString *userId) {
if (error.errorCode == ECErrorType_NoError) {}
}];
? 退出聊天室 — 用戶主動退出聊天室,調(diào)用此接口。代碼如下：
ECExitLiveChatRoomRequest *request = [[ECExitLiveChatRoomRequest alloc] init];
request.roomId =@”聊天室id”;
[[ECDevice sharedInstance].liveChatRoomManager exitLiveChatRoom:request completion:^(ECError *error,
NSString *roomId) {
if (error.errorCode != ECErrorType_NoError) {
}
}];
? 聊天室內(nèi)的通知消息 — 當用戶加入,退出,被禁言,被踢出,被拉黑,變更角色等,聊天室內(nèi)的成員都會收到通知消息. 在聊天室中所有的通知都以消息 ECLiveChatRoomNoticeMessage 的形式展示，內(nèi)部 ECLiveChatRoomNoticeType為不同類型的通知。代碼如下：
/**
收到聊天室的通知消息
@param msg 通知消息體
*/
- (void)onReceiveLiveChatRoomNoticeMessage:(ECLiveChatRoomNoticeMessage *)msg;
通過ECLiveChatRoomNoticeMessage 的type字段區(qū)分不同的通知消息體類型.
文檔更新時間：2017年7月11日