BMXRosterService Class Reference#
Inherits from NSObject
Declared in floo_proxy.h
Overview#
@interface Roster Service
Properties#
swigCMemOwn#
@property (nonatomic) BOOL swigCMemOwn
swigCPtr#
@property (nonatomic) void *swigCPtr
Instance Methods#
acceptWithRosterId:#
Accept a friend request
- (BMXErrorCode)acceptWithRosterId:(long long)rosterId
Parameters#
rosterId
Friend user ID
Return Value#
Declared In#
floo_proxy.h
acceptWithRosterId:completion:#
Accept a friend request
- (void)acceptWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
Friend user ID
Return Value#
Declared In#
floo_proxy.h
addDelegate:#
Add a roster sevice listener
- (void)addDelegate:(id<BMXRosterServiceProtocol>)aDelegate
Parameters#
listener
Friend change listener
Declared In#
floo_proxy.h
addDelegate:delegateQueue:#
- (void)addDelegate:(id<BMXRosterServiceProtocol>)aDelegate delegateQueue:(dispatch_queue_t)aQueue
addRosterListener:#
Add a roster sevice listener
- (void)addRosterListener:(id<BMXRosterServiceProtocol>)listener
Parameters#
listener
Friend change listener
Declared In#
floo_proxy.h
applyWithRosterId:message:#
- (BMXErrorCode)applyWithRosterId:(long long)rosterId message:(NSString )message*
applyWithRosterId:message:authAnswer:#
Apply to add a friend
- (BMXErrorCode)applyWithRosterId:(long long)rosterId message:(NSString )message authAnswer:(NSString )authAnswer
Parameters#
rosterId
Friend user ID
message
The message attached
Return Value#
Declared In#
floo_proxy.h
applyWithRosterId:message:authAnswer:completion:#
Apply to add a friend
- (void)applyWithRosterId:(long long)rosterId message:(NSString )message authAnswer:(NSString )authAnswer completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
Friend user ID
message
The message attached
Return Value#
Declared In#
floo_proxy.h
applyWithRosterId:message:completion:#
- (void)applyWithRosterId:(long long)rosterId message:(NSString )message completion:(void ( ^ ) ( BMXError error ))aCompletionBlock
blockWithRosterId:#
Block a user
- (BMXErrorCode)blockWithRosterId:(long long)rosterId
Parameters#
rosterId
User ID
Return Value#
Declared In#
floo_proxy.h
blockWithRosterId:completion:#
Block a user
- (void)blockWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
User ID
Return Value#
Declared In#
floo_proxy.h
dealloc#
- (void)dealloc
declineWithRosterId:reason:#
Decline a friend request
- (BMXErrorCode)declineWithRosterId:(long long)rosterId reason:(NSString )reason*
Parameters#
rosterId
User ID
reason
Reason for rejection
Return Value#
Declared In#
floo_proxy.h
declineWithRosterId:reason:completion:#
Decline a friend request
- (void)declineWithRosterId:(long long)rosterId reason:(NSString )reason completion:(void ( ^ ) ( BMXError error ))aCompletionBlock
Parameters#
rosterId
User ID
reason
Reason for rejection
Return Value#
Declared In#
floo_proxy.h
downloadAvatarWithItem:thumbnail:callback:#
Download friend's avatar
- (BMXErrorCode)downloadAvatarWithItem:(BMXRosterItem )item thumbnail:(BOOL)thumbnail callback:(void ( ^ ) ( int progress ))callback*
Parameters#
item
User information
thumbnail
Is it a thumbnail
callback
Download callback
Return Value#
Declared In#
floo_proxy.h
downloadAvatarWithItem:thumbnail:callback:completion:#
Download friend's avatar
- (void)downloadAvatarWithItem:(BMXRosterItem )item thumbnail:(BOOL)thumbnail callback:(void ( ^ ) ( int progress ))callback completion:(void ( ^ ) ( BMXError error ))aCompletionBlock
Parameters#
item
User information
thumbnail
Is it a thumbnail
callback
Download callback
Return Value#
Declared In#
floo_proxy.h
fetchRosterByIdWithRosterId:forceRefresh:completion:#
Get a roster item
- (void)fetchRosterByIdWithRosterId:(long long)rosterId forceRefresh:(BOOL)forceRefresh completion:(void ( ^ ) ( BMXRosterItem item , BMXError error ))aCompletionBlock
Parameters#
rosterId
User ID
forceRefresh
From server
item
User returned by the query. Pass an empty shared_ptr; the method assigns the result to it.
Return Value#
Declared In#
floo_proxy.h
fetchRosterByIdWithRosterId:forceRefresh:item:#
Get a roster item
- (BMXErrorCode)fetchRosterByIdWithRosterId:(long long)rosterId forceRefresh:(BOOL)forceRefresh item:(BMXRosterItem )item*
Parameters#
rosterId
User ID
forceRefresh
From server
item
User returned by the query. Pass an empty shared_ptr; the method assigns the result to it.
Return Value#
Declared In#
floo_proxy.h
fetchRosterByNameWithName:forceRefresh:completion:#
Get a roster item
- (void)fetchRosterByNameWithName:(NSString )name forceRefresh:(BOOL)forceRefresh completion:(void ( ^ ) ( BMXRosterItem item , BMXError error ))aCompletionBlock*
Parameters#
name
Username
forceRefresh
From server
item
User returned by the query. Pass an empty shared_ptr; the method assigns the result to it.
Return Value#
Declared In#
floo_proxy.h
fetchRosterByNameWithName:forceRefresh:item:#
Get a roster item
- (BMXErrorCode)fetchRosterByNameWithName:(NSString )name forceRefresh:(BOOL)forceRefresh item:(BMXRosterItem )item
Parameters#
name
Username
forceRefresh
From server
item
User returned by the query. Pass an empty shared_ptr; the method assigns the result to it.
Return Value#
Declared In#
floo_proxy.h
fetchRostersByIdListWithRosterIdList:forceRefresh:completion:#
Get roster items
- (void)fetchRostersByIdListWithRosterIdList:(ListOfLongLong )rosterIdList forceRefresh:(BOOL)forceRefresh completion:(void ( ^ ) ( BMXRosterItemList list , BMXError error ))aCompletionBlock*
Parameters#
rosterIdList
User ID list of roster items
forceRefresh
From server
list
Contact details returned by the operation. Pass an empty list; the method populates it.
Return Value#
Declared In#
floo_proxy.h
fetchRostersByIdListWithRosterIdList:list:forceRefresh:#
Get roster items
- (BMXErrorCode)fetchRostersByIdListWithRosterIdList:(ListOfLongLong )rosterIdList list:(BMXRosterItemList )list forceRefresh:(BOOL)forceRefresh
Parameters#
rosterIdList
User ID list of roster items
list
Contact details returned by the operation. Pass an empty list; the method populates it.
forceRefresh
From server
Return Value#
Declared In#
floo_proxy.h
get:completion:#
Get all roster items
- (void)get:(BOOL)forceRefresh completion:(void ( ^ ) ( ListOfLongLong list , BMXError error ))aCompletionBlock
Parameters#
forceRefresh
From server
list
Contact IDs returned by the operation. Pass an empty list; the method populates it.
Return Value#
Declared In#
floo_proxy.h
get:forceRefresh:#
Get all roster items
- (BMXErrorCode)get:(ListOfLongLong )list forceRefresh:(BOOL)forceRefresh*
Parameters#
list
Contact IDs returned by the operation. Pass an empty list; the method populates it.
forceRefresh
From server
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:#
Get friend request list
- (BMXErrorCode)getApplicationList:(BMXRosterApplicationResultPage )result cursor:(NSString )cursor pageSize:(int)pageSize
Parameters#
result
Contact applications returned by the operation. Pass an empty shared_ptr; the method assigns the result to it.
cursor
Cursor at which to start the page. Leave it empty for the first request, then pass the cursor from the previous result.
pageSize
Page size
Return Value#
Declared In#
floo_proxy.h
getApplicationList:pageSize:completion:#
Get friend request list
- (void)getApplicationList:(NSString )cursor pageSize:(int)pageSize completion:(void ( ^ ) ( BMXRosterApplicationResultPage res , BMXError error ))aCompletionBlock*
Parameters#
cursor
Cursor at which to start the page. Leave it empty for the first request, then pass the cursor from the previous result.
pageSize
Page size
result
Contact applications returned by the operation. Pass an empty shared_ptr; the method assigns the result to it.
Return Value#
Declared In#
floo_proxy.h
getBlockList:completion:#
Get the ID list of user blocked
- (void)getBlockList:(BOOL)forceRefresh completion:(void ( ^ ) ( ListOfLongLong list , BMXError error ))aCompletionBlock
Parameters#
forceRefresh
From server
list
Blocked contact IDs returned by the operation. Pass an empty list; the method populates it.
Return Value#
Declared In#
floo_proxy.h
getBlockList:forceRefresh:#
Get the ID list of user blocked
- (BMXErrorCode)getBlockList:(ListOfLongLong )list forceRefresh:(BOOL)forceRefresh*
Parameters#
list
Blocked contact IDs returned by the operation. Pass an empty list; the method populates it.
forceRefresh
From server
Return Value#
Declared In#
floo_proxy.h
initWithCptr:swigOwnCObject:#
- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*
removeDelegate:#
Remove a roster sevice listener
- (void)removeDelegate:(id<BMXRosterServiceProtocol>)aDelegate
Parameters#
listener
Friend change listener
Declared In#
floo_proxy.h
removeRosterListener:#
Remove a roster sevice listener
- (void)removeRosterListener:(id<BMXRosterServiceProtocol>)listener
Parameters#
listener
Friend change listener
Declared In#
floo_proxy.h
removeWithRosterId:#
Remove a roster item
- (BMXErrorCode)removeWithRosterId:(long long)rosterId
Parameters#
rosterId
User ID
Return Value#
Declared In#
floo_proxy.h
removeWithRosterId:completion:#
Remove a roster item
- (void)removeWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
User 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:#
Search a roster item
- (void)searchWithRosterId:(long long)rosterId forceRefresh:(BOOL)forceRefresh completion:(void ( ^ ) ( BMXRosterItem item , BMXError error ))aCompletionBlock
Parameters#
rosterId
User ID
forceRefresh
From server
item
User returned by the query. Pass an empty shared_ptr; the method assigns the result to it.
Return Value#
Discussion#
Deprecated. use fetchRosterById instead.
Declared In#
floo_proxy.h
searchWithRosterId:forceRefresh:item:#
Search a roster item
- (BMXErrorCode)searchWithRosterId:(long long)rosterId forceRefresh:(BOOL)forceRefresh item:(BMXRosterItem )item*
Parameters#
rosterId
User ID
forceRefresh
From server
item
User returned by the query. Pass an empty shared_ptr; the method assigns the result to it.
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:#
Set friend’s alias
- (BMXErrorCode)setItemAlias:(BMXRosterItem )item alias:(NSString )alias
Parameters#
item
User information
alias
Contact alias
Return Value#
Declared In#
floo_proxy.h
setItemAlias:alias:completion:#
Set friend’s alias
- (void)setItemAlias:(BMXRosterItem )item alias:(NSString )alias completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
item
User information
alias
Contact alias
Return Value#
Declared In#
floo_proxy.h
setItemExtension:extension:#
Set extension information for the roster item(on server)
- (BMXErrorCode)setItemExtension:(BMXRosterItem )item extension:(NSString )extension
Parameters#
item
User information
extension
Server-side extension data
Return Value#
Declared In#
floo_proxy.h
setItemExtension:extension:completion:#
Set extension information for the roster item(on server)
- (void)setItemExtension:(BMXRosterItem )item extension:(NSString )extension completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
item
User information
extension
Server-side extension data
Return Value#
Declared In#
floo_proxy.h
setItemLocalExtension:extension:#
Set extension information for the roster item(on local db)
- (BMXErrorCode)setItemLocalExtension:(BMXRosterItem )item extension:(NSString )extension
Parameters#
item
User information
extension
Local extension data
Return Value#
Declared In#
floo_proxy.h
setItemLocalExtension:extension:completion:#
Set extension information for the roster item(on local db)
- (void)setItemLocalExtension:(BMXRosterItem )item extension:(NSString )extension completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
item
User information
extension
Local extension data
Return Value#
Declared In#
floo_proxy.h
setItemMuteNotification:status:#
Set whether to mute user messages notification
- (BMXErrorCode)setItemMuteNotification:(BMXRosterItem )item status:(BOOL)status*
Parameters#
item
User information
status
true for mute
Return Value#
Declared In#
floo_proxy.h
setItemMuteNotification:status:completion:#
Set whether to mute user messages notification
- (void)setItemMuteNotification:(BMXRosterItem )item status:(BOOL)status completion:(void ( ^ ) ( BMXError error ))aCompletionBlock
Parameters#
item
User information
status
true for mute
Return Value#
Declared In#
floo_proxy.h
unblockWithRosterId:#
Unblock a roster item
- (BMXErrorCode)unblockWithRosterId:(long long)rosterId
Parameters#
rosterId
ID of the user removed from the block list
Return Value#
Declared In#
floo_proxy.h
unblockWithRosterId:completion:#
Unblock a roster item
- (void)unblockWithRosterId:(long long)rosterId completion:(void ( ^ ) ( BMXError error ))aCompletionBlock*
Parameters#
rosterId
ID of the user removed from the block list
Return Value#
Declared In#
floo_proxy.h