| Package | com.smartfoxserver.v2.entities |
| Interface | public interface Buddy |
| Implementors | SFSBuddy |
In the SmartFoxServer 2X client API this interface is implemented by the SFSBuddy class. Read the class description for additional informations.
See also
| Property | Defined By | ||
|---|---|---|---|
| id : int [read-only]
Indicates the id of this buddy. | Buddy | ||
| isBlocked : Boolean [read-only]
Indicates whether this buddy is blocked in the current user's buddies list or not. | Buddy | ||
| isOnline : Boolean [read-only]
Indicates whether this buddy is online in the Buddy List system or not. | Buddy | ||
| isTemp : Boolean [read-only]
Indicates whether this buddy is temporary (non-persistent) in the current user's buddies list or not. | Buddy | ||
| name : String [read-only]
Indicates the name of this buddy. | Buddy | ||
| nickName : String [read-only]
Returns the nickname of this buddy. | Buddy | ||
| state : String [read-only]
Returns the custom state of this buddy. | Buddy | ||
| variables : Array [read-only]
Returns a list of BuddyVariable objects associated with the buddy. | Buddy | ||
| Method | Defined By | ||
|---|---|---|---|
containsVariable(varName:String):Boolean
Indicates whether this buddy has the specified Buddy Variable set or not. | Buddy | ||
getOfflineVariables():Array
Retrieves the list of persistent Buddy Variables of this buddy. | Buddy | ||
getOnlineVariables():Array
Retrieves the list of non-persistent Buddy Variables of this buddy. | Buddy | ||
getVariable(varName:String):BuddyVariable
Retrieves a Buddy Variable from its name. | Buddy | ||
| id | property |
id:int [read-only] Indicates the id of this buddy. This is equal to the id assigned by SmartFoxServer to the corresponding user.
public function get id():intSee also
| isBlocked | property |
isBlocked:Boolean [read-only] Indicates whether this buddy is blocked in the current user's buddies list or not. A buddy can be blocked by means of a BlockBuddyRequest request.
public function get isBlocked():BooleanSee also
| isOnline | property |
isOnline:Boolean [read-only] Indicates whether this buddy is online in the Buddy List system or not.
public function get isOnline():Boolean| isTemp | property |
isTemp:Boolean [read-only] Indicates whether this buddy is temporary (non-persistent) in the current user's buddies list or not.
public function get isTemp():Boolean| name | property |
name:String [read-only] Indicates the name of this buddy. This is equal to the name of the corresponding user.
public function get name():StringSee also
| nickName | property |
nickName:String [read-only]
Returns the nickname of this buddy.
If the nickname is not set, null is returned.
public function get nickName():String| state | property |
state:String [read-only]
Returns the custom state of this buddy.
Examples of custom states are "Available", "Busy", "Be right back", etc. If the custom state is not set, null is returned.
The list of available custom states is returned by the IBuddyManager.buddyStates property.
public function get state():StringSee also
| variables | property |
variables:Array [read-only] Returns a list of BuddyVariable objects associated with the buddy.
public function get variables():ArraySee also
| containsVariable | () | method |
public function containsVariable(varName:String):BooleanIndicates whether this buddy has the specified Buddy Variable set or not.
Parameters
varName:String — The name of the Buddy Variable whose existance must be checked.
|
Boolean — true if a Buddy Variable with the passed name is set for this buddy.
|
| getOfflineVariables | () | method |
public function getOfflineVariables():ArrayRetrieves the list of persistent Buddy Variables of this buddy.
ReturnsArray — An array of BuddyVariable objects.
|
See also
| getOnlineVariables | () | method |
public function getOnlineVariables():ArrayRetrieves the list of non-persistent Buddy Variables of this buddy.
ReturnsArray — An array of BuddyVariable objects.
|
See also
| getVariable | () | method |
public function getVariable(varName:String):BuddyVariableRetrieves a Buddy Variable from its name.
Parameters
varName:String — The name of the Buddy Variable to be retrieved.
|
BuddyVariable — The BuddyVariable object representing the Buddy Variable, or null if no Buddy Variable with the passed name is associated with this buddy.
|
See also