SmartFox

Example

function init()
{
	// Create configuration object
	var config = {};
	config.host = "127.0.0.1";
	config.port = 8080;
	config.useSSL = false;
	config.zone = "BasicExamples";
	config.debug = false;

	// Create SmartFox client instance
	sfs = new SFS2X.SmartFox(config);
}

Parameter

buddyManager  SFSBuddyManager

Returns a reference to the Buddy Manager.

This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property gives access to the buddies list, allowing interaction with Buddy and BuddyVariable objects and access to user properties in the Buddy List system.

config  object

Returns the client configuration object passed during the SmartFox instance creation.

debug  boolean

Indicates whether the client-server messages console debug is enabled or not.

If set to true, detailed debugging informations for all the incoming and outgoing messages are provided in the browser's debug console (if available). Debugging can be enabled when instantiating the SmartFox class too by means of the configuration object.

isConnected  boolean

Indicates whether the client is connected to the server or not.

console.log("Am I connected? " + sfs.isConnected);

lastJoinedRoom  SFSRoom

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

This property is null if no Room was joined.

See also

SmartFox#getJoinedRooms

JoinRoomRequest

logger  Logger

Returns a reference to the internal Logger instance used by SmartFoxServer 2X.

maxMessageSize  number

Returns the maximum size of messages allowed by the server.

Any request exceeding this size will not be sent. The value is determined by the server configuration.

mySelf  SFSUser

Returns the SFSUser object representing the client itself when connected to a SmartFoxServer 2X instance.

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

NOTE: setting the mySelf property manually can disrupt the API functioning.

See also

SFSUser#isItMe

LoginRequest

nodeId  string

[CLUSTER] The identifier of the cluster node which the current SmartFox instance is connected to.

If the SmartFox instance is not connected to a cluster node, this property is null.

roomManager  SFSRoomManager

Returns a reference to the Room Manager.

This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property gives access to the Rooms list and Groups, allowing interaction with SFSRoom objects.

sessionToken  string

Returns the unique session token of the client.

The session token is a string sent by the server to the client after the initial handshake.
It is required as mean of identification when uploading files to the server (see specific documentation).

userManager  SFSUserManager

Returns a reference to the User Manager.

This manager is used internally by the SmartFoxServer 2X API; the reference returned by this property gives access to the users list, allowing interaction with SFSUser objects.

version  string

Returns the current version of the SmartFoxServer 2X JavaScript API.

addEventListener(evtType, callback, scope)

Registers an event listener function that will receive notification of an event.

If you no longer need an event listener, remove it by calling the removeEventListener() method, or memory issues could arise. In fact event listeners are not automatically removed from memory.

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

	// Add LoggerEvent listeners
	sfs.logger.addEventListener(SFS2X.LoggerEvent.DEBUG, onDebugMessage, this);
	sfs.logger.addEventListener(SFS2X.LoggerEvent.INFO, onInfoMessage, this);
	sfs.logger.addEventListener(SFS2X.LoggerEvent.WARNING, onWarningMessage, this);
	sfs.logger.addEventListener(SFS2X.LoggerEvent.ERROR, onErrorMessage, this);

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

Inherited from

EventDispatcher#addEventListener

See also

SFSEvent

SFSBuddyEvent

LoggerEvent

SmartFox#removeEventListener

connect([host][, port][, useSSL])

Establishes a connection between the client and a SmartFoxServer 2X instance.

If one or more arguments are missing, the client will use the corresponding settings passed during the SmartFox class instantiation.

function someMethod()
{
	sfs = new SFS2X.SmartFox();
	sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this);

	// Connect
	sfs.connect(127.0.0.1, 8080);
}

function onConnection(evtParams)
{
	if (evtParams.success)
		console.log("Connection established");
	else
		console.log("Connection failed");
}

See also

SmartFox#disconnect

SFSEvent.CONNECTION

disconnect()

Closes the connection between the client and the SmartFoxServer 2X instance.

See also

SmartFox#connect

SFSEvent.CONNECTION_LOST

enableLagMonitor(enabled[, interval][, queueSize])

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

When turned on, the pingPong event type is dispatched continuously, providing the average of the last ten measured lag values. The lag monitoring is automatically halted when the user logs out of a Zone or gets disconnected.

NOTE: the lag monitoring can be enabled after the login has been completed successfully only.

See also

SFSEvent.PING_PONG

getJoinedRooms() → Array of SFSRoom

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

NOTE: the same list is returned by the SFSRoomManager.getJoinedRooms() method, accessible through the roomManager property; this was replicated on the SmartFox class for handy access due to its usually frequent usage.

See also

SmartFox#lastJoinedRoom

SmartFox#roomManager

SFSRoom

JoinRoomRequest

Returns

Array of SFSRoom The list of SFSRoom objects representing the Rooms joined by the client.

getRoomById(id) → SFSRoom

Retrieves a SFSRoom object from its id.

NOTE: the same object is returned by the SFSRoomManager.getRoomById() method, accessible through the roomManager property; this was replicated on the SmartFox class for handy access due to its usually frequent usage.

var roomId = 3;
var room = sfs.getRoomById(roomId);
console.log("The name of Room " + roomId + " is " + room.name);

See also

SmartFox#getRoomByName

SFSRoomManager#getRoomById

SFSRoom

Returns

SFSRoom The object representing the requested Room; undefined if no SFSRoom object with the passed id exists in the Rooms list.

getRoomByName(name) → SFSRoom

Retrieves a SFSRoom object from its name.

NOTE: the same object is returned by the SFSRoomManager.getRoomByName() method, accessible through the roomManager property; this was replicated on the SmartFox class for handy access due to its usually frequent usage.

var roomName = "The Lobby";
var room = sfs.getRoomByName(roomName);
console.log("The ID of Room '" + roomName + "' is " + room.id);

See also

SmartFox#getRoomById

SFSRoomManager#getRoomByName

SFSRoom

Returns

SFSRoom The object representing the requested Room; undefined if no SFSRoom object with the passed name exists in the Rooms list.

getRoomList() → Array of SFSRoom

Returns the list of SFSRoom objects representing the Rooms currently "watched" by the client.

The list contains all the Rooms that are currently joined and all the Rooms belonging to the Room Groups that have been subscribed by the client.

NOTE 1: at login time, the client automatically subscribes all the Room Groups specified in the Zone's Default Room Groups setting.

NOTE 2: the same list is returned by the SFSRoomManager.getRoomList() method, accessible through the roomManager property; this was replicated on the SmartFox class for handy access due to its usually frequent usage.

See also

SmartFox#roomManager

JoinRoomRequest

SubscribeRoomGroupRequest

UnsubscribeRoomGroupRequest

Returns

Array of SFSRoom The list of SFSRoom objects representing the Rooms available on the client.

getRoomListFromGroup(groupId) → Array of SFSRoom

Retrieves the list of Rooms which are part of the specified Room Group.

NOTE: the same list is returned by the SFSRoomManager.getRoomListFromGroup() method, accessible through the roomManager property; this was replicated on the SmartFox class for handy access due to its usually frequent usage.

See also

SFSRoomManager#getRoomListFromGroup

SFSRoom

Returns

Array of SFSRoom The list of SFSRoom objects belonging to the passed Group.

killConnection()

Simulates an abrupt disconnection from the server.

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

See also

SmartFox#disconnect

SFSEvent.CONNECTION_LOST

removeEventListener(evtType, callback)

Removes an event listener.

Inherited from

EventDispatcher#removeEventListener

See also

SFSEvent

SFSBuddyEvent

SmartFox#addEventListener

send(request)

Sends a request to the server.

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

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

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

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

setClientDetails(platformId, version)

Allows to specify custom client details that will be used to gather statistics about the client platform via the AdminTool's Analytics Module.

By default no details are sent and the client type is the generic "JavaScript".

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