Packagecom.smartfoxserver.v2.entities.variables
Interfacepublic interface UserVariable extends Variable
Implementors SFSUserVariable

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

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

See also

SFSUserVariable

Public Properties
 PropertyDefined By
  isPrivate : Boolean
Indicates whether this User Variable is private or not.
UserVariable
 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
isPrivateproperty
isPrivate:Boolean

Indicates whether this User Variable is private or not. A private User Variable is visible only to its owner; any changes made to the variable will be transmitted to the owner only.

NOTE: setting the isPrivate property manually on an existing User Variable returned by the API has no effect on the server and can disrupt the API functioning. This flag can be set when the User Variable object is created by the developer only (using the new keyword).


Implementation
    public function get isPrivate():Boolean
    public function set isPrivate(value:Boolean):void



© 2016 gotoAndPlay() - All rights reserved

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