即时通讯

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

    BMXPushService

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

    class im.floo.floolib.BMXPushService

    Index
    字段
    方法
    字段
    swigCMemOwn
    • protected transient boolean swigCMemOwn

    方法
    getCPtr
    • protected static long getCPtr(BMXPushService obj);

    • Returns long
    finalize
    • protected void finalize();

    • Returns void
    delete
    • public synchronized void delete();

    • Returns void
    start
    • public BMXErrorCode start(String alias, String bmxToken);

    • 初始化推送sdk。在仅使用推送的情况下使用该接口初始化推送sdk。在同时使用IM功能的时候直接在BMXClient调用登陆功能即可。config对象初始化的时候需要传入平台类型和设备id。

      Parameters
      • alias: String

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

      • bmxToken: String

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

      Returns BMXErrorCode
    start
    • public BMXErrorCode start(String alias);

    • Returns BMXErrorCode
    start
    • public BMXErrorCode start();

    • Returns BMXErrorCode
    stop
    • public BMXErrorCode stop();

    • 停止推送功能接口。

      Returns BMXErrorCode
    resume
    • public BMXErrorCode resume();

    • 恢复推送功能接口。

      Returns BMXErrorCode
    unbindAlias
    • public BMXErrorCode unbindAlias(String alias);

    • 解除用户别名绑定。

      Parameters
      • alias: String

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

      Returns BMXErrorCode
    getToken
    • public String getToken();

    • 获取登陆后使用的用户token。

      Returns String
    getCert
    • public String getCert();

    • 获取登陆后服务器返回的推送证书。

      Returns String
    status
    • public BMXPushService.PushSdkStatus status();

    • 推送sdk当前的状态。

      Returns PushSdkStatus
    bindDeviceToken
    • public BMXErrorCode bindDeviceToken(String token);

    • 推送绑定设备token。

      Parameters
      • token: String

        设备的推送token

      Returns BMXErrorCode
    bindVoipToken
    • public BMXErrorCode bindVoipToken(String token);

    • 绑定推送设备的voiptoken。

      Parameters
      • token: String

        设备的voip推送token

      Returns BMXErrorCode
    getPushProfile
    • public BMXErrorCode getPushProfile(BMXPushUserProfile pushProfile, boolean forceRefresh);

    • 获取推送用户详情，如果forceRefresh == true，则强制从服务端拉取

      Parameters
      • pushProfile: BMXPushUserProfile

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

      • forceRefresh: boolean

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

      Returns BMXErrorCode
    setTags
    • public BMXErrorCode setTags(TagList tags, String operationId);

    • 设置推送用户的标签。

      Parameters
      • tags: TagList

        用户标签

      • operationId: String

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

      Returns BMXErrorCode
    getTags
    • public BMXErrorCode getTags(TagList tags, String operationId);

    • 获取推送用户的标签。

      Parameters
      • tags: TagList

        用户标签

      • operationId: String

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

      Returns BMXErrorCode
    deleteTags
    • public BMXErrorCode deleteTags(TagList tags, String operationId);

    • 删除推送用户的标签。

      Parameters
      • tags: TagList

        要删除用户标签

      • operationId: String

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

      Returns BMXErrorCode
    clearTags
    • public BMXErrorCode clearTags(String operationId);

    • 清空推送用户的标签。

      Parameters
      • operationId: String

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

      Returns BMXErrorCode
    setBadge
    • public BMXErrorCode setBadge(int count);

    • 设置推送用户的未读角标。

      Parameters
      • count: int

        用户未读角标数

      Returns BMXErrorCode
    setPushMode
    • public BMXErrorCode setPushMode(boolean enable);

    • 设置推送启用状态。默认为使用推送。

      Parameters
      • enable: boolean

        推送的启用状态

      Returns BMXErrorCode
    setPushMode
    • public BMXErrorCode setPushMode();

    • Returns BMXErrorCode
    setPushTime
    • public BMXErrorCode setPushTime(int startHour, int endHour);

    • 设置允许推送时间。

      Parameters
      • startHour: int

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

      • endHour: int

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

      Returns BMXErrorCode
    setSilenceTime
    • public BMXErrorCode setSilenceTime(int startHour, int endHour);

    • 设置推送静默的起始结束时间。

      Parameters
      • startHour: int

        静默推送的起始时间小时

      • endHour: int

        静默推送的结束时间小时

      Returns BMXErrorCode
    setRunBackgroundMode
    • public BMXErrorCode setRunBackgroundMode(boolean enable);

    • 设置推送是否可以后台运行。默认是false。

      Parameters
      • enable: boolean

        推送后台运行状态。

      Returns BMXErrorCode
    setRunBackgroundMode
    • public BMXErrorCode setRunBackgroundMode();

    • Returns BMXErrorCode
    setGeoFenceMode
    • public BMXErrorCode setGeoFenceMode(boolean enable, boolean isAllow);

    • 设置推送的地理围栏功能是否运行。

      Parameters
      • enable: boolean

        地理围栏功能是否运行。

      • isAllow: boolean

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

      Returns BMXErrorCode
    setGeoFenceMode
    • public BMXErrorCode setGeoFenceMode(boolean enable);

    • Returns BMXErrorCode
    setGeoFenceMode
    • public BMXErrorCode setGeoFenceMode();

    • Returns BMXErrorCode
    clearNotification
    • public void clearNotification(long notificationId);

    • 清除指定id的通知。

      Parameters
      • notificationId: long

        通知id

      Returns void
    clearAllNotifications
    • public void clearAllNotifications();

    • Returns void
    sendMessage
    • public void sendMessage(String content);

    • 发送推送上行消息，消息状态变化会通过listener通知

      Parameters
      • content: String

        发送的上行推送消息内容

      Returns void
    loadLocalPushMessages
    • public BMXErrorCode loadLocalPushMessages(long refMsgId, long size, BMXMessageList result, BMXPushService.PushDirection arg3);

    • 加载数据库本地存储的推送消息。如果不指定则从最新消息开始

      Parameters
      • refMsgId: long

        加载推送消息的起始id

      • size: long

        最大加载消息条数

      • result: BMXMessageList

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

      • arg3: PushDirection

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

      Returns BMXErrorCode
    loadLocalPushMessages
    • public BMXErrorCode loadLocalPushMessages(long refMsgId, long size, BMXMessageList result);

    • Returns BMXErrorCode
    addPushListener
    • public void addPushListener(BMXPushServiceListener listener);

    • 添加推送监听者

      Parameters
      Returns void
    removePushListener
    • public void removePushListener(BMXPushServiceListener listener);

    • 移除推送监听者

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