Table of Content

SmartFoxClientAPI Namespace

SFSEvent Constructor (type, parameters)

GetParameter Method (key)

onAdminMessage Field

onBuddyList Field

onBuddyListError Field

onBuddyListUpdate Field

onBuddyPermissionRequest Field

onBuddyRoom Field

onConfigLoadFailure Field

onConfigLoadSuccess Field

onConnection Field

onConnectionLost Field

onCreateRoomError Field

onDebugMessage Field

onExtensionResponse Field

onJoinRoom Field

onJoinRoomError Field

onModeratorMessage Field

onObjectReceived Field

onPlayerSwitched Field

onPrivateMessage Field

onPublicMessage Field

onRandomKey Field

onRoomAdded Field

onRoomDeleted Field

onRoomLeft Field

onRoomListUpdate Field

onRoomVariablesUpdate Field

onRoundTripResponse Field

onSpectatorSwitched Field

onUserCountChange Field

onUserEnterRoom Field

onUserLeaveRoom Field

onUserVariablesUpdate Field

SFSEvent.OnAdminMessageDelegate Delegate

SFSEvent.OnBuddyListDelegate Delegate

SFSEvent.OnBuddyListErrorDelegate Delegate

SFSEvent.OnBuddyListUpdateDelegate Delegate

SFSEvent.OnBuddyPermissionRequestDelegate Delegate

SFSEvent.OnBuddyRoomDelegate Delegate

SFSEvent.OnConfigLoadFailureDelegate Delegate

SFSEvent.OnConfigLoadSuccessDelegate Delegate

SFSEvent.OnConnectionDelegate Delegate

SFSEvent.OnConnectionLostDelegate Delegate

SFSEvent.OnCreateRoomErrorDelegate Delegate

SFSEvent.OnDebugMessageDelegate Delegate

SFSEvent.OnExtensionResponseDelegate Delegate

SFSEvent.OnJoinRoomDelegate Delegate

SFSEvent.OnJoinRoomErrorDelegate Delegate

SFSEvent.OnLoginDelegate Delegate

SFSEvent.OnLogoutDelegate Delegate

SFSEvent.OnModeratorMessageDelegate Delegate

SFSEvent.OnObjectReceivedDelegate Delegate

SFSEvent.OnPlayerSwitchedDelegate Delegate

SFSEvent.OnPrivateMessageDelegate Delegate

SFSEvent.OnPublicMessageDelegate Delegate

SFSEvent.OnRandomKeyDelegate Delegate

SFSEvent.OnRoomAddedDelegate Delegate

SFSEvent.OnRoomDeletedDelegate Delegate

SFSEvent.OnRoomLeftDelegate Delegate

SFSEvent.OnRoomListUpdateDelegate Delegate

SFSEvent.OnRoomVariablesUpdateDelegate Delegate

SFSEvent.OnRoundTripResponseDelegate Delegate

SFSEvent.OnSpectatorSwitchedDelegate Delegate

SFSEvent.OnUserCountChangeDelegate Delegate

SFSEvent.OnUserEnterRoomDelegate Delegate

SFSEvent.OnUserLeaveRoomDelegate Delegate

SFSEvent.OnUserVariablesUpdateDelegate Delegate

SmartFoxClient Class

SmartFoxClient Constructor

SmartFoxClient Constructor

SmartFoxClient Constructor (debug)

activeRoomId Field

AddBuddy Method (buddyName)

amIModerator Field

AutoJoin Method

blueBoxIpAddress Field

blueBoxPort Field

buddyList Field

changingRoom Field

ClearBuddyList Method

Connect Method (ipAdr)

Connect Method (ipAdr, port)

CONNECTION_MODE_DISCONNECTED Field

CONNECTION_MODE_HTTP Field

CONNECTION_MODE_SOCKET Field

CreateRoom Method

CreateRoom Method (roomObj)

CreateRoom Method (roomObj, roomId)

defaultZone Field

Disconnect Method

Dispose Method (disposing)

Finalize Method

GetActiveRoom Method

GetAllRooms Method

GetBuddyById Method (id)

GetBuddyByName Method (buddyName)

GetBuddyRoom Method (buddy)

GetConnectionMode Method

GetHttpPollSpeed Method

GetQueuePollSpeed Method

GetRandomKey Method

GetRawProtocolSeparator Method

GetRoom Method (roomId)

GetRoomByName Method (roomName)

GetRoomList Method

GetUploadPath Method

GetVersion Method

ipAddress Field

IsConnected Method

JoinRoom Method

JoinRoom Method (newRoom)

JoinRoom Method (newRoom, pword)

JoinRoom Method (newRoom, pword, isSpectator)

JoinRoom Method (newRoom, pword, isSpectator, dontLeave)

JoinRoom Method (newRoom, pword, isSpectator, dontLeave, oldRoom)

LeaveRoom Method (roomId)

LoadBuddyList Method

LoadConfig Method

LoadConfig Method

LoadConfig Method (configFile)

LoadConfig Method (configFile, autoConnect)

Login Method (zone, name, pass)

MODMSG_TO_ROOM Field

MODMSG_TO_USER Field

MODMSG_TO_ZONE Field

