IM

  • IM > API 文档 > ANDROID API > BMXRosterService

    BMXRosterService

    最近更新时间:2021-07-20 10:09:06

    类 BMXRosterService

    • java.lang.Object

      • im.floo.floolib.BMXRosterService

    • public class BMXRosterService
      extends java.lang.Object
      

      好友Service

      • 嵌套类概要

        嵌套类 
        限定符和类型 类和说明
        static class  BMXRosterService.Application
        好友邀请
        static class  BMXRosterService.ApplicationStatus
        请求状态
      • 字段概要

        字段 
        限定符和类型 字段和说明
        protected boolean swigCMemOwn 
      • 构造器概要

        构造器 
        限定符 构造器和说明
        protected BMXRosterService(long cPtr, boolean cMemoryOwn) 
      • 方法概要

        所有方法 静态方法 实例方法 具体方法 
        限定符和类型 方法和说明
        BMXErrorCode accept(long rosterId)
        接受加好友申请
        void addRosterListener(BMXRosterServiceListener listener)
        添加好友变化监听者
        BMXErrorCode apply(long rosterId, java.lang.String message)
        申请添加好友
        BMXErrorCode apply(long rosterId, java.lang.String message, java.lang.String authAnswer) 
        BMXErrorCode block(long rosterId)
        加入黑名单
        BMXErrorCode decline(long rosterId, java.lang.String reason)
        拒绝加好友申请
        void delete() 
        BMXErrorCode downloadAvatar(BMXRosterItem item, boolean thumbnail, FileProgressListener listener)
        下载头像
        BMXErrorCode fetchRosterById(long rosterId, boolean forceRefresh, BMXRosterItem item)
        搜索用户
        BMXErrorCode fetchRosterByName(java.lang.String name, boolean forceRefresh, BMXRosterItem item)
        搜索用户
        BMXErrorCode fetchRostersByIdList(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh)
        批量搜索用户
        protected void finalize() 
        BMXErrorCode get(ListOfLongLong list, boolean forceRefresh)
        获取好友列表,如果forceRefresh == true,则强制从服务端拉取
        BMXErrorCode getApplicationList(ApplicationPage result, java.lang.String cursor) 
        BMXErrorCode getApplicationList(ApplicationPage result, java.lang.String cursor, int pageSize)
        获取申请添加好友列表
        BMXErrorCode getBlockList(ListOfLongLong list, boolean forceRefresh)
        获取黑名单,如果forceRefresh == true,则强制从服务端拉取
        protected static long getCPtr(BMXRosterService obj) 
        BMXErrorCode remove(long rosterId)
        删除好友
        void removeRosterListener(BMXRosterServiceListener listener)
        移除好友变化监听者
        BMXErrorCode search(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh)
        批量搜索用户
        BMXErrorCode search(long rosterId, boolean forceRefresh, BMXRosterItem item)
        搜索用户
        BMXErrorCode search(java.lang.String name, boolean forceRefresh, BMXRosterItem item)
        搜索用户
        BMXErrorCode setItemAlias(BMXRosterItem item, java.lang.String alias)
        更新好友别名
        BMXErrorCode setItemExtension(BMXRosterItem item, java.lang.String extension)
        更新好友服务器扩展信息
        BMXErrorCode setItemLocalExtension(BMXRosterItem item, java.lang.String extension)
        更新好友本地扩展信息
        BMXErrorCode setItemMuteNotification(BMXRosterItem item, boolean status)
        设置是否拒收用户消息
        BMXErrorCode unblock(long rosterId)
        从黑名单移除
        • 从类继承的方法 java.lang.Object

          clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • 字段详细资料

        • swigCMemOwn

          protected transient boolean swigCMemOwn
          
      • 构造器详细资料

        • BMXRosterService

          protected BMXRosterService(long cPtr,
                                     boolean cMemoryOwn)
          
      • 方法详细资料

        • getCPtr

          protected static long getCPtr(BMXRosterService obj)
          
        • finalize

          protected void finalize()
          

          覆盖:

          finalize 在类中 java.lang.Object

        • delete

          public void delete()
          
        • get

          public BMXErrorCode get(ListOfLongLong list,
                                  boolean forceRefresh)
          

          获取好友列表,如果forceRefresh == true,则强制从服务端拉取

          参数:

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

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

          返回:

          BMXErrorCode

        • fetchRosterById

          public BMXErrorCode fetchRosterById(long rosterId,
                                              boolean forceRefresh,
                                              BMXRosterItem item)
          

          搜索用户

          参数:

          rosterId - 搜索的好友id

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

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

          返回:

          BMXErrorCode

        • search

          public BMXErrorCode search(long rosterId,
                                     boolean forceRefresh,
                                     BMXRosterItem item)
          

          搜索用户

          参数:

          rosterId - 搜索的好友id

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

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

          返回:

          BMXErrorCode

        • fetchRosterByName

          public BMXErrorCode fetchRosterByName(java.lang.String name,
                                                boolean forceRefresh,
                                                BMXRosterItem item)
          

          搜索用户

          参数:

          name - 搜索的用户名

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

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

          返回:

          BMXErrorCode

        • search

          public BMXErrorCode search(java.lang.String name,
                                     boolean forceRefresh,
                                     BMXRosterItem item)
          

          搜索用户

          参数:

          name - 搜索的用户名

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

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

          返回:

          BMXErrorCode

        • fetchRostersByIdList

          public BMXErrorCode fetchRostersByIdList(ListOfLongLong rosterIdList,
                                                   BMXRosterItemList list,
                                                   boolean forceRefresh)
          

          批量搜索用户

          参数:

          rosterIdList - 需要搜索的用户id列表

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

          forceRefresh - 是否强制从服务器获取,为true则强制从服务器获取

          返回:

          BMXErrorCode

        • search

          public BMXErrorCode search(ListOfLongLong rosterIdList,
                                     BMXRosterItemList list,
                                     boolean forceRefresh)
          

          批量搜索用户

          参数:

          rosterIdList - 需要搜索的用户id列表

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

          forceRefresh - 是否强制从服务器获取,为true则强制从服务器获取

          返回:

          BMXErrorCode

        • setItemLocalExtension

          public BMXErrorCode setItemLocalExtension(BMXRosterItem item,
                                                    java.lang.String extension)
          

          更新好友本地扩展信息

          参数:

          item - 用户信息

          extension - 本地扩展信息

          返回:

          BMXErrorCode

        • setItemExtension

          public BMXErrorCode setItemExtension(BMXRosterItem item,
                                               java.lang.String extension)
          

          更新好友服务器扩展信息

          参数:

          item - 用户信息

          extension - 服务器扩展信息

          返回:

          BMXErrorCode

        • setItemAlias

          public BMXErrorCode setItemAlias(BMXRosterItem item,
                                           java.lang.String alias)
          

          更新好友别名

          参数:

          item - 用户信息

          alias - 好友别名

          返回:

          BMXErrorCode

        • setItemMuteNotification

          public BMXErrorCode setItemMuteNotification(BMXRosterItem item,
                                                      boolean status)
          

          设置是否拒收用户消息

          参数:

          item - 用户信息

          status - 是否拒收用户消息,true拒收,false不拒收

          返回:

          BMXErrorCode

        • getApplicationList

          public BMXErrorCode getApplicationList(ApplicationPage result,
                                                 java.lang.String cursor,
                                                 int pageSize)
          

          获取申请添加好友列表

          参数:

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

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

          pageSize - 分页大小

          返回:

          BMXErrorCode

        • getApplicationList

          public BMXErrorCode getApplicationList(ApplicationPage result,
                                                 java.lang.String cursor)
          
        • apply

          public BMXErrorCode apply(long rosterId,
                                    java.lang.String message,
                                    java.lang.String authAnswer)
          
        • apply

          public BMXErrorCode apply(long rosterId,
                                    java.lang.String message)
          

          申请添加好友

          参数:

          rosterId - 申请添加的用户id

          message - 好友申请信息

          返回:

          BMXErrorCode

        • remove

          public BMXErrorCode remove(long rosterId)
          

          删除好友

          参数:

          rosterId - 删除的好友id

          返回:

          BMXErrorCode

        • accept

          public BMXErrorCode accept(long rosterId)
          

          接受加好友申请

          参数:

          rosterId - 申请加为好友的用户id

          返回:

          BMXErrorCode

        • decline

          public BMXErrorCode decline(long rosterId,
                                      java.lang.String reason)
          

          拒绝加好友申请

          参数:

          rosterId - 申请加为好友的用户id

          reason - 拒绝的原因

          返回:

          BMXErrorCode

        • block

          public BMXErrorCode block(long rosterId)
          

          加入黑名单

          参数:

          rosterId - 加入黑名单的用户id

          返回:

          BMXErrorCode

        • unblock

          public BMXErrorCode unblock(long rosterId)
          

          从黑名单移除

          参数:

          rosterId - 从黑名单移除的用户id

          返回:

          BMXErrorCode

        • getBlockList

          public BMXErrorCode getBlockList(ListOfLongLong list,
                                           boolean forceRefresh)
          

          获取黑名单,如果forceRefresh == true,则强制从服务端拉取

          参数:

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

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

          返回:

          BMXErrorCode

        • downloadAvatar

          public BMXErrorCode downloadAvatar(BMXRosterItem item,
                                             boolean thumbnail,
                                             FileProgressListener listener)
          

          下载头像

          参数:

          item - 用户信息

          thumbnail - 是否下载缩略图,ture为缩略图,false为原图

          listener - 下载回调函数

          返回:

          BMXErrorCode

        • addRosterListener

          public void addRosterListener(BMXRosterServiceListener listener)
          

          添加好友变化监听者

          参数:

          listener - 好友变化监听者

        • removeRosterListener

          public void removeRosterListener(BMXRosterServiceListener listener)
          

          移除好友变化监听者

          参数:

          listener - 好友变化监听者

    以上内容是否对您有帮助?
  • Qvm free helper
    Close