Chatroom (open_kit Maven Webapp 1.1.12 API)

java.lang.Object
- cc.openkit.kitChat.rongcloud.rong.methods.Chatroom

public class Chatroom
extends java.lang.Object

构造器概要

构造器
构造器和说明

Chatroom(java.lang.String appKey, java.lang.String appSecret)

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CodeSuccessResult`	`addBlockUser(java.lang.String userId, java.lang.String chatroomId, java.lang.String minute)` 添加封禁聊天室成员方法
`CodeSuccessResult`	`addGagUser(java.lang.String userId, java.lang.String chatroomId, java.lang.String minute)` 添加禁言聊天室成员方法（在 App 中如果不想让某一用户在聊天室中发言时，可将此用户在聊天室中禁言，被禁言用户可以接收查看聊天室中用户聊天信息，但不能发送消息.）
`CodeSuccessResult`	`addPriority(java.lang.String[] objectName)` 添加聊天室消息优先级方法
`CodeSuccessResult`	`addWhiteListUser(java.lang.String chatroomId, java.lang.String[] userId)` 添加聊天室白名单成员方法
`CodeSuccessResult`	`create(ChatRoomInfo[] chatRoomInfo)` 创建聊天室方法
`CodeSuccessResult`	`destroy(java.lang.String[] chatroomId)` 销毁聊天室方法
`ListBlockChatroomUserResult`	`getListBlockUser(java.lang.String chatroomId)` 查询被封禁聊天室成员方法
`CodeSuccessResult`	`join(java.lang.String[] userId, java.lang.String chatroomId)` 加入聊天室方法
`ListGagChatroomUserResult`	`ListGagUser(java.lang.String chatroomId)` 查询被禁言聊天室成员方法
`ChatroomQueryResult`	`query(java.lang.String[] chatroomId)` 查询聊天室信息方法
`ChatroomUserQueryResult`	`queryUser(java.lang.String chatroomId, java.lang.String count, java.lang.String order)` 查询聊天室内用户方法
`CodeSuccessResult`	`resumeDistributionMessage(java.lang.String chatroomId)` 聊天室消息恢复分发方法
`CodeSuccessResult`	`rollbackBlockUser(java.lang.String userId, java.lang.String chatroomId)` 移除封禁聊天室成员方法
`CodeSuccessResult`	`rollbackGagUser(java.lang.String userId, java.lang.String chatroomId)` 移除禁言聊天室成员方法
`CodeSuccessResult`	`stopDistributionMessage(java.lang.String chatroomId)` 聊天室消息停止分发方法（可实现控制对聊天室中消息是否进行分发，停止分发后聊天室中用户发送的消息，融云服务端不会再将消息发送给聊天室中其他用户。）

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Chatroom
```
public Chatroom(java.lang.String appKey,
                java.lang.String appSecret)
```
- 方法详细资料
  - create
```
public CodeSuccessResult create(ChatRoomInfo[] chatRoomInfo)
                         throws java.lang.Exception
```
    创建聊天室方法
    
    参数:
    
    chatRoomInfo:id:要创建的聊天室的id；name:要创建的聊天室的name。（必传） -
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - join
```
public CodeSuccessResult join(java.lang.String[] userId,
                              java.lang.String chatroomId)
                       throws java.lang.Exception
```
    加入聊天室方法
    
    参数:
    
    userId:要加入聊天室的用户 - Id，可提交多个，最多不超过 50 个。（必传）
    
    chatroomId:要加入的聊天室 - Id。（必传）
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - query
```
public ChatroomQueryResult query(java.lang.String[] chatroomId)
                          throws java.lang.Exception
```
    查询聊天室信息方法
    
    参数:
    
    chatroomId:要查询的聊天室id（必传） -
    
    返回:
    
    ChatroomQueryResult
    
    抛出:
    
    java.lang.Exception
  - queryUser
```
public ChatroomUserQueryResult queryUser(java.lang.String chatroomId,
                                         java.lang.String count,
                                         java.lang.String order)
                                  throws java.lang.Exception
```
    查询聊天室内用户方法
    
    参数:
    
    chatroomId:要查询的聊天室 - ID。（必传）
    
    count:要获取的聊天室成员数，上限为 - 500 ，超过 500 时最多返回 500 个成员。（必传）
    
    order:加入聊天室的先后顺序， - 1 为加入时间正序， 2 为加入时间倒序。（必传）
    
    返回:
    
    ChatroomUserQueryResult
    
    抛出:
    
    java.lang.Exception
  - stopDistributionMessage
```
public CodeSuccessResult stopDistributionMessage(java.lang.String chatroomId)
                                          throws java.lang.Exception
```
    聊天室消息停止分发方法（可实现控制对聊天室中消息是否进行分发，停止分发后聊天室中用户发送的消息，融云服务端不会再将消息发送给聊天室中其他用户。）
    
    参数:
    
    chatroomId:聊天室 - Id。（必传）
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - resumeDistributionMessage
```
public CodeSuccessResult resumeDistributionMessage(java.lang.String chatroomId)
                                            throws java.lang.Exception
```
    聊天室消息恢复分发方法
    
    参数:
    
    chatroomId:聊天室 - Id。（必传）
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - addGagUser
```
public CodeSuccessResult addGagUser(java.lang.String userId,
                                    java.lang.String chatroomId,
                                    java.lang.String minute)
                             throws java.lang.Exception
```
    添加禁言聊天室成员方法（在 App 中如果不想让某一用户在聊天室中发言时，可将此用户在聊天室中禁言，被禁言用户可以接收查看聊天室中用户聊天信息，但不能发送消息.）
    
    参数:
    
    userId:用户 - Id。（必传）
    
    chatroomId:聊天室 - Id。（必传）
    
    minute:禁言时长，以分钟为单位，最大值为43200分钟。（必传） -
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - ListGagUser
```
public ListGagChatroomUserResult ListGagUser(java.lang.String chatroomId)
                                      throws java.lang.Exception
```
    查询被禁言聊天室成员方法
    
    参数:
    
    chatroomId:聊天室 - Id。（必传）
    
    返回:
    
    ListGagChatroomUserResult
    
    抛出:
    
    java.lang.Exception
  - rollbackGagUser
```
public CodeSuccessResult rollbackGagUser(java.lang.String userId,
                                         java.lang.String chatroomId)
                                  throws java.lang.Exception
```
    移除禁言聊天室成员方法
    
    参数:
    
    userId:用户 - Id。（必传）
    
    chatroomId:聊天室Id。（必传） -
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - addBlockUser
```
public CodeSuccessResult addBlockUser(java.lang.String userId,
                                      java.lang.String chatroomId,
                                      java.lang.String minute)
                               throws java.lang.Exception
```
    添加封禁聊天室成员方法
    
    参数:
    
    userId:用户 - Id。（必传）
    
    chatroomId:聊天室 - Id。（必传）
    
    minute:封禁时长，以分钟为单位，最大值为43200分钟。（必传） -
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - getListBlockUser
```
public ListBlockChatroomUserResult getListBlockUser(java.lang.String chatroomId)
                                             throws java.lang.Exception
```
    查询被封禁聊天室成员方法
    
    参数:
    
    chatroomId:聊天室 - Id。（必传）
    
    返回:
    
    ListBlockChatroomUserResult
    
    抛出:
    
    java.lang.Exception
  - rollbackBlockUser
```
public CodeSuccessResult rollbackBlockUser(java.lang.String userId,
                                           java.lang.String chatroomId)
                                    throws java.lang.Exception
```
    移除封禁聊天室成员方法
    
    参数:
    
    userId:用户 - Id。（必传）
    
    chatroomId:聊天室 - Id。（必传）
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - addPriority
```
public CodeSuccessResult addPriority(java.lang.String[] objectName)
                              throws java.lang.Exception
```
    添加聊天室消息优先级方法
    
    参数:
    
    objectName:低优先级的消息类型，每次最多提交 - 5 个，设置的消息类型最多不超过 20 个。（必传）
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - destroy
```
public CodeSuccessResult destroy(java.lang.String[] chatroomId)
                          throws java.lang.Exception
```
    销毁聊天室方法
    
    参数:
    
    chatroomId:要销毁的聊天室 - Id。（必传）
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception
  - addWhiteListUser
```
public CodeSuccessResult addWhiteListUser(java.lang.String chatroomId,
                                          java.lang.String[] userId)
                                   throws java.lang.Exception
```
    添加聊天室白名单成员方法
    
    参数:
    
    chatroomId:聊天室中用户 - Id，可提交多个，聊天室中白名单用户最多不超过 5 个。（必传）
    
    userId:聊天室 - Id。（必传）
    
    返回:
    
    CodeSuccessResult
    
    抛出:
    
    java.lang.Exception

类 Chatroom

构造器概要

方法概要

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

构造器详细资料

Chatroom

方法详细资料

create

join

query

queryUser

stopDistributionMessage

resumeDistributionMessage

addGagUser

ListGagUser

rollbackGagUser

addBlockUser

getListBlockUser

rollbackBlockUser

addPriority

destroy

addWhiteListUser