Packagecom.smartfoxserver.v2.entities.variables
Interfacepublic interface Variable
Implementors BaseVariable

The Variable interface defines all the default public methods and properties that an object representing a SmartFoxServer Room/User/Buddy Variable exposes.


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

Indicates the name of this variable.


Implementation
    public function get name():String
typeproperty 
type:String  [read-only]

Indicates the type of this variable.


Implementation
    public function get type():String

See also

VariableType
Method Detail
getBoolValue()method
public function getBoolValue():Boolean

Retrieves the value of a boolean variable.

Returns
Boolean — The variable value as a Boolean.
getDoubleValue()method 
public function getDoubleValue():Number

Retrieves the value of a numeric variable.

Returns
Number — The variable value as a Number.
getIntValue()method 
public function getIntValue():int

Retrieves the value of an integer variable.

Returns
int — The variable value as an int.
getSFSArrayValue()method 
public function getSFSArrayValue():ISFSArray

Retrieves the value of a SFSArray variable.

Returns
ISFSArray — The variable value as an ISFSArray.
getSFSObjectValue()method 
public function getSFSObjectValue():ISFSObject

Retrieves the value of a SFSObject variable.

Returns
ISFSObject — The variable value as an ISFSObject.
getStringValue()method 
public function getStringValue():String

Retrieves the value of a string variable.

Returns
String — The variable value as a String.
getValue()method 
public function getValue():*

Retrieves the untyped value of this variable.

Returns
* — The variable untyped value.
isNull()method 
public function isNull():Boolean

Indicates if the variable is null.

Returns
Boolean — true if the variable has a null value.



© 2016 gotoAndPlay() - All rights reserved

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