SFSBuddyVariable Class |
The SFSBuddyVariable object represents a SmartFoxServer Buddy 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 SFSBuddyVariable : BaseVariable, BuddyVariable, Variable
The SFSBuddyVariable type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SFSBuddyVariable(String, Object) | |
| SFSBuddyVariable(String, Object, Int32) |
Creates a new SFSBuddyVariable instance.
|
Properties| Name | Description | |
|---|---|---|
 | IsOffline |
Indicates whether the Buddy Variable is persistent 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.) |
| ToString |
Returns a string that contains the Buddy Variable name, type and value.
(Overrides ObjectToString.) |
Fields| Name | Description | |
|---|---|---|
  | OFFLINE_PREFIX |
The prefix to be added to a Buddy Variable name to make it persistent.
|
Remarks
The Buddy Variable is a custom value attached to a Buddy object in a Buddy List that gets automatically synchronized between client and server on every change.
Buddy Variables work with the same principle of the User and Room Variables. The only difference is the logic by which they get propagated to other users.
While Room and User Variables are usually broadcast to all clients in the same Room, Buddy Variables updates are sent to all users who have the owner of the Buddy Variable in their Buddy Lists.
Buddy Variables are particularly useful to store custom user data that must be "visible" to the buddies only, such as a profile, a score, a status message, etc.
Buddy Variables can be set by means of the SetBuddyVariablesRequest request; they support the data types listed in the class (also nested). A Buddy Variable can also be null.
There is also a special convention that allows Buddy Variables to be set as "offline". Offline Buddy Variables are persistent values which are made available to all users
who have the owner in their Buddy Lists, whether that Buddy is online or not. In order to make a Buddy Variable persistent, its name should start with a dollar sign ($).
This conventional character is contained in the OFFLINE_PREFIX constant.
See Also