Packagecom.smartfoxserver.v2.entities.variables
Interfacepublic interface BuddyVariable extends Variable
Implementors SFSBuddyVariable

The BuddyVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Buddy Variable exposes.

In the SmartFoxServer 2X client API this interface is implemented by the SFSBuddyVariable class. Read the class description for additional informations.

See also

SFSBuddyVariable

Public Properties
 PropertyDefined By
  isOffline : Boolean
[read-only] Indicates whether the Buddy Variable is persistent or not.
BuddyVariable
 Inheritedname : String
[read-only] Indicates the name of this variable.
Variable
 Inheritedtype : String
[read-only] Indicates the type of this variable.
Variable
Public Methods
 MethodDefined By
 Inherited
getBoolValue():Boolean
Retrieves the value of a boolean variable.
Variable
 Inherited
getDoubleValue():Number
Retrieves the value of a numeric variable.
Variable
 Inherited
getIntValue():int
Retrieves the value of an integer variable.
Variable
 Inherited
getSFSArrayValue():ISFSArray
Retrieves the value of a SFSArray variable.
Variable
 Inherited
getSFSObjectValue():ISFSObject
Retrieves the value of a SFSObject variable.
Variable
 Inherited
getStringValue():String
Retrieves the value of a string variable.
Variable
 Inherited
getValue():*
Retrieves the untyped value of this variable.
Variable
 Inherited
isNull():Boolean
Indicates if the variable is null.
Variable
Property Detail
isOfflineproperty
isOffline:Boolean  [read-only]

Indicates whether the Buddy Variable is persistent or not.

By convention any Buddy Variable whose name starts with the dollar sign ($) will be regarded as persistent and stored locally by the server. Persistent Buddy Variables are also referred to as "offline variables" because they are available to all users who have the owner in their Buddy Lists, whether that Buddy is online or not.


Implementation
    public function get isOffline():Boolean



© 2016 gotoAndPlay() - All rights reserved

lunedì ottobre 29 2018, 09:52 AM +01:00