# 注意：本文档后期不在跟新，新文档迁移到：[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
## 赞助
