im::floo::floolib::BMXPushService

Public Functions

Protected Functions

Protected Attributes

Public Functions Documentation

function delete

inline synchronized void delete()

Example:

function start

inline BMXErrorCode start(
    String alias,
    String bmxToken
)

Initialize push sdk. Use this interface to initialize the push sdk in the case of using push only. When using IM features at the same time, call login function directly in BMXClient. The config object initializes by passing in the platform type and device id.

Parameters:

• alias Current user alias used for push initialization
• bmxToken User token to use that passed in by App when push initialization, and no passing in is OK without users.

Return: [BMXErrorCode]

Example:

function start

inline BMXErrorCode start(
    String alias
)

Example:

function start

inline BMXErrorCode start()

Example:

function stop

inline BMXErrorCode stop()

Shut push feature interface.

Return: [BMXErrorCode]

Example:

function resume

inline BMXErrorCode resume()

Resume push function.

Return: [BMXErrorCode]

Example:

function unbindAlias

inline BMXErrorCode unbindAlias(
    String alias
)

Unbind user alias.

Parameters:

• alias The user alias that needs to be unbound.

Return: [BMXErrorCode]

Example:

function getToken

inline String getToken()

Get user token to use after login.

Example:

function getCert

inline String getCert()

Get push certificate returned by server after login.

Example:

function status

inline BMXPushService.PushSdkStatus status()

Push the current state of sdk.

Return: [PushSdkStatus]

Example:

function bindDeviceToken

inline BMXErrorCode bindDeviceToken(
    String token
)

Push binding device token.

Parameters:

• token Device push token

Return: [BMXErrorCode]

Example:

function bindVoipToken

inline BMXErrorCode bindVoipToken(
    String token
)

Bind voiptoken of push device

Parameters:

• token Device voip push token

Return: [BMXErrorCode]

Example:

function getPushProfile

inline BMXErrorCode getPushProfile(
    BMXPushUserProfile pushProfile,
    boolean forceRefresh
)

Get push user details, force pull from server-side if forceRefresh == true

Parameters:

• pushProfile Push user profile information, initially passing in a pointing-to-empty shared_ptr object, fetch the user profile information here after function returned.
• forceRefresh Whether to force pull from server, automatically if local fetch failed

Return: [BMXErrorCode]

Example:

function setTags

inline BMXErrorCode setTags(
    TagList tags,
    String operationId
)

Set tags of push user.

Parameters:

• tags User tag
• operationId Operation id. Corresponding notification reminder in callback notification.

Return: [BMXErrorCode]

Example:

function getTags

inline BMXErrorCode getTags(
    TagList tags,
    String operationId
)

Get tags of the push user.

Parameters:

• tags User tag
• operationId Operation id. Corresponding notification reminder in callback notification.

Return: [BMXErrorCode]

Example:

function deleteTags

inline BMXErrorCode deleteTags(
    TagList tags,
    String operationId
)

Delete tags of the push user.

Parameters:

• tags User tag to delete
• operationId Operation id. Corresponding notification reminder in callback notification.

Return: [BMXErrorCode]

Example:

function clearTags

inline BMXErrorCode clearTags(
    String operationId
)

Clear tags of the push user.

Parameters:

• operationId Operation id. Corresponding notification reminder in callback notification.

Return: [BMXErrorCode]

Example:

function setBadge

inline BMXErrorCode setBadge(
    int count
)

Set unread badge for push user.

Parameters:

• count Unread badge count of user

Return: [BMXErrorCode]

Example:

function setPushMode

inline BMXErrorCode setPushMode(
    boolean enable
)

Set push enabled state. Default enabled.

Parameters:

• enable Enabled state of push

Return: [BMXErrorCode]

Example:

function setPushMode

inline BMXErrorCode setPushMode()

Example:

function setPushTime

inline BMXErrorCode setPushTime(
    int startHour,
    int endHour
)

Set allowed push time.

Parameters:

• startHour Start time for allowed silent push (hour)
• endHour End time for allowed silent push (hour)

Return: [BMXErrorCode]

Example:

function setSilenceTime

inline BMXErrorCode setSilenceTime(
    int startHour,
    int endHour
)

Set the start and end time of silent push.

Parameters:

• startHour Start time for silent push (hour)
• endHour End time for silent push (hour)

Return: [BMXErrorCode]

Example:

function setRunBackgroundMode

inline BMXErrorCode setRunBackgroundMode(
    boolean enable
)

Set whether to run push in background, default false.

Parameters:

• enable Running state of push background

Return: [BMXErrorCode]

Example:

function setRunBackgroundMode

inline BMXErrorCode setRunBackgroundMode()

Example:

function setGeoFenceMode

inline BMXErrorCode setGeoFenceMode(
    boolean enable,
    boolean isAllow
)

Set whether to run push geo-fencing feature.

Parameters:

• enable Whether the geo-fencing function is running.
• isAllow Whether the user actively pops up a user location request.

Return: [BMXErrorCode]

Example:

function setGeoFenceMode

inline BMXErrorCode setGeoFenceMode(
    boolean enable
)

Example:

function setGeoFenceMode

inline BMXErrorCode setGeoFenceMode()

Example:

function clearNotification

inline void clearNotification(
    long notificationId
)

Clear notifications for the specified id.

Parameters:

• notificationId Notification id

Example:

function clearAllNotifications

inline void clearAllNotifications()

Example:

function sendMessage

inline void sendMessage(
    String content
)

Send a push uplink message and notify the listener of a change in message status

Parameters:

• content Sent uplink push content

Example:

function loadLocalPushMessages

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

Load push message stored in local database. Start with latest message if not specified

Parameters:

• refMsgId Start id for loading pushes
• size Maximum number of searched messages
• result List of loaded local pushes returned by database
• arg3 Direction of loading pushes, default to load earlier messages

Example:

function loadLocalPushMessages

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

Example:

function addPushListener

inline void addPushListener(
    BMXPushServiceListener listener
)

Add push listener

Parameters:

• listener Push listener

Example:

function removePushListener

inline void removePushListener(
    BMXPushServiceListener listener
)

Remove push listener

Parameters:

• listener Push listener

Protected Functions Documentation

Example:

function BMXPushService

inline BMXPushService(
    long cPtr,
    boolean cMemoryOwn
)

Example:

function finalize

inline void finalize()

Example:

function getCPtr

static inline long getCPtr(
    BMXPushService obj
)

Protected Attributes Documentation

variable swigCMemOwn

transient boolean swigCMemOwn;

Example:

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