剛開始碼項(xiàng)目的時(shí)候,我是非常排斥使用極光IM。因?yàn)樵?0115年(青蔥少年)我就使用過,那時(shí)候極光IM剛開始做,還存在諸多的問題(當(dāng)時(shí)把我虐的不要不要的0.0)。奈何胳膊拗不過大腿,領(lǐng)導(dǎo)讓用就用吧。就這樣再次開啟了極光之旅......
實(shí)現(xiàn)單聊、群聊
實(shí)現(xiàn)基本的單聊、群聊還是比較簡單的 ,畢竟我是只是調(diào)用下API。
首先看下JMessage
JMSGAbstractContent
JMSGGroup
JMSGMessage
JMSGUser
JMSGMessageDelegate
這幾個(gè).h文件里面的方法就能大概知道SDK的使用方法了。
首先發(fā)送消息使用的是JMSGMessage
里面的方法
//創(chuàng)建單聊的消息體
//單獨(dú)調(diào)用此接口創(chuàng)建消息,SDK 不會(huì)本地保存消息,再調(diào)用發(fā)送接口時(shí)才會(huì)保、
//如果上層希望創(chuàng)建消息時(shí)就本地化保存,請(qǐng)使用 [JMSGConversation createMessageWithContent:]
+ (JMSGMessage *)createSingleMessageWithContent:(JMSGAbstractContent *)content
username:(NSString *)username;
//創(chuàng)建群聊的消息體
//單獨(dú)使用此接口創(chuàng)建消息體,SDK 不會(huì)本地保存消息,再調(diào)用發(fā)送接口時(shí)才會(huì)保存;
//如果希望創(chuàng)建消息時(shí)就本地化保存,請(qǐng)使用 [JMSGConversation createMessageWithContent:]
+ (JMSGMessage *)createGroupMessageWithContent:(JMSGAbstractContent *)content
groupId:(NSString *)groupId;
//發(fā)送消息我使用的是這個(gè)方法 因?yàn)楹竺嫖乙孟Ⅲw對(duì)界面進(jìn)行更新設(shè)置 后面會(huì)說到
+ (void)sendMessage:(JMSGMessage *)message;
有了極光的用戶ID,配合這三個(gè)接口就能實(shí)現(xiàn)發(fā)送消息了。
既然消息發(fā)了,那消息到底有沒有發(fā)出去呢?
獲取消息發(fā)送的回調(diào)在JMSGMessageDelegate
代理里面
我們只要添加代理就好了。在JMessage
文件下如下方法添加代理
/*!
* @abstract 增加回調(diào)(delegate protocol)監(jiān)聽
*
* @param delegate 需要監(jiān)聽的 Delegate Protocol
* @param conversation 允許為nil
* - 為 nil, 表示接收所有的通知, 不區(qū)分會(huì)話.
* - 不為 nil,表示只接收指定的 conversation 相關(guān)的通知.
*/
+ (void)addDelegate:(id <JMessageDelegate>)delegate withConversation:(JMSGConversation *)conversation;
我是監(jiān)聽了具體的一個(gè)會(huì)話
JMSGMessageDelegate
代理方法
/*!
* @abstract 發(fā)送消息結(jié)果返回回調(diào)
*
* @param message 原發(fā)出的消息對(duì)象
* @param error 不為nil表示發(fā)送消息出錯(cuò)
*
* @discussion 應(yīng)檢查 error 是否為空來判斷是否出錯(cuò). 如果未出錯(cuò), 則成功.
*/
@optional
- (void)onSendMessageResponse:(JMSGMessage *)message
error:(NSError *)error;
/*!
* @abstract 接收消息(服務(wù)器端下發(fā)的)回調(diào)
*
* @param message 接收到下發(fā)的消息
* @param error 不為 nil 表示接收消息出錯(cuò)
*
* @discussion 應(yīng)檢查 error 是否為空來判斷有沒有出錯(cuò). 如果未出錯(cuò), 則成功.
* 留意的是, 這里的 error 不包含媒體消息下載文件錯(cuò)誤. 這類錯(cuò)誤有單獨(dú)的回調(diào) onReceiveMessageDownloadFailed:
*
* 收到的消息里, 也包含服務(wù)器端下發(fā)的各類消息事件, 比如有人被加入了群聊. 這類消息事件處理為特殊的 JMSGMessage 類型.
*
* 事件類的消息, 基于 JMSGMessage 類里的 contentType 屬性來做判斷,
* contentType = kJMSGContentTypeEventNotification.
*/
@optional
- (void)onReceiveMessage:(JMSGMessage *)message
error:(NSError *)error;
/*!
* @abstract 接收消息媒體文件下載失敗的回調(diào)
*
* @param message 下載出錯(cuò)的消息
*
* @discussion 因?yàn)閷?duì)于接收消息, 最主要需要特別做處理的就是媒體文件下載, 所以單列出來. 一定要處理.
*
* 通過的作法是: 如果是圖片, 則 App 展示一張?zhí)貏e的表明未下載成功的圖, 用戶點(diǎn)擊再次發(fā)起下載. 如果是語音,
* 則不必特別處理, 還是原來的圖標(biāo)展示. 用戶點(diǎn)擊時(shí), SDK 發(fā)現(xiàn)語音文件在本地沒有, 會(huì)再次發(fā)起下載.
*/
@optional
- (void)onReceiveMessageDownloadFailed:(JMSGMessage *)message;
實(shí)現(xiàn)onSendMessageResponse :
代理就能獲取到當(dāng)前發(fā)送的消失成功失敗了
實(shí)現(xiàn)onReceiveMessage :
代理就能接收到別人(單聊、群組)發(fā)送的消息了 。
到這里簡單的單聊、群聊就實(shí)現(xiàn)了。
實(shí)現(xiàn)收發(fā) 文字、圖片、語音、自定義消息
在極光IM中文字、圖片、語音、自定義消息。都有自己的類型定義 分別是JMSGTextContent
JMSGImageContent
JMSGVoiceContent
JMSGCustomContent
他們都間接或直接的繼承與JMSGAbstractContent
發(fā)文字
發(fā)送文字用JMSGTextContent
進(jìn)行實(shí)例化
- (instancetype)initWithText:(NSString *)text;
發(fā)圖片
JMSGImageContent
- (nullable instancetype)initWithImageData:(NSData * JMSG_NONNULL)data;
發(fā)送圖片是間接繼承JMSGAbstractContent
的 它直接繼承JMSGMediaAbstractContent
在JMSGMediaAbstractContent
中
@property(nonatomic, copy)JMSGMediaProgressHandler JMSG_NULLABLE uploadHandler;
用上屬性獲取到發(fā)送照片的進(jìn)度 。后面的發(fā)送語音亦是用此方法獲取到發(fā)送進(jìn)度。
假如你需要UI展示發(fā)送圖片、語音的進(jìn)度可以將JMSGImageContent
JMSGVoiceContent
實(shí)例傳遞到cell
中獲取進(jìn)度來展示UI。
messageModel.VoiceContent.uploadHandler = ^(float percent, NSString *msgId) {
};
發(fā)語音
- (instancetype)initWithVoiceData:(NSData *)data
voiceDuration:(NSNumber *)duration;
發(fā)自定義消息
自定義消息在文字、圖片、語音滿足不了你的業(yè)務(wù)需求時(shí)就派上用場了。例如;發(fā)送名片、發(fā)送軟件內(nèi)的一些動(dòng)態(tài)信息等。
注意:字典中的內(nèi)容要和安卓兄弟協(xié)商好
- (instancetype)initWithCustomDictionary:(NSDictionary * JMSG_NULLABLE)customDict;
以上是各內(nèi)容的實(shí)例化方法,鑒于各發(fā)送方法雷同。下面附上發(fā)送單聊文字的代碼供理解。
以上方法得到實(shí)例后用`createSingleMessageWithContent `得到 `JMSGMessage `實(shí)例 就可以 `sendMessage :`即可發(fā)送。
JMSGTextContent *TextContent = [[JMSGTextContent alloc]initWithText:@"message"];
JMSGMessage * JMmessage = [JMSGMessage createSingleMessageWithContent:TextContent username:@"用戶極光ID"];
[JMSGMessage sendMessage:JMmessage];//發(fā)送消息
接受消息
上面已經(jīng)提到接受消息的方法 下面具體說明接受到消息后的處理。
當(dāng)你用不同的Content
發(fā)送消息時(shí)極光內(nèi)部自動(dòng)區(qū)分內(nèi)容類型
極光IM中消息類型定義如下:
typedef NS_ENUM(NSInteger, JMSGContentType) {
/// 不知道類型的消息
kJMSGContentTypeUnknown = 0,
/// 文本消息
kJMSGContentTypeText = 1,
/// 圖片消息
kJMSGContentTypeImage = 2,
/// 語音消息
kJMSGContentTypeVoice = 3,
/// 自定義消息
kJMSGContentTypeCustom = 4,
/// 事件通知消息。服務(wù)器端下發(fā)的事件通知,本地展示為這個(gè)類型的消息展示出來
kJMSGContentTypeEventNotification = 5,
/// 文件消息
kJMSGContentTypeFile = 6,
/// 地理位置消息
kJMSGContentTypeLocation = 7,
/// 提示性消息
kJMSGContentTypePrompt = 8,
};
kJMSGContentTypeEventNotification 在下面聊天記錄部分說明
我們拿到Message
后按要按類型操作就可以了。
以下是操作文本的代碼示例 其他雷同
if (JIMmessage.contentType == kJMSGContentTypeText) {
//獲取到類型然后對(duì)Message進(jìn)行類型轉(zhuǎn)換 獲取到攜帶的內(nèi)容進(jìn)行展示即可
JMSGAbstractContent *content = JIMmessage.content;
JMSGTextContent *textContent = (JMSGTextContent *)content;
recMessage.text = textContent.text;
}
圖片、語音是要進(jìn)行下載操作的 獲取到content
調(diào)用下載發(fā)法即可:
//下載語音
[weakmessageModel.VoiceContent voiceData:^(NSData *data, NSString *objectId, NSError *error) {
}];
//下載圖片縮略圖
[messageModel.ImgContent thumbImageData:^(NSData *data, NSString *objectId, NSError *error) {
}];
獲取到的圖片、語音內(nèi)容 最好不要直接在VC中對(duì)其進(jìn)行下載賦值,最好的是將圖片、語音的content
傳到Cell中在cell中對(duì)其操作
到這里收發(fā)各種消息就可以完成了。
上面說了一些功能的實(shí)現(xiàn),下面開始說與UI相關(guān)的API方法、實(shí)現(xiàn)某些功能的操作
會(huì)話列表、聊天記錄的展示
會(huì)話列表
會(huì)話是整個(gè) IM 的核心. 所有的消息行為都是基于"會(huì)話"的.
當(dāng)你創(chuàng)建單聊、群聊對(duì)話的時(shí)候,IM會(huì)建立起一個(gè)會(huì)話、并保存在本地。
會(huì)話最直白的體現(xiàn)就是 最近的聊天列表
獲取全部會(huì)話的未讀消息
注意:如果你的群組設(shè)置為免打擾,該群組的聊天未讀數(shù)是不計(jì)入此統(tǒng)計(jì)的。
/*!
* @abstract 獲取當(dāng)前所有會(huì)話的未讀消息的總數(shù)
*
* @discussion 獲取所有會(huì)話未讀消息總數(shù)
*/
+ (NSNumber *)getAllUnreadCount;
如果想獲取已開啟免打擾群組的未讀數(shù),要獲取對(duì)應(yīng)的群組會(huì)話,在其屬性中就有
* @abstract 未讀數(shù)
* @discussion 有新消息來時(shí), SDK 會(huì)對(duì)未讀數(shù)自動(dòng)加 1
*/
@property(nonatomic, strong, readonly) NSNumber * JMSG_NULLABLE unreadCount;
會(huì)話還有一個(gè) target
屬性需要根據(jù)會(huì)話類型轉(zhuǎn)型。單聊時(shí)轉(zhuǎn)型為 JMSGUser,群聊時(shí)轉(zhuǎn)型為 JMSGGroup。但是極光文檔中不見建議我們?cè)跁?huì)話列表上用此屬性
注意: 在會(huì)話列表上, 請(qǐng)不要使用此屬性, 否則有性能問題. 只在進(jìn)入聊天界面(單個(gè)會(huì)話) 時(shí)使用此屬性,進(jìn)入會(huì)話(聊天界面)后, 訪問會(huì)話對(duì)象的各種信息, 包括群聊的群組成員, 都應(yīng)使用此屬性, 而沒有必要再通過接口查詢 UserInfo / GroupInfo.
但是會(huì)話列表是需要區(qū)別群聊、單聊來展示頭像和一些信息的我們?cè)趺崔k呢?
1、忽略極光IM的友情提示繼續(xù)使用target屬性
2、利用latestMessage
屬性 區(qū)別、獲取信息
利用 latestMessage 屬性區(qū)別、獲取信息
latestMessage
是JMSGMessage
類型。JMSGMessage
有如下幾個(gè)屬性
/*!
* @abstract 消息來源用戶
* - 收到的消息, fromUser 是發(fā)出消息的對(duì)方.
* 單聊是聊天對(duì)象, 也與當(dāng)前會(huì)話目標(biāo)用戶一致 [JMSGConversation target],
* 群聊是該條消息的發(fā)送用戶.
* - 發(fā)出的消息: fromUser 是我自己.
*/
@property(nonatomic, strong, readonly) JMSGUser *fromUser;
/*!
* @abstract 消息的內(nèi)容類型
*/
@property(nonatomic, assign, readonly) JMSGContentType contentType;
/*!
* @abstract 消息發(fā)送目標(biāo)
* - 收到的消息,target 就是我自己。
* - 發(fā)送的消息,target 是我的聊天對(duì)象。
* 單聊是對(duì)方用戶;
* 群聊是聊天群組, 也與當(dāng)前會(huì)話的目標(biāo)一致 [JMSGConversation target]
*/
@property(nonatomic, strong, readonly) id target;
利用這三個(gè)屬性我們就可以區(qū)分、獲取我們需要的數(shù)據(jù)了,這里就不做贅述了
聊天記錄
聊天記只要調(diào)用API即可獲取到消息(API獲取的記錄都是本地的)
/*!
* @abstract 同步分頁獲取最新的消息
*
* @param offset 開始的位置。nil 表示從最初開始。
* @param limit 獲取的數(shù)量。nil 表示不限。
*
* @return 返回消息列表(數(shù)組)。數(shù)組成員的類型是 JMSGMessage*
*
* @discussion 排序規(guī)則是:最新
*
* 參數(shù)舉例:
*
* - offset = nil, limit = nil,表示獲取全部。相當(dāng)于 allMessages。
* - offset = nil, limit = 100,表示從最新開始取 100 條記錄。
* - offset = 100, limit = nil,表示從最新第 100 條開始,獲取余下所有記錄。
*/
- (NSArray JMSG_GENERIC(__kindof JMSGMessage *) *)messageArrayFromNewestWithOffset:(NSNumber *JMSG_NULLABLE)offset limit:(NSNumber *JMSG_NULLABLE)limit;
/*!
* @abstract 異步獲取所有消息記錄
*
* @param handler 結(jié)果回調(diào)。正常返回時(shí) resultObject 類型為 NSArray,數(shù)據(jù)成員類型為 JMSGMessage。
*
* @discussion 排序規(guī)則:最新
*/
- (void)allMessages:(JMSGCompletionHandler)handler;
可能會(huì)有這樣的需求 ,在群組聊天的時(shí)候、添加某個(gè)人進(jìn)群、踢出某個(gè)人出群都要在聊天界面有一個(gè)提示。
其實(shí)這些群組的動(dòng)態(tài)IM都有下發(fā)一個(gè)消息類型為kJMSGContentTypeEventNotification
的消息給我們給我們
。在JMSGNotificationEvent.h
文件中即可看到其屬性值 獲取展示即可。
消息發(fā)送失敗在聊天界面展示紅色的感嘆號(hào)
剛接到這個(gè)需求的時(shí)候真的是有點(diǎn)懵!!!
因?yàn)闃O光IM的監(jiān)聽消息發(fā)送是全局性的,難道要在每一個(gè)Cell中都寫一個(gè)監(jiān)聽代理嘛?這個(gè)想法聽起來有點(diǎn)扯。但是極光IM沒有針對(duì)JMSGMessage
獲取到消息的發(fā)送回調(diào)。
然后我把極光IM,OC、Swift版本的Demo都看了一遍,極光Demo大致思路是:
創(chuàng)建一個(gè)數(shù)組把獲取到的歷史消息、后面發(fā)送的消息都放在數(shù)組里。一旦消息發(fā)送失敗 ,就取到數(shù)組中對(duì)應(yīng)消息的位置,利用這個(gè)位置再去獲取到對(duì)應(yīng)的Cell然后去更新UI。
以上是我對(duì)極光Demo的理解如有錯(cuò)誤請(qǐng)糾正,勿噴!
不過我沒有按照這種做法去做,因?yàn)槲視r(shí)間上來不及。
下面是我的做法:
//發(fā)送消息 成功、失敗的回調(diào)代理
- (void)onSendMessageResponse:(JMSGMessage *)message error:(NSError *)error
{
}
上方法返回message
error
倆個(gè)屬性 :
屬性error:當(dāng)error
為空的時(shí)候表示消息發(fā)送成功,反之則發(fā)送失敗。發(fā)送失敗對(duì)應(yīng)也會(huì)有一個(gè)error.code
每個(gè)code對(duì)應(yīng)的意思在極光官網(wǎng)就可查詢。
屬性message:message
是JMSGMessage
類型的,其有msgId
serverMessageId
/*!
* 消息ID:這個(gè)ID是本地存數(shù)據(jù)庫生成的ID,不是服務(wù)器端下發(fā)時(shí)的ID。
*/
@property(nonatomic, strong, readonly) NSString *msgId;
/*!
* @abstract 服務(wù)器端下發(fā)的消息ID.
* @discussion 一般用于與服務(wù)器端跟蹤消息.
*/
@property(nonatomic, strong, readonly) NSString * JMSG_NULLABLE serverMessageId;
倆個(gè)ID有個(gè)區(qū)別 msgId
在調(diào)用創(chuàng)建JMSGMessage
實(shí)例的時(shí)候就分配了,serverMessageId
只有消息發(fā)送到后臺(tái)才會(huì)分配。
所以我在消息發(fā)送失敗的時(shí)候發(fā)了一個(gè)通知攜帶msgId
,在Cell中接受通知。如果通知接送到的ID與我在外面?zhèn)鬟M(jìn)來的Id相同則刷新界面UI展示紅點(diǎn)。
- (void)onSendMessageResponse:(JMSGMessage *)message error:(NSError *)error
{
if (error) {
[[NSNotificationCenter defaultCenter]postNotificationName:@"MessageSendFaild" object:message.msgId];
}
}
//Cell中的放法
//添加接受通知
[[NSNotificationCenter defaultCenter]addObserver:self selector:@selector(MessageSendFaild:) name:@"MessageSendFaild" object:nil];
//接受到通知的操作
- (void)MessageSendFaild:(NSNotification *)Notification
{
if ([[Utility strRelay:Notification.object] isEqualToString:[Utility strRelay:self.messageModel.MSGMessage.msgId]]) {
_faildBtn.hidden = NO;
}
}
以上處于聊天界面的時(shí)候是可行的。 但是如果退出重進(jìn)獲取歷史記錄就會(huì)有問題 ,下面將處理這部分問題。
每一條JMSGMessage
都包含一個(gè)發(fā)送狀態(tài)status
只要判斷發(fā)送狀態(tài)來展示UI即可;
/*!
* 消息狀態(tài)
*/
typedef NS_ENUM(NSInteger, JMSGMessageStatus) {
/// 發(fā)送息創(chuàng)建時(shí)的初始狀態(tài)
kJMSGMessageStatusSendDraft = 0,
/// 消息正在發(fā)送過程中. UI 一般顯示進(jìn)度條
kJMSGMessageStatusSending = 1,
/// 媒體類消息文件上傳失敗
kJMSGMessageStatusSendUploadFailed = 2,
/// 媒體類消息文件上傳成功
kJMSGMessageStatusSendUploadSucceed = 3,
/// 消息發(fā)送失敗
kJMSGMessageStatusSendFailed = 4,
/// 消息發(fā)送成功
kJMSGMessageStatusSendSucceed = 5,
/// 接收中的消息(還在處理)
kJMSGMessageStatusReceiving = 6,
/// 接收消息時(shí)自動(dòng)下載媒體失敗
kJMSGMessageStatusReceiveDownloadFailed = 7,
/// 接收消息成功
kJMSGMessageStatusReceiveSucceed = 8,
};
以上就是消息消息失敗展示紅點(diǎn)的方法。如果想獲取消息為什么發(fā)送失敗可以獲取error.code
與極光后臺(tái)的錯(cuò)誤碼對(duì)比
803005
您不是群成員
803004
發(fā)送的目標(biāo)不存在(如:群組已解散)
服務(wù)端錯(cuò)誤碼傳送門