cc.openkit.kitChat.rongcloud.rong.methods

类 Group

java.lang.Object

cc.openkit.kitChat.rongcloud.rong.methods.Group

public class Group
extends java.lang.Object

构造器概要

构造器

构造器和说明
Group(java.lang.String appKey, java.lang.String appSecret)

方法概要

限定符和类型	方法和说明
CodeSuccessResult	addGagUser(java.lang.String userId, java.lang.String groupId, java.lang.String minute) 添加禁言群成员方法（在 App 中如果不想让某一用户在群中发言时，可将此用户在群组中禁言，被禁言用户可以接收查看群组中用户聊天信息，但不能发送消息。）
CodeSuccessResult	create(java.lang.String[] userId, java.lang.String groupId, java.lang.String groupName) 创建群组方法（创建群组，并将用户加入该群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人，App 内的群组数量没有限制.注：其实本方法是加入群组方法 /group/join 的别名。）
CodeSuccessResult	dismiss(java.lang.String userId, java.lang.String groupId) 解散群组方法。
CodeSuccessResult	join(java.lang.String[] userId, java.lang.String groupId, java.lang.String groupName) 将用户加入指定群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人。
ListGagGroupUserResult	lisGagUser(java.lang.String groupId) 查询被禁言群成员方法
GroupUserQueryResult	queryUser(java.lang.String groupId) 查询群成员方法
CodeSuccessResult	quit(java.lang.String[] userId, java.lang.String groupId) 退出群组方法（将用户从群中移除，不再接收该群组的消息.）
CodeSuccessResult	refresh(java.lang.String groupId, java.lang.String groupName) 刷新群组信息方法
CodeSuccessResult	rollBackGagUser(java.lang.String[] userId, java.lang.String groupId) 移除禁言群成员方法
CodeSuccessResult	sync(java.lang.String userId, GroupInfo[] groupInfo) 同步用户所属群组方法（当第一次连接融云服务器时，需要向融云服务器提交 userId 对应的用户当前所加入的所有群组，此接口主要为防止应用中用户群信息同融云已知的用户所属群信息不同步。）

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

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

构造器详细资料

Group

public Group(java.lang.String appKey,
             java.lang.String appSecret)

方法详细资料

create

public CodeSuccessResult create(java.lang.String[] userId,
                                java.lang.String groupId,
                                java.lang.String groupName)
                         throws java.lang.Exception

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

参数:

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

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

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

返回:

CodeSuccessResult

抛出:

java.lang.Exception

sync

public CodeSuccessResult sync(java.lang.String userId,
                              GroupInfo[] groupInfo)
                       throws java.lang.Exception

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

参数:

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

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

返回:

CodeSuccessResult

抛出:

java.lang.Exception

refresh

public CodeSuccessResult refresh(java.lang.String groupId,
                                 java.lang.String groupName)
                          throws java.lang.Exception

刷新群组信息方法

参数:

groupId:群组 - Id。（必传）

groupName:群名称。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

join

public CodeSuccessResult join(java.lang.String[] userId,
                              java.lang.String groupId,
                              java.lang.String groupName)
                       throws java.lang.Exception

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

参数:

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

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

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

返回:

CodeSuccessResult

抛出:

java.lang.Exception

queryUser

public GroupUserQueryResult queryUser(java.lang.String groupId)
                               throws java.lang.Exception

查询群成员方法

参数:

groupId:群组Id。（必传） -

返回:

GroupUserQueryResult

抛出:

java.lang.Exception

quit

public CodeSuccessResult quit(java.lang.String[] userId,
                              java.lang.String groupId)
                       throws java.lang.Exception

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

参数:

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

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

返回:

CodeSuccessResult

抛出:

java.lang.Exception

addGagUser

public CodeSuccessResult addGagUser(java.lang.String userId,
                                    java.lang.String groupId,
                                    java.lang.String minute)
                             throws java.lang.Exception

添加禁言群成员方法（在 App 中如果不想让某一用户在群中发言时，可将此用户在群组中禁言，被禁言用户可以接收查看群组中用户聊天信息，但不能发送消息。）

参数:

userId:用户 - Id。（必传）

groupId:群组 - Id。（必传）

minute:禁言时长，以分钟为单位，最大值为43200分钟。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

lisGagUser

public ListGagGroupUserResult lisGagUser(java.lang.String groupId)
                                  throws java.lang.Exception

查询被禁言群成员方法

参数:

groupId:群组Id。（必传） -

返回:

ListGagGroupUserResult

抛出:

java.lang.Exception

rollBackGagUser

public CodeSuccessResult rollBackGagUser(java.lang.String[] userId,
                                         java.lang.String groupId)
                                  throws java.lang.Exception

移除禁言群成员方法

参数:

userId:用户Id。支持同时移除多个群成员（必传） -

groupId:群组Id。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

dismiss

public CodeSuccessResult dismiss(java.lang.String userId,
                                 java.lang.String groupId)
                          throws java.lang.Exception

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

参数:

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

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

返回:

CodeSuccessResult

抛出:

java.lang.Exception