cc.openkit.kitChat.rongcloud.service

类 RongcloudService

java.lang.Object

cc.openkit.kitChat.rongcloud.service.RongcloudService

public class RongcloudService
extends java.lang.Object

构造器概要

构造器

构造器和说明
RongcloudService()

方法概要

限定符和类型	方法和说明
static CodeSuccessResult	create(RongcoludModel rongcoludModel, java.lang.String id, java.lang.String name) 创建聊天室
static CodeSuccessResult	destroy(RongcoludModel rongcoludModel, java.lang.String id) 销毁聊天室方法
static TokenResult	getToken(RongcoludModel rongcoludModel, java.lang.String userId, java.lang.String name, java.lang.String portraitUri) 获取 Token 方法
static CodeSuccessResult	groupCreate(RongcoludModel rongcoludModel, java.lang.String[] userId, java.lang.String groupId, java.lang.String groupName) 创建群组方法（创建群组，并将用户加入该群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人，App 内的群组数量没有限制.注：其实本方法是加入群组方法 /group/join 的别名。）
static CodeSuccessResult	groupDismiss(RongcoludModel rongcoludModel, java.lang.String userId, java.lang.String groupId) 解散群组方法。
static CodeSuccessResult	groupJoin(RongcoludModel rongcoludModel, java.lang.String[] userId, java.lang.String groupId, java.lang.String groupName) 将用户加入指定群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人。
static GroupUserQueryResult	groupQueryUser(RongcoludModel rongcoludModel, java.lang.String groupId) 查询群成员方法
static CodeSuccessResult	groupQuit(RongcoludModel rongcoludModel, java.lang.String[] userId, java.lang.String groupId) 退出群组方法（将用户从群中移除，不再接收该群组的消息.）
static CodeSuccessResult	groupRefresh(RongcoludModel rongcoludModel, java.lang.String groupId, java.lang.String groupName) 刷新群组信息方法
static CodeSuccessResult	groupSync(RongcoludModel rongcoludModel, java.lang.String userId, GroupInfo[] groupInfo) 同步用户所属群组方法（当第一次连接融云服务器时，需要向融云服务器提交 userId 对应的用户当前所加入的所有群组，此接口主要为防止应用中用户群信息同融云已知的用户所属群信息不同步。）
static CodeSuccessResult	join(RongcoludModel rongcoludModel, java.lang.String[] userId, java.lang.String chatroomId) 加入聊天室方法
static void	main(java.lang.String[] args)
static ChatroomQueryResult	query(RongcoludModel rongcoludModel, java.lang.String id) 查询聊天室详细信息方法
static ChatroomUserQueryResult	queryUser(RongcoludModel rongcoludModel, java.lang.String chatroomId, java.lang.String count, java.lang.String order) 查询聊天室内用户方法
static CheckOnlineResult	userCheckOnline(RongcoludModel rongcoludModel, java.lang.String userId) 检查用户在线状态 方法
static CodeSuccessResult	userRefresh(RongcoludModel rongcoludModel, java.lang.String userId, java.lang.String name, java.lang.String portraitUri) 刷新用户信息方法

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RongcloudService

public RongcloudService()

方法详细资料

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

抛出:

java.lang.Exception

getToken

public static TokenResult getToken(RongcoludModel rongcoludModel,
                                   java.lang.String userId,
                                   java.lang.String name,
                                   java.lang.String portraitUri)
                            throws java.lang.Exception

获取 Token 方法

参数:

rongcoludModel:融云的对象。（必传） -

userId:用户 - Id，最大长度 64 字节.是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）

name:用户名称，最大长度 - 128 字节.用来在 Push 推送时显示用户的名称.用户名称，最大长度 128 字节.用来在 Push 推送时显示用户的名称。（必传）

portraitUri:用户头像 - URI，最大长度 1024 字节.用来在 Push 推送时显示用户的头像。（必传）

返回:

TokenResult

抛出:

java.lang.Exception

userRefresh

public static CodeSuccessResult userRefresh(RongcoludModel rongcoludModel,
                                            java.lang.String userId,
                                            java.lang.String name,
                                            java.lang.String portraitUri)
                                     throws java.lang.Exception

刷新用户信息方法

参数:

rongcoludModel:融云的对象。（必传） -

userId:用户 - Id，最大长度 64 字节.是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）

name:用户名称，最大长度 - 128 字节。用来在 Push 推送时，显示用户的名称，刷新用户名称后 5 分钟内生效。（可选，提供即刷新，不提供忽略）

portraitUri:用户头像 - URI，最大长度 1024 字节。用来在 Push 推送时显示。（可选，提供即刷新，不提供忽略）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

userCheckOnline

public static CheckOnlineResult userCheckOnline(RongcoludModel rongcoludModel,
                                                java.lang.String userId)
                                         throws java.lang.Exception

检查用户在线状态 方法

参数:

rongcoludModel:融云的对象。（必传） -

userId:用户 - Id，最大长度 64 字节。是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）

返回:

CheckOnlineResult

抛出:

java.lang.Exception

create

public static CodeSuccessResult create(RongcoludModel rongcoludModel,
                                       java.lang.String id,
                                       java.lang.String name)
                                throws java.lang.Exception

创建聊天室

参数:

rongcoludModel:融云的对象。（必传） -

id:要创建的聊天室的id。（必传） -

name:要创建的聊天室的name。（必传） -

返回:

codeSuccessResult

