融云SDK

融云SDK是一款安卓App開(kāi)發(fā)源件，融云 SDK針對(duì)了開(kāi)發(fā)者所需的不同需要提供了一系列的技術(shù)解決方案，例如客戶(hù)端 IM 組件，客戶(hù)端IM基礎(chǔ)庫(kù)，Web SDK，服務(wù)端 REST API等，利用這些解決方案開(kāi)發(fā)者可以在應(yīng)用中構(gòu)建自己的產(chǎn)品。

軟件特色

IM 界面組件 - IMKit

IMKit 是融云 SDK 的核心特色之一。融云將即時(shí)通訊產(chǎn)品中最復(fù)雜的會(huì)話(huà)列表、聊天窗口、消息內(nèi)容展現(xiàn)、會(huì)話(huà)設(shè)置等功能封裝為組件，通過(guò)簡(jiǎn)短的代碼，您就可以直接將以上界面集成到您的 App 產(chǎn)品中，省去大量的開(kāi)發(fā)調(diào)試時(shí)間。融云同時(shí)支持業(yè)內(nèi)最豐富的自定義界面組件功能，您可以針對(duì)自己界面需求自由設(shè)計(jì)開(kāi)發(fā)。

IMKit 的核心類(lèi)在 Android 平臺(tái)是 RongIM，在 iOS 平臺(tái)是 RCIM，這兩個(gè)類(lèi)在今后的開(kāi)發(fā)中和 IMKit 代表相同的意義。

IM 通訊能力庫(kù) - IMLib

IMLib 是不含界面的基礎(chǔ) IM 通訊能力庫(kù)，封裝了通信能力和會(huì)話(huà)、消息等對(duì)象。引用到 App 工程中后，需要開(kāi)發(fā)者自己實(shí)現(xiàn) UI 界面，相對(duì)較輕量，適用于對(duì) UI 有較高訂制需求的開(kāi)發(fā)者。

IMLib 的核心類(lèi)在 Android 平臺(tái)是 RongIMClient，在 iOS 平臺(tái)是 RCIMClient，這兩個(gè)類(lèi)在今后的開(kāi)發(fā)中和 IMLib 代表相同的意義。

融云的集成流程如下圖所示，其中幾個(gè)關(guān)鍵環(huán)節(jié)需要注意：

App 服務(wù)端換取 Token 流程，可以參考 Server 開(kāi)發(fā)文檔 - 獲取 Token 方法

客戶(hù)端集成流程，可以參考 Android 開(kāi)發(fā)指南 或者 iOS 開(kāi)發(fā)指南

UI 界面自定義，可以參考 Android 開(kāi)發(fā)指南 - UI 自定義 或者 iOS 開(kāi)發(fā)指南 - UI 自定義

功能介紹

單聊

指兩個(gè)用戶(hù)一對(duì)一進(jìn)行聊天，會(huì)話(huà)關(guān)系由融云負(fù)責(zé)建立并保持，退出聊天界面或者離線(xiàn)后可以收到推送通知。

討論組

指兩個(gè)以上用戶(hù)一起進(jìn)行聊天，用戶(hù)可以自行添加好友生成一個(gè)討論組聊天，會(huì)話(huà)關(guān)系由融云負(fù)責(zé)建立并保持，退出聊天界面或者離線(xiàn)后可以收到推送通知。

群組聊天

指兩個(gè)以上用戶(hù)一起進(jìn)行聊天，與討論組不同的是，參與群組聊天的群成員 Id 集合由您的 App 提供并維系，融云只負(fù)責(zé)將消息傳達(dá)給群聊中的所有用戶(hù)，退出聊天界面或者離線(xiàn)后可以收到推送通知。支持最大至 3000 人的大型社群需求。

聊天室

不設(shè)用戶(hù)上限的群體聊天行為，用戶(hù)退出聊天界面即視為離開(kāi)聊天室，不再會(huì)接收到任何通知和提醒。會(huì)話(huà)關(guān)系由融云負(fù)責(zé)建立并保持連接，通過(guò) SDK 相關(guān)接口，可以讓用戶(hù)加入或者退出聊天室。

客服消息

用戶(hù)與您的 App 后臺(tái)客服進(jìn)行消息通訊，支持單客服和多客服。

VoIP 音頻通話(huà)

指通過(guò) IP 網(wǎng)絡(luò)，使兩個(gè)用戶(hù)建立一對(duì)一的音頻通話(huà)。

會(huì)話(huà)列表

