im::floo::floolib::BMXPushService

Public Functions

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

Protected Functions

	Name
	BMXPushService(long cPtr, boolean cMemoryOwn)
void	finalize()
long	getCPtr(BMXPushService obj)

Protected Attributes

	Name
transient boolean	swigCMemOwn

Public Functions Documentation

function delete

inline synchronized void delete()

function start

inline BMXErrorCode start(
    String alias,
    String bmxToken
)

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

Parameters:

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

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

Return: [BMXErrorCode]

function start

inline BMXErrorCode start(
    String alias
)

function start

inline BMXErrorCode start()

function stop

inline BMXErrorCode stop()

停止推送功能接口。

Return: [BMXErrorCode]

function resume

inline BMXErrorCode resume()

恢复推送功能接口。

Return: [BMXErrorCode]

function unbindAlias

inline BMXErrorCode unbindAlias(
    String alias
)

解除用户别名绑定。

Parameters:

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

Return: [BMXErrorCode]

function getToken

inline String getToken()

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

function getCert

inline String getCert()

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

function status

inline BMXPushService.PushSdkStatus status()

推送sdk当前的状态。

Return: [PushSdkStatus]

function bindDeviceToken

inline BMXErrorCode bindDeviceToken(
    String token
)

推送绑定设备token。

Parameters:

• token 设备的推送token

Return: [BMXErrorCode]

function bindVoipToken

inline BMXErrorCode bindVoipToken(
    String token
)

绑定推送设备的voiptoken。

Parameters:

• token 设备的voip推送token

Return: [BMXErrorCode]

function getPushProfile

inline BMXErrorCode getPushProfile(
    BMXPushUserProfile pushProfile,
    boolean forceRefresh
)

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

Parameters:

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

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

Return: [BMXErrorCode]

function setTags

inline BMXErrorCode setTags(
    TagList tags,
    String operationId
)

设置推送用户的标签。

Parameters:

• tags 用户标签

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

Return: [BMXErrorCode]

function getTags

inline BMXErrorCode getTags(
    TagList tags,
    String operationId
)

获取推送用户的标签。

Parameters:

• tags 用户标签

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

Return: [BMXErrorCode]

function deleteTags

inline BMXErrorCode deleteTags(
    TagList tags,
    String operationId
)

删除推送用户的标签。

Parameters:

• tags 要删除用户标签

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

Return: [BMXErrorCode]

function clearTags

inline BMXErrorCode clearTags(
    String operationId
)

清空推送用户的标签。

Parameters:

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

Return: [BMXErrorCode]

function setBadge

inline BMXErrorCode setBadge(
    int count
)

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

Parameters:

• count 用户未读角标数

Return: [BMXErrorCode]

function setPushMode

inline BMXErrorCode setPushMode(
    boolean enable
)

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

Parameters:

• enable 推送的启用状态

Return: [BMXErrorCode]

function setPushMode

inline BMXErrorCode setPushMode()

function setPushTime

inline BMXErrorCode setPushTime(
    int startHour,
    int endHour
)

设置允许推送时间。

Parameters:

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

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

Return: [BMXErrorCode]

function setSilenceTime

inline BMXErrorCode setSilenceTime(
    int startHour,
    int endHour
)

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

Parameters:

• startHour 静默推送的起始时间小时

• endHour 静默推送的结束时间小时

Return: [BMXErrorCode]

function setRunBackgroundMode

inline BMXErrorCode setRunBackgroundMode(
    boolean enable
)

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

Parameters:

• enable 推送后台运行状态。

Return: [BMXErrorCode]

function setRunBackgroundMode

inline BMXErrorCode setRunBackgroundMode()

function setGeoFenceMode

inline BMXErrorCode setGeoFenceMode(
    boolean enable,
    boolean isAllow
)

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

Parameters:

• enable 地理围栏功能是否运行。

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

Return: [BMXErrorCode]

function setGeoFenceMode

inline BMXErrorCode setGeoFenceMode(
    boolean enable
)

function setGeoFenceMode

inline BMXErrorCode setGeoFenceMode()

function clearNotification

inline void clearNotification(
    long notificationId
)

清除指定id的通知。

Parameters:

• notificationId 通知id

function clearAllNotifications

inline void clearAllNotifications()

function sendMessage

inline void sendMessage(
    String content
)

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

Parameters:

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

function loadLocalPushMessages

inline BMXErrorCode loadLocalPushMessages(
    long refMsgId,
    long size,
    BMXMessageList result,
    BMXPushService.PushDirection arg3
)

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

Parameters:

• refMsgId 加载推送消息的起始id

• size 最大加载消息条数

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

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

function loadLocalPushMessages

inline BMXErrorCode loadLocalPushMessages(
    long refMsgId,
    long size,
    BMXMessageList result
)

function addPushListener

inline void addPushListener(
    BMXPushServiceListener listener
)

添加推送监听者

Parameters:

• listener 推送监听者

function removePushListener

inline void removePushListener(
    BMXPushServiceListener listener
)

移除推送监听者

Parameters:

• listener 推送监听者

Protected Functions Documentation

function BMXPushService

inline BMXPushService(
    long cPtr,
    boolean cMemoryOwn
)

function finalize

inline void finalize()

function getCPtr

static inline long getCPtr(
    BMXPushService obj
)

Protected Attributes Documentation

variable swigCMemOwn

transient boolean swigCMemOwn;

---

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