im::floo::floolib::BMXGroupManager

Group Manager

Public Functions

Name
BMXGroupManager(BMXGroupService service)
void getGroupList(final boolean forceRefresh, final BMXDataCallBack< BMXGroupList > callBack)
Get group list, pull from server if forceRefreshed is set
void getGroupList(final ListOfLongLong groupIdList, final boolean forceRefresh, final BMXDataCallBack< BMXGroupList > callBack)
Get the list of group information for the incoming group id, pull from server if forceRefreshed is set
void getGroupList(final long groupId, final boolean forceUpdate, final BMXDataCallBack< BMXGroup > callBack)
Get group information, pull from server if forceRefreshed is set
void getInvitationList(final String cursor, final int pageSize, final BMXDataCallBack< GroupInvitaionPage > callBack)
Get group invitation list in pages
void getApplicationList(final BMXGroupList list, final String cursor, final int pageSize, final BMXDataCallBack< GroupApplicationPage > callBack)
Get a list of group applications in pages
void create(final BMXGroupService.CreateGroupOptions options, final BMXDataCallBack< BMXGroup > callBack)
Create group
void destroy(final BMXGroup group, final BMXCallBack callBack)
Destroy group
void join(final BMXGroup group, final String message, final BMXCallBack callBack)
Join a group, which may require admin approval depending on group settings
void leave(final BMXGroup group, final BMXCallBack callBack)
Quit group
void getInfo(final BMXGroup group, final BMXDataCallBack< BMXGroup > callBack)
Get group details, pull the latest information from server
void getMembers(final BMXGroup group, final String cursor, final int pageSize, final BMXDataCallBack< BMXGroupMemberResultPage > callBack)
Get group member list, pull from server if forceRefresh is set, up to 1,000
void getMembers(final BMXGroup group, final boolean forceRefresh, final BMXDataCallBack< BMXGroupMemberList > callBack)
Get group member list, pull from server if forceRefresh is set, up to 1,000
void addMembers(final BMXGroup group, final ListOfLongLong members, final String message, final BMXCallBack callBack)
Add group member
void removeMembers(final BMXGroup group, final ListOfLongLong members, final String reason, final BMXCallBack callBack)
Remove group member
void addAdmins(final BMXGroup group, final ListOfLongLong admins, final String message, final BMXCallBack callBack)
Add Admin
void removeAdmins(final BMXGroup group, final ListOfLongLong admins, final String reason, final BMXCallBack callBack)
Remove admin
void getAdmins(final BMXGroup group, final boolean forceRefresh, final BMXDataCallBack< BMXGroupMemberList > callBack)
Get Admins list, pull from server if forceRefreshed is set
void blockMembers(final BMXGroup group, final ListOfLongLong members, final BMXCallBack callBack)
Add to blacklist
void unblockMembers(final BMXGroup group, final ListOfLongLong members, final BMXCallBack callBack)
Unblacklist
void getBlockList(final BMXGroup group, final String cursor, final int pageSize, final BMXDataCallBack< BMXGroupMemberResultPage > callBack)
Get blacklist
void getBlockList(final BMXGroup group, final boolean forceRefresh, final BMXDataCallBack< BMXGroupMemberList > callBack)
Get blacklist
void banMembers(final BMXGroup group, final ListOfLongLong members, final long duration, final String reason, final BMXCallBack callBack)
Ban
void banGroup(final BMXGroup group, final long duration, final BMXCallBack callBack)
Ban all members
void unbanMembers(final BMXGroup group, final ListOfLongLong members, final BMXCallBack callBack)
Unban
void unbanGroup(final BMXGroup group, final BMXCallBack callBack)
Unban all members
void getBannedMembers(final BMXGroup group, final String cursor, final int pageSize, final BMXDataCallBack< BMXGroupBannedMemberResultPage > callBack)
Get a list of banned members
void getBannedMembers(final BMXGroup group, final BMXDataCallBack< BMXGroupBannedMemberList > callBack)
Get a list of banned members
void muteMessage(final BMXGroup group, final BMXGroup.MsgMuteMode mode, final BMXCallBack callBack)
Set whether to block group messages
void acceptApplication(final BMXGroup group, final long applicantId, final BMXCallBack callBack)
Accept application of membership
void declineApplication(final BMXGroup group, final long applicantId, final String reason, final BMXCallBack callBack)
Reject application of membership
void acceptInvitation(final BMXGroup group, final long inviter, final BMXCallBack callBack)
Accept to join group
void declineInvitation(final BMXGroup group, final long inviter, final BMXCallBack callBack)
Reject invitation to join group
void transferOwner(final BMXGroup group, final long newOwnerId, final BMXCallBack callBack)
Transfer of group Owner
void uploadSharedFile(final BMXGroup group, final String filePath, final String displayName, final String extensionName, final FileProgressListener listener, final BMXCallBack callBack)
Add shared file in group
void removeSharedFile(final BMXGroup group, final BMXGroup.SharedFile sharedFile, final BMXCallBack callBack)
Remove shared file in group
void downloadSharedFile(final BMXGroup group, final BMXGroup.SharedFile sharedFile, final FileProgressListener listener, final BMXCallBack callBack)
Download share file in group
void getSharedFilesList(final BMXGroup group, final boolean forceRefresh, final BMXDataCallBack< BMXGroupSharedFileList > callBack)
Get a list of share files in group
void changeSharedFileName(final BMXGroup group, final BMXGroup.SharedFile sharedFile, final String name, final BMXCallBack callBack)
Modify shared file name in group
void getLatestAnnouncement(final BMXGroup group, final boolean forceRefresh, final BMXDataCallBack< BMXGroup.Announcement > callBack)
Get the latest group announcement
void getAnnouncementList(final BMXGroup group, final boolean forceRefresh, final BMXDataCallBack< BMXGroupAnnouncementList > callBack)
Get group announcements list
void editAnnouncement(final BMXGroup group, final String title, final String content, final BMXCallBack callBack)
Write group announcement
void deleteAnnouncement(final BMXGroup group, final long announcementId, final BMXCallBack callBack)
Delete group announcement
void setName(final BMXGroup group, final String name, final BMXCallBack callBack)
Set group name
void setDescription(final BMXGroup group, final String description, final BMXCallBack callBack)
Set group description
void setExtension(final BMXGroup group, final String extension, final BMXCallBack callBack)
Set group extension information
void setMyNickname(final BMXGroup group, final String nickname, final BMXCallBack callBack)
Set nickname in group
void setMsgPushMode(final BMXGroup group, final BMXGroup.MsgPushMode mode, final BMXCallBack callBack)
Set group message notification mode
void setJoinAuthMode(final BMXGroup group, final BMXGroup.JoinAuthMode mode, final BMXCallBack callBack)
Set approval mode for joining group
void setInviteMode(final BMXGroup group, final BMXGroup.InviteMode mode, final BMXCallBack callBack)
Set invitation mode
void setAvatar(final BMXGroup group, final String avatarPath, final FileProgressListener listener, final BMXCallBack callBack)
Set group avatar
void downloadAvatar(final BMXGroup group, final FileProgressListener listener, final BMXCallBack callBack)
Download group avatar
void addGroupListener(BMXGroupServiceListener listener)
Add group change listener
void removeGroupListener(BMXGroupServiceListener listener)
Remove group change listener
void setEnableReadAck(final BMXGroup group, final boolean enable, final BMXCallBack callBack)
Set whether group message read acknowledgement is enabled

