ChatRoomManager (android API)

java.lang.Object
- cn.jpush.im.android.api.ChatRoomManager

public final class ChatRoomManager
extends java.lang.Object

聊天室管理相关接口类

构造器概要

构造器
构造器和说明

ChatRoomManager()

构造器
构造器和说明
`ChatRoomManager()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`addChatRoomAdmin(long roomId, java.util.List<UserInfo> userInfos, BasicCallback callback)` 将指定用户设置为聊天室的房管,只有房主有此权限，房管可设置聊天室的黑名单
`static void`	`addChatRoomBlacklist(long roomId, java.util.List<UserInfo> userInfos, BasicCallback callback)` 将用户添加至聊天室黑名单，只有聊天室的房主和房管有此权限, 被设置黑名单用户会被立即踢出聊天室。
`static void`	`addChatRoomSilence(long roomId, java.util.Collection<UserInfo> userInfos, long times, BasicCallback callback)` 将指定用户添加进聊天室的禁言列表(批量设置一次最多500个)，禁言时间下限5分钟，上限1年聊天室owner或者管理员可以禁言聊天室成员，管理员或owner不能被禁言, 重复调用此接口将根据当前时间重新计算结束时间。
`static void`	`delChatRoomAdmin(long roomId, java.util.List<UserInfo> userInfos, BasicCallback callback)` 取消指定用户的聊天室房管身份，只有房主有此权限
`static void`	`delChatRoomBlacklist(long roomId, java.util.List<UserInfo> userInfos, BasicCallback callback)` 将用户从聊天室黑名单中移除，只有聊天室的房主和房管有此权限
`static void`	`delChatRoomSilence(long roomId, java.util.Collection<UserInfo> userInfos, BasicCallback callback)` 将指定用户从聊天室禁言列表中移除(批量设置一次最多500个) 只有房主和管理员可设置,取消成功聊天室成员会收到`ChatRoomNotificationEvent`
`static void`	`enterChatRoom(long roomId, RequestCallback<Conversation> callback)` 进入聊天室.
`static void`	`getChatRoomAdminList(long roomId, RequestCallback<java.util.List<UserInfo>> callback)` 获取聊天室的房管用户列表
`static void`	`getChatRoomBlacklist(long roomId, RequestCallback<java.util.List<UserInfo>> callback)` 获取聊天室的黑名单用户列表,按照被拉黑时间倒序排列
`static void`	`getChatRoomInfos(java.util.Set<java.lang.Long> roomIds, RequestCallback<java.util.List<ChatRoomInfo>> callback)` 查询指定roomID的聊天室信息。
`static void`	`getChatRoomListByApp(int start, int count, RequestCallback<java.util.List<ChatRoomInfo>> callback)` 获取当前应用appkey所属下聊天室信息。
`static void`	`getChatRoomListByUser(RequestCallback<java.util.List<ChatRoomInfo>> callback)` 获取当前用户所加入的所有聊天室的信息。
`static void`	`getChatRoomMemberSilence(long roomId, java.lang.String username, java.lang.String appkey, RequestCallback<SilenceInfo> callback)` 获取用户在聊天室的禁言状态，如果用户未处于禁言状态，回调中SilenceInfo为null
`static void`	`getChatRoomSilencesFromNewest(long roomId, int start, int count, GetChatRoomSilencesCallback callback)` 获取聊天室禁言列表以添加入禁言的先后的时间倒序排序（后加入的在前），从start位置开始获取count个禁言信息。
`static void`	`leaveChatRoom(long roomId, BasicCallback callback)` 离开聊天室.

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

- 构造器详细资料
  - ChatRoomManager
```
public ChatRoomManager()
```
- 方法详细资料
  - getChatRoomListByApp
```
public static void getChatRoomListByApp(int start,
                                        int count,
                                        RequestCallback<java.util.List<ChatRoomInfo>> callback)
