即时通讯

  • 即时通讯 > API 文档 > ANDROID API > BMXPushManager

    BMXPushManager

    最近更新时间: 2022-07-22 22:44:33

    class im.floo.floolib.BMXPushManager

    推送管理器

    Index
    方法
    方法
    start
    • public void start(final String alias, final String bmxToken, final BMXCallBack callBack);
    • 初始化推送sdk。在仅使用推送的情况下使用该接口初始化推送sdk。在同时使用IM功能的时候直接在BMXClient调用登陆功能即可。config对象初始化的时候需要传入平台类型和设备id。

      Parameters
      • alias: String

        推送初始化使用的当前用户别名

      • bmxToken: String

        推送初始化的时候App传入的使用的用户的token,无用户的状态下不传入即可。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    start
    • public void start(final String alias, final BMXCallBack callBack);
    • Returns void
    start
    • public void start(final BMXCallBack callBack);
    • Returns void
    stop
    • public void stop(final BMXCallBack callBack);
    • 停止推送功能接口。

      Parameters
      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    resume
    • public void resume(final BMXCallBack callBack);
    • 恢复推送功能接口。

      Parameters
      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    unbindAlias
    • public void unbindAlias(final String alias, final BMXCallBack callBack);
    • 解除用户别名绑定。

      Parameters
      • alias: String

        需要解除绑定的用户别名。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    getToken
    • public String getToken();
    • 获取登陆后使用的用户token。

      Returns String
    getCert
    • public String getCert();
    • 获取登陆后服务器返回的推送证书。

      Returns String
    status
    • public BMXPushService.PushSdkStatus status();
    • 推送sdk当前的状态。

      Returns PushSdkStatus
    bindDeviceToken
    • public void bindDeviceToken(final String token, final BMXCallBack callBack);
    • 推送绑定设备token。

      Parameters
      • token: String

        设备的推送token

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    bindVoipToken
    • public void bindVoipToken(final String token, final BMXCallBack callBack);
    • 绑定推送设备的voiptoken。

      Parameters
      • token: String

        设备的voip推送token

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    getPushProfile
    • public void getPushProfile(final boolean forceRefresh, final BMXDataCallBack<BMXPushUserProfile> callBack);
    • 获取推送用户详情,如果forceRefresh == true,则强制从服务端拉取

      Parameters
      • forceRefresh: boolean

        是否强制从服务器拉取,本地获取失败的情况下会自动从服务器拉取

      • callBack: <any>

        推送用户profile信息,初始传入指向为空的shared_ptr对象,函数返回后从此处获取用户profile信息

      Returns void
    setTags
    • public void setTags(final TagList tags, final String operationId, final BMXCallBack callBack);
    • 设置推送用户的标签。

      Parameters
      • tags: TagList

        用户标签

      • operationId: String

        操作id。在回调通知中对应通知提醒。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    getTags
    • public void getTags(final TagList tags, final String operationId, final BMXCallBack callBack);
    • 获取推送用户的标签。

      Parameters
      • tags: TagList

        用户标签

      • operationId: String

        操作id。在回调通知中对应通知提醒。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    deleteTags
    • public void deleteTags(final TagList tags, final String operationId, final BMXCallBack callBack);
    • 删除推送用户的标签。

      Parameters
      • tags: TagList

        要删除用户标签

      • operationId: String

        操作id。在回调通知中对应通知提醒。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    clearTags
    • public void clearTags(final String operationId, final BMXCallBack callBack);
    • 清空推送用户的标签。

      Parameters
      • operationId: String

        操作id。在回调通知中对应通知提醒。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    setBadge
    • public void setBadge(final int count, final BMXCallBack callBack);
    • 设置推送用户的未读角标。

      Parameters
      • count: int

        用户未读角标数

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    setPushMode
    • public void setPushMode(final boolean enable, final BMXCallBack callBack);
    • 设置推送启用状态。默认为使用推送。

      Parameters
      • enable: boolean

        推送的启用状态

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    setPushMode
    • public void setPushMode(final BMXCallBack callBack);
    • Returns void
    setPushTime
    • public void setPushTime(final int startHour, final int endHour, final BMXCallBack callBack);
    • 设置允许推送时间。

      Parameters
      • startHour: int

        静默允许推送的起始时间小时

      • endHour: int

        静默允许推送的结束时间小时

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    setSilenceTime
    • public void setSilenceTime(final int startHour, final int endHour, final BMXCallBack callBack);
    • 设置推送静默的起始结束时间。

      Parameters
      • startHour: int

        静默推送的起始时间小时

      • endHour: int

        静默推送的结束时间小时

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    setRunBackgroundMode
    • public void setRunBackgroundMode(final boolean enable, final BMXCallBack callBack);
    • 设置推送是否可以后台运行。默认是false。

      Parameters
      • enable: boolean

        推送后台运行状态。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    setRunBackgroundMode
    • public void setRunBackgroundMode(final BMXCallBack callBack);
    • Returns void
    setGeoFenceMode
    • public void setGeoFenceMode(final boolean enable, final boolean isAllow, final BMXCallBack callBack);
    • 设置推送的地理围栏功能是否运行。

      Parameters
      • enable: boolean

        地理围栏功能是否运行。

      • isAllow: boolean

        用户是否主动弹出用户定位请求。

      • callBack: BMXCallBack

        BMXErrorCode

      Returns void
    setGeoFenceMode
    • public void setGeoFenceMode(final boolean enable, final BMXCallBack callBack);
    • Returns void
    setGeoFenceMode
    • public void setGeoFenceMode(final BMXCallBack callBack);
    • Returns void
    clearNotification
    • public void clearNotification(final long notificationId);
    • 清除指定id的通知。

      Parameters
      • notificationId: long

        通知id

      Returns void
    clearAllNotifications
    • public void clearAllNotifications();
    • Returns void
    sendMessage
    • public void sendMessage(final String content);
    • 发送推送上行消息,消息状态变化会通过listener通知

      Parameters
      • content: String

        发送的上行推送消息内容

      Returns void
    loadLocalPushMessages
    • public void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXPushService.PushDirection arg3, final BMXCallBack callBack);
    • 加载数据库本地存储的推送消息。如果不指定则从最新消息开始

      Parameters
      • refMsgId: long

        加载推送消息的起始id

      • size: long

        最大加载消息条数

      • result: BMXMessageList

        数据库返回的加载本地推送消息列表

      • arg3: PushDirection

        加载推送消息的方向,默认是加载更早的消息

      Returns void
    loadLocalPushMessages
    • public void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXCallBack callBack);
    • Returns void
    addPushListener
    • public void addPushListener(BMXPushServiceListener listener);
    • 添加推送监听者

      Parameters
      Returns void
    removePushListener
    • public void removePushListener(BMXPushServiceListener listener);
    • 移除推送监听者

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