Package sfs2x.client.entities.variables
Interface UserVariable
-
- All Superinterfaces:
Variable
- All Known Implementing Classes:
SFSUserVariable
public interface UserVariable extends Variable
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
isPrivate()
Indicates whether this User Variable is private or not.void
setPrivate(boolean value)
* API internal usage only *-
Methods inherited from interface sfs2x.client.entities.variables.Variable
getBoolValue, getDoubleValue, getIntValue, getName, getSFSArrayValue, getSFSObjectValue, getStringValue, getType, getValue, isNull, toSFSArray
-
-
-
-
Method Detail
-
isPrivate
boolean isPrivate()
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 private 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).
- Returns:
- whether or not the variable is private
-
setPrivate
void setPrivate(boolean value)
* API internal usage only *
-
-