RoomVariable

All Superinterfaces:: Cloneable, UserVariable, Variable

All Known Implementing Classes:: SFSRoomVariable

public interface RoomVariable extends UserVariable

Method Summary

Modifier and Type

Method

Description

User

getOwner()

Return the User that created the variable.

boolean

isGlobal()

Checks if a RoomVariable is global.

boolean

isPersistent()

Checks if a RoomVariable is persistent

void

setGlobal(boolean flag)

When a RoomVariable is set to global all changes will be broadcast not only to the Users in the Room but also to all other Users in the same Room Group

void

setOwner(User user)

Sets the creator of a variable.

void

setPersistent(boolean flag)

When a RoomVariable is set to persistent the variable will not be removed from a Room when the user leaves it.

Methods inherited from interface com.smartfoxserver.entities.variables.UserVariable
isHidden, isPrivate, isStorable, setHidden, setNull, setPrivate, setStorable

Methods inherited from interface com.smartfoxserver.entities.variables.Variable
getBoolValue, getByteValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getName, getSFSArrayValue, getSFSObjectValue, getShortValue, getStringValue, getType, getValue, getVector2Value, getVector3Value, isNull, toSFSArray

Method Details
- isPersistent
  
  boolean isPersistent()
  
  Checks if a RoomVariable is persistent
  Returns:
  
  true if the variable is persistent
  
  See Also:
  
  setPersistent(boolean)
- isGlobal
  
  boolean isGlobal()
  
  Checks if a RoomVariable is global. Global RV are visible outside of the Room and available to all Users subscribed to its Room Group
  Returns:
  
  true if the variable is global
  
  See Also:
  
  setGlobal(boolean)
- setPersistent
  
  void setPersistent(boolean flag)
  
  When a RoomVariable is set to persistent the variable will not be removed from a Room when the user leaves it. RoomVariables created by a certain User are removed when the User disconnects
  
  Parameters:
  
  flag -
- setGlobal
  
  void setGlobal(boolean flag)
  
  When a RoomVariable is set to global all changes will be broadcast not only to the Users in the Room but also to all other Users in the same Room Group
  
  Parameters:
  
  flag -
- getOwner
  
  User getOwner()
  
  Return the User that created the variable. Null is returned if the variable is owned by the Server
  
  Returns:
  
  the variable owner
- setOwner
  
  void setOwner(User user)
  
  Sets the creator of a variable. Null can be used to set the Server as the owner. When a variable is owned by the Server it will never be removed.
  
  Parameters:
  
  user -