```
    获取当前应用appkey所属下聊天室信息。
    
    参数:
    
    start - 起始位置
    
    count - 获取个数
    
    callback - 接口回调
    
    从以下版本开始:
    
    2.4.0
  - getChatRoomListByUser
```
public static void getChatRoomListByUser(RequestCallback<java.util.List<ChatRoomInfo>> callback)
```
    获取当前用户所加入的所有聊天室的信息。
    
    参数:
    
    callback - 接口回调
    
    从以下版本开始:
    
    2.4.0
  - getChatRoomInfos
```
public static void getChatRoomInfos(java.util.Set<java.lang.Long> roomIds,
                                    RequestCallback<java.util.List<ChatRoomInfo>> callback)
```
    查询指定roomID的聊天室信息。
    
    参数:
    
    roomIds - 待查询的roomID集合
    
    callback - 接口回调
    
    从以下版本开始:
    
    2.4.0
  - enterChatRoom
```
public static void enterChatRoom(long roomId,
                                 RequestCallback<Conversation> callback)
```
    进入聊天室. 用户只有成功调用此接口之后，才能收到聊天室消息，以及在此聊天室中发言。成功进入聊天室之后，会将聊天室中最近若干条聊天记录同步到本地并以ChatRoomMessageEvent事件的形式通知到上层。
    
    参数:
    
    roomId - 聊天室的roomId
    
    callback - 接口回调
    
    从以下版本开始:
    
    2.4.0
  - leaveChatRoom
```
public static void leaveChatRoom(long roomId,
                                 BasicCallback callback)
```
    离开聊天室. 成功调用此接口之后，用户将能不在此聊天室收发消息。
    
    参数:
    
    roomId - 聊天室的roomId
    
    callback - 接口回调
    
    从以下版本开始:
    
    2.4.0
  - addChatRoomAdmin
```
public static void addChatRoomAdmin(long roomId,
                                    java.util.List<UserInfo> userInfos,
                                    BasicCallback callback)
```
    将指定用户设置为聊天室的房管,只有房主有此权限，房管可设置聊天室的黑名单
    
    参数:
    
    roomId - 聊天室的roomId
    
    userInfos - 准备设置为房管的用户UserInfo列表
    
    callback - 回调
    
    从以下版本开始:
    
    2.8.0
  - delChatRoomAdmin
```
public static void delChatRoomAdmin(long roomId,
                                    java.util.List<UserInfo> userInfos,
                                    BasicCallback callback)
```
    取消指定用户的聊天室房管身份，只有房主有此权限
    
    参数:
    
    roomId - 聊天室的roomId
    
    userInfos - 准备取消房管的用户UserInfo列表
    
    callback - 回调
    
    从以下版本开始:
    
    2.8.0
  - getChatRoomAdminList
```
public static void getChatRoomAdminList(long roomId,
                                        RequestCallback<java.util.List<UserInfo>> callback)
```
    获取聊天室的房管用户列表
    
    参数:
    
    roomId - 聊天室的roomId
    
    callback - 回调
    
    从以下版本开始:
    
    2.8.0
  - addChatRoomBlacklist
```
public static void addChatRoomBlacklist(long roomId,
                                        java.util.List<UserInfo> userInfos,
                                        BasicCallback callback)
```
    将用户添加至聊天室黑名单，只有聊天室的房主和房管有此权限, 被设置黑名单用户会被立即踢出聊天室。
    
    参数:
    
    roomId - 聊天室的roomId
    
    userInfos - 准备加入聊天室黑名单的用户userInfo集合
    
    callback - 结果回调
    
    从以下版本开始:
    
    2.8.0
  - delChatRoomBlacklist
```
public static void delChatRoomBlacklist(long roomId,
                                        java.util.List<UserInfo> userInfos,
                                        BasicCallback callback)
```
    将用户从聊天室黑名单中移除，只有聊天室的房主和房管有此权限
    
    参数:
    
    roomId - 聊天室的roomId
    
    userInfos - 准备移出聊天室黑名单的用户userInfo集合
    
    callback - 回调
    
    从以下版本开始:
    
    2.8.0
  - getChatRoomBlacklist
```
public static void getChatRoomBlacklist(long roomId,
                                        RequestCallback<java.util.List<UserInfo>> callback)