Public Functions Documentation

function BMXGroupManager

inline BMXGroupManager(
    BMXGroupService service
)

Example:

function getGroupList

inline void getGroupList(
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroupList > callBack
)

Get group list, pull from server if forceRefreshed is set

Parameters:

  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], group id list

Example:

public void getGroupList(boolean forceRefresh, BMXDataCallBack<BMXGroupList> callBack) {
    mService.getGroupList(forceRefresh, callBack);

function getGroupList

inline void getGroupList(
    final ListOfLongLong groupIdList,
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroupList > callBack
)

Get the list of group information for the incoming group id, pull from server if forceRefreshed is set

Parameters:

  • groupIdList List of group ids
  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], group details list

Example:

public void getGroupList(boolean forceRefresh, BMXDataCallBack<BMXGroupList> callBack) {
    mService.getGroupList(forceRefresh, callBack);

function getGroupList

inline void getGroupList(
    final long groupId,
    final boolean forceUpdate,
    final BMXDataCallBack< BMXGroup > callBack
)

Get group information, pull from server if forceRefreshed is set

Parameters:

  • groupId Group id to search
  • forceUpdate True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], group details returned by search

Example:

public void getGroupList(boolean forceRefresh, BMXDataCallBack<BMXGroupList> callBack) {
    mService.getGroupList(forceRefresh, callBack);

function getInvitationList

inline void getInvitationList(
    final String cursor,
    final int pageSize,
    final BMXDataCallBack< GroupInvitaionPage > callBack
)

Get group invitation list in pages

Parameters:

  • cursor Paged starting cursor, passed in as empty-valued first, followed by the cursor in the result returned by last operation
  • pageSize Page size
  • callBack [BMXErrorCode], paged list of group invitation

Example:

public void getInvitationList(String cursor, int pageSize, BMXDataCallBack<GroupInvitaionPage> callBack) {
    mService.getInvitationList(cursor, pageSize, callBack);

function getApplicationList

inline void getApplicationList(
    final BMXGroupList list,
    final String cursor,
    final int pageSize,
    final BMXDataCallBack< GroupApplicationPage > callBack
)

Get a list of group applications in pages

Parameters:

  • list List of group ids for which group application list information needs to be obtained
  • cursor Paged starting cursor, passed in as empty-valued first, followed by the cursor in the result returned by last operation
  • pageSize Page size
  • callBack [BMXErrorCode], paged list of group application

Example:

function create

inline void create(
    final BMXGroupService.CreateGroupOptions options,
    final BMXDataCallBack< BMXGroup > callBack
)

Create group

Parameters:

  • options Parameters passed in when creating a group
  • callBack [BMXErrorCode], created group

Example:

function destroy

inline void destroy(
    final BMXGroup group,
    final BMXCallBack callBack
)

Destroy group

Parameters:

  • callBack BMXErrorCode,Group to destroy

Example:

public void destroy(BMXGroup group, BMXCallBack callBack) {
    mService.destroy(group, callBack);

function join

inline void join(
    final BMXGroup group,
    final String message,
    final BMXCallBack callBack
)

Join a group, which may require admin approval depending on group settings

Parameters:

  • group Group to join
  • message Information for group membership application
  • callBack [BMXErrorCode]

Example:

public void join(BMXGroup group, String message, BMXCallBack callBack) {
    mService.join(group, message, callBack);

function leave

inline void leave(
    final BMXGroup group,
    final BMXCallBack callBack
)

Quit group

Parameters:

  • group Group to quit
  • callBack [BMXErrorCode]

Example:

public void leave(BMXGroup group, BMXCallBack callBack) {
    mService.leave(group, callBack);

function getInfo

inline void getInfo(
    final BMXGroup group,
    final BMXDataCallBack< BMXGroup > callBack
)

Get group details, pull the latest information from server

Parameters:

  • callBack [BMXErrorCode], the group to get its latest information

Example:

public void getInfo(BMXGroup group, BMXDataCallBack<BMXGroup> callBack) {
    mService.getInfo(group, callBack);

function getMembers

inline void getMembers(
    final BMXGroup group,
    final String cursor,
    final int pageSize,
    final BMXDataCallBack< BMXGroupMemberResultPage > callBack
)

Get group member list, pull from server if forceRefresh is set, up to 1,000

Parameters:

  • group Group to operate on
  • cursor Paged starting cursor, passed in as empty-valued first, followed by the cursor in the result returned by last operation
  • pageSize Page size
  • callBack [BMXErrorCode], group member list

Example:

public void getMembers(BMXGroup group, boolean forceRefresh, BMXDataCallBack<BMXGroupMemberList> callBack) {
    mService.getMembers(group, forceRefresh, callBack);
public void getMembers(BMXGroup group, String cursor, int pageSize, BMXDataCallBack<BMXGroupMemberResultPage> callBack) {
    mService.getMembers(group, cursor, pageSize, callBack);

function getMembers

inline void getMembers(
    final BMXGroup group,
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroupMemberList > callBack
)

Get group member list, pull from server if forceRefresh is set, up to 1,000

Parameters:

  • group Group to operate on
  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], group member list

Example:

public void getMembers(BMXGroup group, boolean forceRefresh, BMXDataCallBack<BMXGroupMemberList> callBack) {
    mService.getMembers(group, forceRefresh, callBack);
public void getMembers(BMXGroup group, String cursor, int pageSize, BMXDataCallBack<BMXGroupMemberResultPage> callBack) {
    mService.getMembers(group, cursor, pageSize, callBack);

function addMembers

inline void addMembers(
    final BMXGroup group,
    final ListOfLongLong members,
    final String message,
    final BMXCallBack callBack
)

Add group member

Parameters:

  • group Group to operate on
  • members List of member ids to join group
  • message Reason for membership application
  • callBack [BMXErrorCode]

Example:

public void addMembers(BMXGroup group, ListOfLongLong listOfLongLong, String message, BMXCallBack callBack) {
    mService.addMembers(group, listOfLongLong, message, callBack);

function removeMembers

inline void removeMembers(
    final BMXGroup group,
    final ListOfLongLong members,
    final String reason,
    final BMXCallBack callBack
)

Remove group member

Parameters:

  • group Group to operate on
  • members List of group member ids to delete
  • reason Reason for deletion
  • callBack [BMXErrorCode]

Example:

public void removeMembers(BMXGroup group, ListOfLongLong listOfLongLong, String reason,
        BMXCallBack callBack) {
    mService.removeMembers(group, listOfLongLong, reason, callBack);

function addAdmins

inline void addAdmins(
    final BMXGroup group,
    final ListOfLongLong admins,
    final String message,
    final BMXCallBack callBack
)

Add Admin

Parameters:

  • group Group to operate on
  • admins List of member ids to be added as Admins
  • message Reason for adding as Admin
  • callBack [BMXErrorCode]

Example:

public void addAdmins(BMXGroup group, ListOfLongLong listOfLongLong, String message,
        BMXCallBack callBack) {
    mService.addAdmins(group, listOfLongLong, message, callBack);

function removeAdmins

inline void removeAdmins(
    final BMXGroup group,
    final ListOfLongLong admins,
    final String reason,
    final BMXCallBack callBack
)

Remove admin

Parameters:

  • group Group to operate on
  • admins List of member ids to degrade from Admins
  • reason Reason to degrade from Admin
  • callBack [BMXErrorCode]

Example:

public void removeAdmins(BMXGroup group, ListOfLongLong listOfLongLong, String reason,
        BMXCallBack callBack) {
    mService.removeAdmins(group, listOfLongLong, reason, callBack);

function getAdmins

inline void getAdmins(
    final BMXGroup group,
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroupMemberList > callBack
)

Get Admins list, pull from server if forceRefreshed is set

Parameters:

  • group Group to operate on
  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], list of group Admins

Example:

public void getAdmins(BMXGroup group, boolean forceRefresh, BMXDataCallBack<BMXGroupMemberList> callBack) {
    mService.getAdmins(group, forceRefresh, callBack);

function blockMembers

inline void blockMembers(
    final BMXGroup group,
    final ListOfLongLong members,
    final BMXCallBack callBack
)

Add to blacklist

Parameters:

  • group Group to operate on
  • members List of member ids to be blacklisted
  • callBack [BMXErrorCode]

Example:

public void blockMembers(BMXGroup group, ListOfLongLong listOfLongLong, BMXCallBack callBack) {
    mService.blockMembers(group, listOfLongLong, callBack);

function unblockMembers

inline void unblockMembers(
    final BMXGroup group,
    final ListOfLongLong members,
    final BMXCallBack callBack
)

Unblacklist

Parameters:

  • group Group to operate on
  • members List of unblacklisted user ids
  • callBack [BMXErrorCode]

Example:

public void unblockMembers(BMXGroup group, ListOfLongLong listOfLongLong, BMXCallBack callBack) {
    mService.unblockMembers(group, listOfLongLong, callBack);

function getBlockList

inline void getBlockList(
    final BMXGroup group,
    final String cursor,
    final int pageSize,
    final BMXDataCallBack< BMXGroupMemberResultPage > callBack
)

Get blacklist

Parameters:

  • group Group to operate on
  • cursor Paged starting cursor, passed in as empty-valued first, followed by the cursor in the result returned by last operation
  • pageSize Page size
  • callBack [BMXErrorCode], list of group blacklists

Example:

function getBlockList

inline void getBlockList(
    final BMXGroup group,
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroupMemberList > callBack
)

Get blacklist

Parameters:

  • group Group to operate on
  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], list of group blacklists

Example:

function banMembers

inline void banMembers(
    final BMXGroup group,
    final ListOfLongLong members,
    final long duration,
    final String reason,
    final BMXCallBack callBack
)

Ban

Parameters:

  • group Group to operate on
  • members List of banned member ids
  • duration Duration of banned
  • reason Reason for banned
  • callBack [BMXErrorCode]

Example:

public void banMembers(BMXGroup group, ListOfLongLong listOfLongLong, long duration,
        String reason, BMXCallBack callBack) {
    mService.banMembers(group, listOfLongLong, duration, reason, callBack);

function banGroup

inline void banGroup(
    final BMXGroup group,
    final long duration,
    final BMXCallBack callBack
)

Ban all members

Parameters:

  • group Group to operate on
  • duration Duration of banned
  • callBack [BMXErrorCode]

Example:

public void banGroup(BMXGroup group, long duration, BMXCallBack callBack) {
    mService.banGroup(group, duration, callBack);

function unbanMembers

inline void unbanMembers(
    final BMXGroup group,
    final ListOfLongLong members,
    final BMXCallBack callBack
)

Unban

Parameters:

  • group Group to operate on
  • members List of unbanned group member ids
  • callBack [BMXErrorCode]

Example:

public void unbanMembers(BMXGroup group, ListOfLongLong listOfLongLong, BMXCallBack callBack) {
    mService.unbanMembers(group, listOfLongLong, callBack);

function unbanGroup

inline void unbanGroup(
    final BMXGroup group,
    final BMXCallBack callBack
)

Unban all members

Parameters:

  • group Group to operate on
  • callBack [BMXErrorCode]

Example:

public void unbanGroup(BMXGroup group, BMXCallBack callBack) {
    mService.unbanGroup(group, callBack);

function getBannedMembers

inline void getBannedMembers(
    final BMXGroup group,
    final String cursor,
    final int pageSize,
    final BMXDataCallBack< BMXGroupBannedMemberResultPage > callBack
)

Get a list of banned members

Parameters:

  • group Group to operate on
  • cursor Paged starting cursor, passed in as empty-valued first, followed by the cursor in the result returned by last operation
  • pageSize Page size
  • callBack [BMXErrorCode], list of group bans

Example:

public void getBannedMembers(BMXGroup group, BMXDataCallBack<BMXGroupBannedMemberList> callBack) {
    mService.getBannedMembers(group, callBack);
public void getBannedMembers(BMXGroup group, String cursor, int pageSize, BMXDataCallBack<BMXGroupBannedMemberResultPage> callBack) {
    mService.getBannedMembers(group, cursor, pageSize, callBack);

function getBannedMembers

inline void getBannedMembers(
    final BMXGroup group,
    final BMXDataCallBack< BMXGroupBannedMemberList > callBack
)

Get a list of banned members

Parameters:

  • group Group to operate on
  • callBack [BMXErrorCode], list of group bans

Example:

public void getBannedMembers(BMXGroup group, BMXDataCallBack<BMXGroupBannedMemberList> callBack) {
    mService.getBannedMembers(group, callBack);
public void getBannedMembers(BMXGroup group, String cursor, int pageSize, BMXDataCallBack<BMXGroupBannedMemberResultPage> callBack) {
    mService.getBannedMembers(group, cursor, pageSize, callBack);

function muteMessage

inline void muteMessage(
    final BMXGroup group,
    final BMXGroup.MsgMuteMode mode,
    final BMXCallBack callBack
)

Set whether to block group messages

Parameters:

  • group Group to operate on
  • mode Group blocking mode
  • callBack [BMXErrorCode]

Example:

public void muteMessage(BMXGroup group, BMXGroup.MsgMuteMode mode, BMXCallBack callBack) {
    mService.muteMessage(group, mode, callBack);

function acceptApplication

inline void acceptApplication(
    final BMXGroup group,
    final long applicantId,
    final BMXCallBack callBack
)

Accept application of membership

Parameters:

  • group Group to operate on
  • applicantId User id that request to join group
  • callBack [BMXErrorCode]

Example:

public void acceptApplication(BMXGroup group, long applicantId, BMXCallBack callBack) {
    mService.acceptApplication(group, applicantId, callBack);

function declineApplication

inline void declineApplication(
    final BMXGroup group,
    final long applicantId,
    final String reason,
    final BMXCallBack callBack
)

Reject application of membership

Parameters:

  • group Group to operate on
  • applicantId User id that request to join group
  • reason Reason for rejection
  • callBack [BMXErrorCode]

Example:

public void declineApplication(BMXGroup group, long applicantId, String reason, BMXCallBack callBack) {
    mService.declineApplication(group, applicantId, reason, callBack);

function acceptInvitation

inline void acceptInvitation(
    final BMXGroup group,
    final long inviter,
    final BMXCallBack callBack
)

Accept to join group

Parameters:

  • group Group to operate on
  • inviter Inviter id
  • callBack [BMXErrorCode]

Example:

public void acceptInvitation(BMXGroup group, long inviter, BMXCallBack callBack) {
    mService.acceptInvitation(group, inviter, callBack);

function declineInvitation

inline void declineInvitation(
    final BMXGroup group,
    final long inviter,
    final BMXCallBack callBack
)

Reject invitation to join group

Parameters:

  • group Group to operate on
  • inviter Inviter id
  • callBack [BMXErrorCode]

Example:

public void declineInvitation(BMXGroup group, long inviter, BMXCallBack callBack) {
    mService.declineInvitation(group, inviter, callBack);

function transferOwner

inline void transferOwner(
    final BMXGroup group,
    final long newOwnerId,
    final BMXCallBack callBack
)

Transfer of group Owner

Parameters:

  • group Group to operate on
  • newOwnerId User id that transferred as new group Owner
  • callBack [BMXErrorCode]

Example:

public void transferOwner(BMXGroup group, long newOwnerId, BMXCallBack callBack) {
    mService.transferOwner(group, newOwnerId, callBack);

function uploadSharedFile

inline void uploadSharedFile(
    final BMXGroup group,
    final String filePath,
    final String displayName,
    final String extensionName,
    final FileProgressListener listener,
    final BMXCallBack callBack
)

Add shared file in group

Parameters:

  • group Group to operate on
  • filePath Local path of file
  • displayName File display name
  • extensionName File extension name
  • listener Upload callback function
  • callBack [BMXErrorCode]

Example:

public void uploadSharedFile(BMXGroup group, String filePath, String displayName,
        String extensionName, FileProgressListener listener, BMXCallBack callBack) {
    mService.uploadSharedFile(group, filePath, displayName, extensionName, listener, callBack);

function removeSharedFile

inline void removeSharedFile(
    final BMXGroup group,
    final BMXGroup.SharedFile sharedFile,
    final BMXCallBack callBack
)

Remove shared file in group

Parameters:

  • group Group to operate on
  • sharedFile Deleted group shared file
  • callBack [BMXErrorCode]

Example:

public void removeSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile, BMXCallBack callBack) {
    mService.removeSharedFile(group, sharedFile, callBack);

function downloadSharedFile

inline void downloadSharedFile(
    final BMXGroup group,
    final BMXGroup.SharedFile sharedFile,
    final FileProgressListener listener,
    final BMXCallBack callBack
)

Download share file in group

Parameters:

  • group Group to operate on
  • sharedFile Downloaded group shared files
  • listener Download callback function
  • callBack [BMXErrorCode]

Example:

public void downloadSharedFile(BMXGroup group, BMXGroup.SharedFile sharedFile,
        FileProgressListener listener, BMXCallBack callBack) {
    mService.downloadSharedFile(group, sharedFile, listener, callBack);

function getSharedFilesList

inline void getSharedFilesList(
    final BMXGroup group,
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroupSharedFileList > callBack
)

Get a list of share files in group

Parameters:

  • group Group to operate on
  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], list of group shared files

Example:

public void getSharedFilesList(BMXGroup group, boolean forceRefresh,
        BMXDataCallBack<BMXGroupSharedFileList> callBack) {
    mService.getSharedFilesList(group, forceRefresh, callBack);

function changeSharedFileName

inline void changeSharedFileName(
    final BMXGroup group,
    final BMXGroup.SharedFile sharedFile,
    final String name,
    final BMXCallBack callBack
)

Modify shared file name in group

Parameters:

  • group Group to operate on
  • sharedFile Group shared file to change
  • name Modified group shared file name
  • callBack [BMXErrorCode]

Example:

public void changeSharedFileName(BMXGroup group, BMXGroup.SharedFile sharedFile, String name,
        BMXCallBack callBack) {
    mService.changeSharedFileName(group, sharedFile, name, callBack);

function getLatestAnnouncement

inline void getLatestAnnouncement(
    final BMXGroup group,
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroup.Announcement > callBack
)

Get the latest group announcement

Parameters:

  • group Group to operate on
  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], latest group announcement

Example:

public void getLatestAnnouncement(BMXGroup group, boolean forceRefresh,
        BMXDataCallBack<BMXGroup.Announcement> callBack) {
    mService.getLatestAnnouncement(group, forceRefresh, callBack);

function getAnnouncementList

inline void getAnnouncementList(
    final BMXGroup group,
    final boolean forceRefresh,
    final BMXDataCallBack< BMXGroupAnnouncementList > callBack
)

Get group announcements list

Parameters:

  • group Group to operate on
  • forceRefresh True to force fetch from server, sdk will fetch from server automatically if local fetch failed
  • callBack [BMXErrorCode], list of group announcements

Example:

public void getAnnouncementList(BMXGroup group, boolean forceRefresh,
        BMXDataCallBack<BMXGroupAnnouncementList> callBack) {
    mService.getAnnouncementList(group, forceRefresh, callBack);

function editAnnouncement

inline void editAnnouncement(
    final BMXGroup group,
    final String title,
    final String content,
    final BMXCallBack callBack
)

Write group announcement

Parameters:

  • group Group to operate on
  • title Tittle of group announcement
  • content Content of group announcement
  • callBack [BMXErrorCode]

Example:

public void editAnnouncement(BMXGroup group, String title, String content, BMXCallBack callBack) {
    mService.editAnnouncement(group, title, content, callBack);

function deleteAnnouncement

inline void deleteAnnouncement(
    final BMXGroup group,
    final long announcementId,
    final BMXCallBack callBack
)

Delete group announcement

Parameters:

  • group Group to operate on
  • announcementId Deleted group announcement id
  • callBack [BMXErrorCode]

Example:

public void deleteAnnouncement(BMXGroup group, long announcementId, BMXCallBack callBack) {
    mService.deleteAnnouncement(group, announcementId, callBack);

function setName

inline void setName(
    final BMXGroup group,
    final String name,
    final BMXCallBack callBack
)

Set group name

Parameters:

  • group Group to operate on
  • name Group name
  • callBack [BMXErrorCode]

Example:

public void setName(BMXGroup group, String name, BMXCallBack callBack) {
    mService.setName(group, name, callBack);

function setDescription

inline void setDescription(
    final BMXGroup group,
    final String description,
    final BMXCallBack callBack
)

Set group description

Parameters:

  • group Group to operate on
  • description Group description
  • callBack [BMXErrorCode]

Example:

public void setDescription(BMXGroup group, String description,BMXCallBack callBack) {
    mService.setDescription(group, description, callBack);

function setExtension

inline void setExtension(
    final BMXGroup group,
    final String extension,
    final BMXCallBack callBack
)

Set group extension information

Parameters:

  • group Group to operate on
  • extension Group extension information
  • callBack [BMXErrorCode]

Example:

public void setExtension(BMXGroup group, String extension, BMXCallBack callBack) {
    mService.setExtension(group, extension, callBack);

function setMyNickname

inline void setMyNickname(
    final BMXGroup group,
    final String nickname,
    final BMXCallBack callBack
)

Set nickname in group

Parameters:

  • group Group to operate on
  • nickname My nickname in group
  • callBack [BMXErrorCode]

Example:

public void setMyNickname(BMXGroup group, String nickname, BMXCallBack callBack) {
    mService.setMyNickname(group, nickname, callBack);

function setMsgPushMode

inline void setMsgPushMode(
    final BMXGroup group,
    final BMXGroup.MsgPushMode mode,
    final BMXCallBack callBack
)

Set group message notification mode

Parameters:

  • group Group to operate on
  • mode Group message notification mode
  • callBack [BMXErrorCode]

Example:

public void setMsgPushMode(BMXGroup group, BMXGroup.MsgPushMode mode, BMXCallBack callBack) {
    mService.setMsgPushMode(group, mode, callBack);

function setJoinAuthMode

inline void setJoinAuthMode(
    final BMXGroup group,
    final BMXGroup.JoinAuthMode mode,
    final BMXCallBack callBack
)

Set approval mode for joining group

Parameters:

  • group Group to operate on
  • mode Join approval mode
  • callBack [BMXErrorCode]

Example:

public void setJoinAuthMode(BMXGroup group, BMXGroup.JoinAuthMode mode, BMXCallBack callBack) {
    mService.setJoinAuthMode(group, mode, callBack);

function setInviteMode

inline void setInviteMode(
    final BMXGroup group,
    final BMXGroup.InviteMode mode,
    final BMXCallBack callBack
)

Set invitation mode

Parameters:

  • group Group to operate on
  • mode Group invitation mode
  • callBack [BMXErrorCode]

Example:

public void setInviteMode(BMXGroup group, BMXGroup.InviteMode mode, BMXCallBack callBack) {
    mService.setInviteMode(group, mode, callBack);

function setAvatar

inline void setAvatar(
    final BMXGroup group,
    final String avatarPath,
    final FileProgressListener listener,
    final BMXCallBack callBack
)

Set group avatar

Parameters:

  • group Group to operate on
  • avatarPath Local path of group avatar file
  • listener Upload callback function
  • callBack [BMXErrorCode]

Example:

public void setAvatar(BMXGroup group, String avatarPath,
        FileProgressListener listener, BMXCallBack callBack) {
    mService.setAvatar(group, avatarPath, listener, callBack);

function downloadAvatar

inline void downloadAvatar(
    final BMXGroup group,
    final FileProgressListener listener,
    final BMXCallBack callBack
)

Download group avatar

Parameters:

  • group Group to operate on
  • listener Download callback function
  • callBack [BMXErrorCode]

Example:

public void downloadAvatar(BMXGroup group, FileProgressListener listener, BMXCallBack callBack) {
    mService.downloadAvatar(group, listener, callBack);

function addGroupListener

inline void addGroupListener(
    BMXGroupServiceListener listener
)

Add group change listener

Parameters:

  • listener Group change listener

Example:

public void addGroupListener(BMXGroupServiceListener listener) {
    mService.addGroupListener(listener);

function removeGroupListener

inline void removeGroupListener(
    BMXGroupServiceListener listener
)

Remove group change listener

Parameters:

  • listener Group change listener

Example:

public void removeGroupListener(BMXGroupServiceListener listener) {
    mService.removeGroupListener(listener);

function setEnableReadAck

inline void setEnableReadAck(
    final BMXGroup group,
    final boolean enable,
    final BMXCallBack callBack
)

Set whether group message read acknowledgement is enabled

Parameters:

  • group Group to operate on
  • enable Enable or not
  • callBack [BMXErrorCode]

Example:

public void setEnableReadAck(BMXGroup group, boolean enable, BMXCallBack callBack) {
    mService.setEnableReadAck(group, enable, callBack);


Updated on 2022-01-26 at 17:18:31 +0800

© 2019-2024 MaximTop | Homepage | Site Map Last modified time: 2024-12-07 06:49:06