Package com.easemob.im.server.api.block

Class BlockApi

  • public class BlockApi
extends java.lang.Object
    封禁API，提供封禁相关的功能。

    • Constructor Summary

      Constructors 
      Constructor Description
      BlockApi​(Context context)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      reactor.core.publisher.Mono<java.lang.Void> blockAllUserSendMsgToGroup​(java.lang.String groupId)
      禁言群组全体成员。
      reactor.core.publisher.Mono<java.lang.Void> blockAllUserSendMsgToRoom​(java.lang.String roomId)
      禁言聊天室全体成员。
      reactor.core.publisher.Mono<java.lang.Void> blockUserJoinGroup​(java.lang.String username, java.lang.String groupId)
      阻止进群。
      reactor.core.publisher.Mono<java.lang.Void> blockUserJoinRoom​(java.lang.String username, java.lang.String roomId)
      阻止进聊天室。
      reactor.core.publisher.Mono<java.lang.Void> blockUserLogin​(java.lang.String username)
      用户账号禁用，阻止该用户登录。
      reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToGroup​(java.lang.String username, java.lang.String groupId, java.time.Duration duration)
      添加群禁言。
      reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToRoom​(java.lang.String username, java.lang.String roomId, java.time.Duration duration)
      添加聊天室禁言。
      reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToRoom​(java.util.List<java.lang.String> usernames, java.lang.String roomId, java.time.Duration duration)
      将多个用户添加聊天室禁言。
      reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToUser​(java.lang.String fromUser, java.lang.String toUser)
      用户禁言，阻止向这个用户发消息。
      reactor.core.publisher.Mono<java.lang.Void> blockUsersSendMsgToGroup​(java.util.List<java.lang.String> usernames, java.lang.String groupId, java.time.Duration duration)
      添加群禁言，支持同时禁言多个用户。
      reactor.core.publisher.Flux<EMBlock> getUsersBlockedFromSendMsgToUser​(java.lang.String username)
      获取禁言列表，即这个用户禁言的其他用户。
      reactor.core.publisher.Flux<EMBlock> getUsersBlockedJoinGroup​(java.lang.String groupId)
      获取阻止进群的用户列表。
      reactor.core.publisher.Flux<EMBlock> getUsersBlockedJoinRoom​(java.lang.String roomId)
      获取阻止进聊天室的用户列表。
      reactor.core.publisher.Flux<EMBlock> getUsersBlockedSendMsgToGroup​(java.lang.String groupId)
      获取群禁言列表。
      reactor.core.publisher.Flux<EMBlock> listUsersBlockedSendMsgToRoom​(java.lang.String roomId)
      获取聊天室禁言列表。
      reactor.core.publisher.Mono<java.lang.Void> unblockAllUserSendMsgToGroup​(java.lang.String groupId)
      解除群组全员禁言。
      reactor.core.publisher.Mono<java.lang.Void> unblockAllUserSendMsgToRoom​(java.lang.String roomId)
      解除聊天室全员禁言。
      reactor.core.publisher.Mono<java.lang.Void> unblockUserJoinGroup​(java.lang.String username, java.lang.String groupId)
      解除阻止进群。
      reactor.core.publisher.Mono<java.lang.Void> unblockUserJoinRoom​(java.lang.String username, java.lang.String roomId)
      解除阻止进聊天室。
      reactor.core.publisher.Mono<java.lang.Void> unblockUserLogin​(java.lang.String username)
      用户账号解禁，恢复该用户登录。
      reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToGroup​(java.lang.String username, java.lang.String groupId)
      解除群禁言。
      reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToRoom​(java.lang.String username, java.lang.String roomId)
      解除聊天室禁言。
      reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToRoom​(java.util.List<java.lang.String> usernames, java.lang.String roomId)
      将多个用户解除聊天室禁言。
      reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToUser​(java.lang.String fromUser, java.lang.String toUser)
      解除用户禁言，恢复向这个用户发消息。

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BlockApi

        public BlockApi​(Context context)

    • Method Detail

      • getUsersBlockedFromSendMsgToUser

        public reactor.core.publisher.Flux<EMBlock> getUsersBlockedFromSendMsgToUser​(java.lang.String username)
        获取禁言列表，即这个用户禁言的其他用户。

        API使用示例： 

         
 EMService service;
 try {
     List<EMBlock> blocks = service.block().getUsersBlockedFromSendMsgToUser("username").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 发起禁言的用户名
        Returns:
        每个被禁言用户的用户的用户名或错误
        See Also:
        获取用户禁言列表

      • blockUserSendMsgToUser

        public reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToUser​(java.lang.String fromUser,
                                                                          java.lang.String toUser)
        用户禁言，阻止向这个用户发消息。

        要阻止 userA 给 userB发送消息：

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockUserSendMsgToUser("userA", "userB").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        fromUser - 被阻止的用户的用户名
        toUser - 接收消息的用户的用户名
        Returns:
        成功或错误
        See Also:
        添加用户禁言

      • unblockUserSendMsgToUser

        public reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToUser​(java.lang.String fromUser,
                                                                            java.lang.String toUser)
        解除用户禁言，恢复向这个用户发消息。

        要恢复 userA 给 userB发送消息：

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockUserSendMsgToUser("userA", "userB").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        fromUser - 被阻止的用户的用户名
        toUser - 接受消息的用户的用户名
        Returns:
        成功或错误
        See Also:
        解除用户禁言

      • blockUserLogin

        public reactor.core.publisher.Mono<java.lang.Void> blockUserLogin​(java.lang.String username)
        用户账号禁用，阻止该用户登录。

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockUserLogin("username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被阻止的用户的用户名
        Returns:
        成功或失败
        See Also:
        用户账号禁用

      • unblockUserLogin

        public reactor.core.publisher.Mono<java.lang.Void> unblockUserLogin​(java.lang.String username)
        用户账号解禁，恢复该用户登录。

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockUserLogin("username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被阻止的用户的用户名
        Returns:
        成功或失败
        See Also:
        用户账号解禁

      • getUsersBlockedJoinGroup

        public reactor.core.publisher.Flux<EMBlock> getUsersBlockedJoinGroup​(java.lang.String groupId)
        获取阻止进群的用户列表。

        API使用示例： 

         
 EMService service;
 try {
     List<EMBlock> blocks = service.block().getUsersBlockedJoinGroup("groupId").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        groupId - 群id
        Returns:
        被阻止进入的用户名
        See Also:
        获取阻止进群列表

      • blockUserJoinGroup

        public reactor.core.publisher.Mono<java.lang.Void> blockUserJoinGroup​(java.lang.String username,
                                                                      java.lang.String groupId)
        阻止进群。

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockUserJoinGroup("username", "groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被阻止的用户的用户名
        groupId - 群id
        Returns:
        成功或错误
        See Also:
        阻止进群

      • unblockUserJoinGroup

        public reactor.core.publisher.Mono<java.lang.Void> unblockUserJoinGroup​(java.lang.String username,
                                                                        java.lang.String groupId)
        解除阻止进群。

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockUserJoinGroup("username", "groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被阻止的用户的用户名
        groupId - 群id
        Returns:
        成功或错误
        See Also:

      • getUsersBlockedJoinRoom

        public reactor.core.publisher.Flux<EMBlock> getUsersBlockedJoinRoom​(java.lang.String roomId)
        获取阻止进聊天室的用户列表。

        API使用示例： 

         
 EMService service;
 try {
     List<EMBlock> blocks = service.block().getUsersBlockedJoinRoom("roomId").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        roomId - 聊天室id
        Returns:
        被阻止进入的用户名

      • blockUserJoinRoom

        public reactor.core.publisher.Mono<java.lang.Void> blockUserJoinRoom​(java.lang.String username,
                                                                     java.lang.String roomId)
        阻止进聊天室。

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockUserJoinRoom("username", "roomId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被阻止的用户的用户名
        roomId - 聊天室id
        Returns:
        成功或错误

      • unblockUserJoinRoom

        public reactor.core.publisher.Mono<java.lang.Void> unblockUserJoinRoom​(java.lang.String username,
                                                                       java.lang.String roomId)
        解除阻止进聊天室。

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockUserJoinRoom("username", "roomId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被阻止的用户的用户名
        roomId - 聊天室id
        Returns:
        成功或错误

      • getUsersBlockedSendMsgToGroup

        public reactor.core.publisher.Flux<EMBlock> getUsersBlockedSendMsgToGroup​(java.lang.String groupId)
        获取群禁言列表。

        API使用示例： 

         
 EMService service;
 try {
     List<EMBlock> blocks = service.block().getUsersBlockedSendMsgToGroup("groupId").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        groupId - 群id
        Returns:
        每个禁言或错误.
        See Also:
        获取禁言列表

      • blockUserSendMsgToGroup

        public reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToGroup​(java.lang.String username,
                                                                           java.lang.String groupId,
                                                                           java.time.Duration duration)
        添加群禁言。

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockUserSendMsgToGroup("username", "groupId", Duration.ofMillis(6000)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被禁言的用户的用户名
        groupId - 群id
        duration - 禁言多长时间，为null则永久禁言
        Returns:
        成功或错误
        See Also:
        添加禁言

      • blockUsersSendMsgToGroup

        public reactor.core.publisher.Mono<java.lang.Void> blockUsersSendMsgToGroup​(java.util.List<java.lang.String> usernames,
                                                                            java.lang.String groupId,
                                                                            java.time.Duration duration)
        添加群禁言，支持同时禁言多个用户。

        API使用示例： 

         
 EMService service;
 try {
     List<String> usernames = new ArrayList<>();
     usernames.add("user1");
     usernames.add("user2");

     service.block().blockUsersSendMsgToGroup(usernames, "groupId", Duration.ofMillis(6000)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        usernames - 被禁言的用户的用户名列表
        groupId - 群id
        duration - 禁言多长时间，为null则永久禁言
        Returns:
        成功或错误
        See Also:
        添加禁言

      • unblockUserSendMsgToGroup

        public reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToGroup​(java.lang.String username,
                                                                             java.lang.String groupId)
        解除群禁言。

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockUserSendMsgToGroup("username", "groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被禁言的用户的用户名
        groupId - 群id
        Returns:
        成功或错误
        See Also:
        移除禁言

      • unblockAllUserSendMsgToGroup

        public reactor.core.publisher.Mono<java.lang.Void> unblockAllUserSendMsgToGroup​(java.lang.String groupId)
        解除群组全员禁言。

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockAllUserSendMsgToGroup("groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        groupId - 群组id
        Returns:
        成功或错误
        See Also:
        解除群组全员禁言

      • blockAllUserSendMsgToGroup

        public reactor.core.publisher.Mono<java.lang.Void> blockAllUserSendMsgToGroup​(java.lang.String groupId)
        禁言群组全体成员。

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockAllUserSendMsgToGroup("groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        groupId - 群组id
        Returns:
        成功或错误
        See Also:
        禁言群组全体成员

      • listUsersBlockedSendMsgToRoom

        public reactor.core.publisher.Flux<EMBlock> listUsersBlockedSendMsgToRoom​(java.lang.String roomId)
        获取聊天室禁言列表。

        API使用示例： 

         
 EMService service;
 try {
     List<EMBlock> blocks = service.block().listUsersBlockedSendMsgToRoom("roomId").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        roomId - 聊天室id
        Returns:
        每个禁言或错误
        See Also:
        获取禁言列表

      • blockUserSendMsgToRoom

        public reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToRoom​(java.lang.String username,
                                                                          java.lang.String roomId,
                                                                          java.time.Duration duration)
        添加聊天室禁言。

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockUserSendMsgToRoom("username", "roomId", Duration.ofMillis(6000)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被禁言的用户的用户名
        roomId - 聊天室id
        duration - 禁言时长，为null则永久禁言
        Returns:
        成功或错误
        See Also:
        添加禁言

      • blockUserSendMsgToRoom

        public reactor.core.publisher.Mono<java.lang.Void> blockUserSendMsgToRoom​(java.util.List<java.lang.String> usernames,
                                                                          java.lang.String roomId,
                                                                          java.time.Duration duration)
        将多个用户添加聊天室禁言。

        API使用示例： 

         
 EMService service;
 try {
     List<String> usernames = new ArrayList<>();
     usernames.add("user1");
     service.block().blockUserSendMsgToRoom(usernames, "roomId", Duration.ofMillis(6000)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        usernames - 被禁言的用户名列表
        roomId - 聊天室id
        duration - 禁言时长，为null则永久禁言
        Returns:
        成功或错误
        See Also:
        添加禁言

      • unblockUserSendMsgToRoom

        public reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToRoom​(java.lang.String username,
                                                                            java.lang.String roomId)
        解除聊天室禁言。

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockUserSendMsgToRoom("username", "roomId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        username - 被解除禁言的用户的用户名
        roomId - 聊天室id
        Returns:
        成功或错误
        See Also:
        移除禁言

      • unblockUserSendMsgToRoom

        public reactor.core.publisher.Mono<java.lang.Void> unblockUserSendMsgToRoom​(java.util.List<java.lang.String> usernames,
                                                                            java.lang.String roomId)
        将多个用户解除聊天室禁言。

        API使用示例： 

         
 EMService service;
 try {
     List<String> usernames = new ArrayList<>();
     usernames.add("user1");
     service.block().unblockUserSendMsgToRoom(usernames, "roomId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        usernames - 被解除禁言的用户名列表
        roomId - 聊天室id
        Returns:
        成功或错误
        See Also:
        移除禁言

      • unblockAllUserSendMsgToRoom

        public reactor.core.publisher.Mono<java.lang.Void> unblockAllUserSendMsgToRoom​(java.lang.String roomId)
        解除聊天室全员禁言。

        API使用示例： 

         
 EMService service;
 try {
     service.block().unblockAllUserSendMsgToRoom("roomId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        roomId - 聊天室id
        Returns:
        成功或错误
        See Also:
        解除聊天室全员禁言

      • blockAllUserSendMsgToRoom

        public reactor.core.publisher.Mono<java.lang.Void> blockAllUserSendMsgToRoom​(java.lang.String roomId)
        禁言聊天室全体成员。

        API使用示例： 

         
 EMService service;
 try {
     service.block().blockAllUserSendMsgToRoom("roomId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
        Parameters:
        roomId - 聊天室id
        Returns:
        成功或错误
        See Also:
        禁言聊天室全体成员