即时通讯

    • 即时通讯 > API 文档 > ANDROID API > BMXGroupService

    BMXGroupService

    最近更新时间: 2022-07-22 22:41:28

    class im.floo.floolib.BMXGroupService

    群组Service

    Index
    字段
    方法
    字段
    swigCMemOwn
    • protected transient boolean swigCMemOwn

    方法
    getCPtr
    • protected static long getCPtr(BMXGroupService obj);

    • Returns long
    finalize
    • @Override() protected void finalize();

    • Returns void
    delete
    • public synchronized void delete();

    • Returns void
    get
    • public BMXErrorCode get(BMXGroupList list, boolean forceRefresh);

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

      Parameters
      • list: BMXGroupList

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

      • forceRefresh: boolean

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

      Returns BMXErrorCode
    search
    • public BMXErrorCode search(BMXGroupList list, boolean forceRefresh);

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

      Parameters
      • list: BMXGroupList

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

      • forceRefresh: boolean

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

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

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

      Parameters
      • groupIdList: ListOfLongLong

        群组id列表

      • list: BMXGroupList

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

      • forceRefresh: boolean

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

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

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

      Parameters
      • groupIdList: ListOfLongLong

        群组id列表

      • list: BMXGroupList

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

      • forceRefresh: boolean

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

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

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

      Parameters
      • groupId: long

        要搜索的群组id

      • group: BMXGroup

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

      • forceRefresh: boolean

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

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

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

      Parameters
      • groupId: long

        要搜索的群组id

      • group: BMXGroup

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

      • forceUpdate: boolean

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

      Returns BMXErrorCode
    fetchLocalGroupsByName
    • public BMXErrorCode fetchLocalGroupsByName(BMXGroupList list, String name);

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

      Parameters
      • list: BMXGroupList

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

      • name: String

        查询的群名称关键字

      Returns BMXErrorCode
    search
    • public BMXErrorCode search(BMXGroupList list, String name);

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

      Parameters
      • list: BMXGroupList

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

      • name: String

        查询的群名称关键字

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

    • 创建群

      Parameters
      • options: CreateGroupOptions

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

      • group: BMXGroup

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

      Returns BMXErrorCode
    destroy
    • public BMXErrorCode destroy(BMXGroup group);

    • 销毁群

      Parameters
      Returns BMXErrorCode
    join
    • public BMXErrorCode join(BMXGroup group, String message);

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

      Parameters
      • group: BMXGroup

        要加入的群组

      • message: String

        申请入群的信息

      Returns BMXErrorCode
    leave
    • public BMXErrorCode leave(BMXGroup group);

    • 退出群

      Parameters
      Returns BMXErrorCode
    getInfo
    • public BMXErrorCode getInfo(BMXGroup group);

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

      Parameters
      • group: BMXGroup

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

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

    • 获取群组成员详细信息

      Parameters
      • group: BMXGroup

        进行操作的群组

      • members: ListOfLongLong

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

      • list: BMXGroupMemberList

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

      Returns BMXErrorCode
    getInvitationList
    • public BMXErrorCode getInvitationList(GroupInvitaionPage result, String cursor, int pageSize);

    • 分页获取群组邀请列表

      Parameters
      • result: GroupInvitaionPage

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

      • cursor: String

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

      • pageSize: int

        分页大小

      Returns BMXErrorCode
    getApplicationList
    • public BMXErrorCode getApplicationList(BMXGroupList list, GroupApplicationPage result, String cursor, int pageSize);

    • 分页获取群组申请列表

      Parameters
      • list: BMXGroupList

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

      • result: GroupApplicationPage

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

      • cursor: String

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

      • pageSize: int

        分页大小

      Returns BMXErrorCode
    getMembers
    • public BMXErrorCode getMembers(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize);

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

      Parameters
      • group: BMXGroup

        进行操作的群组

      • result: BMXGroupMemberResultPage

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

      • cursor: String

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

      • pageSize: int

        分页大小

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

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

      Parameters
      • group: BMXGroup

        进行操作的群组

      • list: BMXGroupMemberList

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

      • forceRefresh: boolean

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

      Returns BMXErrorCode
    addMembers
    • public BMXErrorCode addMembers(BMXGroup group, ListOfLongLong members, String message);

    • 添加群成员

      Parameters
      • group: BMXGroup

        进行操作的群组

      • members: ListOfLongLong

        要添加进群的成员id列表

      • message: String

        添加成员原因信息

      Returns BMXErrorCode
    removeMembers
    • public BMXErrorCode removeMembers(BMXGroup group, ListOfLongLong members, String reason);

    • 删除群成员

      Parameters
      • group: BMXGroup

        进行操作的群组

      • members: ListOfLongLong

        要删除的群组成员id列表

      • reason: String

        删除的原因

      Returns BMXErrorCode
    addAdmins
    • public BMXErrorCode addAdmins(BMXGroup group, ListOfLongLong admins, String message);

    • 添加管理员

      Parameters
      • group: BMXGroup

        进行操作的群组

      • admins: ListOfLongLong

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

      • message: String

        添加为管理员的原因

      Returns BMXErrorCode
    removeAdmins
    • public BMXErrorCode removeAdmins(BMXGroup group, ListOfLongLong admins, String reason);

    • 删除管理员

      Parameters
      • group: BMXGroup

        进行操作的群组

      • admins: ListOfLongLong

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

      • reason: String

        要移除管理员的原因

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

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

      Parameters
      • group: BMXGroup

        进行操作的群组

      • list: BMXGroupMemberList

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

      • forceRefresh: boolean

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

      Returns BMXErrorCode
    blockMembers
    • public BMXErrorCode blockMembers(BMXGroup group, ListOfLongLong members);

    • 添加黑名单

      Parameters
      • group: BMXGroup

        进行操作的群组

      • members: ListOfLongLong

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

      Returns BMXErrorCode
    unblockMembers
    • public BMXErrorCode unblockMembers(BMXGroup group, ListOfLongLong members);

    • 从黑名单删除

      Parameters
      • group: BMXGroup

        进行操作的群组

      • members: ListOfLongLong

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

      Returns BMXErrorCode
    getBlockList
    • public BMXErrorCode getBlockList(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize);

    • 分页获取黑名单

      Parameters
      • group: BMXGroup

        进行操作的群组

      • result: BMXGroupMemberResultPage

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

      • cursor: String

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

      • pageSize: int

        分页大小

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

    • 获取黑名单

      Parameters
      • group: BMXGroup

        进行操作的群组

      • list: BMXGroupMemberList

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

      • forceRefresh: boolean

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

      Returns BMXErrorCode
    banMembers
    • public BMXErrorCode banMembers(BMXGroup group, ListOfLongLong members, long duration, String reason);

    • 禁言

      Parameters
      • group: BMXGroup

        进行操作的群组

      • members: ListOfLongLong

        被禁言的群成员id列表

      • duration: long

        禁言时长

      • reason: String

        禁言原因

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

    • Returns BMXErrorCode
    banGroup
    • public BMXErrorCode banGroup(BMXGroup group, long duration);

    • Parameters
      • group: BMXGroup

        进行操作的群组

      • duration: long

        禁言时长(分钟)

      Returns BMXErrorCode
    unbanMembers
    • public BMXErrorCode unbanMembers(BMXGroup group, ListOfLongLong members);

    • 解除禁言

      Parameters
      • group: BMXGroup

        进行操作的群组

      • members: ListOfLongLong

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

      Returns BMXErrorCode
    unbanGroup
    • public BMXErrorCode unbanGroup(BMXGroup group);

    • Parameters
      Returns BMXErrorCode
    getBannedMembers
    • public BMXErrorCode getBannedMembers(BMXGroup group, BMXGroupBannedMemberResultPage result, String cursor, int pageSize);

    • 分页获取禁言列表

      Parameters
      • group: BMXGroup

        进行操作的群组

      • result: BMXGroupBannedMemberResultPage

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

      • cursor: String

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

      • pageSize: int

        分页大小

      Returns BMXErrorCode
    getBannedMembers
    • public BMXErrorCode getBannedMembers(BMXGroup group, BMXGroupBannedMemberList list);

    • 获取禁言列表

      Parameters
      • group: BMXGroup

        进行操作的群组

      • list: BMXGroupBannedMemberList

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

      Returns BMXErrorCode
    muteMessage
    • public BMXErrorCode muteMessage(BMXGroup group, BMXGroup.MsgMuteMode mode);

    • 设置是否屏蔽群消息

      Parameters
      • group: BMXGroup

        进行操作的群组

      • mode: MsgMuteMode

        群屏蔽的模式

      Returns BMXErrorCode
    acceptApplication
    • public BMXErrorCode acceptApplication(BMXGroup group, long applicantId);

    • 接受入群申请

      Parameters
      • group: BMXGroup

        进行操作的群组

      • applicantId: long

        申请进群的用户id

      Returns BMXErrorCode
    declineApplication
    • public BMXErrorCode declineApplication(BMXGroup group, long applicantId, String reason);

    • 拒绝入群申请

      Parameters
      • group: BMXGroup

        进行操作的群组

      • applicantId: long

        申请进群的用户id

      • reason: String

        拒绝的原因

      Returns BMXErrorCode
    declineApplication
    • public BMXErrorCode declineApplication(BMXGroup group, long applicantId);

    • Returns BMXErrorCode
    acceptInvitation
    • public BMXErrorCode acceptInvitation(BMXGroup group, long inviter);

    • 接受入群邀请

      Parameters
      • group: BMXGroup

        进行操作的群组

      • inviter: long

        邀请者id

      Returns BMXErrorCode
    declineInvitation
    • public BMXErrorCode declineInvitation(BMXGroup group, long inviter, String reason);

    • 拒绝入群邀请

      Parameters
      • group: BMXGroup

        进行操作的群组

      • inviter: long

        邀请者id

      • reason: String

        拒绝的原因

      Returns BMXErrorCode
    declineInvitation
    • public BMXErrorCode declineInvitation(BMXGroup group, long inviter);

    • Returns BMXErrorCode
    transferOwner
    • public BMXErrorCode transferOwner(BMXGroup group, long newOwnerId);

    • 转移群主

      Parameters
      • group: BMXGroup

        进行操作的群组

      • newOwnerId: long

        转让为新群主的用户id

      Returns BMXErrorCode
    uploadSharedFile
    • public BMXErrorCode uploadSharedFile(BMXGroup group, String filePath, String displayName, String extensionName, FileProgressListener arg4);

    • 添加群共享文件

      Parameters
      • group: BMXGroup

        进行操作的群组

      • filePath: String

        文件的本地路径

      • displayName: String

        文件的展示名

      • extensionName: String

        文件的扩展名

      • arg4: FileProgressListener

        上传回调函数

      Returns BMXErrorCode
    cancelUploadSharedFile
    • public BMXErrorCode cancelUploadSharedFile(BMXGroup group, String filePath);

    • 取消上传群共享文件

      Parameters
      • group: BMXGroup

        进行操作的群组

      • filePath: String

        文件的本地路径

      Returns BMXErrorCode
    removeSharedFile
    • public BMXErrorCode removeSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile);

    • 移除群共享文件

      Parameters
      • group: BMXGroup

        进行操作的群组

      • sharedFile: SharedFile

        删除的群共享文件

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

    • 下载群共享文件

      Parameters
      • group: BMXGroup

        进行操作的群组

      • sharedFile: SharedFile

        下载的群共享文件

      • arg2: FileProgressListener

        下载回调函数

      Returns BMXErrorCode
    cancelDownloadSharedFile
    • public BMXErrorCode cancelDownloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile);

    • 取消下载群共享文件

      Parameters
      • group: BMXGroup

        进行操作的群组

      • sharedFile: SharedFile

        下载的群共享文件

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

    • 获取群共享文件列表

      Parameters
      • group: BMXGroup

        进行操作的群组

      • list: BMXGroupSharedFileList

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

      • forceRefresh: boolean

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

      Returns BMXErrorCode
    changeSharedFileName
    • public BMXErrorCode changeSharedFileName(BMXGroup group, BMXGroup.SharedFile sharedFile, String name);

    • 修改群共享文件名称

      Parameters
      • group: BMXGroup

        进行操作的群组

      • sharedFile: SharedFile

        进行更改的群共享文件

      • name: String

        修改的群共享文件名称

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

    • 获取最新的群公告

      Parameters
      • group: BMXGroup

        进行操作的群组

      • announcement: Announcement

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

      • forceRefresh: boolean

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

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

    • 获取群公告列表

      Parameters
      • group: BMXGroup

        进行操作的群组

      • list: BMXGroupAnnouncementList

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

      • forceRefresh: boolean

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

      Returns BMXErrorCode
    editAnnouncement
    • public BMXErrorCode editAnnouncement(BMXGroup group, String title, String content);

    • 设置群公告

      Parameters
      • group: BMXGroup

        进行操作的群组

      • title: String

        群公告的标题

      • content: String

        群公告的内容

      Returns BMXErrorCode
    deleteAnnouncement
    • public BMXErrorCode deleteAnnouncement(BMXGroup group, long announcementId);

    • 删除群公告

      Parameters
      • group: BMXGroup

        进行操作的群组

      • announcementId: long

        删除的群公告id

      Returns BMXErrorCode
    setName
    • public BMXErrorCode setName(BMXGroup group, String name);

    • 设置群名称

      Parameters
      • group: BMXGroup

        进行操作的群组

      • name: String

        群组名称

      Returns BMXErrorCode
    setDescription
    • public BMXErrorCode setDescription(BMXGroup group, String description);

    • 设置群描述信息

      Parameters
      • group: BMXGroup

        进行操作的群组

      • description: String

        群组描述

      Returns BMXErrorCode
    setExtension
    • public BMXErrorCode setExtension(BMXGroup group, String extension);

    • 设置群扩展信息

      Parameters
      • group: BMXGroup

        进行操作的群组

      • extension: String

        群组的扩展信息

      Returns BMXErrorCode
    setMyNickname
    • public BMXErrorCode setMyNickname(BMXGroup group, String nickname);

    • 设置在群里的昵称

      Parameters
      • group: BMXGroup

        进行操作的群组

      • nickname: String

        用户在群组内的昵称

      Returns BMXErrorCode
    setMsgPushMode
    • public BMXErrorCode setMsgPushMode(BMXGroup group, BMXGroup.MsgPushMode mode);

    • 设置群消息通知模式

      Parameters
      • group: BMXGroup

        进行操作的群组

      • mode: MsgPushMode

        群消息通知模式

      Returns BMXErrorCode
    setJoinAuthMode
    • public BMXErrorCode setJoinAuthMode(BMXGroup group, BMXGroup.JoinAuthMode mode);

    • 设置入群审批模式

      Parameters
      • group: BMXGroup

        进行操作的群组

      • mode: JoinAuthMode

        入群审批模式

      Returns BMXErrorCode
    setInviteMode
    • public BMXErrorCode setInviteMode(BMXGroup group, BMXGroup.InviteMode mode);

    • 设置邀请模式

      Parameters
      • group: BMXGroup

        进行操作的群组

      • mode: InviteMode

        群组的邀请模式

      Returns BMXErrorCode
    setAllowMemberModify
    • public BMXErrorCode setAllowMemberModify(BMXGroup group, boolean enable);

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

      Parameters
      • group: BMXGroup

        进行操作的群组

      • enable: boolean

        是否允许操作

      Returns BMXErrorCode
    setEnableReadAck
    • public BMXErrorCode setEnableReadAck(BMXGroup group, boolean enable);

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

      Parameters
      • group: BMXGroup

        进行操作的群组

      • enable: boolean

        是否开启

      Returns BMXErrorCode
    setHistoryVisible
    • public BMXErrorCode setHistoryVisible(BMXGroup group, boolean enable);

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

      Parameters
      • group: BMXGroup

        进行操作的群组

      • enable: boolean

        是否开启

      Returns BMXErrorCode
    setAvatar
    • public BMXErrorCode setAvatar(BMXGroup group, String avatarPath, FileProgressListener arg2);

    • 设置群头像

      Parameters
      • group: BMXGroup

        进行操作的群组

      • avatarPath: String

        群头像文件的本地路径

      • arg2: FileProgressListener

        上传回调函数

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

    • 下载群头像

      Parameters
      • group: BMXGroup

        进行操作的群组

      • thumbnail: boolean

        设置为true下载缩略图，false下载原图

      • arg2: FileProgressListener

        下载回调函数

      Returns BMXErrorCode
    addGroupListener
    • public void addGroupListener(BMXGroupServiceListener listener);

    • 添加群组变化监听者

      Parameters
      Returns void
    removeGroupListener
    • public void removeGroupListener(BMXGroupServiceListener listener);

    • 移除群组变化监听者

      Parameters
      Returns void
    以上内容是否对您有帮助？
    • Qvm free helper
    Close