floo2
Classes | Public Types | Public Member Functions | List of all members
floo::BMXGroupService Class Referenceabstract

群组Service More...

#include <bmx_group_service.h>

Classes

struct  CreateGroupOptions
 创建群组选项 More...
 

Public Types

typedef std::function< void(int percent)> Callback
 
typedef std::shared_ptr< CreateGroupOptionsCreateGroupOptionsPtr
 

Public Member Functions

virtual BMXErrorCode get (BMXGroupList &list, bool forceRefresh)=0
 获取群组列表,如果设置了forceRefresh则从服务器拉取 More...
 
virtual BMXErrorCode search (BMXGroupList &list, bool forceRefresh)=0
 获取群组列表,如果设置了forceRefresh则从服务器拉取 More...
 
virtual BMXErrorCode fetchGroupsByIdList (const std::vector< int64_t > &groupIdList, BMXGroupList &list, bool forceRefresh)=0
 通过传入群组的id列表获取群组信息列表,如果设置了forceRefresh则从服务器拉取 More...
 
virtual BMXErrorCode search (const std::vector< int64_t > &groupIdList, BMXGroupList &list, bool forceRefresh)=0
 获取传入群组id的群组信息列表,如果设置了forceRefresh则从服务器拉取 More...
 
virtual BMXErrorCode fetchGroupById (int64_t groupId, BMXGroupPtr &group, bool forceRefresh)=0
 通过群组id获取群信息,如果设置了forceRefresh则从服务器拉取 More...
 
virtual BMXErrorCode search (int64_t groupId, BMXGroupPtr &group, bool forceRefresh)=0
 获取群信息,如果设置了forceRefresh则从服务器拉取 More...
 
virtual BMXErrorCode fetchLocalGroupsByName (BMXGroupList &list, const std::string &name)=0
 通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组 More...
 
virtual BMXErrorCode search (BMXGroupList &list, const std::string &name)=0
 通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组 More...
 
virtual BMXErrorCode create (const CreateGroupOptions &options, BMXGroupPtr &group)=0
 创建群 More...
 
virtual BMXErrorCode destroy (BMXGroupPtr group)=0
 销毁群 More...
 
virtual BMXErrorCode join (BMXGroupPtr group, const std::string &message)=0
 加入一个群,根据群设置可能需要管理员批准 More...
 
virtual BMXErrorCode leave (BMXGroupPtr group)=0
 退出群 More...
 
virtual BMXErrorCode getInfo (BMXGroupPtr group)=0
 获取群详情,从服务端拉取最新信息 More...
 
virtual BMXErrorCode getMembersNickname (BMXGroupPtr group, const std::vector< int64_t > &members, BMXGroup::MemberList &list)=0
 获取群组成员详细信息 More...
 
virtual BMXErrorCode getInvitationList (BMXGroupInvitationPagePtr &result, const std::string &cursor="", int pageSize=10)=0
 分页获取群组邀请列表 More...
 
virtual BMXErrorCode getApplicationList (BMXGroupList list, BMXGroupApplicationPagePtr &result, const std::string &cursor="", int pageSize=10)=0
 分页获取群组申请列表 More...
 
virtual BMXErrorCode getMembers (BMXGroupPtr group, BMXGroupMemberResultPagePtr &result, const std::string &cursor="", int pageSize=200)=0
 分页获取群成员列表,如果设置了forceRefresh则从服务器拉取,单页最大数量为500. More...
 
virtual BMXErrorCode getMembers (BMXGroupPtr group, BMXGroup::MemberList &list, bool forceRefresh)=0
 获取群成员列表,如果设置了forceRefresh则从服务器拉取,最多拉取1000人 More...
 
virtual BMXErrorCode addMembers (BMXGroupPtr group, const std::vector< int64_t > &members, const std::string &message)=0
 添加群成员 More...
 
virtual BMXErrorCode removeMembers (BMXGroupPtr group, const std::vector< int64_t > &members, const std::string &reason)=0
 删除群成员 More...
 