抛出:

java.lang.Exception

join

public static CodeSuccessResult join(RongcoludModel rongcoludModel,
                                     java.lang.String[] userId,
                                     java.lang.String chatroomId)
                              throws java.lang.Exception

加入聊天室方法

参数:

rongcoludModel:融云的对象。（必传） -

userId:要加入聊天室的用户 - Id，可提交多个，最多不超过 50 个。（必传）

chatroomId:要加入的聊天室 - Id。（必传）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

query

public static ChatroomQueryResult query(RongcoludModel rongcoludModel,
                                        java.lang.String id)
                                 throws java.lang.Exception

查询聊天室详细信息方法

参数:

rongcoludModel:融云的对象。（必传） -

id:要查询的聊天室id（必传） -

返回:

ChatroomQueryResult

抛出:

java.lang.Exception

queryUser

public static ChatroomUserQueryResult queryUser(RongcoludModel rongcoludModel,
                                                java.lang.String chatroomId,
                                                java.lang.String count,
                                                java.lang.String order)
                                         throws java.lang.Exception

查询聊天室内用户方法

参数:

rongcoludModel:融云的对象。（必传） -

chatroomId:要查询的聊天室 - ID。（必传）

count:要获取的聊天室成员数，上限为 - 500 ，超过 500 时最多返回 500 个成员。（必传）

order:加入聊天室的先后顺序， - 1 为加入时间正序， 2 为加入时间倒序。（必传）

返回:

ChatroomUserQueryResult

抛出:

java.lang.Exception

destroy

public static CodeSuccessResult destroy(RongcoludModel rongcoludModel,
                                        java.lang.String id)
                                 throws java.lang.Exception

销毁聊天室方法

参数:

rongcoludModel:融云的对象。（必传） -

id:要销毁的聊天室 - Id。（必传）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

groupCreate

public static CodeSuccessResult groupCreate(RongcoludModel rongcoludModel,
                                            java.lang.String[] userId,
                                            java.lang.String groupId,
                                            java.lang.String groupName)
                                     throws java.lang.Exception

创建群组方法（创建群组，并将用户加入该群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人，App 内的群组数量没有限制.注：其实本方法是加入群组方法 /group/join 的别名。）

参数:

rongcoludModel:融云的对象。（必传） -

userId:要加入群的用户 - Id。（必传）

groupId:创建群组 - Id。（必传）

groupName:群组 - Id 对应的名称。（必传）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

groupSync

public static CodeSuccessResult groupSync(RongcoludModel rongcoludModel,
                                          java.lang.String userId,
                                          GroupInfo[] groupInfo)
                                   throws java.lang.Exception

同步用户所属群组方法（当第一次连接融云服务器时，需要向融云服务器提交 userId 对应的用户当前所加入的所有群组，此接口主要为防止应用中用户群信息同融云已知的用户所属群信息不同步。）

参数:

rongcoludModel:融云的对象。（必传） -

userId:被同步群信息的用户 - Id。（必传）

groupInfo:该用户的群信息，如群 - Id 已经存在，则不会刷新对应群组名称，如果想刷新群组名称请调用刷新群组信息方法。

返回:

CodeSuccessResult

抛出:

java.lang.Exception

groupRefresh

public static CodeSuccessResult groupRefresh(RongcoludModel rongcoludModel,
                                             java.lang.String groupId,
                                             java.lang.String groupName)
                                      throws java.lang.Exception

刷新群组信息方法

参数:

rongcoludModel:融云的对象。（必传） -

groupId:群组 - Id。（必传）

groupName:群名称。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

groupJoin

public static CodeSuccessResult groupJoin(RongcoludModel rongcoludModel,
                                          java.lang.String[] userId,
                                          java.lang.String groupId,
                                          java.lang.String groupName)
                                   throws java.lang.Exception

将用户加入指定群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人。

参数:

rongcoludModel:融云的对象。（必传） -

userId:要加入群的用户 - Id，可提交多个，最多不超过 1000 个。（必传）

groupId:要加入的群 - Id。（必传）

groupName:要加入的群 - Id 对应的名称。（必传）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

groupQueryUser

public static GroupUserQueryResult groupQueryUser(RongcoludModel rongcoludModel,
                                                  java.lang.String groupId)
                                           throws java.lang.Exception

查询群成员方法

参数:

rongcoludModel:融云的对象。（必传） -

groupId:群组Id。（必传） -

返回:

GroupUserQueryResult

抛出:

java.lang.Exception

groupQuit

public static CodeSuccessResult groupQuit(RongcoludModel rongcoludModel,
                                          java.lang.String[] userId,
                                          java.lang.String groupId)
                                   throws java.lang.Exception

退出群组方法（将用户从群中移除，不再接收该群组的消息.）

参数:

rongcoludModel:融云的对象。（必传） -

userId:要退出群的用户 - Id.（必传）

groupId:要退出的群 - Id.（必传）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

groupDismiss

public static CodeSuccessResult groupDismiss(RongcoludModel rongcoludModel,
                                             java.lang.String userId,
                                             java.lang.String groupId)
                                      throws java.lang.Exception

解散群组方法。（将该群解散，所有用户都无法再接收该群的消息。）

参数:

rongcoludModel:融云的对象。（必传） -

userId:操作解散群的用户 - Id。（必传）

groupId:要解散的群 - Id。（必传）

返回:

CodeSuccessResult

抛出:

java.lang.Exception