SmartFox

Reference to the Buddy Manager.

The Buddy Manager is used internally by the SmartFoxServer Client API; the reference returned by this property gives access to the Buddy List, allowing interaction with SFSBuddy and SFSBuddyVariable objects and access to User properties in the Buddy List System.

Client configuration settings.

The object properties are set to their default values when the SmartFox class is instantiated.

HTTP/S URI that can be used to upload files to SmartFoxServer, using a regular HTTP POST request.

Uploads must be enabled on the server side for the specific Zone. The value of this property is null if the client is not yet logged in.

Indicates whether the client is currently connected to the server.

The value is false until a successful connection is established, or a disconnection occurred.

SFSRoom object representing the last Room joined by the client, if any.

This property is null if no Room was joined yet, or all joined Rooms have been left.

Reference to the internal logger used by the SmartFoxServer Client API.

SFSUser object representing the client when connected to a SmartFoxServer instance.

This object is generated upon successful login only, so it is null if login was not performed yet or client logged out.

Reference to the Room Manager.

The Room Manager is used internally by the SmartFoxServer Client API; the reference returned by this property gives access to the Room List and Groups, allowing interaction with SFSRoom objects.

Unique session token of the client.

The session token is a string sent by the server to the client after the initial handshake, so it is null until handshake is complete. It is required as a mean of identification when uploading files to the server.

Reference to the User Manager.

The User Manager is used internally by the SmartFoxServer Client API; the reference returned by this property gives access to the User List, allowing interaction with SFSUser objects.

Version string of the SmartFoxServer C# Client API.

Adds a listener for a given API event type that will be used for callbacks.

function init()
{
	sfs = new SmartFox();

	// Add SFSEvent listeners
	sfs.addEventListener(SFSEvent.CONNECTION, onConnection, this);
	sfs.addEventListener(SFSEvent.CONNECTION_LOST, onConnectionLost, this);
	sfs.addEventListener(SFSEvent.LOGIN_ERROR, onLoginError, this);
	sfs.addEventListener(SFSEvent.LOGIN, onLogin, this);
	sfs.addEventListener(SFSEvent.LOGOUT, onLogout, this);
	sfs.addEventListener(SFSEvent.ROOM_JOIN_ERROR, onRoomJoinError, this);
	sfs.addEventListener(SFSEvent.ROOM_JOIN, onRoomJoin, this);
}

Establishes a connection between the client and a SmartFoxServer instance using the passed configuration object, if any.

The client communicates with the SmartFoxServer instance through a WebSocket connection.

It is possible to configure che connection without passing the cfg parameter: just set the properties on the default configuration object throught the SmartFox#config getter.

Closes the connection between the client and the SmartFoxServer instance.

Activates the automatic realtime monitoring of the lag between client and server (round robin).

When the lag monitor is activated, the SFSEvent.PING_PONG event type is then dispatched continuously. The event provides the average value of the last ten measured lag values, and the minimum and maximum lag avalues for the current lag monitoring session. The lag monitoring can be enabled after a successful login only and it is automatically halted when the client logs out of a Zone or gets disconnected.

Returns a list of SFSRoom objects representing the Rooms currently joined by the client.

The same list is returned by the SFSRoomManager#getJoinedRooms method, accessible through the SmartFox#roomManager getter; this is replicated on this class for handy access due to its usually frequent usage.

Simulates an abrupt disconnection from the server.

This method should be used for testing and simulations only, otherwise use the SmartFox#disconnect method.

Removes all event listeners.

Removes a listener for a given API event.

Sends a request to the server.

sfs.send(new LoginRequest("KermitTheFrog", "kermitPwd", "TheMuppetZone"));

sfs.send(new JoinRoomRequest("Lobby"));

const params = new SFSObject();
params.putInt("x", 10);
params.putInt("y", 37);

sfs.send(new ExtensionRequest("setPosition", params));

Allows to set custom client details used to gather statistics about the client platform in the Analytics module of the SmartFoxServer Administration Tool.

This method must be called before the connection is started. The length of the two strings combined must be less than 512 characters.

If not set, the default value of the underlying property is the generic JavaScript. Version is not specified in this case.