蓝莺开发者
Web & Mini ProgramiOSAndroidC++Server API

BMXUserService Class Reference#

Inherits from NSObject
Declared in floo_proxy.h

Overview#

@interface 用户Service

Properties#

swigCMemOwn#

@property (nonatomic) BOOL swigCMemOwn

swigCPtr#

@property (nonatomic) void *swigCPtr

Instance Methods#

addDelegate:#

添加用户状态监听者

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

Parameters#

listener
用户状态监听者

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="addDelegate:" %}{% endlanying_code_snippet %}

addDelegate:delegateQueue:#

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


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="addDelegate:delegateQueue:" %}{% endlanying_code_snippet %}

bindDeviceWithToken:#

绑定设备推送token

- (BMXErrorCode)bindDeviceWithToken:(NSString )token*

Parameters#

token
设备token

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="bindDeviceWithToken:" %}{% endlanying_code_snippet %}

bindDeviceWithToken:completion:#

绑定设备推送token

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

Parameters#

token
设备token

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="bindDeviceWithToken:completion:" %}{% endlanying_code_snippet %}

dealloc#

- (void)dealloc


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="dealloc" %}{% endlanying_code_snippet %}

deleteDeviceWithDeviceSn:#

删除设备

- (BMXErrorCode)deleteDeviceWithDeviceSn:(int)device_sn

Parameters#

device_sn
设备序列号

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="deleteDeviceWithDeviceSn:" %}{% endlanying_code_snippet %}

deleteDeviceWithDeviceSn:completion:#

删除设备

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

Parameters#

device_sn
设备序列号

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="deleteDeviceWithDeviceSn:completion:" %}{% endlanying_code_snippet %}

downloadAvatarWithProfile:thumbnail:callback:#

下载头像,默认下载缩略图

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

Parameters#

profile
用户profile

thumbnail
是否下载缩略图,true下载缩略图,false下载原图

callback
下载回调函数

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="downloadAvatarWithProfile:thumbnail:callback:" %}{% endlanying_code_snippet %}

downloadAvatarWithProfile:thumbnail:callback:completion:#

下载头像,默认下载缩略图

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

Parameters#

profile
用户profile

thumbnail
是否下载缩略图,true下载缩略图,false下载原图

callback
下载回调函数

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="downloadAvatarWithProfile:thumbnail:callback:completion:" %}{% endlanying_code_snippet %}

getDeviceList:#

获取设备列表

- (BMXErrorCode)getDeviceList:(BMXDeviceList )deviceList*

Parameters#

deviceList
设备列表,传入空列表函数返回后从此处获取返回的设备列表

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="getDeviceList:" %}{% endlanying_code_snippet %}

getDeviceListWithCompletion:#

获取设备列表

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

Parameters#

deviceList
设备列表,传入空列表函数返回后从此处获取返回的设备列表

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="getDeviceListWithCompletion:" %}{% endlanying_code_snippet %}

getProfile:completion:#

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

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

Parameters#

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

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="getProfile:completion:" %}{% endlanying_code_snippet %}

getProfile:forceRefresh:#

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

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

Parameters#

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

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="getProfile:forceRefresh:" %}{% endlanying_code_snippet %}

initWithCptr:swigOwnCObject:#

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


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="initWithCptr:swigOwnCObject:" %}{% endlanying_code_snippet %}

removeDelegate:#

移除用户状态监听者

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

Parameters#

listener
用户状态监听者

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="removeDelegate:" %}{% endlanying_code_snippet %}

setAddFriendAuthMode:#

设置加好友验证方式

- (BMXErrorCode)setAddFriendAuthMode:(BMXUserProfile_AddFriendAuthMode)mode

Parameters#

mode
加好友验证方式

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAddFriendAuthMode:" %}{% endlanying_code_snippet %}

setAddFriendAuthMode:completion:#

设置加好友验证方式

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

Parameters#

mode
加好友验证方式

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAddFriendAuthMode:completion:" %}{% endlanying_code_snippet %}

setAuthQuestion:#

设置加好友验证问题

- (BMXErrorCode)setAuthQuestion:(BMXUserProfileAuthQuestion )authQuestion*

Parameters#

authQuestion
加好友验证问题

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAuthQuestion:" %}{% endlanying_code_snippet %}

setAuthQuestion:completion:#

设置加好友验证问题

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

Parameters#

authQuestion
加好友验证问题

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAuthQuestion:completion:" %}{% endlanying_code_snippet %}

setAutoAcceptGroupInvite:#

设置是否自动同意入群邀请

- (BMXErrorCode)setAutoAcceptGroupInvite:(BOOL)enable

Parameters#

enable
是否自动同意入群邀请,true同意,false不同意

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAutoAcceptGroupInvite:" %}{% endlanying_code_snippet %}

setAutoAcceptGroupInvite:completion:#

设置是否自动同意入群邀请

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

Parameters#

enable
是否自动同意入群邀请,true同意,false不同意

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAutoAcceptGroupInvite:completion:" %}{% endlanying_code_snippet %}

setAutoDownloadAttachment:#

设置是否自动缩略图和语音附件

- (BMXErrorCode)setAutoDownloadAttachment:(BOOL)enable

Parameters#

enable
是否自动缩略图和语音附件,true自动下载,false不会自动下载

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAutoDownloadAttachment:" %}{% endlanying_code_snippet %}

setAutoDownloadAttachment:completion:#

设置是否自动缩略图和语音附件

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

Parameters#

enable
是否自动缩略图和语音附件,true自动下载,false不会自动下载

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setAutoDownloadAttachment:completion:" %}{% endlanying_code_snippet %}

setEnablePush:#

设置是否允许推送

- (BMXErrorCode)setEnablePush:(BOOL)enable

Parameters#

enable
是否允许推送,true推送,false不推送

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setEnablePush:" %}{% endlanying_code_snippet %}

setEnablePush:completion:#

设置是否允许推送

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

Parameters#

enable
是否允许推送,true推送,false不推送

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setEnablePush:completion:" %}{% endlanying_code_snippet %}

setEnablePushDetaile:#

设置是否推送详情

- (BMXErrorCode)setEnablePushDetaile:(BOOL)enable

Parameters#

enable
是否推送详情,true推送,false不推送

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setEnablePushDetaile:" %}{% endlanying_code_snippet %}

setEnablePushDetaile:completion:#

设置是否推送详情

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

Parameters#

enable
是否推送详情,true推送,false不推送

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setEnablePushDetaile:completion:" %}{% endlanying_code_snippet %}

setNickname:#

设置昵称

- (BMXErrorCode)setNickname:(NSString )nickname*

Parameters#

nickname
用户昵称

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setNickname:" %}{% endlanying_code_snippet %}

setNickname:completion:#

设置昵称

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

Parameters#

nickname
用户昵称

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setNickname:completion:" %}{% endlanying_code_snippet %}

setNotificationSound:#

设置收到新消息是否声音提醒

- (BMXErrorCode)setNotificationSound:(BOOL)enable

Parameters#

enable
收到新消息是否声音提醒,true提醒,false不提醒

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setNotificationSound:" %}{% endlanying_code_snippet %}

setNotificationSound:completion:#

设置收到新消息是否声音提醒

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

Parameters#

enable
收到新消息是否声音提醒,true提醒,false不提醒

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setNotificationSound:completion:" %}{% endlanying_code_snippet %}

setNotificationVibrate:#

设置收到新消息是否震动

- (BMXErrorCode)setNotificationVibrate:(BOOL)enable

Parameters#

enable
收到新消息是否震动,true震动,false不震动

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setNotificationVibrate:" %}{% endlanying_code_snippet %}

setNotificationVibrate:completion:#

设置收到新消息是否震动

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

Parameters#

enable
收到新消息是否震动,true震动,false不震动

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setNotificationVibrate:completion:" %}{% endlanying_code_snippet %}

setPrivateInfo:#

设置私有扩展信息

- (BMXErrorCode)setPrivateInfo:(NSString )privateInfo*

Parameters#

privateInfo
私有扩展信息

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPrivateInfo:" %}{% endlanying_code_snippet %}

setPrivateInfo:completion:#

设置私有扩展信息

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

Parameters#

privateInfo
私有扩展信息

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPrivateInfo:completion:" %}{% endlanying_code_snippet %}

setPublicInfo:#

设置公开扩展信息

- (BMXErrorCode)setPublicInfo:(NSString )publicInfo*

Parameters#

publicInfo
公开扩展信息

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPublicInfo:" %}{% endlanying_code_snippet %}

setPublicInfo:completion:#

设置公开扩展信息

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

Parameters#

publicInfo
公开扩展信息

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPublicInfo:completion:" %}{% endlanying_code_snippet %}

setPushAlias:bmxPushToken:#

@brief

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

Parameters#

nickname
推送昵称

Return Value#

BMXErrorCode

Discussion#

@brief

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPushAlias:bmxPushToken:" %}{% endlanying_code_snippet %}

setPushAlias:bmxPushToken:completion:#

@brief

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

Parameters#

nickname
推送昵称

Return Value#

BMXErrorCode

Discussion#

@brief

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPushAlias:bmxPushToken:completion:" %}{% endlanying_code_snippet %}

setPushNickname:#

设置推送昵称

- (BMXErrorCode)setPushNickname:(NSString )nickname*

Parameters#

nickname
推送昵称

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPushNickname:" %}{% endlanying_code_snippet %}

setPushNickname:completion:#

设置推送昵称

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

Parameters#

nickname
推送昵称

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="setPushNickname:completion:" %}{% endlanying_code_snippet %}

uploadAvatarWithAvatarPath:callback:#

上传头像

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

Parameters#

avatarPath
上传头像的本地地址

callback
上传回调函数

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="uploadAvatarWithAvatarPath:callback:" %}{% endlanying_code_snippet %}

uploadAvatarWithAvatarPath:callback:completion:#

上传头像

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

Parameters#

avatarPath
上传头像的本地地址

callback
上传回调函数

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXUserService",function="uploadAvatarWithAvatarPath:callback:completion:" %}{% endlanying_code_snippet %}
自动生成的 API 内容,仅在必要位置补充精简的 AI 解释。