IM

  • IM > API 文档 > ANDROID API > BMXGroupService

    BMXGroupService

    最近更新时间:2021-07-19 15:06:09

    类 BMXGroupService

    • java.lang.Object

      • im.floo.floolib.BMXGroupService

    • public class BMXGroupService
      extends java.lang.Object
      

      群组Service

      • 字段详细资料

        • swigCMemOwn

          protected transient boolean swigCMemOwn
          
      • 构造器详细资料

        • BMXGroupService

          protected BMXGroupService(long cPtr,
                                    boolean cMemoryOwn)
          
      • 方法详细资料

        • getCPtr

          protected static long getCPtr(BMXGroupService obj)
          
        • finalize

          protected void finalize()
          

          覆盖:

          finalize 在类中 java.lang.Object

        • delete

          public void delete()
          
        • get

          public BMXErrorCode get(BMXGroupList list,
                                  boolean forceRefresh)
          

          获取群组列表,如果设置了forceRefresh则从服务器拉取

          参数:

          list - 群组id列表,传入空列表函数返回后从此处获取返回的群组id列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • search

          public BMXErrorCode search(BMXGroupList list,
                                     boolean forceRefresh)
          

          获取群组列表,如果设置了forceRefresh则从服务器拉取

          参数:

          list - 群组id列表,传入空列表函数返回后从此处获取返回的群组id列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • fetchGroupsByIdList

          public BMXErrorCode fetchGroupsByIdList(ListOfLongLong groupIdList,
                                                  BMXGroupList list,
                                                  boolean forceRefresh)
          

          获取传入群组id的群组信息列表,如果设置了forceRefresh则从服务器拉取

          参数:

          groupIdList - 群组id列表

          list - 群组详细信息列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • search

          public BMXErrorCode search(ListOfLongLong groupIdList,
                                     BMXGroupList list,
                                     boolean forceRefresh)
          

          获取传入群组id的群组信息列表,如果设置了forceRefresh则从服务器拉取

          参数:

          groupIdList - 群组id列表

          list - 群组详细信息列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • fetchGroupById

          public BMXErrorCode fetchGroupById(long groupId,
                                             BMXGroup group,
                                             boolean forceRefresh)
          

          获取群信息,如果设置了forceRefresh则从服务器拉取

          参数:

          groupId - 要搜索的群组id

          group - 搜索返回的群组信息,传入指向为空的shared_ptr对象函数执行后从此获取返回结果

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • search

          public BMXErrorCode search(long groupId,
                                     BMXGroup group,
                                     boolean forceUpdate)
          

          获取群信息,如果设置了forceRefresh则从服务器拉取

          参数:

          groupId - 要搜索的群组id

          group - 搜索返回的群组信息,传入指向为空的shared_ptr对象函数执行后从此获取返回结果

          forceUpdate - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • fetchLocalGroupsByName

          public BMXErrorCode fetchLocalGroupsByName(BMXGroupList list,
                                                     java.lang.String name)
          

          通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组

          参数:

          list - 搜索结果返回的群列表信息

          name - 查询的群名称关键字

          返回:

          BMXErrorCode

        • search

          public BMXErrorCode search(BMXGroupList list,
                                     java.lang.String name)
          

          通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组

          参数:

          list - 搜索结果返回的群列表信息

          name - 查询的群名称关键字

          返回:

          BMXErrorCode

        • create

          public BMXErrorCode create(BMXGroupService.CreateGroupOptions options,
                                     BMXGroup group)
          

          创建群

          参数:

          options - 创建群组时传入的参数选项

          group - 创建好的群,传入指向为空的shared_ptr对象函数执行后从此获取返回结果

          返回:

          BMXErrorCode

        • destroy

          public BMXErrorCode destroy(BMXGroup group)
          

          销毁群

          参数:

          group - 要销毁的群组

          返回:

          BMXErrorCode

        • join

          public BMXErrorCode join(BMXGroup group,
                                   java.lang.String message)
          

          加入一个群,根据群设置可能需要管理员批准

          参数:

          group - 要加入的群组

          message - 申请入群的信息

          返回:

          BMXErrorCode

        • leave

          public BMXErrorCode leave(BMXGroup group)
          

          退出群

          参数:

          group - 要退出的群组

          返回:

          BMXErrorCode

        • getInfo

          public BMXErrorCode getInfo(BMXGroup group)
          

          获取群详情,从服务端拉取最新信息

          参数:

          group - 要获取群组最新信息的群组

          返回:

          BMXErrorCode

        • getMembersNickname

          public BMXErrorCode getMembersNickname(BMXGroup group,
                                                 ListOfLongLong members,
                                                 BMXGroupMemberList list)
          

          获取群组成员详细信息

          参数:

          group - 进行操作的群组

          members - 要获取群组成员信息详情的群成员id

          list - 返回的群成员详细,传入空列表在函数操作后从此处获取群成员详细信息列表

          返回:

          BMXErrorCode

        • getInvitationList

          public BMXErrorCode getInvitationList(GroupInvitaionPage result,
                                                java.lang.String cursor,
                                                int pageSize)
          

          分页获取群组邀请列表

          参数:

          result - 分页获取的群组邀请列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果

          cursor - 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor

          pageSize - 分页大小

          返回:

          BMXErrorCode

        • getInvitationList

          public BMXErrorCode getInvitationList(GroupInvitaionPage result,
                                                java.lang.String cursor)
          
        • getInvitationList

          public BMXErrorCode getInvitationList(GroupInvitaionPage result)
          
        • getApplicationList

          public BMXErrorCode getApplicationList(BMXGroupList list,
                                                 GroupApplicationPage result,
                                                 java.lang.String cursor,
                                                 int pageSize)
          

          分页获取群组申请列表

          参数:

          list - 需要获取群组申请列表信息的群组id列表

          result - 分页获取的群组申请列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果

          cursor - 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor

          pageSize - 分页大小

          返回:

          BMXErrorCode

        • getApplicationList

          public BMXErrorCode getApplicationList(BMXGroupList list,
                                                 GroupApplicationPage result,
                                                 java.lang.String cursor)
          
        • getApplicationList

          public BMXErrorCode getApplicationList(BMXGroupList list,
                                                 GroupApplicationPage result)
          
        • getMembers

          public BMXErrorCode getMembers(BMXGroup group,
                                         BMXGroupMemberResultPage result,
                                         java.lang.String cursor,
                                         int pageSize)
          

          分页获取群成员列表,如果设置了forceRefresh则从服务器拉取,单页最大数量为500.

          参数:

          group - 进行操作的群组

          result - 分页获取的群成员列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果

          cursor - 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor

          pageSize - 分页大小

          返回:

          BMXErrorCode

        • getMembers

          public BMXErrorCode getMembers(BMXGroup group,
                                         BMXGroupMemberResultPage result,
                                         java.lang.String cursor)
          
        • getMembers

          public BMXErrorCode getMembers(BMXGroup group,
                                         BMXGroupMemberResultPage result)
          
        • getMembers

          public BMXErrorCode getMembers(BMXGroup group,
                                         BMXGroupMemberList list,
                                         boolean forceRefresh)
          

          获取群成员列表,如果设置了forceRefresh则从服务器拉取,最多拉取1000人

          参数:

          group - 进行操作的群组

          list - 群成员列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • addMembers

          public BMXErrorCode addMembers(BMXGroup group,
                                         ListOfLongLong members,
                                         java.lang.String message)
          

          添加群成员

          参数:

          group - 进行操作的群组

          members - 要添加进群的成员id列表

          message - 添加成员原因信息

          返回:

          BMXErrorCode

        • removeMembers

          public BMXErrorCode removeMembers(BMXGroup group,
                                            ListOfLongLong members,
                                            java.lang.String reason)
          

          删除群成员

          参数:

          group - 进行操作的群组

          members - 要删除的群组成员id列表

          reason - 删除的原因

          返回:

          BMXErrorCode

        • addAdmins

          public BMXErrorCode addAdmins(BMXGroup group,
                                        ListOfLongLong admins,
                                        java.lang.String message)
          

          添加管理员

          参数:

          group - 进行操作的群组

          admins - 要添加为管理员的成员id列表

          message - 添加为管理员的原因

          返回:

          BMXErrorCode

        • removeAdmins

          public BMXErrorCode removeAdmins(BMXGroup group,
                                           ListOfLongLong admins,
                                           java.lang.String reason)
          

          删除管理员

          参数:

          group - 进行操作的群组

          admins - 要从管理员移除的成员id列表

          reason - 要移除管理员的原因

          返回:

          BMXErrorCode

        • getAdmins

          public BMXErrorCode getAdmins(BMXGroup group,
                                        BMXGroupMemberList list,
                                        boolean forceRefresh)
          

          获取Admins列表,如果设置了forceRefresh则从服务器拉取

          参数:

          group - 进行操作的群组

          list - 群管理员列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • blockMembers

          public BMXErrorCode blockMembers(BMXGroup group,
                                           ListOfLongLong members)
          

          添加黑名单

          参数:

          group - 进行操作的群组

          members - 要加入黑名单的群成员id列表

          返回:

          BMXErrorCode

        • unblockMembers

          public BMXErrorCode unblockMembers(BMXGroup group,
                                             ListOfLongLong members)
          

          从黑名单删除

          参数:

          group - 进行操作的群组

          members - 从黑名单移除的用户id列表

          返回:

          BMXErrorCode

        • getBlockList

          public BMXErrorCode getBlockList(BMXGroup group,
                                           BMXGroupMemberResultPage result,
                                           java.lang.String cursor,
                                           int pageSize)
          

          分页获取黑名单

          参数:

          group - 进行操作的群组

          result - 分页获取的黑名单列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果

          cursor - 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor

          pageSize - 分页大小

          返回:

          BMXErrorCode

        • getBlockList

          public BMXErrorCode getBlockList(BMXGroup group,
                                           BMXGroupMemberResultPage result,
                                           java.lang.String cursor)
          
        • getBlockList

          public BMXErrorCode getBlockList(BMXGroup group,
                                           BMXGroupMemberResultPage result)
          
        • getBlockList

          public BMXErrorCode getBlockList(BMXGroup group,
                                           BMXGroupMemberList list,
                                           boolean forceRefresh)
          

          获取黑名单

          参数:

          group - 进行操作的群组

          list - 群黑名单列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • banMembers

          public BMXErrorCode banMembers(BMXGroup group,
                                         ListOfLongLong members,
                                         long duration,
                                         java.lang.String reason)
          

          禁言

          参数:

          group - 进行操作的群组

          members - 被禁言的群成员id列表

          duration - 禁言时长

          reason - 禁言原因

          返回:

          BMXErrorCode

        • banMembers

          public BMXErrorCode banMembers(BMXGroup group,
                                         ListOfLongLong members,
                                         long duration)
          
        • unbanMembers

          public BMXErrorCode unbanMembers(BMXGroup group,
                                           ListOfLongLong members)
          

          解除禁言

          参数:

          group - 进行操作的群组

          members - 被解除禁言的群成员id列表

          返回:

          BMXErrorCode

        • getBannedMembers

          public BMXErrorCode getBannedMembers(BMXGroup group,
                                               BMXGroupBannedMemberResultPage result,
                                               java.lang.String cursor,
                                               int pageSize)
          

          分页获取禁言列表

          参数:

          group - 进行操作的群组

          result - 分页获取的禁言列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果

          cursor - 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor

          pageSize - 分页大小

          返回:

          BMXErrorCode

        • getBannedMembers

          public BMXErrorCode getBannedMembers(BMXGroup group,
                                               BMXGroupBannedMemberResultPage result,
                                               java.lang.String cursor)
          
        • getBannedMembers

          public BMXErrorCode getBannedMembers(BMXGroup group,
                                               BMXGroupBannedMemberResultPage result)
          
        • getBannedMembers

          public BMXErrorCode getBannedMembers(BMXGroup group,
                                               BMXGroupBannedMemberList list)
          

          获取禁言列表

          参数:

          group - 进行操作的群组

          list - 群禁言列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          返回:

          BMXErrorCode

        • muteMessage

          public BMXErrorCode muteMessage(BMXGroup group,
                                          BMXGroup.MsgMuteMode mode)
          

          设置是否屏蔽群消息

          参数:

          group - 进行操作的群组

          mode - 群屏蔽的模式

          返回:

          BMXErrorCode

        • acceptApplication

          public BMXErrorCode acceptApplication(BMXGroup group,
                                                long applicantId)
          

          接受入群申请

          参数:

          group - 进行操作的群组

          applicantId - 申请进群的用户id

          返回:

          BMXErrorCode

        • declineApplication

          public BMXErrorCode declineApplication(BMXGroup group,
                                                 long applicantId,
                                                 java.lang.String reason)
          

          拒绝入群申请

          参数:

          group - 进行操作的群组

          applicantId - 申请进群的用户id

          reason - 拒绝的原因

          返回:

          BMXErrorCode

        • declineApplication

          public BMXErrorCode declineApplication(BMXGroup group,
                                                 long applicantId)
          
        • acceptInvitation

          public BMXErrorCode acceptInvitation(BMXGroup group,
                                               long inviter)
          

          接受入群邀请

          参数:

          group - 进行操作的群组

          inviter - 邀请者id

          返回:

          BMXErrorCode

        • declineInvitation

          public BMXErrorCode declineInvitation(BMXGroup group,
                                                long inviter,
                                                java.lang.String reason)
          

          拒绝入群邀请

          参数:

          group - 进行操作的群组

          inviter - 邀请者id

          reason - 拒绝的原因

          返回:

          BMXErrorCode

        • declineInvitation

          public BMXErrorCode declineInvitation(BMXGroup group,
                                                long inviter)
          
        • transferOwner

          public BMXErrorCode transferOwner(BMXGroup group,
                                            long newOwnerId)
          

          转移群主

          参数:

          group - 进行操作的群组

          newOwnerId - 转让为新群主的用户id

          返回:

          BMXErrorCode

        • uploadSharedFile

          public BMXErrorCode uploadSharedFile(BMXGroup group,
                                               java.lang.String filePath,
                                               java.lang.String displayName,
                                               java.lang.String extensionName,
                                               FileProgressListener arg4)
          

          添加群共享文件

          参数:

          group - 进行操作的群组

          filePath - 文件的本地路径

          displayName - 文件的展示名

          extensionName - 文件的扩展名

          arg4 - 上传回调函数

          返回:

          BMXErrorCode

        • cancelUploadSharedFile

          public BMXErrorCode cancelUploadSharedFile(BMXGroup group,
                                                     java.lang.String filePath)
          

          取消上传群共享文件

          参数:

          group - 进行操作的群组

          filePath - 文件的本地路径

          返回:

          BMXErrorCode

        • removeSharedFile

          public BMXErrorCode removeSharedFile(BMXGroup group,
                                               BMXGroup.SharedFile sharedFile)
          

          移除群共享文件

          参数:

          group - 进行操作的群组

          sharedFile - 删除的群共享文件

          返回:

          BMXErrorCode

        • downloadSharedFile

          public BMXErrorCode downloadSharedFile(BMXGroup group,
                                                 BMXGroup.SharedFile sharedFile,
                                                 FileProgressListener arg2)
          

          下载群共享文件

          参数:

          group - 进行操作的群组

          sharedFile - 下载的群共享文件

          arg2 - 下载回调函数

          返回:

          BMXErrorCode

        • cancelDownloadSharedFile

          public BMXErrorCode cancelDownloadSharedFile(BMXGroup group,
                                                       BMXGroup.SharedFile sharedFile)
          

          取消下载群共享文件

          参数:

          group - 进行操作的群组

          sharedFile - 下载的群共享文件

          返回:

          BMXErrorCode

        • getSharedFilesList

          public BMXErrorCode getSharedFilesList(BMXGroup group,
                                                 BMXGroupSharedFileList list,
                                                 boolean forceRefresh)
          

          获取群共享文件列表

          参数:

          group - 进行操作的群组

          list - 群共享文件列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • changeSharedFileName

          public BMXErrorCode changeSharedFileName(BMXGroup group,
                                                   BMXGroup.SharedFile sharedFile,
                                                   java.lang.String name)
          

          修改群共享文件名称

          参数:

          group - 进行操作的群组

          sharedFile - 进行更改的群共享文件

          name - 修改的群共享文件名称

          返回:

          BMXErrorCode

        • getLatestAnnouncement

          public BMXErrorCode getLatestAnnouncement(BMXGroup group,
                                                    BMXGroup.Announcement announcement,
                                                    boolean forceRefresh)
          

          获取最新的群公告

          参数:

          group - 进行操作的群组

          announcement - 最新的群组公告,传入指向为空的shared_ptr对象函数返回后从此处获取最新的群组公告

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • getAnnouncementList

          public BMXErrorCode getAnnouncementList(BMXGroup group,
                                                  BMXGroupAnnouncementList list,
                                                  boolean forceRefresh)
          

          获取群公告列表

          参数:

          group - 进行操作的群组

          list - 群公告列表,传入空列表函数返回后从此处获取返回的群组详细信息列表

          forceRefresh - 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取

          返回:

          BMXErrorCode

        • editAnnouncement

          public BMXErrorCode editAnnouncement(BMXGroup group,
                                               java.lang.String title,
                                               java.lang.String content)
          

          设置群公告

          参数:

          group - 进行操作的群组

          title - 群公告的标题

          content - 群公告的内容

          返回:

          BMXErrorCode

        • deleteAnnouncement

          public BMXErrorCode deleteAnnouncement(BMXGroup group,
                                                 long announcementId)
          

          删除群公告

          参数:

          group - 进行操作的群组

          announcementId - 删除的群公告id

          返回:

          BMXErrorCode

        • setName

          public BMXErrorCode setName(BMXGroup group,
                                      java.lang.String name)
          

          设置群名称

          参数:

          group - 进行操作的群组

          name - 群组名称

          返回:

          BMXErrorCode

        • setDescription

          public BMXErrorCode setDescription(BMXGroup group,
                                             java.lang.String description)
          

          设置群描述信息

          参数:

          group - 进行操作的群组

          description - 群组描述

          返回:

          BMXErrorCode

        • setExtension

          public BMXErrorCode setExtension(BMXGroup group,
                                           java.lang.String extension)
          

          设置群扩展信息

          参数:

          group - 进行操作的群组

          extension - 群组的扩展信息

          返回:

          BMXErrorCode

        • setMyNickname

          public BMXErrorCode setMyNickname(BMXGroup group,
                                            java.lang.String nickname)
          

          设置在群里的昵称

          参数:

          group - 进行操作的群组

          nickname - 用户在群组内的昵称

          返回:

          BMXErrorCode

        • setMsgPushMode

          public BMXErrorCode setMsgPushMode(BMXGroup group,
                                             BMXGroup.MsgPushMode mode)
          

          设置群消息通知模式

          参数:

          group - 进行操作的群组

          mode - 群消息通知模式

          返回:

          BMXErrorCode

        • setJoinAuthMode

          public BMXErrorCode setJoinAuthMode(BMXGroup group,
                                              BMXGroup.JoinAuthMode mode)
          

          设置入群审批模式

          参数:

          group - 进行操作的群组

          mode - 入群审批模式

          返回:

          BMXErrorCode

        • setInviteMode

          public BMXErrorCode setInviteMode(BMXGroup group,
                                            BMXGroup.InviteMode mode)
          

          设置邀请模式

          参数:

          group - 进行操作的群组

          mode - 群组的邀请模式

          返回:

          BMXErrorCode

        • setAllowMemberModify

          public BMXErrorCode setAllowMemberModify(BMXGroup group,
                                                   boolean enable)
          

          设置是否允许群成员设置群信息

          参数:

          group - 进行操作的群组

          enable - 是否允许操作

          返回:

          BMXErrorCode

        • setEnableReadAck

          public BMXErrorCode setEnableReadAck(BMXGroup group,
                                               boolean enable)
          

          设置是否开启群消息已读功能

          参数:

          group - 进行操作的群组

          enable - 是否开启

          返回:

          BMXErrorCode

        • setHistoryVisible

          public BMXErrorCode setHistoryVisible(BMXGroup group,
                                                boolean enable)
          

          设置群成员是否开可见群历史聊天记录

          参数:

          group - 进行操作的群组

          enable - 是否开启

          返回:

          BMXErrorCode

        • setAvatar

          public BMXErrorCode setAvatar(BMXGroup group,
                                        java.lang.String avatarPath,
                                        FileProgressListener arg2)
          

          设置群头像

          参数:

          group - 进行操作的群组

          avatarPath - 群头像文件的本地路径

          arg2 - 上传回调函数

          返回:

          BMXErrorCode

        • downloadAvatar

          public BMXErrorCode downloadAvatar(BMXGroup group,
                                             boolean thumbnail,
                                             FileProgressListener arg2)
          

          下载群头像

          参数:

          group - 进行操作的群组

          thumbnail - 设置为true下载缩略图,false下载原图

          arg2 - 下载回调函数

          返回:

          BMXErrorCode

        • addGroupListener

          public void addGroupListener(BMXGroupServiceListener listener)
          

          添加群组变化监听者

          参数:

          listener - 群组变化监听者

        • removeGroupListener

          public void removeGroupListener(BMXGroupServiceListener listener)
          

          移除群组变化监听者

          参数:

          listener - 群组变化监听者

    以上内容是否对您有帮助?
  • Qvm free helper
    Close