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#
Declared In#
floo_proxy.h
acceptWithRosterId:completion:#
接受加好友申請
- (void)acceptWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
申請加為好友的使用者id
Return Value#
Declared In#
floo_proxy.h
addDelegate:#
添加好友變化監聽者
- (void)addDelegate:(id<BMXRosterServiceProtocol>)aDelegate
Parameters#
listener
好友變化監聽者
Declared In#
floo_proxy.h
addDelegate:delegateQueue:#
- (void)addDelegate:(id<BMXRosterServiceProtocol>)aDelegate delegateQueue:(dispatch_queue_t)aQueue
addRosterListener:#
添加好友變化監聽者
- (void)addRosterListener:(id<BMXRosterServiceProtocol>)listener
Parameters#
listener
好友變化監聽者
Declared In#
floo_proxy.h
applyWithRosterId:message:#
- (BMXErrorCode)applyWithRosterId:(long long)rosterId message:(NSString )message*
applyWithRosterId:message:authAnswer:#
申請添加好友
- (BMXErrorCode)applyWithRosterId:(long long)rosterId message:(NSString )message authAnswer:(NSString )authAnswer
Parameters#
rosterId
申請添加的使用者id
message
好友申請信息
Return Value#
Declared In#
floo_proxy.h
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#
Declared In#
floo_proxy.h
applyWithRosterId:message:completion:#
- (void)applyWithRosterId:(long long)rosterId message:(NSString )message completion:(void ( ^ ) ( BMXError error ))aCompletionBlock
blockWithRosterId:#
加入黑名單
- (BMXErrorCode)blockWithRosterId:(long long)rosterId
Parameters#
rosterId
加入黑名單的使用者id
Return Value#
Declared In#
floo_proxy.h
blockWithRosterId:completion:#
加入黑名單
- (void)blockWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
加入黑名單的使用者id
Return Value#
Declared In#
floo_proxy.h
dealloc#
- (void)dealloc
declineWithRosterId:reason:#
拒絕加好友申請
- (BMXErrorCode)declineWithRosterId:(long long)rosterId reason:(NSString )reason*
Parameters#
rosterId
申請加為好友的使用者id
reason
拒絕的原因
Return Value#
Declared In#
floo_proxy.h
declineWithRosterId:reason:completion:#
拒絕加好友申請
- (void)declineWithRosterId:(long long)rosterId reason:(NSString )reason completion:(void ( ^ ) ( BMXError error ))aCompletionBlock
Parameters#
rosterId
申請加為好友的使用者id
reason
拒絕的原因
Return Value#
Declared In#
floo_proxy.h
downloadAvatarWithItem:thumbnail:callback:#
下載頭像
- (BMXErrorCode)downloadAvatarWithItem:(BMXRosterItem )item thumbnail:(BOOL)thumbnail callback:(void ( ^ ) ( int progress ))callback*
Parameters#
item
使用者信息
thumbnail
是否下載縮略圖，ture為縮略圖，false為原圖
callback
下載回呼函數
Return Value#
Declared In#
floo_proxy.h
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#
Declared In#
floo_proxy.h
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#
Declared In#
floo_proxy.h
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#
Declared In#
floo_proxy.h
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#
Declared In#
floo_proxy.h
fetchRosterByNameWithName:forceRefresh:item:#
通過使用者名搜索使用者
- (BMXErrorCode)fetchRosterByNameWithName:(NSString )name forceRefresh:(BOOL)forceRefresh item:(BMXRosterItem )item
Parameters#
name
搜索的使用者名
forceRefresh
為true強制從伺服器取得，為false情況下查詢結果為空時自動從伺服器取得。
item
查詢回傳的使用者的信息，傳入指向為空的shared_ptr物件函數執行後會自動賦值。
Return Value#
Declared In#
floo_proxy.h
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#
Declared In#
floo_proxy.h
fetchRostersByIdListWithRosterIdList:list:forceRefresh:#
通過聯繫人id列表批量搜索使用者
- (BMXErrorCode)fetchRostersByIdListWithRosterIdList:(ListOfLongLong )rosterIdList list:(BMXRosterItemList )list forceRefresh:(BOOL)forceRefresh
Parameters#
rosterIdList
需要搜索的使用者id列表
list
回傳的好友信息列表，傳入空列表函數回傳後從此處取得回傳的好友信息列表
forceRefresh
是否強制從伺服器取得，為true則強制從伺服器取得
Return Value#
Declared In#
floo_proxy.h
get:completion:#
取得好友列表，如果forceRefresh == true，則強制從服務端拉取
- (void)get:(BOOL)forceRefresh completion:(void ( ^ ) ( ListOfLongLong list , BMXError error ))aCompletionBlock
Parameters#
forceRefresh
是否從伺服器讀取資料，true為強制從伺服器取得，false情況下本地讀取列表為空的情況下會自動從伺服器讀取
list
好友id列表，傳入空列表函數回傳後從此處取得回傳的好友id列表
Return Value#
Declared In#
floo_proxy.h
get:forceRefresh:#
取得好友列表，如果forceRefresh == true，則強制從服務端拉取
- (BMXErrorCode)get:(ListOfLongLong )list forceRefresh:(BOOL)forceRefresh*
Parameters#
list
好友id列表，傳入空列表函數回傳後從此處取得回傳的好友id列表
forceRefresh
是否從伺服器讀取資料，true為強制從伺服器取得，false情況下本地讀取列表為空的情況下會自動從伺服器讀取
Return Value#
Declared In#
floo_proxy.h
getApplicationList:completion:#
- (void)getApplicationList:(NSString )cursor completion:(void ( ^ ) ( BMXRosterApplicationResultPage res , BMXError error ))aCompletionBlock*
getApplicationList:cursor:#
- (BMXErrorCode)getApplicationList:(BMXRosterApplicationResultPage )result cursor:(NSString )cursor
getApplicationList:cursor:pageSize:#
取得申請添加好友列表
- (BMXErrorCode)getApplicationList:(BMXRosterApplicationResultPage )result cursor:(NSString )cursor pageSize:(int)pageSize
Parameters#
result
回傳的申請好友列表信息，傳入指向為空的shared_ptr物件函數執行後會自動賦值。
cursor
分頁取得的起始cursor，第一次傳入為空，後續傳入上次操作回傳的result中的cursor
pageSize
分頁大小
Return Value#
Declared In#
floo_proxy.h
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#
Declared In#
floo_proxy.h
getBlockList:completion:#
取得黑名單，如果forceRefresh == true，則強制從服務端拉取
- (void)getBlockList:(BOOL)forceRefresh completion:(void ( ^ ) ( ListOfLongLong list , BMXError error ))aCompletionBlock
Parameters#
forceRefresh
是否從伺服器讀取資料，true為強制從伺服器取得，false情況下本地讀取列表為空的情況下會自動從伺服器讀取
list
好友id列表，傳入空列表函數回傳後從此處取得回傳的黑名單id列表
Return Value#
Declared In#
floo_proxy.h
getBlockList:forceRefresh:#
取得黑名單，如果forceRefresh == true，則強制從服務端拉取
- (BMXErrorCode)getBlockList:(ListOfLongLong )list forceRefresh:(BOOL)forceRefresh*
Parameters#
list
好友id列表，傳入空列表函數回傳後從此處取得回傳的黑名單id列表
forceRefresh
是否從伺服器讀取資料，true為強制從伺服器取得，false情況下本地讀取列表為空的情況下會自動從伺服器讀取
Return Value#
Declared In#
floo_proxy.h
initWithCptr:swigOwnCObject:#
- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*
removeDelegate:#
移除好友變化監聽者
- (void)removeDelegate:(id<BMXRosterServiceProtocol>)aDelegate
Parameters#
listener
好友變化監聽者
Declared In#
floo_proxy.h
removeRosterListener:#
移除好友變化監聽者
- (void)removeRosterListener:(id<BMXRosterServiceProtocol>)listener
Parameters#
listener
好友變化監聽者
Declared In#
floo_proxy.h
removeWithRosterId:#
刪除好友
- (BMXErrorCode)removeWithRosterId:(long long)rosterId
Parameters#
rosterId
刪除的好友id
Return Value#
Declared In#
floo_proxy.h
removeWithRosterId:completion:#
刪除好友
- (void)removeWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
刪除的好友id
Return Value#
Declared In#
floo_proxy.h
searchWithName:forceRefresh:completion:#
- (void)searchWithName:(NSString )name forceRefresh:(BOOL)forceRefresh completion:(void ( ^ ) ( BMXRosterItem item , BMXError error ))aCompletionBlock*
searchWithName:forceRefresh:item:#
- (BMXErrorCode)searchWithName:(NSString )name forceRefresh:(BOOL)forceRefresh item:(BMXRosterItem )item
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#
Discussion#
Deprecated. use fetchRosterById instead.
Declared In#
floo_proxy.h
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#
Discussion#
Deprecated. use fetchRosterById instead.
Declared In#
floo_proxy.h
searchWithRosterIdList:forceRefresh:completion:#
- (void)searchWithRosterIdList:(ListOfLongLong )rosterIdList forceRefresh:(BOOL)forceRefresh completion:(void ( ^ ) ( BMXRosterItemList list , BMXError error ))aCompletionBlock*
searchWithRosterIdList:list:forceRefresh:#
- (BMXErrorCode)searchWithRosterIdList:(ListOfLongLong )rosterIdList list:(BMXRosterItemList )list forceRefresh:(BOOL)forceRefresh
setItemAlias:alias:#
更新好友別名
- (BMXErrorCode)setItemAlias:(BMXRosterItem )item alias:(NSString )alias
Parameters#
item
使用者信息
alias
好友別名
Return Value#
Declared In#
floo_proxy.h
setItemAlias:alias:completion:#
更新好友別名
- (void)setItemAlias:(BMXRosterItem )item alias:(NSString )alias completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
item
使用者信息
alias
好友別名
Return Value#
Declared In#
floo_proxy.h
setItemExtension:extension:#
更新好友伺服器擴展信息
- (BMXErrorCode)setItemExtension:(BMXRosterItem )item extension:(NSString )extension
Parameters#
item
使用者信息
extension
伺服器擴展信息
Return Value#
Declared In#
floo_proxy.h
setItemExtension:extension:completion:#
更新好友伺服器擴展信息
- (void)setItemExtension:(BMXRosterItem )item extension:(NSString )extension completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
item
使用者信息
extension
伺服器擴展信息
Return Value#
Declared In#
floo_proxy.h
setItemLocalExtension:extension:#
更新好友本地擴展信息
- (BMXErrorCode)setItemLocalExtension:(BMXRosterItem )item extension:(NSString )extension
Parameters#
item
使用者信息
extension
本地擴展信息
Return Value#
Declared In#
floo_proxy.h
setItemLocalExtension:extension:completion:#
更新好友本地擴展信息
- (void)setItemLocalExtension:(BMXRosterItem )item extension:(NSString )extension completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
item
使用者信息
extension
本地擴展信息
Return Value#
Declared In#
floo_proxy.h
setItemMuteNotification:status:#
設定是否拒收使用者訊息
- (BMXErrorCode)setItemMuteNotification:(BMXRosterItem )item status:(BOOL)status*
Parameters#
item
使用者信息
status
是否拒收使用者訊息，true拒收，false不拒收
Return Value#
Declared In#
floo_proxy.h
setItemMuteNotification:status:completion:#
設定是否拒收使用者訊息
- (void)setItemMuteNotification:(BMXRosterItem )item status:(BOOL)status completion:(void ( ^ ) ( BMXError error ))aCompletionBlock
Parameters#
item
使用者信息
status
是否拒收使用者訊息，true拒收，false不拒收
Return Value#
Declared In#
floo_proxy.h
unblockWithRosterId:#
從黑名單移除
- (BMXErrorCode)unblockWithRosterId:(long long)rosterId
Parameters#
rosterId
從黑名單移除的使用者id
Return Value#
Declared In#
floo_proxy.h
unblockWithRosterId:completion:#
從黑名單移除
- (void)unblockWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
從黑名單移除的使用者id
Return Value#
Declared In#
floo_proxy.h