sfs2x.client.entities.variables
Interface RoomVariable

All Superinterfaces:

UserVariable

All Known Implementing Classes:

SFSRoomVariable

public interface RoomVariable
extends UserVariable

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

Method Summary

boolean	isPersistent() Indicates whether this Room Variable is persistent or not.
boolean	isPrivate() Indicates whether this Room Variable is private or not.
void	setPersistent(boolean persistent) *Private*
void	setPrivate(boolean setPrivate) *Private*

Methods inherited from interface sfs2x.client.entities.variables.UserVariable

getBoolValue, getDoubleValue, getIntValue, getName, getSFSArrayValue, getSFSObjectValue, getStringValue, getType, getValue, isNull, toSFSArray

Method Detail

isPrivate

boolean isPrivate()

Indicates whether this Room Variable is private or not. A private Room Variable can be modified by its owner only (the user that created it).

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).

isPersistent

boolean isPersistent()

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).

setPrivate

void setPrivate(boolean setPrivate)

*Private*

setPersistent

void setPersistent(boolean persistent)

*Private*