指各種會(huì)話(huà)依照順序先后排列的界面，其中會(huì)話(huà)列表中的每一個(gè)列表項(xiàng)稱(chēng)之為一條會(huì)話(huà)。排列的先后順序會(huì)依賴(lài)于置頂、最新會(huì)話(huà)、未讀會(huì)話(huà)和時(shí)間等因素

使用指南

要進(jìn)行應(yīng)用開(kāi)發(fā)之前，需要先在融云開(kāi)發(fā)者平臺(tái)創(chuàng)建應(yīng)用。如果您已經(jīng)注冊(cè)了融云開(kāi)發(fā)者帳號(hào)，請(qǐng)前往 融云開(kāi)發(fā)者平臺(tái) 創(chuàng)建應(yīng)用。

您創(chuàng)建完應(yīng)用后，首先需要了解的是 App Key / Secret，它們是融云 SDK 連接服務(wù)器所必須的標(biāo)識(shí)，每一個(gè) App 對(duì)應(yīng)一套 App Key / Secret。針對(duì)開(kāi)發(fā)者的生產(chǎn)環(huán)境和開(kāi)發(fā)環(huán)境，我們提供兩套 App Key / Secret，兩套環(huán)境的功能完全一致。您在應(yīng)用最終上線(xiàn)前，使用開(kāi)發(fā)環(huán)境即可。

image

App Key / Secret 位置

開(kāi)發(fā)環(huán)境 App Key / Secret 是專(zhuān)門(mén)為您提供的僅供開(kāi)發(fā)使用的，開(kāi)發(fā)環(huán)境將和生產(chǎn)環(huán)境的數(shù)據(jù)隔離，避免開(kāi)發(fā)環(huán)境數(shù)據(jù)和線(xiàn)上生產(chǎn)環(huán)境數(shù)據(jù)互相沖突。

生產(chǎn)環(huán)境的 App Key / Secret 默認(rèn)先不提供，等您提交上線(xiàn)后，我們會(huì)提供生產(chǎn)環(huán)境的 App Key / Secret。

4、獲取 Token

Token 稱(chēng)為用戶(hù)令牌，App Key 是您的 App 的唯一標(biāo)識(shí)，Token 則是您 App 上的每一個(gè)用戶(hù)的身份授權(quán)象征。您可以通過(guò)提交 userId 等信息來(lái)獲得一個(gè)該用戶(hù)對(duì)應(yīng)的 Token，并使用這個(gè) Token 作為該用戶(hù)的唯一身份憑證與其他用戶(hù)進(jìn)行通信。

Token 的主要作用是身份授權(quán)和安全，因此不能通過(guò)客戶(hù)端直接訪問(wèn)融云服務(wù)器獲取 Token，您必須通過(guò) Server API 從融云服務(wù)器 獲取 Token 返回給您的 App，并在之后連接時(shí)使用。詳細(xì)描述請(qǐng)參考 Server 開(kāi)發(fā)指南 中的用戶(hù)服務(wù)和獲取 Token 方法小節(jié)。

為了方便您在集成和測(cè)試過(guò)程中使用，我們還提供了 API 調(diào)試工具，在您不能部署服務(wù)器程序時(shí)，可以直接通過(guò)傳入 userId 和 name 來(lái)獲得 Token。請(qǐng)?jiān)L問(wèn) 融云開(kāi)發(fā)者平臺(tái)，打開(kāi)您想測(cè)試的應(yīng)用，在左側(cè)菜單中選擇“API 調(diào)試”即可。

userId : 每一個(gè)用戶(hù)對(duì)應(yīng)一個(gè) userId，這個(gè) userId 是您維護(hù)的，所以您可以直接賦值，兩個(gè)您的的用戶(hù)通信，對(duì)于融云來(lái)說(shuō)就是兩個(gè) userId 間通訊。

name : 用戶(hù)的顯示名稱(chēng)，用來(lái)在 Push 推送時(shí)，或者您沒(méi)有傳入用戶(hù)信息時(shí)，默認(rèn)顯示的用戶(hù)名稱(chēng)。

portraitUri : 用戶(hù)頭像，用來(lái)當(dāng)您沒(méi)有傳入用戶(hù)信息時(shí)作為默認(rèn)頭像，如果圖片不存在，IMKit 會(huì)顯示默認(rèn)頭像。

通過(guò) API 調(diào)試，您可以得到一個(gè) Token 返回值。你就可以直接使用這個(gè) Token 為這位用戶(hù)進(jìn)行發(fā)送和接受消息。