BMXPushService Class Reference#
Inherits from NSObject
Declared in floo_proxy.h
Overview#
@interface Push Service
Properties#
swigCMemOwn#
@property (nonatomic) BOOL swigCMemOwn
swigCPtr#
@property (nonatomic) void *swigCPtr
Instance Methods#
bindDeviceTokenWithToken:#
Bind device token for push service
- (BMXErrorCode)bindDeviceTokenWithToken:(NSString )token*
Parameters#
token
Device token
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="bindDeviceTokenWithToken:" %}{% endlanying_code_snippet %}bindVoipTokenWithToken:#
Bind VOIP device token for push service
- (BMXErrorCode)bindVoipTokenWithToken:(NSString )token*
Parameters#
token
Device token
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="bindVoipTokenWithToken:" %}{% endlanying_code_snippet %}clearAllNotifications#
Clear all notifications on the notification bar
- (void)clearAllNotifications
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="clearAllNotifications" %}{% endlanying_code_snippet %}clearNotificationWithNotificationId:#
Clear a notification by ID
- (void)clearNotificationWithNotificationId:(long long)notificationId
Parameters#
notificationId
Notification ID
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="clearNotificationWithNotificationId:" %}{% endlanying_code_snippet %}clearTagsWithOperationId:#
Clear tags by operation ID
- (BMXErrorCode)clearTagsWithOperationId:(NSString )operationId*
Parameters#
operationId
Operation ID
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="clearTagsWithOperationId:" %}{% endlanying_code_snippet %}dealloc#
- (void)dealloc
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="dealloc" %}{% endlanying_code_snippet %}deleteTagsWithTags:operationId:#
Remove tags by operation ID
- (BMXErrorCode)deleteTagsWithTags:(TagList )tags operationId:(NSString )operationId
Parameters#
tags
tags
operationId
Operation ID
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="deleteTagsWithTags:operationId:" %}{% endlanying_code_snippet %}getCert#
Get the push service certificate
- (NSString *)getCert
Return Value#
NSString
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="getCert" %}{% endlanying_code_snippet %}getPushProfile:forceRefresh:#
Get the profile of push user
- (BMXErrorCode)getPushProfile:(BMXPushUserProfile )pushProfile forceRefresh:(BOOL)forceRefresh*
Parameters#
forceRefresh
From server
profile
Push profile returned by the operation. Pass an empty shared_ptr; the method assigns the profile to it.
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="getPushProfile:forceRefresh:" %}{% endlanying_code_snippet %}getTags:operationId:#
Get tags of push user
- (BMXErrorCode)getTags:(TagList )tags operationId:(NSString )operationId
Parameters#
tags
Tag list
operationId
Operation ID
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="getTags:operationId:" %}{% endlanying_code_snippet %}getToken#
Get access token
- (NSString *)getToken
Return Value#
NSString
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="getToken" %}{% endlanying_code_snippet %}initWithCptr:swigOwnCObject:#
- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="initWithCptr:swigOwnCObject:" %}{% endlanying_code_snippet %}loadLocalPushMessagesWithRefMsgId:size:result:#
- (BMXErrorCode)loadLocalPushMessagesWithRefMsgId:(long long)refMsgId size:(unsigned long)size result:(BMXMessageList )result*
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="loadLocalPushMessagesWithRefMsgId:size:result:" %}{% endlanying_code_snippet %}loadLocalPushMessagesWithRefMsgId:size:result:arg4:#
Load push messages in local db
- (BMXErrorCode)loadLocalPushMessagesWithRefMsgId:(long long)refMsgId size:(unsigned long)size result:(BMXMessageList )result arg4:(BMXPushService_PushDirection)arg4*
Parameters#
refMsgId
First Message Id
size
Message list as result
result
Local push messages loaded from the database
arg4
Direction for loading push messages; earlier messages are loaded by default
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="loadLocalPushMessagesWithRefMsgId:size:result:arg4:" %}{% endlanying_code_snippet %}resume#
Resume push function
- (BMXErrorCode)resume
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="resume" %}{% endlanying_code_snippet %}sendMessageWithContent:#
Send a push message
- (void)sendMessageWithContent:(NSString )content*
Parameters#
content
Content of the upstream push message
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="sendMessageWithContent:" %}{% endlanying_code_snippet %}setBadge:#
Set badge count
- (BMXErrorCode)setBadge:(int)count
Parameters#
count
Badge count
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setBadge:" %}{% endlanying_code_snippet %}setGeoFenceMode#
- (BMXErrorCode)setGeoFenceMode
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setGeoFenceMode" %}{% endlanying_code_snippet %}setGeoFenceMode:#
- (BMXErrorCode)setGeoFenceMode:(BOOL)enable
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setGeoFenceMode:" %}{% endlanying_code_snippet %}setGeoFenceMode:isAllow:#
Set geo-fencing mode
- (BMXErrorCode)setGeoFenceMode:(BOOL)enable isAllow:(BOOL)isAllow
Parameters#
enable
Enable the feature
isAllow
Does the user allow
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setGeoFenceMode:isAllow:" %}{% endlanying_code_snippet %}setPushMode#
Set whether push is allowed
- (BMXErrorCode)setPushMode
Parameters#
startHour
Hour at which push delivery becomes allowed after the quiet period
endHour
Hour when the silent push period ends
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setPushMode" %}{% endlanying_code_snippet %}setPushMode:#
Set push enabled state. Default enabled.
- (BMXErrorCode)setPushMode:(BOOL)enable
Parameters#
enable
Whether push notifications are enabled
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setPushMode:" %}{% endlanying_code_snippet %}setPushTime:endHour:#
- (BMXErrorCode)setPushTime:(int)startHour endHour:(int)endHour
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setPushTime:endHour:" %}{% endlanying_code_snippet %}setRunBackgroundMode#
- (BMXErrorCode)setRunBackgroundMode
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setRunBackgroundMode" %}{% endlanying_code_snippet %}setRunBackgroundMode:#
Set whether push is allowed to run in the background
- (BMXErrorCode)setRunBackgroundMode:(BOOL)enable
Parameters#
enable
Whether push is running in the background.
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setRunBackgroundMode:" %}{% endlanying_code_snippet %}setSilenceTime:endHour:#
Set the silence time range for the push service
- (BMXErrorCode)setSilenceTime:(int)startHour endHour:(int)endHour
Parameters#
startHour
Hour at which the push quiet period starts
endHour
Hour at which the push quiet period ends
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setSilenceTime:endHour:" %}{% endlanying_code_snippet %}setTags:operationId:#
Set tags for push service
- (BMXErrorCode)setTags:(TagList )tags operationId:(NSString )operationId
Parameters#
tags
Tag list
operationId
Operation ID
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="setTags:operationId:" %}{% endlanying_code_snippet %}start#
- (BMXErrorCode)start
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="start" %}{% endlanying_code_snippet %}startWithAlias:#
- (BMXErrorCode)startWithAlias:(NSString )alias*
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="startWithAlias:" %}{% endlanying_code_snippet %}startWithAlias:bmxToken:#
Start push service
- (BMXErrorCode)startWithAlias:(NSString )alias bmxToken:(NSString )bmxToken
Parameters#
alias
User alias for push service
bmxToken
User access token
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="startWithAlias:bmxToken:" %}{% endlanying_code_snippet %}status#
The status of push SDK
- (BMXPushService_PushSdkStatus)status
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="status" %}{% endlanying_code_snippet %}stop#
Stop push service
- (BMXErrorCode)stop
Return Value#
Declared In#
floo_proxy.h
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="stop" %}{% endlanying_code_snippet %}unbindAliasWithAlias:#
Unbind user alias
- (BMXErrorCode)unbindAliasWithAlias:(NSString )alias*
Parameters#
alias
User alias
Return Value#
Declared In#
floo_proxy.h
Example:
{% lanying_code_snippet repo="lanying-im-ios",class="BMXPushService",function="unbindAliasWithAlias:" %}{% endlanying_code_snippet %}