human: 如何处理七牛云的即时通讯BMXRosterManager

gpt: [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterManager

#  BMXRosterManager

最近更新时间: 2022-07-22 22:42:39

class im.floo.floolib.BMXRosterManager

好友管理器

Index

方法

  * get
  * search
  * search
  * search
  * setItemExtension
  * setItemAlias
  * setItemMuteNotification
  * apply
  * remove
  * getApplicationList
  * accept
  * decline
  * block
  * unblock
  * getBlockList
  * downloadAvatar
  * addRosterListener
  * removeRosterListener

方法

get

  * public void get(final boolean forceRefresh, final BMXDataCallBack<ListOfLongLong> callBack);
  * 获取好友列表，如果forceRefresh == true，则强制从服务端拉取

Parameters

    * forceRefresh: boolean 

是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取

    * callBack: <any>

BMXErrorCode 好友id列表

Returns void

search

  * public void search(final long rosterId, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItem> callBack);
  * 搜索用户

Parameters

    * rosterId: long 

搜索的好友id

    * forceRefresh: boolean 

为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

    * callBack: <any>

BMXErrorCode 查询返回的用户的信息

Returns void

search

  * public void search(final String name, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItem> callBack);
  * 搜索用户

Parameters

    * name: String 

搜索的用户名

    * forceRefresh: boolean 

为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

    * callBack: <any>

BMXErrorCode 查询返回的用户的信息

Returns void

search

  * public void search(final ListOfLongLong rosterIdList, final boolean forceRefresh, final BMXDataCallBack<BMXRosterItemList> callBack);
  * 批量搜索用户

Parameters

    * rosterIdList: ListOfLongLong 

需要搜索的用户id列表

    * forceRefresh: boolean 

是否强制从服务器获取，为true则强制从服务器获取

    * callBack: <any>

BMXErrorCode 返回的好友信息列表

Returns void

setItemExtension

  * public void setItemExtension(final BMXRosterItem item, final String extension, final BMXCallBack callBack);
  * 更新好友本地扩展信息

Parameters

    * item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)

用户信息

    * extension: String 

本地扩展信息

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

setItemAlias

  * public void setItemAlias(final BMXRosterItem item, final String alias, final BMXCallBack callBack);
  * 更新好友别名

Parameters

    * item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)

用户信息

    * alias: String 

好友别名

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

setItemMuteNotification

  * public void setItemMuteNotification(final BMXRosterItem item, final boolean status, final BMXCallBack callBack);
  * 设置是否拒收用户消息

Parameters

    * item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)

用户信息

    * status: boolean 

是否拒收用户消息，true拒收，false不拒收

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

apply

  * public void apply(final long rosterId, final String message, final BMXCallBack callBack);
  * 申请添加好友

Parameters

    * rosterId: long 

申请添加的用户id

    * message: String 

好友申请信息

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

remove

  * public void remove(final long rosterId, final BMXCallBack callBack);
  * 删除好友

Parameters

    * rosterId: long 

删除的好友id

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

getApplicationList

  * public void getApplicationList(final String cursor, final int pageSize, final BMXDataCallBack<ApplicationPage> callBack);
  * 获取申请添加好友列表

Parameters

    * cursor: String 

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

    * pageSize: int 

分页大小

    * callBack: <any>

BMXErrorCode 返回的申请好友列表信息

Returns void

accept

  * public void accept(final long rosterId, final BMXCallBack callBack);
  * 接受加好友申请

Parameters

    * rosterId: long 

申请加为好友的用户id

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

decline

  * public void decline(final long rosterId, final String reason, final BMXCallBack callBack);
  * 拒绝加好友申请

Parameters

    * rosterId: long 

申请加为好友的用户id

    * reason: String 

拒绝的原因

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

block

  * public void block(final long rosterId, final BMXCallBack callBack);
  * 加入黑名单

Parameters

    * rosterId: long 

加入黑名单的用户id

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

unblock

  * public void unblock(final long rosterId, final BMXCallBack callBack);
  * 从黑名单移除

Parameters

    * rosterId: long 

从黑名单移除的用户id

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

getBlockList

  * public void getBlockList(final boolean forceRefresh, final BMXDataCallBack<ListOfLongLong> callBack);
  * 获取黑名单，如果forceRefresh == true，则强制从服务端拉取

Parameters

    * forceRefresh: boolean 

是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取

    * callBack: <any>

BMXErrorCode 好友id列表

Returns void

downloadAvatar

  * public void downloadAvatar(final BMXRosterItem item, final FileProgressListener listener, final BMXCallBack callBack);
  * 下载头像

Parameters

    * item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)

用户信息

    * listener: FileProgressListener 

下载回调函数

    * callBack: BMXCallBack 

BMXErrorCode

Returns void

addRosterListener

  * public void addRosterListener(BMXRosterServiceListener listener);
  * 添加好友变化监听者

Parameters

    * listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)

好友变化监听者

Returns void

removeRosterListener

  * public void removeRosterListener(BMXRosterServiceListener listener);
  * 移除好友变化监听者

Parameters

    * listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)

好友变化监听者

Returns void

以上内容是否对您有帮助？