im::floo::floolib::BMXGroupService
群组Service
Public Classes
Name | |
---|---|
class | CreateGroupOptions 创建群组选项 |
Public Functions
Name | |
---|---|
synchronized void | delete() |
[BMXErrorCode] | get(BMXGroupList list, boolean forceRefresh) 获取群组列表,如果设置了forceRefresh则从服务器拉取 |
[BMXErrorCode] | search(BMXGroupList list, boolean forceRefresh) 获取群组列表,如果设置了forceRefresh则从服务器拉取 |
[BMXErrorCode] | fetchGroupsByIdList(ListOfLongLong groupIdList, BMXGroupList list, boolean forceRefresh) 获取传入群组id的群组信息列表,如果设置了forceRefresh则从服务器拉取 |
[BMXErrorCode] | search(ListOfLongLong groupIdList, BMXGroupList list, boolean forceRefresh) 获取传入群组id的群组信息列表,如果设置了forceRefresh则从服务器拉取 |
[BMXErrorCode] | fetchGroupById(long groupId, BMXGroup group, boolean forceRefresh) 获取群信息,如果设置了forceRefresh则从服务器拉取 |
[BMXErrorCode] | search(long groupId, BMXGroup group, boolean forceUpdate) 获取群信息,如果设置了forceRefresh则从服务器拉取 |
[BMXErrorCode] | fetchLocalGroupsByName(BMXGroupList list, String name) 通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组 |
[BMXErrorCode] | search(BMXGroupList list, String name) 通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组 |
[BMXErrorCode] | create(BMXGroupService.CreateGroupOptions options, BMXGroup group) 创建群 |
[BMXErrorCode] | destroy(BMXGroup group) 销毁群 |
[BMXErrorCode] | join(BMXGroup group, String message) 加入一个群,根据群设置可能需要管理员批准 |
[BMXErrorCode] | leave(BMXGroup group) 退出群 |
[BMXErrorCode] | getInfo(BMXGroup group) 获取群详情,从服务端拉取最新信息 |
[BMXErrorCode] | getMembersNickname(BMXGroup group, ListOfLongLong members, BMXGroupMemberList list) 获取群组成员详细信息 |
[BMXErrorCode] | getInvitationList(GroupInvitaionPage result, String cursor, int pageSize) 分页获取群组邀请列表 |
[BMXErrorCode] | getApplicationList(BMXGroupList list, GroupApplicationPage result, String cursor, int pageSize) 分页获取群组申请列表 |
[BMXErrorCode] | getMembers(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize) 分页获取群成员列表,如果设置了forceRefresh则从服务器拉取,单页最大数量为500. |
[BMXErrorCode] | getMembers(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh) 获取群成员列表,如果设置了forceRefresh则从服务器拉取,最多拉取1000人 |
[BMXErrorCode] | addMembers(BMXGroup group, ListOfLongLong members, String message) 添加群成员 |
[BMXErrorCode] | removeMembers(BMXGroup group, ListOfLongLong members, String reason) 删除群成员 |
[BMXErrorCode] | addAdmins(BMXGroup group, ListOfLongLong admins, String message) 添加管理员 |
[BMXErrorCode] | removeAdmins(BMXGroup group, ListOfLongLong admins, String reason) 删除管理员 |
[BMXErrorCode] | getAdmins(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh) 获取Admins列表,如果设置了forceRefresh则从服务器拉取 |
[BMXErrorCode] | blockMembers(BMXGroup group, ListOfLongLong members) 添加黑名单 |
[BMXErrorCode] | unblockMembers(BMXGroup group, ListOfLongLong members) 从黑名单删除 |
[BMXErrorCode] | getBlockList(BMXGroup group, BMXGroupMemberResultPage result, String cursor, int pageSize) 分页获取黑名单 |
[BMXErrorCode] | getBlockList(BMXGroup group, BMXGroupMemberList list, boolean forceRefresh) 获取黑名单 |
[BMXErrorCode] | banMembers(BMXGroup group, ListOfLongLong members, long duration, String reason) 禁言 |
[BMXErrorCode] | banMembers(BMXGroup group, ListOfLongLong members, long duration) |
[BMXErrorCode] | banGroup(BMXGroup group, long duration) 全员禁言,当前服务器时间加上禁言时长后计算出全员禁言到期时间(只有管理和群主可以发言) |
[BMXErrorCode] | unbanMembers(BMXGroup group, ListOfLongLong members) 解除禁言 |
[BMXErrorCode] | unbanGroup(BMXGroup group) 全员解除禁言 |
[BMXErrorCode] | getBannedMembers(BMXGroup group, BMXGroupBannedMemberResultPage result, String cursor, int pageSize) 分页获取禁言列表 |
[BMXErrorCode] | getBannedMembers(BMXGroup group, BMXGroupBannedMemberList list) 获取禁言列表 |
[BMXErrorCode] | muteMessage(BMXGroup group, BMXGroup.MsgMuteMode mode) 设置是否屏蔽群消息 |
[BMXErrorCode] | acceptApplication(BMXGroup group, long applicantId) 接受入群申请 |
[BMXErrorCode] | declineApplication(BMXGroup group, long applicantId, String reason) 拒绝入群申请 |
[BMXErrorCode] | declineApplication(BMXGroup group, long applicantId) |
[BMXErrorCode] | acceptInvitation(BMXGroup group, long inviter) 接受入群邀请 |
[BMXErrorCode] | declineInvitation(BMXGroup group, long inviter, String reason) 拒绝入群邀请 |
[BMXErrorCode] | declineInvitation(BMXGroup group, long inviter) |
[BMXErrorCode] | transferOwner(BMXGroup group, long newOwnerId) 转移群主 |
[BMXErrorCode] | uploadSharedFile(BMXGroup group, String filePath, String displayName, String extensionName, FileProgressListener arg4) 添加群共享文件 |
[BMXErrorCode] | cancelUploadSharedFile(BMXGroup group, String filePath) 取消上传群共享文件 |
[BMXErrorCode] | removeSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile) 移除群共享文件 |
[BMXErrorCode] | downloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, FileProgressListener arg2) 下载群共享文件 |
[BMXErrorCode] | cancelDownloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile) 取消下载群共享文件 |
[BMXErrorCode] | getSharedFilesList(BMXGroup group, BMXGroupSharedFileList list, boolean forceRefresh) 获取群共享文件列表 |
[BMXErrorCode] | changeSharedFileName(BMXGroup group, BMXGroup.SharedFile sharedFile, String name) 修改群共享文件名称 |
[BMXErrorCode] | getLatestAnnouncement(BMXGroup group, BMXGroup.Announcement announcement, boolean forceRefresh) 获取最新的群公告 |
[BMXErrorCode] | getAnnouncementList(BMXGroup group, BMXGroupAnnouncementList list, boolean forceRefresh) 获取群公告列表 |
[BMXErrorCode] | editAnnouncement(BMXGroup group, String title, String content) 设置群公告 |
[BMXErrorCode] | deleteAnnouncement(BMXGroup group, long announcementId) 删除群公告 |
[BMXErrorCode] | setName(BMXGroup group, String name) 设置群名称 |
[BMXErrorCode] | setDescription(BMXGroup group, String description) 设置群描述信息 |
[BMXErrorCode] | setExtension(BMXGroup group, String extension) 设置群扩展信息 |
[BMXErrorCode] | setMyNickname(BMXGroup group, String nickname) 设置在群里的昵称 |
[BMXErrorCode] | setMsgPushMode(BMXGroup group, BMXGroup.MsgPushMode mode) 设置群消息通知模式 |
[BMXErrorCode] | setJoinAuthMode(BMXGroup group, BMXGroup.JoinAuthMode mode) 设置入群审批模式 |
[BMXErrorCode] | setInviteMode(BMXGroup group, BMXGroup.InviteMode mode) 设置邀请模式 |
[BMXErrorCode] | setAllowMemberModify(BMXGroup group, boolean enable) 设置是否允许群成员设置群信息 |
[BMXErrorCode] | setEnableReadAck(BMXGroup group, boolean enable) 设置是否开启群消息已读功能 |
[BMXErrorCode] | setHistoryVisible(BMXGroup group, boolean enable) 设置群成员是否开可见群历史聊天记录 |
[BMXErrorCode] | setAvatar(BMXGroup group, String avatarPath, FileProgressListener arg2) 设置群头像 |
[BMXErrorCode] | downloadAvatar(BMXGroup group, boolean thumbnail, FileProgressListener arg2) 下载群头像 |
void | addGroupListener(BMXGroupServiceListener listener) 添加群组变化监听者 |
void | removeGroupListener(BMXGroupServiceListener listener) 移除群组变化监听者 |
Protected Functions
Name | |
---|---|
BMXGroupService(long cPtr, boolean cMemoryOwn) | |
void | finalize() |
long | getCPtr(BMXGroupService obj) |
Protected Attributes
Name | |
---|---|
transient boolean | swigCMemOwn |
Public Functions Documentation
function delete
inline synchronized void delete()
Example:
function get
inline BMXErrorCode get(
BMXGroupList list,
boolean forceRefresh
)
获取群组列表,如果设置了forceRefresh则从服务器拉取
Parameters:
- list 群组id列表,传入空列表函数返回后从此处获取返回的群组id列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
function search
inline BMXErrorCode search(
BMXGroupList list,
boolean forceRefresh
)
获取群组列表,如果设置了forceRefresh则从服务器拉取
Parameters:
- list 群组id列表,传入空列表函数返回后从此处获取返回的群组id列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
public BMXGroup getGroupListByDB(long groupId) {
BMXGroup group = new BMXGroup();
BMXErrorCode error = mGroupService.search(groupId, group, false);
if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
return null;
}
return group;
function fetchGroupsByIdList
inline BMXErrorCode fetchGroupsByIdList(
ListOfLongLong groupIdList,
BMXGroupList list,
boolean forceRefresh
)
获取传入群组id的群组信息列表,如果设置了forceRefresh则从服务器拉取
Parameters:
- groupIdList 群组id列表
- list 群组详细信息列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
function search
inline BMXErrorCode search(
ListOfLongLong groupIdList,
BMXGroupList list,
boolean forceRefresh
)
获取传入群组id的群组信息列表,如果设置了forceRefresh则从服务器拉取
Parameters:
- groupIdList 群组id列表
- list 群组详细信息列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
public BMXGroup getGroupListByDB(long groupId) {
BMXGroup group = new BMXGroup();
BMXErrorCode error = mGroupService.search(groupId, group, false);
if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
return null;
}
return group;
function fetchGroupById
inline BMXErrorCode fetchGroupById(
long groupId,
BMXGroup group,
boolean forceRefresh
)
获取群信息,如果设置了forceRefresh则从服务器拉取
Parameters:
- groupId 要搜索的群组id
- group 搜索返回的群组信息,传入指向为空的shared_ptr对象函数执行后从此获取返回结果
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
function search
inline BMXErrorCode search(
long groupId,
BMXGroup group,
boolean forceUpdate
)
获取群信息,如果设置了forceRefresh则从服务器拉取
Parameters:
- groupId 要搜索的群组id
- group 搜索返回的群组信息,传入指向为空的shared_ptr对象函数执行后从此获取返回结果
- forceUpdate 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
public BMXGroup getGroupListByDB(long groupId) {
BMXGroup group = new BMXGroup();
BMXErrorCode error = mGroupService.search(groupId, group, false);
if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
return null;
}
return group;
function fetchLocalGroupsByName
inline BMXErrorCode fetchLocalGroupsByName(
BMXGroupList list,
String name
)
通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组
Parameters:
- list 搜索结果返回的群列表信息
- name 查询的群名称关键字
Return: [BMXErrorCode]
Example:
function search
inline BMXErrorCode search(
BMXGroupList list,
String name
)
通过群名称查询本地群信息,从本地数据库中通过群名称查询获取群组
Parameters:
- list 搜索结果返回的群列表信息
- name 查询的群名称关键字
Return: [BMXErrorCode]
Example:
public BMXGroup getGroupListByDB(long groupId) {
BMXGroup group = new BMXGroup();
BMXErrorCode error = mGroupService.search(groupId, group, false);
if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
return null;
}
return group;
function create
inline BMXErrorCode create(
BMXGroupService.CreateGroupOptions options,
BMXGroup group
)
创建群
Parameters:
- options 创建群组时传入的参数选项
- group 创建好的群,传入指向为空的shared_ptr对象函数执行后从此获取返回结果
Return: [BMXErrorCode]
Example:
function destroy
inline BMXErrorCode destroy(
BMXGroup group
)
销毁群
Parameters:
- group 要销毁的群组
Return: [BMXErrorCode]
Example:
function join
inline BMXErrorCode join(
BMXGroup group,
String message
)
加入一个群,根据群设置可能需要管理员批准
Parameters:
- group 要加入的群组
- message 申请入群的信息
Return: [BMXErrorCode]
Example:
function leave
inline BMXErrorCode leave(
BMXGroup group
)
退出群
Parameters:
- group 要退出的群组
Return: [BMXErrorCode]
Example:
function getInfo
inline BMXErrorCode getInfo(
BMXGroup group
)
获取群详情,从服务端拉取最新信息
Parameters:
- group 要获取群组最新信息的群组
Return: [BMXErrorCode]
Example:
function getMembersNickname
inline BMXErrorCode getMembersNickname(
BMXGroup group,
ListOfLongLong members,
BMXGroupMemberList list
)
获取群组成员详细信息
Parameters:
- group 进行操作的群组
- members 要获取群组成员信息详情的群成员id
- list 返回的群成员详细,传入空列表在函数操作后从此处获取群成员详细信息列表
Return: [BMXErrorCode]
Example:
function getInvitationList
inline BMXErrorCode getInvitationList(
GroupInvitaionPage result,
String cursor,
int pageSize
)
分页获取群组邀请列表
Parameters:
- result 分页获取的群组邀请列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
- cursor 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
- pageSize 分页大小
Return: [BMXErrorCode]
Example:
function getApplicationList
inline BMXErrorCode getApplicationList(
BMXGroupList list,
GroupApplicationPage result,
String cursor,
int pageSize
)
分页获取群组申请列表
Parameters:
- list 需要获取群组申请列表信息的群组id列表
- result 分页获取的群组申请列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
- cursor 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
- pageSize 分页大小
Return: [BMXErrorCode]
Example:
function getMembers
inline BMXErrorCode getMembers(
BMXGroup group,
BMXGroupMemberResultPage result,
String cursor,
int pageSize
)
分页获取群成员列表,如果设置了forceRefresh则从服务器拉取,单页最大数量为500.
Parameters:
- group 进行操作的群组
- result 分页获取的群成员列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
- cursor 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
- pageSize 分页大小
Return: [BMXErrorCode]
Example:
public BMXGroup.Member getMemberByDB(long groupId, long memberId) {
BMXGroup group = getGroupListByDB(groupId);
BMXGroupMemberList list = new BMXGroupMemberList();
BMXErrorCode error = mGroupService.getMembers(group, list, false);
if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
return null;
}
if (list != null && !list.isEmpty()) {
for (int i = 0; i < list.size(); i++) {
BMXGroup.Member member = list.get(i);
if(member.getMUid() == memberId){
return member;
}
}
}
return null;
function getMembers
inline BMXErrorCode getMembers(
BMXGroup group,
BMXGroupMemberList list,
boolean forceRefresh
)
获取群成员列表,如果设置了forceRefresh则从服务器拉取,最多拉取1000人
Parameters:
- group 进行操作的群组
- list 群成员列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
public BMXGroup.Member getMemberByDB(long groupId, long memberId) {
BMXGroup group = getGroupListByDB(groupId);
BMXGroupMemberList list = new BMXGroupMemberList();
BMXErrorCode error = mGroupService.getMembers(group, list, false);
if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
return null;
}
if (list != null && !list.isEmpty()) {
for (int i = 0; i < list.size(); i++) {
BMXGroup.Member member = list.get(i);
if(member.getMUid() == memberId){
return member;
}
}
}
return null;
function addMembers
inline BMXErrorCode addMembers(
BMXGroup group,
ListOfLongLong members,
String message
)
添加群成员
Parameters:
- group 进行操作的群组
- members 要添加进群的成员id列表
- message 添加成员原因信息
Return: [BMXErrorCode]
Example:
function removeMembers
inline BMXErrorCode removeMembers(
BMXGroup group,
ListOfLongLong members,
String reason
)
删除群成员
Parameters:
- group 进行操作的群组
- members 要删除的群组成员id列表
- reason 删除的原因
Return: [BMXErrorCode]
Example:
function addAdmins
inline BMXErrorCode addAdmins(
BMXGroup group,
ListOfLongLong admins,
String message
)
添加管理员
Parameters:
- group 进行操作的群组
- admins 要添加为管理员的成员id列表
- message 添加为管理员的原因
Return: [BMXErrorCode]
Example:
function removeAdmins
inline BMXErrorCode removeAdmins(
BMXGroup group,
ListOfLongLong admins,
String reason
)
删除管理员
Parameters:
- group 进行操作的群组
- admins 要从管理员移除的成员id列表
- reason 要移除管理员的原因
Return: [BMXErrorCode]
Example:
function getAdmins
inline BMXErrorCode getAdmins(
BMXGroup group,
BMXGroupMemberList list,
boolean forceRefresh
)
获取Admins列表,如果设置了forceRefresh则从服务器拉取
Parameters:
- group 进行操作的群组
- list 群管理员列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
public boolean isAdmin(BMXGroup group, long memberId) {
BMXGroupMemberList list = new BMXGroupMemberList();
BMXErrorCode error = mGroupService.getAdmins(group, list, false);
if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
return false;
}
if (list != null && !list.isEmpty()) {
for (int i = 0; i < list.size(); i++) {
BMXGroup.Member member = list.get(i);
if (member.getMUid() == memberId) {
return true;
}
}
}
return false;
function blockMembers
inline BMXErrorCode blockMembers(
BMXGroup group,
ListOfLongLong members
)
添加黑名单
Parameters:
- group 进行操作的群组
- members 要加入黑名单的群成员id列表
Return: [BMXErrorCode]
Example:
function unblockMembers
inline BMXErrorCode unblockMembers(
BMXGroup group,
ListOfLongLong members
)
从黑名单删除
Parameters:
- group 进行操作的群组
- members 从黑名单移除的用户id列表
Return: [BMXErrorCode]
Example:
function getBlockList
inline BMXErrorCode getBlockList(
BMXGroup group,
BMXGroupMemberResultPage result,
String cursor,
int pageSize
)
分页获取黑名单
Parameters:
- group 进行操作的群组
- result 分页获取的黑名单列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
- cursor 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
- pageSize 分页大小
Return: [BMXErrorCode]
Example:
function getBlockList
inline BMXErrorCode getBlockList(
BMXGroup group,
BMXGroupMemberList list,
boolean forceRefresh
)
获取黑名单
Parameters:
- group 进行操作的群组
- list 群黑名单列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
function banMembers
inline BMXErrorCode banMembers(
BMXGroup group,
ListOfLongLong members,
long duration,
String reason
)
禁言
Parameters:
- group 进行操作的群组
- members 被禁言的群成员id列表
- duration 禁言时长
- reason 禁言原因
Return: [BMXErrorCode]
Example:
function banMembers
inline BMXErrorCode banMembers(
BMXGroup group,
ListOfLongLong members,
long duration
)
Example:
function banGroup
inline BMXErrorCode banGroup(
BMXGroup group,
long duration
)
全员禁言,当前服务器时间加上禁言时长后计算出全员禁言到期时间(只有管理和群主可以发言)
Parameters:
- group 进行操作的群组
- duration 禁言时长(分钟)
Return: [BMXErrorCode]
Example:
function unbanMembers
inline BMXErrorCode unbanMembers(
BMXGroup group,
ListOfLongLong members
)
解除禁言
Parameters:
- group 进行操作的群组
- members 被解除禁言的群成员id列表
Return: [BMXErrorCode]
Example:
function unbanGroup
inline BMXErrorCode unbanGroup(
BMXGroup group
)
全员解除禁言
Parameters:
- group 进行操作的群组
Return: [BMXErrorCode]
Example:
function getBannedMembers
inline BMXErrorCode getBannedMembers(
BMXGroup group,
BMXGroupBannedMemberResultPage result,
String cursor,
int pageSize
)
分页获取禁言列表
Parameters:
- group 进行操作的群组
- result 分页获取的禁言列表,传入指向为空的shared_ptr对象函数执行后从此处获取结果
- cursor 分页获取的起始cursor,第一次传入为空,后续传入上次操作返回的result中的cursor
- pageSize 分页大小
Return: [BMXErrorCode]
Example:
function getBannedMembers
inline BMXErrorCode getBannedMembers(
BMXGroup group,
BMXGroupBannedMemberList list
)
获取禁言列表
Parameters:
- group 进行操作的群组
- list 群禁言列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
Return: [BMXErrorCode]
Example:
function muteMessage
inline BMXErrorCode muteMessage(
BMXGroup group,
BMXGroup.MsgMuteMode mode
)
设置是否屏蔽群消息
Parameters:
- group 进行操作的群组
- mode 群屏蔽的模式
Return: [BMXErrorCode]
Example:
function acceptApplication
inline BMXErrorCode acceptApplication(
BMXGroup group,
long applicantId
)
接受入群申请
Parameters:
- group 进行操作的群组
- applicantId 申请进群的用户id
Return: [BMXErrorCode]
Example:
function declineApplication
inline BMXErrorCode declineApplication(
BMXGroup group,
long applicantId,
String reason
)
拒绝入群申请
Parameters:
- group 进行操作的群组
- applicantId 申请进群的用户id
- reason 拒绝的原因
Return: [BMXErrorCode]
Example:
function declineApplication
inline BMXErrorCode declineApplication(
BMXGroup group,
long applicantId
)
Example:
function acceptInvitation
inline BMXErrorCode acceptInvitation(
BMXGroup group,
long inviter
)
接受入群邀请
Parameters:
- group 进行操作的群组
- inviter 邀请者id
Return: [BMXErrorCode]
Example:
function declineInvitation
inline BMXErrorCode declineInvitation(
BMXGroup group,
long inviter,
String reason
)
拒绝入群邀请
Parameters:
- group 进行操作的群组
- inviter 邀请者id
- reason 拒绝的原因
Return: [BMXErrorCode]
Example:
function declineInvitation
inline BMXErrorCode declineInvitation(
BMXGroup group,
long inviter
)
Example:
function transferOwner
inline BMXErrorCode transferOwner(
BMXGroup group,
long newOwnerId
)
转移群主
Parameters:
- group 进行操作的群组
- newOwnerId 转让为新群主的用户id
Return: [BMXErrorCode]
Example:
function uploadSharedFile
inline BMXErrorCode uploadSharedFile(
BMXGroup group,
String filePath,
String displayName,
String extensionName,
FileProgressListener arg4
)
添加群共享文件
Parameters:
- group 进行操作的群组
- filePath 文件的本地路径
- displayName 文件的展示名
- extensionName 文件的扩展名
- arg4 上传回调函数
Return: [BMXErrorCode]
Example:
function cancelUploadSharedFile
inline BMXErrorCode cancelUploadSharedFile(
BMXGroup group,
String filePath
)
取消上传群共享文件
Parameters:
- group 进行操作的群组
- filePath 文件的本地路径
Return: [BMXErrorCode]
Example:
function removeSharedFile
inline BMXErrorCode removeSharedFile(
BMXGroup group,
BMXGroup.SharedFile sharedFile
)
移除群共享文件
Parameters:
- group 进行操作的群组
- sharedFile 删除的群共享文件
Return: [BMXErrorCode]
Example:
function downloadSharedFile
inline BMXErrorCode downloadSharedFile(
BMXGroup group,
BMXGroup.SharedFile sharedFile,
FileProgressListener arg2
)
下载群共享文件
Parameters:
- group 进行操作的群组
- sharedFile 下载的群共享文件
- arg2 下载回调函数
Return: [BMXErrorCode]
Example:
function cancelDownloadSharedFile
inline BMXErrorCode cancelDownloadSharedFile(
BMXGroup group,
BMXGroup.SharedFile sharedFile
)
取消下载群共享文件
Parameters:
- group 进行操作的群组
- sharedFile 下载的群共享文件
Return: [BMXErrorCode]
Example:
function getSharedFilesList
inline BMXErrorCode getSharedFilesList(
BMXGroup group,
BMXGroupSharedFileList list,
boolean forceRefresh
)
获取群共享文件列表
Parameters:
- group 进行操作的群组
- list 群共享文件列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
function changeSharedFileName
inline BMXErrorCode changeSharedFileName(
BMXGroup group,
BMXGroup.SharedFile sharedFile,
String name
)
修改群共享文件名称
Parameters:
- group 进行操作的群组
- sharedFile 进行更改的群共享文件
- name 修改的群共享文件名称
Return: [BMXErrorCode]
Example:
function getLatestAnnouncement
inline BMXErrorCode getLatestAnnouncement(
BMXGroup group,
BMXGroup.Announcement announcement,
boolean forceRefresh
)
获取最新的群公告
Parameters:
- group 进行操作的群组
- announcement 最新的群组公告,传入指向为空的shared_ptr对象函数返回后从此处获取最新的群组公告
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
function getAnnouncementList
inline BMXErrorCode getAnnouncementList(
BMXGroup group,
BMXGroupAnnouncementList list,
boolean forceRefresh
)
获取群公告列表
Parameters:
- group 进行操作的群组
- list 群公告列表,传入空列表函数返回后从此处获取返回的群组详细信息列表
- forceRefresh 设置为true强制从服务器获取,本地获取失败的情况sdk会自动从服务器获取
Return: [BMXErrorCode]
Example:
function editAnnouncement
inline BMXErrorCode editAnnouncement(
BMXGroup group,
String title,
String content
)
设置群公告
Parameters:
- group 进行操作的群组
- title 群公告的标题
- content 群公告的内容
Return: [BMXErrorCode]
Example:
function deleteAnnouncement
inline BMXErrorCode deleteAnnouncement(
BMXGroup group,
long announcementId
)
删除群公告
Parameters:
- group 进行操作的群组
- announcementId 删除的群公告id
Return: [BMXErrorCode]
Example:
function setName
inline BMXErrorCode setName(
BMXGroup group,
String name
)
设置群名称
Parameters:
- group 进行操作的群组
- name 群组名称
Return: [BMXErrorCode]
Example:
function setDescription
inline BMXErrorCode setDescription(
BMXGroup group,
String description
)
设置群描述信息
Parameters:
- group 进行操作的群组
- description 群组描述
Return: [BMXErrorCode]
Example:
function setExtension
inline BMXErrorCode setExtension(
BMXGroup group,
String extension
)
设置群扩展信息
Parameters:
- group 进行操作的群组
- extension 群组的扩展信息
Return: [BMXErrorCode]
Example:
function setMyNickname
inline BMXErrorCode setMyNickname(
BMXGroup group,
String nickname
)
设置在群里的昵称
Parameters:
- group 进行操作的群组
- nickname 用户在群组内的昵称
Return: [BMXErrorCode]
Example:
function setMsgPushMode
inline BMXErrorCode setMsgPushMode(
BMXGroup group,
BMXGroup.MsgPushMode mode
)
设置群消息通知模式
Parameters:
- group 进行操作的群组
- mode 群消息通知模式
Return: [BMXErrorCode]
Example:
function setJoinAuthMode
inline BMXErrorCode setJoinAuthMode(
BMXGroup group,
BMXGroup.JoinAuthMode mode
)
设置入群审批模式
Parameters:
- group 进行操作的群组
- mode 入群审批模式
Return: [BMXErrorCode]
Example:
function setInviteMode
inline BMXErrorCode setInviteMode(
BMXGroup group,
BMXGroup.InviteMode mode
)
设置邀请模式
Parameters:
- group 进行操作的群组
- mode 群组的邀请模式
Return: [BMXErrorCode]
Example:
function setAllowMemberModify
inline BMXErrorCode setAllowMemberModify(
BMXGroup group,
boolean enable
)
设置是否允许群成员设置群信息
Parameters:
- group 进行操作的群组
- enable 是否允许操作
Return: [BMXErrorCode]
Example:
function setEnableReadAck
inline BMXErrorCode setEnableReadAck(
BMXGroup group,
boolean enable
)
设置是否开启群消息已读功能
Parameters:
- group 进行操作的群组
- enable 是否开启
Return: [BMXErrorCode]
Example:
function setHistoryVisible
inline BMXErrorCode setHistoryVisible(
BMXGroup group,
boolean enable
)
设置群成员是否开可见群历史聊天记录
Parameters:
- group 进行操作的群组
- enable 是否开启
Return: [BMXErrorCode]
Example:
function setAvatar
inline BMXErrorCode setAvatar(
BMXGroup group,
String avatarPath,
FileProgressListener arg2
)
设置群头像
Parameters:
- group 进行操作的群组
- avatarPath 群头像文件的本地路径
- arg2 上传回调函数
Return: [BMXErrorCode]
Example:
function downloadAvatar
inline BMXErrorCode downloadAvatar(
BMXGroup group,
boolean thumbnail,
FileProgressListener arg2
)
下载群头像
Parameters:
- group 进行操作的群组
- thumbnail 设置为true下载缩略图,false下载原图
- arg2 下载回调函数
Return: [BMXErrorCode]
Example:
function addGroupListener
inline void addGroupListener(
BMXGroupServiceListener listener
)
添加群组变化监听者
Parameters:
- listener 群组变化监听者
Example:
function removeGroupListener
inline void removeGroupListener(
BMXGroupServiceListener listener
)
移除群组变化监听者
Parameters:
- listener 群组变化监听者
Protected Functions Documentation
Example:
function BMXGroupService
inline BMXGroupService(
long cPtr,
boolean cMemoryOwn
)
Example:
function finalize
inline void finalize()
Example:
function getCPtr
static inline long getCPtr(
BMXGroupService obj
)
Protected Attributes Documentation
variable swigCMemOwn
transient boolean swigCMemOwn;
Example:
Updated on 2022-01-26 at 17:18:31 +0800