floo2
Public Types | Public Member Functions | List of all members
floo::BMXPushService Class Referenceabstract

Public Types

enum  PushSdkStatus { PushSdkStatus::Starting = 1, PushSdkStatus::Started, PushSdkStatus::Stoped, PushSdkStatus::Offline }
 push sdk状态 More...
 
enum  PushDirection { PushDirection::Up, PushDirection::Down }
 本地推送消息搜索方向 More...
 

Public Member Functions

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

Member Enumeration Documentation

◆ PushDirection

本地推送消息搜索方向

Enumerator
Up 

取更旧消息

Down 

取更新消息

◆ PushSdkStatus

push sdk状态

Enumerator
Starting 

正在启动

Started 

启动,在线

Stoped 

停止

Offline 

离线

Member Function Documentation

◆ addPushListener()

virtual void floo::BMXPushService::addPushListener ( BMXPushServiceListener listener)
pure virtual

添加推送监听者

Parameters
listener推送监听者

◆ bindDeviceToken()

virtual BMXErrorCode floo::BMXPushService::bindDeviceToken ( const std::string &  token)
pure virtual

推送绑定设备token。

Parameters
token设备的推送token
Returns
BMXErrorCode

◆ bindVoipToken()

virtual BMXErrorCode floo::BMXPushService::bindVoipToken ( const std::string &  token)
pure virtual

绑定推送设备的voiptoken。

Parameters
token设备的voip推送token
Returns
BMXErrorCode

◆ clearNotification()

virtual void floo::BMXPushService::clearNotification ( int64_t  notificationId)
pure virtual

清除指定id的通知。

Parameters
notificationId通知id

◆ clearTags()

virtual BMXErrorCode floo::BMXPushService::clearTags ( const std::string &  operationId)
pure virtual

清空推送用户的标签。

Parameters
operationId操作id。在回调通知中对应通知提醒。
Returns
BMXErrorCode

◆ deleteTags()

virtual BMXErrorCode floo::BMXPushService::deleteTags ( const std::vector< std::string > &  tags,
const std::string &  operationId 
)
pure virtual

删除推送用户的标签。

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

◆ getCert()

virtual const std::string& floo::BMXPushService::getCert ( )
pure virtual

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

Returns
std::stirng

◆ getPushProfile()

virtual BMXErrorCode floo::BMXPushService::getPushProfile ( BMXPushUserProfilePtr &  pushProfile,
bool  forceRefresh 
)
pure virtual

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

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

◆ getTags()

virtual BMXErrorCode floo::BMXPushService::getTags ( std::vector< std::string > &  tags,
const std::string &  operationId 
)
pure virtual

获取推送用户的标签。

Parameters
tags用户标签
operationId操作id。在回调通知中对应通知提醒。
Returns
BMXErrorCode

◆ getToken()

virtual const std::string& floo::BMXPushService::getToken ( )
pure virtual

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

Returns
std::stirng

◆ loadLocalPushMessages()

virtual BMXErrorCode floo::BMXPushService::loadLocalPushMessages ( int64_t  refMsgId,
size_t  size,
BMXMessageList &  result,
PushDirection  = PushDirection::Up 
)
pure virtual

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

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

◆ removePushListener()

virtual void floo::BMXPushService::removePushListener ( BMXPushServiceListener listener)
pure virtual

移除推送监听者

Parameters
listener推送监听者

◆ resume()

virtual BMXErrorCode floo::BMXPushService::resume ( )
pure virtual

恢复推送功能接口。

Returns
BMXErrorCode

◆ sendMessage()

virtual void floo::BMXPushService::sendMessage ( const std::string &  content)
pure virtual

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

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

◆ setBadge()

virtual BMXErrorCode floo::BMXPushService::setBadge ( int  count)
pure virtual

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

Parameters
count用户未读角标数
Returns
BMXErrorCode

◆ setGeoFenceMode()

virtual BMXErrorCode floo::BMXPushService::setGeoFenceMode ( bool  enable = false,
bool  isAllow = false 
)
pure virtual

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

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

◆ setPushMode()

virtual BMXErrorCode floo::BMXPushService::setPushMode ( bool  enable = true)
pure virtual

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

Parameters
enable推送的启用状态
Returns
BMXErrorCode

◆ setPushTime()

virtual BMXErrorCode floo::BMXPushService::setPushTime ( int  startHour,
int  endHour 
)
pure virtual

设置允许推送时间。

Parameters
startHour静默允许推送的起始时间小时
endHour静默允许推送的结束时间小时
Returns
BMXErrorCode

◆ setRunBackgroundMode()

virtual BMXErrorCode floo::BMXPushService::setRunBackgroundMode ( bool  enable = false)
pure virtual

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

Parameters
enable推送后台运行状态。
Returns
BMXErrorCode

◆ setSilenceTime()

virtual BMXErrorCode floo::BMXPushService::setSilenceTime ( int  startHour,
int  endHour 
)
pure virtual

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

Parameters
startHour静默推送的起始时间小时
endHour静默推送的结束时间小时
Returns
BMXErrorCode

◆ setTags()

virtual BMXErrorCode floo::BMXPushService::setTags ( const std::vector< std::string > &  tags,
const std::string &  operationId 
)
pure virtual

设置推送用户的标签。

Parameters
tags用户标签
operationId操作id。在回调通知中对应通知提醒。
Returns
BMXErrorCode

◆ start()

virtual BMXErrorCode floo::BMXPushService::start ( const std::string &  alias = "",
const std::string &  bmxToken = "" 
)
pure virtual

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

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

◆ status()

virtual PushSdkStatus floo::BMXPushService::status ( )
pure virtual

推送sdk当前的状态。

Returns
PushSdkStatus

◆ stop()

virtual BMXErrorCode floo::BMXPushService::stop ( )
pure virtual

停止推送功能接口。

Returns
BMXErrorCode

◆ unbindAlias()

virtual BMXErrorCode floo::BMXPushService::unbindAlias ( const std::string &  alias)
pure virtual

解除用户别名绑定。

Parameters
alias需要解除绑定的用户别名。
Returns
BMXErrorCode

The documentation for this class was generated from the following file: