BMXRosterService 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

acceptWithRosterId:

接受加好友申请

- (BMXErrorCode)acceptWithRosterId:(long long)*rosterId*

Parameters

rosterId
申请加为好友的用户id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

acceptWithRosterId:completion:

接受加好友申请

- (void)acceptWithRosterId:(long long)*rosterId* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

rosterId
申请加为好友的用户id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

addDelegate:

添加好友变化监听者

- (void)addDelegate:(id<BMXRosterServiceProtocol>)*aDelegate*

Parameters

listener
好友变化监听者

Declared In

• floo_proxy.h

Example:

addDelegate:delegateQueue:

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

Example:

addRosterListener:

添加好友变化监听者

- (void)addRosterListener:(id<BMXRosterServiceProtocol>)*listener*

Parameters

listener
好友变化监听者

Declared In

• floo_proxy.h

Example:

applyWithRosterId:message:

- (BMXErrorCode)applyWithRosterId:(long long)*rosterId* message:(NSString *)*message*

Example:

applyWithRosterId:message:authAnswer:

申请添加好友

- (BMXErrorCode)applyWithRosterId:(long long)*rosterId* message:(NSString *)*message* authAnswer:(NSString *)*authAnswer*

Parameters

rosterId
申请添加的用户id

message
好友申请信息

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

applyWithRosterId:message:authAnswer:completion:

申请添加好友

- (void)applyWithRosterId:(long long)*rosterId* message:(NSString *)*message* authAnswer:(NSString *)*authAnswer* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

rosterId
申请添加的用户id

message
好友申请信息

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

applyWithRosterId:message:completion:

- (void)applyWithRosterId:(long long)*rosterId* message:(NSString *)*message* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Example:

blockWithRosterId:

加入黑名单

- (BMXErrorCode)blockWithRosterId:(long long)*rosterId*

Parameters

rosterId
加入黑名单的用户id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

blockWithRosterId:completion:

加入黑名单

- (void)blockWithRosterId:(long long)*rosterId* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

rosterId
加入黑名单的用户id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

dealloc

- (void)dealloc

Example:

declineWithRosterId:reason:

拒绝加好友申请

- (BMXErrorCode)declineWithRosterId:(long long)*rosterId* reason:(NSString *)*reason*

Parameters

rosterId
申请加为好友的用户id

reason
拒绝的原因

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

declineWithRosterId:reason:completion:

拒绝加好友申请

- (void)declineWithRosterId:(long long)*rosterId* reason:(NSString *)*reason* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

rosterId
申请加为好友的用户id

reason
拒绝的原因

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

downloadAvatarWithItem:thumbnail:callback:

下载头像

- (BMXErrorCode)downloadAvatarWithItem:(BMXRosterItem *)*item* thumbnail:(BOOL)*thumbnail* callback:(void ( ^ ) ( int progress ))*callback*

Parameters

item
用户信息

thumbnail
是否下载缩略图，ture为缩略图，false为原图

callback
下载回调函数

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

downloadAvatarWithItem:thumbnail:callback:completion:

下载头像

- (void)downloadAvatarWithItem:(BMXRosterItem *)*item* thumbnail:(BOOL)*thumbnail* callback:(void ( ^ ) ( int progress ))*callback* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

item
用户信息

thumbnail
是否下载缩略图，ture为缩略图，false为原图

callback
下载回调函数

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

fetchRosterByIdWithRosterId:forceRefresh:completion:

通过联系人id搜索用户

- (void)fetchRosterByIdWithRosterId:(long long)*rosterId* forceRefresh:(BOOL)*forceRefresh* completion:(void ( ^ ) ( BMXRosterItem *item , BMXError *error ))*aCompletionBlock*

Parameters

rosterId
搜索的好友id

forceRefresh
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

item
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

fetchRosterByIdWithRosterId:forceRefresh:item:

通过联系人id搜索用户

- (BMXErrorCode)fetchRosterByIdWithRosterId:(long long)*rosterId* forceRefresh:(BOOL)*forceRefresh* item:(BMXRosterItem *)*item*

Parameters

rosterId
搜索的好友id

forceRefresh
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

item
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

fetchRosterByNameWithName:forceRefresh:completion:

通过用户名搜索用户

- (void)fetchRosterByNameWithName:(NSString *)*name* forceRefresh:(BOOL)*forceRefresh* completion:(void ( ^ ) ( BMXRosterItem *item , BMXError *error ))*aCompletionBlock*

Parameters

name
搜索的用户名

forceRefresh
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

item
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

fetchRosterByNameWithName:forceRefresh:item:

通过用户名搜索用户

- (BMXErrorCode)fetchRosterByNameWithName:(NSString *)*name* forceRefresh:(BOOL)*forceRefresh* item:(BMXRosterItem *)*item*

Parameters

name
搜索的用户名

forceRefresh
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

item
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

fetchRostersByIdListWithRosterIdList:forceRefresh:completion:

通过联系人id列表批量搜索用户

- (void)fetchRostersByIdListWithRosterIdList:(ListOfLongLong *)*rosterIdList* forceRefresh:(BOOL)*forceRefresh* completion:(void ( ^ ) ( BMXRosterItemList *list , BMXError *error ))*aCompletionBlock*

Parameters

rosterIdList
需要搜索的用户id列表

forceRefresh
是否强制从服务器获取，为true则强制从服务器获取

list
返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

fetchRostersByIdListWithRosterIdList:list:forceRefresh:

通过联系人id列表批量搜索用户

- (BMXErrorCode)fetchRostersByIdListWithRosterIdList:(ListOfLongLong *)*rosterIdList* list:(BMXRosterItemList *)*list* forceRefresh:(BOOL)*forceRefresh*

Parameters

rosterIdList
需要搜索的用户id列表

list
返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表

forceRefresh
是否强制从服务器获取，为true则强制从服务器获取

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

get:completion:

获取好友列表，如果forceRefresh == true，则强制从服务端拉取

- (void)get:(BOOL)*forceRefresh* completion:(void ( ^ ) ( ListOfLongLong *list , BMXError *error ))*aCompletionBlock*

Parameters

forceRefresh
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取

list
好友id列表，传入空列表函数返回后从此处获取返回的好友id列表

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

get:forceRefresh:

获取好友列表，如果forceRefresh == true，则强制从服务端拉取

- (BMXErrorCode)get:(ListOfLongLong *)*list* forceRefresh:(BOOL)*forceRefresh*

Parameters

list
好友id列表，传入空列表函数返回后从此处获取返回的好友id列表

forceRefresh
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

getApplicationList:completion:

- (void)getApplicationList:(NSString *)*cursor* completion:(void ( ^ ) ( BMXRosterApplicationResultPage *res , BMXError *error ))*aCompletionBlock*

Example:

getApplicationList:cursor:

- (BMXErrorCode)getApplicationList:(BMXRosterApplicationResultPage *)*result* cursor:(NSString *)*cursor*

Example:

getApplicationList:cursor:pageSize:

获取申请添加好友列表

- (BMXErrorCode)getApplicationList:(BMXRosterApplicationResultPage *)*result* cursor:(NSString *)*cursor* pageSize:(int)*pageSize*

Parameters

result
返回的申请好友列表信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

cursor
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor

pageSize
分页大小

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

getApplicationList:pageSize:completion:

获取申请添加好友列表

- (void)getApplicationList:(NSString *)*cursor* pageSize:(int)*pageSize* completion:(void ( ^ ) ( BMXRosterApplicationResultPage *res , BMXError *error ))*aCompletionBlock*

Parameters

cursor
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor

pageSize
分页大小

result
返回的申请好友列表信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

getBlockList:completion:

获取黑名单，如果forceRefresh == true，则强制从服务端拉取

- (void)getBlockList:(BOOL)*forceRefresh* completion:(void ( ^ ) ( ListOfLongLong *list , BMXError *error ))*aCompletionBlock*

Parameters

forceRefresh
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取

list
好友id列表，传入空列表函数返回后从此处获取返回的黑名单id列表

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

getBlockList:forceRefresh:

获取黑名单，如果forceRefresh == true，则强制从服务端拉取

- (BMXErrorCode)getBlockList:(ListOfLongLong *)*list* forceRefresh:(BOOL)*forceRefresh*

Parameters

list
好友id列表，传入空列表函数返回后从此处获取返回的黑名单id列表

forceRefresh
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

initWithCptr:swigOwnCObject:

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

Example:

removeDelegate:

移除好友变化监听者

- (void)removeDelegate:(id<BMXRosterServiceProtocol>)*aDelegate*

Parameters

listener
好友变化监听者

Declared In

• floo_proxy.h

Example:

removeRosterListener:

移除好友变化监听者

- (void)removeRosterListener:(id<BMXRosterServiceProtocol>)*listener*

Parameters

listener
好友变化监听者

Declared In

• floo_proxy.h

Example:

removeWithRosterId:

删除好友

- (BMXErrorCode)removeWithRosterId:(long long)*rosterId*