virtual BMXErrorCode addAdmins (BMXGroupPtr group, const std::vector< int64_t > &admins, const std::string &message)=0
 添加管理员 More...
 
virtual BMXErrorCode removeAdmins (BMXGroupPtr group, const std::vector< int64_t > &admins, const std::string &reason)=0
 删除管理员 More...
 
virtual BMXErrorCode getAdmins (BMXGroupPtr group, BMXGroup::MemberList &list, bool forceRefresh)=0
 获取Admins列表,如果设置了forceRefresh则从服务器拉取 More...
 
virtual BMXErrorCode blockMembers (BMXGroupPtr group, const std::vector< int64_t > &members)=0
 添加黑名单 More...
 
virtual BMXErrorCode unblockMembers (BMXGroupPtr group, const std::vector< int64_t > &members)=0
 从黑名单删除 More...
 
virtual BMXErrorCode getBlockList (BMXGroupPtr group, BMXGroupMemberResultPagePtr &result, const std::string &cursor="", int pageSize=200)=0
 分页获取黑名单 More...
 
virtual BMXErrorCode getBlockList (BMXGroupPtr group, BMXGroup::MemberList &list, bool forceRefresh)=0
 获取黑名单 More...
 
virtual BMXErrorCode banMembers (BMXGroupPtr group, const std::vector< int64_t > &members, int64_t duration, const std::string &reason="")=0
 禁言 More...
 
virtual BMXErrorCode unbanMembers (BMXGroupPtr group, const std::vector< int64_t > &members)=0
 解除禁言 More...
 
virtual BMXErrorCode getBannedMembers (BMXGroupPtr group, BMXGroupBannedMemberResultPagePtr &result, const std::string &cursor="", int pageSize=200)=0
 分页获取禁言列表 More...
 
virtual BMXErrorCode getBannedMembers (BMXGroupPtr group, BMXGroup::BannedMemberList &list)=0
 获取禁言列表 More...
 
virtual BMXErrorCode muteMessage (BMXGroupPtr group, BMXGroup::MsgMuteMode mode)=0
 设置是否屏蔽群消息 More...
 
virtual BMXErrorCode acceptApplication (BMXGroupPtr group, int64_t applicantId)=0
 接受入群申请 More...
 
virtual BMXErrorCode declineApplication (BMXGroupPtr group, int64_t applicantId, const std::string &reason="")=0
 拒绝入群申请 More...
 
virtual BMXErrorCode acceptInvitation (BMXGroupPtr group, int64_t inviter)=0
 接受入群邀请 More...
 
virtual BMXErrorCode declineInvitation (BMXGroupPtr group, int64_t inviter, const std::string &reason="")=0
 拒绝入群邀请 More...
 
virtual BMXErrorCode transferOwner (BMXGroupPtr group, int64_t newOwnerId)=0
 转移群主 More...
 
virtual BMXErrorCode uploadSharedFile (BMXGroupPtr group, const std::string &filePath, const std::string &displayName, const std::string &extensionName, Callback)=0
 添加群共享文件 More...
 
virtual BMXErrorCode cancelUploadSharedFile (BMXGroupPtr group, const std::string &filePath)=0
 取消上传群共享文件 More...
 
virtual BMXErrorCode removeSharedFile (BMXGroupPtr group, BMXGroup::SharedFilePtr sharedFile)=0
 移除群共享文件 More...
 
virtual BMXErrorCode downloadSharedFile (BMXGroupPtr group, BMXGroup::SharedFilePtr sharedFile, Callback)=0
 下载群共享文件 More...
 
virtual BMXErrorCode cancelDownloadSharedFile (BMXGroupPtr group, BMXGroup::SharedFilePtr sharedFile)=0
 取消下载群共享文件 More...
 
virtual BMXErrorCode getSharedFilesList (BMXGroupPtr group, BMXGroup::SharedFileList &list, bool forceRefresh)=0
 获取群共享文件列表 More...
 
