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

#include <UserVariable.h>

Inheritance diagram for Sfs2X::Entities::Variables::UserVariable:

Public Member Functions
virtual bool	IsPrivate ()=0
	Indicates whether this User Variable is private or not. More...

virtual void	IsPrivate (bool value)=0
	Indicates whether this User Variable is private or not. More...

Public Member Functions inherited from Sfs2X::Entities::Variables::Variable
virtual boost::shared_ptr< string >	Name ()=0
	Indicates the name of this variable. More...

virtual VariableType	Type ()=0
	Indicates the type of this variable. More...

virtual boost::shared_ptr< void >	Value ()=0
	Returns the untyped value of this variable. More...

virtual boost::shared_ptr< bool >	GetBoolValue ()=0
	Retrieves the value of a boolean variable. More...

virtual boost::shared_ptr< long int >	GetIntValue ()=0
	Retrieves the value of an integer variable. More...

virtual boost::shared_ptr< double >	GetDoubleValue ()=0
	Retrieves the value of a double precision variable. More...

virtual boost::shared_ptr< string >	GetStringValue ()=0
	Retrieves the value of a string variable. More...

virtual boost::shared_ptr< ISFSObject >	GetSFSObjectValue ()=0
	Retrieves the value of a SFSObject variable. More...

virtual boost::shared_ptr< ISFSArray >	GetSFSArrayValue ()=0
	Retrieves the value of a SFSArray variable. More...

virtual bool	IsNull ()=0
	Indicates if the variable is `null`. More...

virtual boost::shared_ptr< ISFSArray >	ToSFSArray ()=0
	<exclude>

Detailed Description

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: Variable

Member Function Documentation

◆ IsPrivate() [1/2]

virtual bool Sfs2X::Entities::Variables::UserVariable::IsPrivate ( )

pure virtual

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

Implemented in Sfs2X::Entities::Variables::SFSUserVariable.

◆ IsPrivate() [2/2]

virtual void Sfs2X::Entities::Variables::UserVariable::IsPrivate ( bool value )