im::floo::floolib::BMXPushManager

推送管理器

Public Functions

Name
BMXPushManager(BMXPushService service)
void start(final String alias, final String bmxToken, final BMXCallBack callBack)
初始化推送sdk。在仅使用推送的情况下使用该接口初始化推送sdk。在同时使用IM功能的时候直接在BMXClient调用登陆功能即可。config对象初始化的时候需要传入平台类型和设备id。
void start(final String alias, final BMXCallBack callBack)
void start(final BMXCallBack callBack)
void stop(final BMXCallBack callBack)
停止推送功能接口。
void resume(final BMXCallBack callBack)
恢复推送功能接口。
void unbindAlias(final String alias, final BMXCallBack callBack)
解除用户别名绑定。
String getToken()
获取登陆后使用的用户token。
String getCert()
获取登陆后服务器返回的推送证书。
BMXPushService.PushSdkStatus status()
推送sdk当前的状态。
void bindDeviceToken(final String token, final BMXCallBack callBack)
推送绑定设备token。
void bindVoipToken(final String token, final BMXCallBack callBack)
绑定推送设备的voiptoken。
void getPushProfile(final boolean forceRefresh, final BMXDataCallBack< BMXPushUserProfile > callBack)
获取推送用户详情,如果forceRefresh == true,则强制从服务端拉取
void setTags(final TagList tags, final String operationId, final BMXCallBack callBack)
设置推送用户的标签。
void getTags(final TagList tags, final String operationId, final BMXCallBack callBack)
获取推送用户的标签。
void deleteTags(final TagList tags, final String operationId, final BMXCallBack callBack)
删除推送用户的标签。
void clearTags(final String operationId, final BMXCallBack callBack)
清空推送用户的标签。
void setBadge(final int count, final BMXCallBack callBack)
设置推送用户的未读角标。
void setPushMode(final boolean enable, final BMXCallBack callBack)
设置推送启用状态。默认为使用推送。
void setPushMode(final BMXCallBack callBack)
void setPushTime(final int startHour, final int endHour, final BMXCallBack callBack)
设置允许推送时间。
void setSilenceTime(final int startHour, final int endHour, final BMXCallBack callBack)
设置推送静默的起始结束时间。
void setRunBackgroundMode(final boolean enable, final BMXCallBack callBack)
设置推送是否可以后台运行。默认是false。
void setRunBackgroundMode(final BMXCallBack callBack)
void setGeoFenceMode(final boolean enable, final boolean isAllow, final BMXCallBack callBack)
设置推送的地理围栏功能是否运行。
void setGeoFenceMode(final boolean enable, final BMXCallBack callBack)
void setGeoFenceMode(final BMXCallBack callBack)
void clearNotification(final long notificationId)
清除指定id的通知。
void clearAllNotifications()
void sendMessage(final String content)
发送推送上行消息,消息状态变化会通过listener通知
void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXPushService.PushDirection arg3, final BMXCallBack callBack)
加载数据库本地存储的推送消息。如果不指定则从最新消息开始
void loadLocalPushMessages(final long refMsgId, final long size, final BMXMessageList result, final BMXCallBack callBack)
void addPushListener(BMXPushServiceListener listener)
添加推送监听者
void removePushListener(BMXPushServiceListener listener)
移除推送监听者

Public Functions Documentation

function BMXPushManager

inline BMXPushManager(
    BMXPushService service
)

Example:

function start

inline void start(
    final String alias,
    final String bmxToken,
    final BMXCallBack callBack
)

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

Parameters:

  • alias 推送初始化使用的当前用户别名
  • bmxToken 推送初始化的时候App传入的使用的用户的token,无用户的状态下不传入即可。
  • callBack [BMXErrorCode]

Example:

public void start(String alias, String bmxToken, BMXCallBack callBack) {
    mService.start(alias, bmxToken, callBack);
public void start(String alias, BMXCallBack callBack) {
    mService.start(alias, callBack);
public void start(BMXCallBack callBack) {
    mService.start(callBack);

function start

inline void start(
    final String alias,
    final BMXCallBack callBack
)

Example:

public void start(String alias, String bmxToken, BMXCallBack callBack) {
    mService.start(alias, bmxToken, callBack);
public void start(String alias, BMXCallBack callBack) {
    mService.start(alias, callBack);
public void start(BMXCallBack callBack) {
    mService.start(callBack);

function start

inline void start(
    final BMXCallBack callBack
)

Example:

public void start(String alias, String bmxToken, BMXCallBack callBack) {
    mService.start(alias, bmxToken, callBack);
public void start(String alias, BMXCallBack callBack) {
    mService.start(alias, callBack);
public void start(BMXCallBack callBack) {
    mService.start(callBack);

function stop

inline void stop(
    final BMXCallBack callBack
)

停止推送功能接口。

Parameters:

  • callBack [BMXErrorCode]

Example:

public void stop(BMXCallBack callBack) {
    mService.stop(callBack);

function resume

inline void resume(
    final BMXCallBack callBack
)

恢复推送功能接口。

Parameters:

  • callBack [BMXErrorCode]

Example:

public void resume(BMXCallBack callBack) {
    mService.resume(callBack);

function unbindAlias

inline void unbindAlias(
    final String alias,
    final BMXCallBack callBack
)

解除用户别名绑定。

Parameters:

  • alias 需要解除绑定的用户别名。
  • callBack [BMXErrorCode]

Example:

public void unbindAlias(String alias, BMXCallBack callBack) {
    mService.unbindAlias(alias, callBack);

function getToken

inline String getToken()

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

Example:

public String getToken() {
    return mService.getToken();

function getCert

inline String getCert()

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

Example:

public String getCert() {
    return mService.getCert();

function status

inline BMXPushService.PushSdkStatus status()

推送sdk当前的状态。

Return: PushSdkStatus

Example:

public BMXPushService.PushSdkStatus status() {
    return mService.status();

function bindDeviceToken

inline void bindDeviceToken(
    final String token,
    final BMXCallBack callBack
)

推送绑定设备token。

Parameters:

  • token 设备的推送token
  • callBack [BMXErrorCode]

Example:

public void bindDeviceToken(String token, BMXCallBack callBack) {
    mService.bindDeviceToken(token, callBack);

function bindVoipToken

inline void bindVoipToken(
    final String token,
    final BMXCallBack callBack
)

绑定推送设备的voiptoken。

Parameters:

  • token 设备的voip推送token
  • callBack [BMXErrorCode]

Example:

function getPushProfile

inline void getPushProfile(
    final boolean forceRefresh,
    final BMXDataCallBack< BMXPushUserProfile > callBack
)

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

Parameters:

  • forceRefresh 是否强制从服务器拉取,本地获取失败的情况下会自动从服务器拉取
  • callBack 推送用户profile信息,初始传入指向为空的shared_ptr对象,函数返回后从此处获取用户profile信息

Example:

public void getPushProfile(boolean forceRefresh, final BMXDataCallBack<BMXPushUserProfile> callBack) {
    mService.getPushProfile(forceRefresh, callBack);

function setTags

inline void setTags(
    final TagList tags,
    final String operationId,
    final BMXCallBack callBack
)

设置推送用户的标签。

Parameters:

  • tags 用户标签
  • operationId 操作id。在回调通知中对应通知提醒。
  • callBack [BMXErrorCode]

Example:

public void setTags(TagList tags, String operationId, BMXCallBack callBack) {
    mService.setTags(tags, operationId, callBack);

function getTags

inline void getTags(
    final TagList tags,
    final String operationId,
    final BMXCallBack callBack
)

获取推送用户的标签。

Parameters:

  • tags 用户标签
  • operationId 操作id。在回调通知中对应通知提醒。
  • callBack [BMXErrorCode]

Example:

public void getTags(TagList tags, String operationId, BMXCallBack callBack) {
    mService.getTags(tags, operationId, callBack);

function deleteTags

inline void deleteTags(
    final TagList tags,
    final String operationId,
    final BMXCallBack callBack
)

删除推送用户的标签。

Parameters:

  • tags 要删除用户标签
  • operationId 操作id。在回调通知中对应通知提醒。
  • callBack [BMXErrorCode]

Example:

public void deleteTags(TagList tags, String operationId, BMXCallBack callBack) {
    mService.deleteTags(tags, operationId, callBack);

function clearTags

inline void clearTags(
    final String operationId,
    final BMXCallBack callBack
)

清空推送用户的标签。

Parameters:

  • operationId 操作id。在回调通知中对应通知提醒。
  • callBack [BMXErrorCode]

Example:

public void clearTags(String operationId, BMXCallBack callBack) {
    mService.clearTags(operationId, callBack);

function setBadge

inline void setBadge(
    final int count,
    final BMXCallBack callBack
)

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

Parameters:

  • count 用户未读角标数
  • callBack [BMXErrorCode]

Example:

public void setBadge(int count, BMXCallBack callBack) {
    mService.setBadge(count, callBack);

function setPushMode

inline void setPushMode(
    final boolean enable,
    final BMXCallBack callBack
)

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

Parameters:

  • enable 推送的启用状态
  • callBack [BMXErrorCode]

Example:

public void setPushMode(boolean enable, BMXCallBack callBack) {
    mService.setPushMode(enable, callBack);
public void setPushMode(BMXCallBack callBack) {
    mService.setPushMode(callBack);

function setPushMode

inline void setPushMode(
    final BMXCallBack callBack
)

Example:

public void setPushMode(boolean enable, BMXCallBack callBack) {
    mService.setPushMode(enable, callBack);
public void setPushMode(BMXCallBack callBack) {
    mService.setPushMode(callBack);

function setPushTime

inline void setPushTime(
    final int startHour,
    final int endHour,
    final BMXCallBack callBack
)

设置允许推送时间。

Parameters:

  • startHour 静默允许推送的起始时间小时
  • endHour 静默允许推送的结束时间小时
  • callBack [BMXErrorCode]

Example:

public void setPushTime(int startHour, int endHour, BMXCallBack callBack) {
    mService.setPushTime(startHour, endHour, callBack);

function setSilenceTime

inline void setSilenceTime(
    final int startHour,
    final int endHour,
    final BMXCallBack callBack
)

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

Parameters:

  • startHour 静默推送的起始时间小时
  • endHour 静默推送的结束时间小时
  • callBack [BMXErrorCode]

Example:

public void setSilenceTime(int startHour, int endHour, BMXCallBack callBack) {
    mService.setSilenceTime(startHour, endHour, callBack);

function setRunBackgroundMode

inline void setRunBackgroundMode(
    final boolean enable,
    final BMXCallBack callBack
)

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

Parameters:

  • enable 推送后台运行状态。
  • callBack [BMXErrorCode]

Example:

public void setRunBackgroundMode(boolean enable, BMXCallBack callBack) {
    mService.setRunBackgroundMode(enable, callBack);
public void setRunBackgroundMode(BMXCallBack callBack) {
    mService.setRunBackgroundMode(callBack);

function setRunBackgroundMode

inline void setRunBackgroundMode(
    final BMXCallBack callBack
)

Example:

public void setRunBackgroundMode(boolean enable, BMXCallBack callBack) {
    mService.setRunBackgroundMode(enable, callBack);
public void setRunBackgroundMode(BMXCallBack callBack) {
    mService.setRunBackgroundMode(callBack);

function setGeoFenceMode

inline void setGeoFenceMode(
    final boolean enable,
    final boolean isAllow,
    final BMXCallBack callBack
)

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

Parameters:

  • enable 地理围栏功能是否运行。
  • isAllow 用户是否主动弹出用户定位请求。
  • callBack [BMXErrorCode]

Example:

public void setGeoFenceMode(boolean enable, boolean isAllow, BMXCallBack callBack) {
    mService.setGeoFenceMode(enable, isAllow, callBack);
public void setGeoFenceMode(boolean enable, BMXCallBack callBack) {
    mService.setGeoFenceMode(enable, callBack);
public void setGeoFenceMode(BMXCallBack callBack) {
    mService.setGeoFenceMode(callBack);

function setGeoFenceMode

inline void setGeoFenceMode(
    final boolean enable,
    final BMXCallBack callBack
)

Example:

public void setGeoFenceMode(boolean enable, boolean isAllow, BMXCallBack callBack) {
    mService.setGeoFenceMode(enable, isAllow, callBack);
public void setGeoFenceMode(boolean enable, BMXCallBack callBack) {
    mService.setGeoFenceMode(enable, callBack);
public void setGeoFenceMode(BMXCallBack callBack) {
    mService.setGeoFenceMode(callBack);

function setGeoFenceMode

inline void setGeoFenceMode(
    final BMXCallBack callBack
)

Example:

public void setGeoFenceMode(boolean enable, boolean isAllow, BMXCallBack callBack) {
    mService.setGeoFenceMode(enable, isAllow, callBack);
public void setGeoFenceMode(boolean enable, BMXCallBack callBack) {
    mService.setGeoFenceMode(enable, callBack);
public void setGeoFenceMode(BMXCallBack callBack) {
    mService.setGeoFenceMode(callBack);

function clearNotification

inline void clearNotification(
    final long notificationId
)

清除指定id的通知。

Parameters:

  • notificationId 通知id

Example:

public void clearNotification(long notificationId) {
    mService.clearNotification(notificationId);

function clearAllNotifications

inline void clearAllNotifications()

Example:

public void clearAllNotifications() {
    mService.clearAllNotifications();

function sendMessage

inline void sendMessage(
    final String content
)

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

Parameters:

  • content 发送的上行推送消息内容

Example:

public void sendMessage(String content) {
    mService.sendMessage(content);

function loadLocalPushMessages

inline void loadLocalPushMessages(
    final long refMsgId,
    final long size,
    final BMXMessageList result,
    final BMXPushService.PushDirection arg3,
    final BMXCallBack callBack
)

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

Parameters:

  • refMsgId 加载推送消息的起始id
  • size 最大加载消息条数
  • result 数据库返回的加载本地推送消息列表
  • arg3 加载推送消息的方向,默认是加载更早的消息

Example:

public void loadLocalPushMessages(long refMsgId, long size, BMXMessageList result,
        BMXCallBack callBack) {
    mService.loadLocalPushMessages(refMsgId, size, result, callBack);

function loadLocalPushMessages

inline void loadLocalPushMessages(
    final long refMsgId,
    final long size,
    final BMXMessageList result,
    final BMXCallBack callBack
)

Example:

public void loadLocalPushMessages(long refMsgId, long size, BMXMessageList result,
        BMXCallBack callBack) {
    mService.loadLocalPushMessages(refMsgId, size, result, callBack);

function addPushListener

inline void addPushListener(
    BMXPushServiceListener listener
)

添加推送监听者

Parameters:

  • listener 推送监听者

Example:

public void addPushListener(BMXPushServiceListener listener) {
    mService.addPushListener(listener);

function removePushListener

inline void removePushListener(
    BMXPushServiceListener listener
)

移除推送监听者

Parameters:

  • listener 推送监听者

Example:

public void removePushListener(BMXPushServiceListener listener) {
    mService.removePushListener(listener);


Updated on 2022-01-26 at 17:18:31 +0800

© 2019-2022 美信拓扑 | 官网 该文件修订时间: 2022-09-21 11:43:07

results matching ""

    No results matching ""