virtual BMXErrorCode changeSharedFileName (BMXGroupPtr group, BMXGroup::SharedFilePtr sharedFile, const std::string &name)=0
 修改群共享文件名称 More...
 
virtual BMXErrorCode getLatestAnnouncement (BMXGroupPtr group, BMXGroup::AnnouncementPtr &announcement, bool forceRefresh)=0
 获取最新的群公告 More...
 
virtual BMXErrorCode getAnnouncementList (BMXGroupPtr group, BMXGroup::AnnouncementList &list, bool forceRefresh)=0
 获取群公告列表 More...
 
virtual BMXErrorCode editAnnouncement (BMXGroupPtr group, const std::string &title, const std::string &content)=0
 设置群公告 More...
 
virtual BMXErrorCode deleteAnnouncement (BMXGroupPtr group, int64_t announcementId)=0
 删除群公告 More...
 
virtual BMXErrorCode setName (BMXGroupPtr group, const std::string &name)=0
 设置群名称 More...
 
virtual BMXErrorCode setDescription (BMXGroupPtr group, const std::string &description)=0
 设置群描述信息 More...
 
virtual BMXErrorCode setExtension (BMXGroupPtr group, const std::string &extension)=0
 设置群扩展信息 More...
 
virtual BMXErrorCode setMyNickname (BMXGroupPtr group, const std::string &nickname)=0
 设置在群里的昵称 More...
 
virtual BMXErrorCode setMsgPushMode (BMXGroupPtr group, BMXGroup::MsgPushMode mode)=0
 设置群消息通知模式 More...
 
virtual BMXErrorCode setJoinAuthMode (BMXGroupPtr group, BMXGroup::JoinAuthMode mode)=0
 设置入群审批模式 More...
 
virtual BMXErrorCode setInviteMode (BMXGroupPtr group, BMXGroup::InviteMode mode)=0
 设置邀请模式 More...
 
virtual BMXErrorCode setAllowMemberModify (BMXGroupPtr group, bool enable)=0
 设置是否允许群成员设置群信息 More...
 
virtual BMXErrorCode setEnableReadAck (BMXGroupPtr group, bool enable)=0
 设置是否开启群消息已读功能 More...
 
virtual BMXErrorCode setHistoryVisible (BMXGroupPtr group, bool enable)=0
 设置群成员是否开可见群历史聊天记录 More...
 
virtual BMXErrorCode setAvatar (BMXGroupPtr group, const std::string &avatarPath, Callback)=0
 设置群头像 More...
 
virtual BMXErrorCode downloadAvatar (BMXGroupPtr group, bool thumbnail=true, Callback callback=[](int){})=0
 下载群头像 More...
 
virtual void addGroupListener (BMXGroupServiceListener *listener)=0
 添加群组变化监听者 More...
 
virtual void removeGroupListener (BMXGroupServiceListener *listener)=0
 移除群组变化监听者 More...
 

Detailed Description

群组Service

Member Function Documentation

◆ acceptApplication()

virtual BMXErrorCode floo::BMXGroupService::acceptApplication ( BMXGroupPtr  group,
int64_t  applicantId 
)
pure virtual

接受入群申请

Parameters
group进行操作的群组
applicantId申请进群的用户id
Returns
BMXErrorCode

◆ acceptInvitation()

virtual BMXErrorCode floo::BMXGroupService::acceptInvitation ( BMXGroupPtr  group,
int64_t  inviter 
)
pure virtual

接受入群邀请

Parameters
group进行操作的群组
inviter邀请者id
Returns
BMXErrorCode

◆ addAdmins()

virtual BMXErrorCode floo::BMXGroupService::addAdmins ( BMXGroupPtr  group,
const std::vector< int64_t > &  admins,
const std::string &  message 
)
pure virtual

添加管理员

Parameters
group进行操作的群组
admins要添加为管理员的成员id列表
message添加为管理员的原因
Returns
BMXErrorCode

