Packagecom.smartfoxserver.v2.entities.variables
Interfacepublic interface RoomVariable extends Variable
Implementors SFSRoomVariable

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

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

See also

SFSRoomVariable

Public Properties
 PropertyDefined By
  isPersistent : Boolean
Indicates whether this Room Variable is persistent or not.
RoomVariable
  isPrivate : Boolean
Indicates whether this Room Variable is private or not.
RoomVariable
 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
isPersistentproperty
isPersistent:Boolean

Indicates whether this Room Variable is persistent or not. A persistent Room Variable continues to exist in the Room after the user who created it has left it and until he disconnects.

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


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

Indicates whether this Room Variable is private or not. A private Room Variable is visible to all users in the same Room, but it can be modified only by its owner (the user that created it).

NOTE: setting the isPrivate property manually on an existing Room Variable returned by the API has no effect on the server and can disrupt the API functioning. This flag can be set when the Room 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