IBuddyManager Protocol Reference
Conforms to | NSObject |
Declared in | IBuddyManager.h |
Tasks
-
– isInited
Checks if the current User’s Buddy List is inited. If not you should send an InitBuddyListRequest to the server in order to retrieve your persistent Buddy List data.
required method -
– containsBuddy:
Checks if a Buddy is present in the current User’s Buddy List
required method -
– getBuddyById:
Find a Buddy from its User Id
required method -
– getBuddyByName:
Find a Buddy from its name
required method -
– getBuddyByNickName:
Find a Buddy from its optional nick name
required method -
– offlineBuddies
Get a list of all offline Buddies in the User’s Buddy list
required method -
– onlineBuddies
Get a list of all online Buddies in the User’s Buddy list
required method -
– buddyList
Get the User’s buddy list. It could be null if the Buddy List was not initialized
required method -
– buddyStates
Get a list of Strings representing the custom Buddy states that the application can use. The custom states are sent upon initialization of the Buddy List and are configured on the server side.
required method -
– getMyVariable:
Get current Users' BuddyVariable by name
required method -
– myVariables
Get all current User’s Buddy Variables This operation is valid only if the User’s BuddyList has already been initialized
required method -
– myOnlineState
Get the current User’s Online State This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
required method -
– myNickName
Get the current User’s optional nickname This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
required method -
– myState
Get the current User’s optional custom state (e.g. “Available”; “Busy”, “Be right back”…) This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
required method
Instance Methods
buddyList
Get the User’s buddy list. It could be null if the Buddy List was not initialized
- (NSArray *)buddyList
Discussion
Get the User’s buddy list. It could be null if the Buddy List was not initialized
See Also
Declared In
IBuddyManager.h
buddyStates
Get a list of Strings representing the custom Buddy states that the application can use. The custom states are sent upon initialization of the Buddy List and are configured on the server side.
- (NSArray *)buddyStates
Discussion
Get a list of Strings representing the custom Buddy states that the application can use. The custom states are sent upon initialization of the Buddy List and are configured on the server side.
Declared In
IBuddyManager.h
containsBuddy:
Checks if a Buddy is present in the current User’s Buddy List
- (BOOL)containsBuddy:(NSString *)name
Parameters
- name
the Buddy name
Return Value
the true if the Buddy exists
Discussion
Checks if a Buddy is present in the current User’s Buddy List
See Also
Declared In
IBuddyManager.h
getBuddyById:
Find a Buddy from its User Id
- (id<Buddy>)getBuddyById:(NSInteger)id_
Parameters
- id_
the user id
Return Value
the Buddy, or null if not found
Discussion
Find a Buddy from its User Id
See Also
Declared In
IBuddyManager.h
getBuddyByName:
Find a Buddy from its name
- (id<Buddy>)getBuddyByName:(NSString *)name
Parameters
- name
the Buddy name
Return Value
the Buddy, or null if not found
Discussion
Find a Buddy from its name
See Also
Declared In
IBuddyManager.h
getBuddyByNickName:
Find a Buddy from its optional nick name
- (id<Buddy>)getBuddyByNickName:(NSString *)nickName
Parameters
- nickName
the nickname
Return Value
the Buddy, or null if not found
Discussion
Find a Buddy from its optional nick name
See Also
Declared In
IBuddyManager.h
getMyVariable:
Get current Users' BuddyVariable by name
- (id<BuddyVariable>)getMyVariable:(NSString *)varName
Parameters
- varName
the variable name
Discussion
Get current Users' BuddyVariable by name
Declared In
IBuddyManager.h
isInited
Checks if the current User’s Buddy List is inited. If not you should send an InitBuddyListRequest to the server in order to retrieve your persistent Buddy List data.
- (BOOL)isInited
Discussion
Checks if the current User’s Buddy List is inited. If not you should send an InitBuddyListRequest to the server in order to retrieve your persistent Buddy List data.
See Also
Declared In
IBuddyManager.h
myNickName
Get the current User’s optional nickname This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
- (NSString *)myNickName
Return Value
return the Users' nickname or null if the nickname was never set
Discussion
Get the current User’s optional nickname This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
See Also
Declared In
IBuddyManager.h
myOnlineState
Get the current User’s Online State This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
- (BOOL)myOnlineState
Return Value
true if the User is online, false otherwise
Discussion
Get the current User’s Online State This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
See Also
Declared In
IBuddyManager.h
myState
Get the current User’s optional custom state (e.g. “Available”; “Busy”, “Be right back”…) This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
- (NSString *)myState
Return Value
return the Users' state or null if the state was not set
Discussion
Get the current User’s optional custom state (e.g. “Available”; “Busy”, “Be right back”…) This operation is valid only if the User’s BuddyList has already been initialized The value is handled by a reserved Buddy Variable
See Also
Declared In
IBuddyManager.h
myVariables
Get all current User’s Buddy Variables This operation is valid only if the User’s BuddyList has already been initialized
- (NSArray *)myVariables
Discussion
Get all current User’s Buddy Variables This operation is valid only if the User’s BuddyList has already been initialized
See Also
Declared In
IBuddyManager.h