◆ addGroupListener()

virtual void floo::BMXGroupService::addGroupListener ( BMXGroupServiceListener listener)
pure virtual

添加群组变化监听者

Parameters
listener群组变化监听者

◆ addMembers()

virtual BMXErrorCode floo::BMXGroupService::addMembers ( BMXGroupPtr  group,
const std::vector< int64_t > &  members,
const std::string &  message 
)
pure virtual

添加群成员

Parameters
group进行操作的群组
members要添加进群的成员id列表
message添加成员原因信息
Returns
BMXErrorCode

◆ banMembers()

virtual BMXErrorCode floo::BMXGroupService::banMembers ( BMXGroupPtr  group,
const std::vector< int64_t > &  members,
int64_t  duration,
const std::string &  reason = "" 
)
pure virtual

禁言

Parameters
group进行操作的群组
members被禁言的群成员id列表
duration禁言时长
reason禁言原因
Returns
BMXErrorCode

◆ blockMembers()

virtual BMXErrorCode floo::BMXGroupService::blockMembers ( BMXGroupPtr  group,
const std::vector< int64_t > &  members 
)
pure virtual

添加黑名单

Parameters
group进行操作的群组
members要加入黑名单的群成员id列表
Returns
BMXErrorCode

◆ cancelDownloadSharedFile()

virtual BMXErrorCode floo::BMXGroupService::cancelDownloadSharedFile ( BMXGroupPtr  group,
BMXGroup::SharedFilePtr  sharedFile 
)
pure virtual

取消下载群共享文件

Parameters
group进行操作的群组
sharedFile下载的群共享文件
Returns
BMXErrorCode

◆ cancelUploadSharedFile()

virtual BMXErrorCode floo::BMXGroupService::cancelUploadSharedFile ( BMXGroupPtr  group,
const std::string &  filePath 
)
pure virtual

取消上传群共享文件

Parameters
group进行操作的群组
filePath文件的本地路径
Returns
BMXErrorCode

◆ changeSharedFileName()

virtual BMXErrorCode floo::BMXGroupService::changeSharedFileName ( BMXGroupPtr  group,
BMXGroup::SharedFilePtr  sharedFile,
const std::string &  name 
)
pure virtual

修改群共享文件名称

Parameters
group进行操作的群组
sharedFile进行更改的群共享文件
name修改的群共享文件名称
Returns
BMXErrorCode

◆ create()

virtual BMXErrorCode floo::BMXGroupService::create ( const CreateGroupOptions options,
BMXGroupPtr &  group 
)
pure virtual

创建群

Parameters
options创建群组时传入的参数选项
group创建返回的结果,传入指向为空的shared_ptr对象函数执行后从此获取返回结果
Returns
BMXErrorCode

◆ declineApplication()

virtual BMXErrorCode floo::BMXGroupService::declineApplication ( BMXGroupPtr  group,
int64_t  applicantId,
const std::string &  reason = "" 
)
pure virtual

拒绝入群申请

Parameters
group进行操作的群组
applicantId申请进群的用户id
reason拒绝的原因
Returns
BMXErrorCode

◆ declineInvitation()

virtual BMXErrorCode floo::BMXGroupService::declineInvitation ( BMXGroupPtr  group,
int64_t  inviter,
const std::string &  reason = "" 
)
pure virtual

拒绝入群邀请

Parameters
group进行操作的群组
inviter邀请者id
reason拒绝的原因
Returns
BMXErrorCode

◆ deleteAnnouncement()

virtual BMXErrorCode floo::BMXGroupService::deleteAnnouncement ( BMXGroupPtr  group,
int64_t  announcementId 
)
pure virtual

删除群公告

Parameters
group进行操作的群组
announcementId删除的群公告id
Returns
BMXErrorCode

◆ destroy()

virtual BMXErrorCode floo::BMXGroupService::destroy ( BMXGroupPtr  group)
pure virtual

销毁群

Parameters
group要销毁的群组
Returns
BMXErrorCode

◆ downloadAvatar()

virtual BMXErrorCode floo::BMXGroupService::downloadAvatar ( BMXGroupPtr  group,
bool  thumbnail = true,
Callback  callback = [](int){} 
)
pure virtual

下载群头像

Parameters
group进行操作的群组
thumbnail设置为true下载缩略图,false下载原图
callback下载回调函数
Returns
BMXErrorCode

◆ downloadSharedFile()

virtual BMXErrorCode floo::BMXGroupService::downloadSharedFile ( BMXGroupPtr  group,
BMXGroup::SharedFilePtr  sharedFile,
Callback   
)
pure virtual

下载群共享文件

Parameters
group进行操作的群组
sharedFile下载的群共享文件
Callback下载回调函数
Returns
BMXErrorCode

◆ editAnnouncement()

virtual BMXErrorCode floo::BMXGroupService::editAnnouncement ( BMXGroupPtr  group,
const std::string &  title,
const std::string &  content 
)
pure virtual

设置群公告

Parameters
group进行操作的群组
title群公告的标题
content群公告的内容
Returns
BMXErrorCode

◆ fetchGroupById()

virtual BMXErrorCode floo::BMXGroupService::fetchGroupById ( int64_t  groupId,
BMXGroupPtr &  group,
bool  forceRefresh 
)
pure virtual

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

Parameters
groupId要搜索的群组id
group搜索返回的群组信息,传入指向为空的shared_ptr对象函数执行后从此获取返回结果
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ fetchGroupsByIdList()

virtual BMXErrorCode floo::BMXGroupService::fetchGroupsByIdList ( const std::vector< int64_t > &  groupIdList,
BMXGroupList &  list,
bool  forceRefresh 
)
pure virtual

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

Parameters
groupIdList群组id列表
list群组详细信息列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ fetchLocalGroupsByName()

virtual BMXErrorCode floo::BMXGroupService::fetchLocalGroupsByName ( BMXGroupList &  list,
const std::string &  name 
)
pure virtual

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

Parameters
list搜索结果返回的群列表信息
name查询的群名称关键字
Returns
BMXErrorCode

◆ get()

virtual BMXErrorCode floo::BMXGroupService::get ( BMXGroupList &  list,
bool  forceRefresh 
)
pure virtual

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

Parameters
list群组id列表,传入空列表函数返回后从此处获取返回的群组id列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ getAdmins()

virtual BMXErrorCode floo::BMXGroupService::getAdmins ( BMXGroupPtr  group,
BMXGroup::MemberList &  list,
bool  forceRefresh 
)
pure virtual

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

Parameters
group进行操作的群组
list群管理员列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ getAnnouncementList()

virtual BMXErrorCode floo::BMXGroupService::getAnnouncementList ( BMXGroupPtr  group,
BMXGroup::AnnouncementList &  list,
bool  forceRefresh 
)
pure virtual

获取群公告列表

Parameters
group进行操作的群组
list群公告列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ getApplicationList()

virtual BMXErrorCode floo::BMXGroupService::getApplicationList ( BMXGroupList  list,
BMXGroupApplicationPagePtr &  result,
const std::string &  cursor = "",
int  pageSize = 10 
)
pure virtual

分页获取群组申请列表

Parameters
list需要获取群组申请列表信息的群组id列表
result分页获取的群组申请列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
cursor分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
pageSize分页大小
Returns
BMXErrorCode

◆ getBannedMembers() [1/2]

virtual BMXErrorCode floo::BMXGroupService::getBannedMembers ( BMXGroupPtr  group,
BMXGroupBannedMemberResultPagePtr &  result,
const std::string &  cursor = "",
int  pageSize = 200 
)
pure virtual

分页获取禁言列表

Parameters
group进行操作的群组
result分页获取的禁言列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
cursor分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
pageSize分页大小
Returns
BMXErrorCode

◆ getBannedMembers() [2/2]

virtual BMXErrorCode floo::BMXGroupService::getBannedMembers ( BMXGroupPtr  group,
BMXGroup::BannedMemberList &  list 
)
pure virtual

获取禁言列表

Parameters
group进行操作的群组
list群禁言列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
Returns
BMXErrorCode

◆ getBlockList() [1/2]

virtual BMXErrorCode floo::BMXGroupService::getBlockList ( BMXGroupPtr  group,
BMXGroupMemberResultPagePtr &  result,
const std::string &  cursor = "",
int  pageSize = 200 
)
pure virtual

分页获取黑名单

Parameters
group进行操作的群组
result分页获取的黑名单列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
cursor分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
pageSize分页大小
Returns
BMXErrorCode

◆ getBlockList() [2/2]

virtual BMXErrorCode floo::BMXGroupService::getBlockList ( BMXGroupPtr  group,
BMXGroup::MemberList &  list,
bool  forceRefresh 
)
pure virtual

获取黑名单

Parameters
group进行操作的群组
list群黑名单列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ getInfo()

virtual BMXErrorCode floo::BMXGroupService::getInfo ( BMXGroupPtr  group)
pure virtual

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

Parameters
group要获取群组最新信息的群组
Returns
BMXErrorCode

◆ getInvitationList()

virtual BMXErrorCode floo::BMXGroupService::getInvitationList ( BMXGroupInvitationPagePtr &  result,
const std::string &  cursor = "",
int  pageSize = 10 
)
pure virtual

分页获取群组邀请列表

Parameters
result分页获取的群组邀请列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
cursor分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
pageSize分页大小
Returns
BMXErrorCode

◆ getLatestAnnouncement()

virtual BMXErrorCode floo::BMXGroupService::getLatestAnnouncement ( BMXGroupPtr  group,
BMXGroup::AnnouncementPtr &  announcement,
bool  forceRefresh 
)
pure virtual

获取最新的群公告

Parameters
group进行操作的群组
announcement最新的群组公告,传入指向为空的shared_ptr对象函数返回后从此处获取最新的群组公告
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ getMembers() [1/2]

virtual BMXErrorCode floo::BMXGroupService::getMembers ( BMXGroupPtr  group,
BMXGroupMemberResultPagePtr &  result,
const std::string &  cursor = "",
int  pageSize = 200 
)
pure virtual

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

Parameters
group进行操作的群组
result分页获取的群成员列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
cursor分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
pageSize分页大小
Returns
BMXErrorCode

◆ getMembers() [2/2]

virtual BMXErrorCode floo::BMXGroupService::getMembers ( BMXGroupPtr  group,
BMXGroup::MemberList &  list,
bool  forceRefresh 
)
pure virtual

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

Parameters
group进行操作的群组
list群成员列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ getMembersNickname()

virtual BMXErrorCode floo::BMXGroupService::getMembersNickname ( BMXGroupPtr  group,
const std::vector< int64_t > &  members,
BMXGroup::MemberList &  list 
)
pure virtual

获取群组成员详细信息

Parameters
group进行操作的群组
members要获取群组成员信息详情的群成员id
list返回的群成员详细,传入空列表在函数操作后从此处获取群成员详细信息列表
Returns
BMXErrorCode

◆ getSharedFilesList()

virtual BMXErrorCode floo::BMXGroupService::getSharedFilesList ( BMXGroupPtr  group,
BMXGroup::SharedFileList &  list,
bool  forceRefresh 
)
pure virtual

获取群共享文件列表

Parameters
group进行操作的群组
list群共享文件列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ join()

virtual BMXErrorCode floo::BMXGroupService::join ( BMXGroupPtr  group,
const std::string &  message 
)
pure virtual

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

Parameters
group要加入的群组
message申请入群的信息
Returns
BMXErrorCode

◆ leave()

virtual BMXErrorCode floo::BMXGroupService::leave ( BMXGroupPtr  group)
pure virtual

退出群

Parameters
group要退出的群组
Returns
BMXErrorCode

◆ muteMessage()

virtual BMXErrorCode floo::BMXGroupService::muteMessage ( BMXGroupPtr  group,
BMXGroup::MsgMuteMode  mode 
)
pure virtual

设置是否屏蔽群消息

Parameters
group进行操作的群组
mode群屏蔽的模式
Returns
BMXErrorCode

◆ removeAdmins()

virtual BMXErrorCode floo::BMXGroupService::removeAdmins ( BMXGroupPtr  group,
const std::vector< int64_t > &  admins,
const std::string &  reason 
)
pure virtual

删除管理员

Parameters
group进行操作的群组
admins要从管理员移除的成员id列表
reason要移除管理员的原因
Returns
BMXErrorCode

◆ removeGroupListener()

virtual void floo::BMXGroupService::removeGroupListener ( BMXGroupServiceListener listener)
pure virtual

移除群组变化监听者

Parameters
listener群组变化监听者

◆ removeMembers()

virtual BMXErrorCode floo::BMXGroupService::removeMembers ( BMXGroupPtr  group,
const std::vector< int64_t > &  members,
const std::string &  reason 
)
pure virtual

删除群成员

Parameters
group进行操作的群组
members要删除的群组成员id列表
reason删除的原因
Returns
BMXErrorCode

◆ removeSharedFile()

virtual BMXErrorCode floo::BMXGroupService::removeSharedFile ( BMXGroupPtr  group,
BMXGroup::SharedFilePtr  sharedFile 
)
pure virtual

移除群共享文件

Parameters
group进行操作的群组
sharedFile删除的群共享文件
Returns
BMXErrorCode

◆ search() [1/4]

virtual BMXErrorCode floo::BMXGroupService::search ( BMXGroupList &  list,
bool  forceRefresh 
)
pure virtual

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

Deprecated. use get instead.

Parameters
list群组id列表,传入空列表函数返回后从此处获取返回的群组id列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ search() [2/4]

virtual BMXErrorCode floo::BMXGroupService::search ( const std::vector< int64_t > &  groupIdList,
BMXGroupList &  list,
bool  forceRefresh 
)
pure virtual

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

Deprecated. use fetchGroupsByIdList instead.

Parameters
groupIdList群组id列表
list群组详细信息列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ search() [3/4]

virtual BMXErrorCode floo::BMXGroupService::search ( int64_t  groupId,
BMXGroupPtr &  group,
bool  forceRefresh 
)
pure virtual

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

Deprecated. use fetchGroupById instead.

Parameters
groupId要搜索的群组id
group搜索返回的群组信息,传入指向为空的shared_ptr对象函数执行后从此获取返回结果
forceRefresh设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Returns
BMXErrorCode

◆ search() [4/4]

virtual BMXErrorCode floo::BMXGroupService::search ( BMXGroupList &  list,
const std::string &  name 
)
pure virtual

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

Deprecated. use fetchLocalGroupsByName instead.

Parameters
list搜索结果返回的群列表信息
name查询的群名称关键字
Returns
BMXErrorCode

◆ setAllowMemberModify()

virtual BMXErrorCode floo::BMXGroupService::setAllowMemberModify ( BMXGroupPtr  group,
bool  enable 
)
pure virtual

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

Parameters
group进行操作的群组
enable是否允许操作
Returns
BMXErrorCode

◆ setAvatar()

virtual BMXErrorCode floo::BMXGroupService::setAvatar ( BMXGroupPtr  group,
const std::string &  avatarPath,
Callback   
)
pure virtual

设置群头像

Parameters
group进行操作的群组
avatarPath群头像文件的本地路径
Callback上传回调函数
Returns
BMXErrorCode

◆ setDescription()

virtual BMXErrorCode floo::BMXGroupService::setDescription ( BMXGroupPtr  group,
const std::string &  description 
)
pure virtual

设置群描述信息

Parameters
group进行操作的群组
description群组描述
Returns
BMXErrorCode

◆ setEnableReadAck()

virtual BMXErrorCode floo::BMXGroupService::setEnableReadAck ( BMXGroupPtr  group,
bool  enable 
)
pure virtual

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

Parameters
group进行操作的群组
enable是否开启
Returns
BMXErrorCode

◆ setExtension()

virtual BMXErrorCode floo::BMXGroupService::setExtension ( BMXGroupPtr  group,
const std::string &  extension 
)
pure virtual

设置群扩展信息

Parameters
group进行操作的群组
extension群组的扩展信息
Returns
BMXErrorCode

◆ setHistoryVisible()

virtual BMXErrorCode floo::BMXGroupService::setHistoryVisible ( BMXGroupPtr  group,
bool  enable 
)
pure virtual

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

Parameters
group进行操作的群组
enable是否开启
Returns
BMXErrorCode

◆ setInviteMode()

virtual BMXErrorCode floo::BMXGroupService::setInviteMode ( BMXGroupPtr  group,
BMXGroup::InviteMode  mode 
)
pure virtual

设置邀请模式

Parameters
group进行操作的群组
mode群组的邀请模式
Returns
BMXErrorCode

◆ setJoinAuthMode()

virtual BMXErrorCode floo::BMXGroupService::setJoinAuthMode ( BMXGroupPtr  group,
BMXGroup::JoinAuthMode  mode 
)
pure virtual

设置入群审批模式

Parameters
group进行操作的群组
mode入群审批模式
Returns
BMXErrorCode

◆ setMsgPushMode()

virtual BMXErrorCode floo::BMXGroupService::setMsgPushMode ( BMXGroupPtr  group,
BMXGroup::MsgPushMode  mode 
)
pure virtual

设置群消息通知模式

Parameters
group进行操作的群组
mode群消息通知模式
Returns
BMXErrorCode

◆ setMyNickname()

virtual BMXErrorCode floo::BMXGroupService::setMyNickname ( BMXGroupPtr  group,
const std::string &  nickname 
)
pure virtual

设置在群里的昵称

Parameters
group进行操作的群组
nickname用户在群组内的昵称
Returns
BMXErrorCode

◆ setName()

virtual BMXErrorCode floo::BMXGroupService::setName ( BMXGroupPtr  group,
const std::string &  name 
)
pure virtual

设置群名称

Parameters
group进行操作的群组
name群组名称
Returns
BMXErrorCode

◆ transferOwner()

virtual BMXErrorCode floo::BMXGroupService::transferOwner ( BMXGroupPtr  group,
int64_t  newOwnerId 
)
pure virtual

转移群主

Parameters
group进行操作的群组
newOwnerId转让为新群主的用户id
Returns
BMXErrorCode

◆ unbanMembers()

virtual BMXErrorCode floo::BMXGroupService::unbanMembers ( BMXGroupPtr  group,
const std::vector< int64_t > &  members 
)
pure virtual

解除禁言

Parameters
group进行操作的群组
members被解除禁言的群成员id列表
Returns
BMXErrorCode

◆ unblockMembers()

virtual BMXErrorCode floo::BMXGroupService::unblockMembers ( BMXGroupPtr  group,
const std::vector< int64_t > &  members 
)
pure virtual

从黑名单删除

Parameters
group进行操作的群组
members从黑名单移除的用户id列表
Returns
BMXErrorCode

◆ uploadSharedFile()

virtual BMXErrorCode floo::BMXGroupService::uploadSharedFile ( BMXGroupPtr  group,
const std::string &  filePath,
const std::string &  displayName,
const std::string &  extensionName,
Callback   
)
pure virtual

添加群共享文件

Parameters
group进行操作的群组
filePath文件的本地路径
displayName文件的展示名
extensionName文件的扩展名
Callback上传回调函数
Returns
BMXErrorCode

The documentation for this class was generated from the following file: