LANYINGDevelopers
Web & Mini ProgramiOSAndroidC++Server API

BMXUserService Class Reference#

Inherits from NSObject
Declared in floo_proxy.h

Overview#

@interface User Service

Properties#

swigCMemOwn#

@property (nonatomic) BOOL swigCMemOwn

swigCPtr#

@property (nonatomic) void *swigCPtr

Instance Methods#

addDelegate:#

Add a user service listener

- (void)addDelegate:(id<BMXUserServiceProtocol>)aDelegate

Parameters#

listener
User state listener

Declared In#

  • floo_proxy.h


Example:

addDelegate:delegateQueue:#

- (void)addDelegate:(id<BMXUserServiceProtocol>)aDelegate delegateQueue:(dispatch_queue_t)aQueue


Example:

bindDeviceWithToken:#

Bind device token

- (BMXErrorCode)bindDeviceWithToken:(NSString )token*

Parameters#

token
Device token

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

bindDeviceWithToken:completion:#

Bind device token

- (void)bindDeviceWithToken:(NSString )token completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

token
Device token

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

dealloc#

- (void)dealloc


Example:

deleteDeviceWithDeviceSn:#

Delete a device

- (BMXErrorCode)deleteDeviceWithDeviceSn:(int)device_sn

Parameters#

device_sn
Device serial number

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

deleteDeviceWithDeviceSn:completion:#

Delete a device

- (void)deleteDeviceWithDeviceSn:(int)device_sn completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

device_sn
Device serial number

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

downloadAvatarWithProfile:thumbnail:callback:#

Download my avatar

- (BMXErrorCode)downloadAvatarWithProfile:(BMXUserProfile )profile thumbnail:(BOOL)thumbnail callback:(void ( ^ ) ( int progress ))callback*

Parameters#

profile
My user profile

thumbnail
Whether to download my avatar thumbnail

callback
Download callback

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

downloadAvatarWithProfile:thumbnail:callback:completion:#

Download my avatar

- (void)downloadAvatarWithProfile:(BMXUserProfile )profile thumbnail:(BOOL)thumbnail callback:(void ( ^ ) ( int progress ))callback completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

profile
My user profile

thumbnail
Whether to download my avatar thumbnail

callback
Download callback

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

getDeviceList:#

Get my deivce list

- (BMXErrorCode)getDeviceList:(BMXDeviceList )deviceList*

Parameters#

deviceList
Devices returned by the operation. Pass an empty list; the method populates it.

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

getDeviceListWithCompletion:#

Get my deivce list

- (void)getDeviceListWithCompletion:(void ( ^ ) ( BMXDeviceList deviceList , BMXError aError ))resBlock

Parameters#

deviceList
Devices returned by the operation. Pass an empty list; the method populates it.

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

getProfile:completion:#

Get my user profile

- (void)getProfile:(BOOL)forceRefresh completion:(void ( ^ ) ( BMXUserProfile profile , BMXError aError ))resBlock

Parameters#

forceRefresh
From server

profile
User profile returned by the operation. Pass an empty shared_ptr; the method assigns the profile to it.

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

getProfile:forceRefresh:#

Get my user profile

- (BMXErrorCode)getProfile:(BMXUserProfile )profile forceRefresh:(BOOL)forceRefresh*

Parameters#

profile
User profile returned by the operation. Pass an empty shared_ptr; the method assigns the profile to it.

forceRefresh
From server

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

initWithCptr:swigOwnCObject:#

- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*


Example:

removeDelegate:#

Remove a user service listener

- (void)removeDelegate:(id<BMXUserServiceProtocol>)aDelegate

Parameters#

listener
User state listener

Declared In#

  • floo_proxy.h


Example:

setAddFriendAuthMode:#

Set friend authorization mode

- (BMXErrorCode)setAddFriendAuthMode:(BMXUserProfile_AddFriendAuthMode)mode

Parameters#

mode
Contact request verification mode

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAddFriendAuthMode:completion:#

Set friend authorization mode

- (void)setAddFriendAuthMode:(BMXUserProfile_AddFriendAuthMode)mode completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

mode
Contact request verification mode

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAuthQuestion:#

Set friend authorization question

- (BMXErrorCode)setAuthQuestion:(BMXUserProfileAuthQuestion )authQuestion*

Parameters#

authQuestion
Contact request verification question

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAuthQuestion:completion:#

Set friend authorization question

- (void)setAuthQuestion:(BMXUserProfileAuthQuestion )authQuestion completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

authQuestion
Contact request verification question

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAutoAcceptGroupInvite:#

Set whether to accept group invitation automatically

- (BMXErrorCode)setAutoAcceptGroupInvite:(BOOL)enable

Parameters#

enable
Whether to accept group invitations automatically: true to accept; false not to accept

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAutoAcceptGroupInvite:completion:#

Set whether to accept group invitation automatically

- (void)setAutoAcceptGroupInvite:(BOOL)enable completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

enable
Whether to accept group invitations automatically: true to accept; false not to accept

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAutoDownloadAttachment:#

Set whether download attachment automatically

- (BMXErrorCode)setAutoDownloadAttachment:(BOOL)enable

Parameters#

enable
Whether to download thumbnails and voice attachments automatically: true to download; false not to download

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAutoDownloadAttachment:completion:#

Set whether download attachment automatically

- (void)setAutoDownloadAttachment:(BOOL)enable completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

enable
Whether to download thumbnails and voice attachments automatically: true to download; false not to download

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setEnablePush:#

Set whether to enable push function

- (BMXErrorCode)setEnablePush:(BOOL)enable

Parameters#

enable
Whether push is enabled: true to enable; false to disable

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setEnablePush:completion:#

Set whether to enable push function

- (void)setEnablePush:(BOOL)enable completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

enable
Whether push is enabled: true to enable; false to disable

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setEnablePushDetaile:#

Set whether to enable push message detail

- (BMXErrorCode)setEnablePushDetaile:(BOOL)enable

Parameters#

enable
Whether push notifications include details: true to include them; false to omit them

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setEnablePushDetaile:completion:#

Set whether to enable push message detail

- (void)setEnablePushDetaile:(BOOL)enable completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

enable
Whether push notifications include details: true to include them; false to omit them

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setNickname:#

Set my nickname

- (BMXErrorCode)setNickname:(NSString )nickname*

Parameters#

nickname
User display name

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setNickname:completion:#

Set my nickname

- (void)setNickname:(NSString )nickname completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

nickname
User display name

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setNotificationSound:#

Set whether to enable sound notification

- (BMXErrorCode)setNotificationSound:(BOOL)enable

Parameters#

enable
Whether to play a sound for new messages: true to play; false to stay silent

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setNotificationSound:completion:#

Set whether to enable sound notification

- (void)setNotificationSound:(BOOL)enable completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

enable
Whether to play a sound for new messages: true to play; false to stay silent

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setNotificationVibrate:#

Set whether to enable vibrate notification

- (BMXErrorCode)setNotificationVibrate:(BOOL)enable

Parameters#

enable
Whether to vibrate for new messages: true to vibrate; false not to vibrate

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setNotificationVibrate:completion:#

Set whether to enable vibrate notification

- (void)setNotificationVibrate:(BOOL)enable completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

enable
Whether to vibrate for new messages: true to vibrate; false not to vibrate

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setPrivateInfo:#

Set private information(Invisible to friends)

- (BMXErrorCode)setPrivateInfo:(NSString )privateInfo*

Parameters#

privateInfo
Private extension information

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setPrivateInfo:completion:#

Set private information(Invisible to friends)

- (void)setPrivateInfo:(NSString )privateInfo completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

privateInfo
Private extension information

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setPublicInfo:#

Set public information(Visible to friends)

- (BMXErrorCode)setPublicInfo:(NSString )publicInfo*

Parameters#

publicInfo
Public extension information

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setPublicInfo:completion:#

Set public information(Visible to friends)

- (void)setPublicInfo:(NSString )publicInfo completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

publicInfo
Public extension information

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setPushAlias:bmxPushToken:#

@brief

- (BMXErrorCode)setPushAlias:(NSString )alias bmxPushToken:(NSString )bmxPushToken

Parameters#

nickname
Push display name

Return Value#

BMXErrorCode

Discussion#

@brief

Declared In#

  • floo_proxy.h


Example:

setPushAlias:bmxPushToken:completion:#

@brief

- (void)setPushAlias:(NSString )alias bmxPushToken:(NSString )bmxPushToken completion:(void ( ^ ) ( BMXError aError ))resBlock*

Parameters#

nickname
Push display name

Return Value#

BMXErrorCode

Discussion#

@brief

Declared In#

  • floo_proxy.h


Example:

setPushNickname:#

Set nickname for push

- (BMXErrorCode)setPushNickname:(NSString )nickname*

Parameters#

nickname
Push display name

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setPushNickname:completion:#

Set nickname for push

- (void)setPushNickname:(NSString )nickname completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

nickname
Push display name

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

uploadAvatarWithAvatarPath:callback:#

Upload my avatar

- (BMXErrorCode)uploadAvatarWithAvatarPath:(NSString )avatarPath callback:(void ( ^ ) ( int progress ))callback*

Parameters#

avatarPath
Local path of my avatar file

callback
Upload callback

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

uploadAvatarWithAvatarPath:callback:completion:#

Upload my avatar

- (void)uploadAvatarWithAvatarPath:(NSString )avatarPath callback:(void ( ^ ) ( int progress ))callback completion:(void ( ^ ) ( BMXError aError ))resBlock

Parameters#

avatarPath
Local path of my avatar file

callback
Upload callback

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h
Generated API content with concise AI notes where context helps.