Parameters

rosterId
删除的好友id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

removeWithRosterId:completion:

删除好友

- (void)removeWithRosterId:(long long)*rosterId* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

rosterId
删除的好友id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

searchWithName:forceRefresh:completion:

- (void)searchWithName:(NSString *)*name* forceRefresh:(BOOL)*forceRefresh* completion:(void ( ^ ) ( BMXRosterItem *item , BMXError *error ))*aCompletionBlock*

Example:

searchWithName:forceRefresh:item:

- (BMXErrorCode)searchWithName:(NSString *)*name* forceRefresh:(BOOL)*forceRefresh* item:(BMXRosterItem *)*item*

Example:

searchWithRosterId:forceRefresh:completion:

搜索用户

- (void)searchWithRosterId:(long long)*rosterId* forceRefresh:(BOOL)*forceRefresh* completion:(void ( ^ ) ( BMXRosterItem *item , BMXError *error ))*aCompletionBlock*

Parameters

rosterId
搜索的好友id

forceRefresh
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

item
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Return Value

BMXErrorCode

Discussion

Deprecated. use fetchRosterById instead.

Declared In

• floo_proxy.h

Example:

searchWithRosterId:forceRefresh:item:

搜索用户

- (BMXErrorCode)searchWithRosterId:(long long)*rosterId* forceRefresh:(BOOL)*forceRefresh* item:(BMXRosterItem *)*item*

Parameters

rosterId
搜索的好友id

forceRefresh
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。

item
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。

Return Value

BMXErrorCode

Discussion

Deprecated. use fetchRosterById instead.

Declared In

• floo_proxy.h

Example:

searchWithRosterIdList:forceRefresh:completion:

- (void)searchWithRosterIdList:(ListOfLongLong *)*rosterIdList* forceRefresh:(BOOL)*forceRefresh* completion:(void ( ^ ) ( BMXRosterItemList *list , BMXError *error ))*aCompletionBlock*

Example:

searchWithRosterIdList:list:forceRefresh:

- (BMXErrorCode)searchWithRosterIdList:(ListOfLongLong *)*rosterIdList* list:(BMXRosterItemList *)*list* forceRefresh:(BOOL)*forceRefresh*

Example:

setItemAlias:alias:

更新好友别名

- (BMXErrorCode)setItemAlias:(BMXRosterItem *)*item* alias:(NSString *)*alias*

Parameters

item
用户信息

alias
好友别名

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setItemAlias:alias:completion:

更新好友别名

- (void)setItemAlias:(BMXRosterItem *)*item* alias:(NSString *)*alias* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

item
用户信息

alias
好友别名

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setItemExtension:extension:

更新好友服务器扩展信息

- (BMXErrorCode)setItemExtension:(BMXRosterItem *)*item* extension:(NSString *)*extension*

Parameters

item
用户信息

extension
服务器扩展信息

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setItemExtension:extension:completion:

更新好友服务器扩展信息

- (void)setItemExtension:(BMXRosterItem *)*item* extension:(NSString *)*extension* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

item
用户信息

extension
服务器扩展信息

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setItemLocalExtension:extension:

更新好友本地扩展信息

- (BMXErrorCode)setItemLocalExtension:(BMXRosterItem *)*item* extension:(NSString *)*extension*

Parameters

item
用户信息

extension
本地扩展信息

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setItemLocalExtension:extension:completion:

更新好友本地扩展信息

- (void)setItemLocalExtension:(BMXRosterItem *)*item* extension:(NSString *)*extension* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

item
用户信息

extension
本地扩展信息

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setItemMuteNotification:status:

设置是否拒收用户消息

- (BMXErrorCode)setItemMuteNotification:(BMXRosterItem *)*item* status:(BOOL)*status*

Parameters

item
用户信息

status
是否拒收用户消息，true拒收，false不拒收

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setItemMuteNotification:status:completion:

设置是否拒收用户消息

- (void)setItemMuteNotification:(BMXRosterItem *)*item* status:(BOOL)*status* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

item
用户信息

status
是否拒收用户消息，true拒收，false不拒收

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

unblockWithRosterId:

从黑名单移除

- (BMXErrorCode)unblockWithRosterId:(long long)*rosterId*

Parameters

rosterId
从黑名单移除的用户id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

unblockWithRosterId:completion:

从黑名单移除

- (void)unblockWithRosterId:(long long)*rosterId* completion:(void ( ^ ) ( BMXError *error ))*aCompletionBlock*

Parameters

rosterId
从黑名单移除的用户id

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example: