# 注意：本文檔后期不在跟新，新文檔遷移到：[http://www.openkit.cc/docs/openkit/#/](http://www.openkit.cc/docs/openkit/#/) # 首先感謝使用OpenKit工具包 ## 反饋交流QQ群：696279396 ## 下面我們開始來使用OpenKit中的 融云 模塊 - 首先我們需要 new 一個 RongcoludModel 對象 ```java // 不傳參數，后期用set傳參 RongcoludModel j = new RongcoludModel() /** * 推送給某所有用戶，你可以這樣傳參 * appkey： 融云的 appkey * appservice：融云的 mastersecret */ RongcoludModel r = new RongcoludModel(String appkey,String appservice) ``` - 接下來你就可以直接調用啦，我們的方法同樣是靜態方法 ```java RongcloudService.xxx(參數); ``` # 獲取融云 Token > 前端調用融云聊天的時候，是需要通過融云的 Token 進行關聯的，所以，我們需要把我們的用戶的UUID綁定到融云的Token 調用：RongcloudService.getToken(RongcoludModel rongcoludModel,String userId, String name, String portraitUri); 備注： ```java /** * 獲取 Token 方法 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:用戶 Id，最大長度 64 字節.是用戶在 App 中的唯一標識碼，必須保證在同一個 * App 內不重復，重復的用戶 Id 將被當作是同一用戶。（必傳） * @param name:用戶名稱，最大長度 128 字節.用來在 Push 推送時顯示用戶的名稱.用戶名稱， * 最大長度 128 字節.用來在 Push 推送時顯示用戶的名稱。（必傳） * @param portraitUri:用戶頭像 URI，最大長度 1024 字節.用來在 Push 推送時顯示用戶的頭像。（必傳） * * @return TokenResult **/ ``` # 刷新用戶信息方法 調用：RongcloudService.userRefresh(RongcoludModel rongcoludModel,String userId, String name, String portraitUri); 備注： ```java /** * 刷新用戶信息方法 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:用戶 Id，最大長度 64 字節.是用戶在 App 中的唯一標識碼，必須保證在同一個 * App 內不重復，重復的用戶 Id 將被當作是同一用戶。（必傳） * @param name:用戶名稱，最大長度 128 字節。用來在 Push 推送時，顯示用戶的名稱，刷新用 * 戶名稱后 5 分鐘內生效。（可選，提供即刷新，不提供忽略） * @param portraitUri:用戶頭像 URI，最大長度 1024 字節。用來在 Push 推送時顯示。（可選，提供即刷新，不提供忽略） * * @return CodeSuccessResult **/ ``` # 檢查用戶在線狀態 方法 調用：RongcloudService.userCheckOnline(RongcoludModel rongcoludModel,String userId) ; 備注： ```java /** * 檢查用戶在線狀態 方法 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:用戶 Id，最大長度 64 字節。是用戶在 App 中的唯一標識碼，必須保證在同一個 * App 內不重復，重復的用戶 Id 將被當作是同一用戶。（必傳） * * @return CheckOnlineResult **/ ``` # 創建聊天室 調用：RongcloudService.create(RongcoludModel rongcoludModel,String id,String name) ; 備注： ```java /** * 創建聊天室 * * @param rongcoludModel:融云的對象。（必傳） * @param id:要創建的聊天室的id。（必傳） * @param name:要創建的聊天室的name。（必傳） * * @return codeSuccessResult */ ``` # 加入聊天室方法 調用：RongcloudService.join(RongcoludModel rongcoludModel,String[] userId, String chatroomId) ; 備注： ```java /** * 加入聊天室方法 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:要加入聊天室的用戶 Id，可提交多個，最多不超過 50 個。（必傳） * @param chatroomId:要加入的聊天室 Id。（必傳） * * @return CodeSuccessResult **/ ``` # 查詢聊天室詳細信息方法 調用：RongcloudService.query(RongcoludModel rongcoludModel, String id) ; 備注： ```java /** * 查詢聊天室詳細信息方法 * * @param rongcoludModel:融云的對象。（必傳） * @param id:要查詢的聊天室id（必傳） * * @return ChatroomQueryResult **/ ``` # 查詢聊天室內用戶方法 調用：RongcloudService.queryUser(RongcoludModel rongcoludModel,String chatroomId, String count, String order) ; 備注： ```java /** * 查詢聊天室內用戶方法 * * @param rongcoludModel:融云的對象。（必傳） * @param chatroomId:要查詢的聊天室 ID。（必傳） * @param count:要獲取的聊天室成員數，上限為 500 ，超過 500 時最多返回 500 個成員。（必傳） * @param order:加入聊天室的先后順序， 1 為加入時間正序， 2 為加入時間倒序。（必傳） * * @return ChatroomUserQueryResult **/ ``` # 銷毀聊天室方法 調用：RongcloudService.destroy(RongcoludModel rongcoludModel,String id); 備注： ```java /** * 銷毀聊天室方法 * * @param rongcoludModel:融云的對象。（必傳） * @param id:要銷毀的聊天室 Id。（必傳） * * @return CodeSuccessResult **/ ``` # 創建群組方法 > 創建群組，并將用戶加入該群組，用戶將可以收到該群的消息，同一用戶最多可加入 500 個群，每個群最大至 3000 人，App 內的群組數量沒有限制.注：其實本方法是加入群組方法 /group/join 的別名。 調用：RongcloudService.groupCreate(RongcoludModel rongcoludModel,String[] userId, String groupId, String groupName) ; 備注： ```java /** * 創建群組方法 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:要加入群的用戶 Id。（必傳） * @param groupId:創建群組 Id。（必傳） * @param groupName:群組 Id 對應的名稱。（必傳） * * @return CodeSuccessResult **/ ``` # 同步用戶所屬群組方法 > 當第一次連接融云服務器時，需要向融云服務器提交 userId 對應的用戶當前所加入的所有群組，此接口主要為防止應用中用戶群信息同融云已知的用戶所屬群信息不同步。 調用：RongcloudService.groupSync(RongcoludModel rongcoludModel,String userId, GroupInfo[] groupInfo) ; 備注： ```java /** * 同步用戶所屬群組方法 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:被同步群信息的用戶 Id。（必傳） * @param groupInfo:該用戶的群信息，如群 Id 已經存在，則不會刷新對應群組名稱，如果想刷新 * 群組名稱請調用刷新群組信息方法。 * * @return CodeSuccessResult **/ ``` # 刷新群組信息方法 調用：RongcloudService.groupRefresh(RongcoludModel rongcoludModel,String groupId, String groupName); 備注： ```java /** * 刷新群組信息方法 * * @param rongcoludModel:融云的對象。（必傳） * @param groupId:群組 Id。（必傳） * @param groupName:群名稱。（必傳） * * @return CodeSuccessResult **/ ``` # 將用戶加入指定群組 > 將用戶加入指定群組，用戶將可以收到該群的消息，同一用戶最多可加入 500 個群，每個群最大至 3000 人。 調用：RongcloudService.groupJoin(RongcoludModel rongcoludModel,String[] userId, String groupId, String groupName) ; 備注： ```java /** * 將用戶加入指定群組，用戶將可以收到該群的消息，同一用戶最多可加入 500 個群， * 每個群最大至 3000 人。 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:要加入群的用戶 Id，可提交多個，最多不超過 1000 個。（必傳） * @param groupId:要加入的群 Id。（必傳） * @param groupName:要加入的群 Id 對應的名稱。（必傳） * * @return CodeSuccessResult **/ ``` # 查詢群成員方法 調用：RongcloudService.groupQueryUser(RongcoludModel rongcoludModel,String groupId) ; 備注： ```java /** * 查詢群成員方法 * * @param rongcoludModel:融云的對象。（必傳） * @param groupId:群組Id。（必傳） * * @return GroupUserQueryResult **/ ``` # 退出群組方法 > 將用戶從群中移除，不再接收該群組的消息. 調用：RongcloudService.groupQuit(RongcoludModel rongcoludModel,String[] userId, String groupId) ; 備注： ```java /** * 退出群組方法（將用戶從群中移除，不再接收該群組的消息.） * * @param rongcoludModel:融云的對象。（必傳） * @param userId:要退出群的用戶 Id.（必傳） * @param groupId:要退出的群 Id.（必傳） * * @return CodeSuccessResult **/ ``` # 解散群組方法 > 將該群解散，所有用戶都無法再接收該群的消息。 調用：RongcloudService.groupDismiss(RongcoludModel rongcoludModel,String userId, String groupId) ; 備注： ```java /** * 同步用戶所屬群組方法 * * @param rongcoludModel:融云的對象。（必傳） * @param userId:被同步群信息的用戶 Id。（必傳） * @param groupInfo:該用戶的群信息，如群 Id 已經存在，則不會刷新對應群組名稱，如果想刷新 * 群組名稱請調用刷新群組信息方法。 * * @return CodeSuccessResult **/ ``` ## 反饋交流QQ群：696279396 ## 贊助