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

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

#  BMXRosterService

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

class im.floo.floolib.BMXRosterService

好友Service

Index

字段

  * swigCMemOwn

方法

  * getCPtr
  * finalize
  * delete
  * get
  * fetchRosterById
  * search
  * fetchRosterByName
  * search
  * fetchRostersByIdList
  * search
  * setItemLocalExtension
  * setItemExtension
  * setItemAlias
  * setItemMuteNotification
  * getApplicationList
  * apply
  * apply
  * remove
  * accept
  * decline
  * block
  * unblock
  * getBlockList
  * downloadAvatar
  * addRosterListener
  * removeRosterListener

字段

swigCMemOwn

  * protected transient boolean swigCMemOwn
  * 

方法

getCPtr

  * protected static long getCPtr(BMXRosterService obj);
  * Returns long

finalize

  * @Override() protected void finalize();
  * Returns void

delete

  * public synchronized void delete();
  * Returns void

get

  * public BMXErrorCode get(ListOfLongLong list, boolean forceRefresh);
  * 获取好友列表，如果forceRefresh == true，则强制从服务端拉取

Parameters

    * list: ListOfLongLong 

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

    * forceRefresh: boolean 

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

Returns BMXErrorCode

fetchRosterById

  * public BMXErrorCode fetchRosterById(long rosterId, boolean forceRefresh, BMXRosterItem item);
  * 搜索用户

Parameters

    * rosterId: long 

搜索的好友id

    * forceRefresh: boolean 

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

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

查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Returns BMXErrorCode

search

  * public BMXErrorCode search(long rosterId, boolean forceRefresh, BMXRosterItem item);
  * 搜索用户

Parameters

    * rosterId: long 

搜索的好友id

    * forceRefresh: boolean 

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

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

查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Returns BMXErrorCode

fetchRosterByName

  * public BMXErrorCode fetchRosterByName(String name, boolean forceRefresh, BMXRosterItem item);
  * 搜索用户

Parameters

    * name: String 

搜索的用户名

    * forceRefresh: boolean 

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

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

查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Returns BMXErrorCode

search

  * public BMXErrorCode search(String name, boolean forceRefresh, BMXRosterItem item);
  * 搜索用户

Parameters

    * name: String 

搜索的用户名

    * forceRefresh: boolean 

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

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

查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Returns BMXErrorCode

fetchRostersByIdList

  * public BMXErrorCode fetchRostersByIdList(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh);
  * 批量搜索用户

Parameters

    * rosterIdList: ListOfLongLong 

需要搜索的用户id列表

    * list: BMXRosterItemList 

返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表

    * forceRefresh: boolean 

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

Returns BMXErrorCode

search

  * public BMXErrorCode search(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh);
  * 批量搜索用户

Parameters

    * rosterIdList: ListOfLongLong 

需要搜索的用户id列表

    * list: BMXRosterItemList 

返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表

    * forceRefresh: boolean 

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

Returns BMXErrorCode

setItemLocalExtension

  * public BMXErrorCode setItemLocalExtension(BMXRosterItem item, String extension);
  * 更新好友本地扩展信息

Parameters

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

用户信息

    * extension: String 

本地扩展信息

Returns BMXErrorCode

setItemExtension

  * public BMXErrorCode setItemExtension(BMXRosterItem item, String extension);
  * 更新好友服务器扩展信息

Parameters

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

用户信息

    * extension: String 

服务器扩展信息

Returns BMXErrorCode

setItemAlias

  * public BMXErrorCode setItemAlias(BMXRosterItem item, String alias);
  * 更新好友别名

Parameters

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

用户信息

    * alias: String 

好友别名

Returns BMXErrorCode

setItemMuteNotification

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

Parameters

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

用户信息

    * status: boolean 

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

Returns BMXErrorCode

getApplicationList

  * public BMXErrorCode getApplicationList(ApplicationPage result, String cursor, int pageSize);
  * 获取申请添加好友列表

Parameters

    * result: ApplicationPage 

返回的申请好友列表信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

    * cursor: String 

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

    * pageSize: int 

分页大小

Returns BMXErrorCode

apply

  * public BMXErrorCode apply(long rosterId, String message, String authAnswer);
  * Returns BMXErrorCode

apply

  * public BMXErrorCode apply(long rosterId, String message);
  * 申请添加好友

Parameters

    * rosterId: long 

申请添加的用户id

    * message: String 

好友申请信息

Returns BMXErrorCode

remove

  * public BMXErrorCode remove(long rosterId);
  * 删除好友

Parameters

    * rosterId: long 

删除的好友id

Returns BMXErrorCode

accept

  * public BMXErrorCode accept(long rosterId);
  * 接受加好友申请

Parameters

    * rosterId: long 

申请加为好友的用户id

Returns BMXErrorCode

decline

  * public BMXErrorCode decline(long rosterId, String reason);
  * 拒绝加好友申请

Parameters

    * rosterId: long 

申请加为好友的用户id

    * reason: String 

拒绝的原因

Returns BMXErrorCode

block

  * public BMXErrorCode block(long rosterId);
  * 加入黑名单

Parameters

    * rosterId: long 

加入黑名单的用户id

Returns BMXErrorCode

unblock

  * public BMXErrorCode unblock(long rosterId);
  * 从黑名单移除

Parameters

    * rosterId: long 

从黑名单移除的用户id

Returns BMXErrorCode

getBlockList

  * public BMXErrorCode getBlockList(ListOfLongLong list, boolean forceRefresh);
  * 获取黑名单，如果forceRefresh == true，则强制从服务端拉取

Parameters

    * list: ListOfLongLong 

好友id列表，传入空列表函数返回后从此处获取返回的黑名单id列表

    * forceRefresh: boolean 

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

Returns BMXErrorCode

downloadAvatar

  * public BMXErrorCode downloadAvatar(BMXRosterItem item, boolean thumbnail, FileProgressListener listener);
  * 下载头像

Parameters

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

用户信息

    * thumbnail: boolean 

是否下载缩略图，ture为缩略图，false为原图

    * listener: FileProgressListener 

下载回调函数

Returns BMXErrorCode

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

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