myBuddyVars Field

myUserName Field

RemoveBuddy Method (buddyName)

RoundTripBench Method

SendBuddyPermissionResponse Method (allowBuddy, targetBuddy)

SendModeratorMessage Method

SendModeratorMessage Method (message, type)

SendModeratorMessage Method (message, type, id)

SendObject Method

SendObject Method (obj)

SendObject Method (obj, roomId)

SendObjectToGroup Method

SendObjectToGroup Method (obj, userList)

SendObjectToGroup Method (obj, userList, roomId)

SendPrivateMessage Method

SendPrivateMessage Method (message, recipientId)

SendPrivateMessage Method (message, recipientId, roomId)

SendPublicMessage Method

SendPublicMessage Method (message)

SendPublicMessage Method (message, roomId)

SendXtMessage Method

SendXtMessage Method (xtName, cmd, paramObj)

SendXtMessage Method (xtName, cmd, paramObj, type)

SendXtMessage Method (xtName, cmd, paramObj, type, roomId)

SetBuddyBlockStatus Method (buddyName, status)

SetBuddyVariables Method (varList)

SetHttpPollSpeed Method (sp)

SetIsConnected Method (b)

SetQueuePollSpeed Method (sp)

SetRawProtocolSeparator Method (value)

SetRoomVariables Method

SetRoomVariables Method (varList)

SetRoomVariables Method (varList, roomId)

SetRoomVariables Method (varList, roomId, setOwnership)

SetUserVariables Method

SetUserVariables Method (varObj)

SetUserVariables Method (varObj, roomId)

smartConnect Field

SwitchPlayer Method

SwitchPlayer Method

SwitchPlayer Method (roomId)

SwitchSpectator Method

SwitchSpectator Method

SwitchSpectator Method (roomId)

UploadFile Method

UploadFile Method (filePath)

UploadFile Method (filePath, id)

UploadFile Method (filePath, id, nick)

UploadFile Method (filePath, id, nick, port)

XTMSG_TYPE_JSON Field

XTMSG_TYPE_STR Field

XTMSG_TYPE_XML Field

SmartFoxClientAPI.Data Namespace

Buddy Constructor

Buddy Constructor (id, name, isOnline, isBlocked)

Buddy Constructor (id, name, isOnline, isBlocked, variables)

GetVariable Method (key)

GetVariables Method

IsBlocked Method

IsOnline Method

SetBlocked Method (status)

SetVariable Method (key, value)

SetVariables Method (variables)

NewRoomDescriptor Class

NewRoomDescriptor Constructor

NewRoomDescriptor Constructor (name, maxUsers)

NewRoomDescriptor Constructor (name, maxUsers, isGame)

NewRoomDescriptor Constructor (name, maxUsers, isGame, maxSpectators, variables, extension)

NewRoomDescriptor Constructor (name, maxUsers, isGame, maxSpectators, variables, extension, password, exitCurrentRoom, receiveUCount)

ExitCurrentRoom Property

Extension Property

IsGame Property

MaxSpectators Property

MaxUsers Property

Password Property

ReceiveUCount Property

Variables Property

NewRoomDescriptor.ExtensionDescriptor Class

NewRoomDescriptor.ExtensionDescriptor Constructor (name, script)

Script Property

Room Constructor

Room Constructor (id, name, maxUsers, maxSpectators, isTemp, isGame, isPrivate, isLimbo)

Room Constructor (id, name, maxUsers, maxSpectators, isTemp, isGame, isPrivate, isLimbo, userCount)

Room Constructor (id, name, maxUsers, maxSpectators, isTemp, isGame, isPrivate, isLimbo, userCount, specCount)

AddUser Method (u, id)

ClearUserList Method

ClearVariables Method

GetMaxSpectators Method

GetMaxUsers Method

GetMyPlayerIndex Method

GetSpectatorCount Method

GetUser Method (userId)

GetUserCount Method

GetUserList Method

GetVariable Method (varName)

GetVariables Method

IsPrivate Method

RemoveUser Method (id)

SetIsLimbo Method (b)

SetMyPlayerIndex Method (id)

SetSpectatorCount Method (n)

SetUserCount Method (n)

SetVariables Method (vars)

RoomVariable Class

RoomVariable Constructor

RoomVariable Constructor (name, value)

RoomVariable Constructor (name, value, isPrivate)

RoomVariable Constructor (name, value, isPrivate, isPersistent)

GetValue Method

IsPersistent Method

IsPrivate Method

SFSObject Class

SFSObject Constructor

Get Method (key)

GetBool Method (key)

GetNumber Method (key)

GetObj Method (key)

GetObj Method (key)

GetString Method (key)

Put Method (key, value)

PutBool Method (key, value)

PutDictionary Method (key, collection)

PutList Method (key, collection)

PutNumber Method (key, value)

Remove Method (key)

User Constructor (id, name)

GetPlayerId Method

GetVariable Method (varName)

GetVariables Method

IsModerator Method

IsSpectator Method

SetIsSpectator Method (b)

SetModerator Method (b)

SetPlayerId Method (pid)

SetVariables Method (o)

Zone Constructor (name)

GetRoom Method (id)

GetRoomByName Method (name)