SFSUserVariable Class |
The SFSUserVariable object represents a SmartFoxServer User Variable entity on the client.
Inheritance HierarchyNamespace: Sfs2X.Entities.Variables
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class SFSUserVariable : BaseVariable, UserVariable, Variable
The SFSUserVariable type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SFSUserVariable(String, Object) | |
| SFSUserVariable(String, Object, Int32) |
Creates a new SFSUserVariable instance.
|
Properties| Name | Description | |
|---|---|---|
 | IsPrivate |
Indicates whether this User Variable is private or not.
|
| Name |
Indicates the name of this variable.
(Inherited from BaseVariable.) |
| Type |
Indicates the type of this variable.
(Inherited from BaseVariable.) |
| Value |
Returns the untyped value of this variable.
(Inherited from BaseVariable.) |
Methods| Name | Description | |
|---|---|---|
| GetBoolValue |
Retrieves the value of a boolean variable.
(Inherited from BaseVariable.) |
| GetDoubleValue |
Retrieves the value of a double precision variable.
(Inherited from BaseVariable.) |
| GetIntValue |
Retrieves the value of an integer variable.
(Inherited from BaseVariable.) |
| GetSFSArrayValue |
Retrieves the value of a SFSArray variable.
(Inherited from BaseVariable.) |
| GetSFSObjectValue |
Retrieves the value of a SFSObject variable.
(Inherited from BaseVariable.) |
| GetStringValue |
Retrieves the value of a string variable.
(Inherited from BaseVariable.) |
| IsNull |
Indicates if the variable is null.
(Inherited from BaseVariable.) |
 | newPrivateVariable |
Creates a new private User Variable.
|
| ToString |
Returns a string that contains the User Variable name, type, value and IsPrivate flag.
(Overrides ObjectToString.) |
Remarks
This is a custom value attached to a User object that gets automatically synchronized between client and server on every change.
User Variables are particularly useful to store custom user data that must be "visible" to the other users, such as a profile, a score, a status message, etc.
User Variables can be set by means of the SetUserVariablesRequest request; they support the data types listed in the class (also nested). A User Variable can also be null.
User Variables can be 'private' (starting from SFS2X v2.12 with client API v1.7): this flag allows to limit the visibility of variables to their owner only.
In other words User Variables marked as private are not sent to other users, even if located in the same Room.
See Also