```
    获取聊天室的黑名单用户列表,按照被拉黑时间倒序排列
    
    参数:
    
    roomId - 聊天室的roomId
    
    callback - 回调
    
    从以下版本开始:
    
    2.8.0
  - addChatRoomSilence
```
public static void addChatRoomSilence(long roomId,
                                      java.util.Collection<UserInfo> userInfos,
                                      long times,
                                      BasicCallback callback)
```
    将指定用户添加进聊天室的禁言列表(批量设置一次最多500个)，禁言时间下限5分钟，上限1年聊天室owner或者管理员可以禁言聊天室成员，管理员或owner不能被禁言, 重复调用此接口将根据当前时间重新计算结束时间。禁言成功聊天室成员会收到ChatRoomNotificationEvent
    
    参数:
    
    roomId - 聊天室的roomId
    
    userInfos - 准备加入聊天室禁言名单的用户
    
    times - 禁言时间，单位：毫秒,禁言时间最少5分钟（300000毫秒），最长一年（31536000000毫秒) 即300000 <= times <= 31536000000
    
    callback - 禁言结果回调
    
    从以下版本开始:
    
    2.8.2
  - delChatRoomSilence
```
public static void delChatRoomSilence(long roomId,
                                      java.util.Collection<UserInfo> userInfos,
                                      BasicCallback callback)
```
    将指定用户从聊天室禁言列表中移除(批量设置一次最多500个) 只有房主和管理员可设置,取消成功聊天室成员会收到ChatRoomNotificationEvent
    
    参数:
    
    roomId - 聊天室的roomId
    
    userInfos - 将要被解除禁言的用户信息，size <= 500
    
    callback - 解除禁言结果回调
    
    从以下版本开始:
    
    2.8.2
  - getChatRoomSilencesFromNewest
```
public static void getChatRoomSilencesFromNewest(long roomId,
                                                 int start,
                                                 int count,
                                                 GetChatRoomSilencesCallback callback)
```
    获取聊天室禁言列表以添加入禁言的先后的时间倒序排序（后加入的在前），从start位置开始获取count个禁言信息。例如总共20个被禁言，分页每次获取15人，第一次获取 start: 0, count : 15,返回15个人的禁言信息，第二次获取 start : 15, count : 15 返回5个人的禁言信息。禁言用户总数在回调中会返回。
    
    参数:
    
    roomId - 聊天室的roomId
    
    start - 获取禁言列表开始位置，从第 start 个开始，start >= 0
    
    count - 获取禁言信息数量, count > 0
    
    callback - 结果回调GetChatRoomSilencesCallback
    
    从以下版本开始:
    
    2.8.2
  - getChatRoomMemberSilence
```
public static void getChatRoomMemberSilence(long roomId,
                                            java.lang.String username,
                                            java.lang.String appkey,
                                            RequestCallback<SilenceInfo> callback)
```
    获取用户在聊天室的禁言状态，如果用户未处于禁言状态，回调中SilenceInfo为null
    
    参数:
    
    roomId - 聊天室的roomId
    
    username - 用户名
    
    appkey - 用户所在应用 AppKey，不填这默认本应用
    
    callback - 结果回调, 如果用户未处于禁言状态，回调中SilenceInfo为null
    
    从以下版本开始:
    
    2.8.2

类 ChatRoomManager

构造器概要

方法概要

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

构造器详细资料

ChatRoomManager

方法详细资料

getChatRoomListByApp

getChatRoomListByUser

getChatRoomInfos

enterChatRoom

leaveChatRoom

addChatRoomAdmin

delChatRoomAdmin

getChatRoomAdminList

addChatRoomBlacklist

delChatRoomBlacklist

getChatRoomBlacklist

addChatRoomSilence

delChatRoomSilence

getChatRoomSilencesFromNewest

getChatRoomMemberSilence