SmartFoxServer Silverlight API
SmartFoxClientAPI Namespace
Namespaces ► SmartFoxClientAPI
Main API interface classes
Declaration Syntax

C# | Visual Basic | Visual C++

    namespace SmartFoxClientAPI

    Namespace SmartFoxClientAPI

    namespace SmartFoxClientAPI

Types

All Types | Classes | Delegates

Icon | Type | Description
--- | --- | ---
| SFSEvent..::.OnAdminMessageDelegate | Dispatched when a message from the Administrator is received. Admin messages are special messages that can be sent by an Administrator to a user or group of users.
| SFSEvent..::.OnBuddyListDelegate | Dispatched when the buddy list for the current user is received or a buddy is added/removed.
| SFSEvent..::.OnBuddyListErrorDelegate | Dispatched when an error occurs while loading the buddy list.
| SFSEvent..::.OnBuddyListUpdateDelegate | Dispatched when the status or variables of a buddy in the buddy list change.
| SFSEvent..::.OnBuddyPermissionRequestDelegate | Dispatched when the current user receives a request to be added to the buddy list of another user.
| SFSEvent..::.OnBuddyRoomDelegate | Dispatched in response to a GetBuddyRoom(Buddy) request.
| SFSEvent..::.OnConfigLoadFailureDelegate | Dispatched when an error occurs while loading the external SmartFoxClient configuration file.
| SFSEvent..::.OnConfigLoadSuccessDelegate | Dispatched when the external SmartFoxClient configuration file has been loaded successfully. This event is dispatched only if the autoConnect parameter of the LoadConfig(String, Boolean) method is set to true otherwise the connection is made and the SFSEvent..::.OnConnectionDelegate event fired.
| SFSEvent..::.OnConnectionDelegate | Dispatched in response to the Connect(String, Int32) request. The connection to SmartFoxServer may have succeeded or failed: the success parameter must be checked.
| SFSEvent..::.OnConnectionLostDelegate | Dispatched when the connection with SmartFoxServer is closed (either from the client or from the server).
| SFSEvent..::.OnCreateRoomErrorDelegate | Dispatched when an error occurs during the creation of a room. Usually this happens when a client tries to create a room but its name is already taken.
| SFSEvent..::.OnDebugMessageDelegate | Dispatched when a debug message is traced by the SmartFoxServer API. In order to receive this event you have to previously set the debug flag to true.
| SFSEvent..::.OnExtensionResponseDelegate | Dispatched when a command/response from a server-side extension is received.
| SFSEvent..::.OnJoinRoomDelegate | Dispatched when a room is joined successfully.
| SFSEvent..::.OnJoinRoomErrorDelegate | Dispatched when an error occurs while joining a room. This error could happen, for example, if the user is trying to join a room which is currently full.
| SFSEvent..::.OnLoginDelegate | Dispatched when the login to a SmartFoxServer zone has been attempted.
| SFSEvent..::.OnLogoutDelegate | Dispatched when the user logs out successfully. After a successful logout the user is still connected to the server, but he/she has to login again into a zone, in order to be able to interact with the server.
| SFSEvent..::.OnModeratorMessageDelegate | Dispatched when a message from a Moderator is received.
| SFSEvent..::.OnObjectReceivedDelegate | Dispatched when an SFSObject is received.
| SFSEvent..::.OnPlayerSwitchedDelegate | Dispatched in response to the SwitchPlayer(Int32) request. The request to turn a player into a spectator may fail if another user did the same before your request, and there was only one spectator slot available.
| SFSEvent..::.OnPrivateMessageDelegate | Dispatched when a private chat message is received.
| SFSEvent..::.OnPublicMessageDelegate | Dispatched when a public chat message is received.
| SFSEvent..::.OnRandomKeyDelegate | Dispatched in response to a GetRandomKey()()() request.
| SFSEvent..::.OnRoomAddedDelegate | Dispatched when a new room is created in the zone where the user is currently logged in.
| SFSEvent..::.OnRoomDeletedDelegate | Dispatched when a room is removed from the zone where the user is currently logged in.
| SFSEvent..::.OnRoomLeftDelegate | Dispatched when a room is left in multi-room mode, in response of a LeaveRoom(Int32) request.
| SFSEvent..::.OnRoomListUpdateDelegate | Dispatched when the list of rooms available in the current zone is received. If the default login mechanism provided by SmartFoxServer is used, then this event is dispatched right after a successful login. This is because the SmartFoxServer API, internally, call the GetRoomList()()() method after a successful login is performed. If a custom login handler is implemented, the room list must be manually requested to the server by calling the mentioned method.
| SFSEvent..::.OnRoomVariablesUpdateDelegate | Dispatched when Room Variables are updated. A user receives this notification only from the room(s) where he/she is currently logged in. Also, only the variables that changed are transmitted.
| SFSEvent..::.OnRoundTripResponseDelegate | Dispatched when a response to the RoundTripBench()()() request is received. The "roundtrip time" represents the number of milliseconds that it takes to a message to go from the client to the server and back to the client. A good way to measure the network lag is to send continuos requests (every 3 or 5 seconds) and then calculate the average roundtrip time on a fixed number of responses (i.e. the last 10 measurements).
| SFSEvent..::.OnSpectatorSwitchedDelegate | Dispatched in response to the SwitchSpectator(Int32) request. The request to turn a spectator into a player may fail if another user did the same before your request, and there was only one player slot available.
| SFSEvent..::.OnUserCountChangeDelegate | Dispatched when the number of users and/or spectators changes in a room within the current zone. This event allows to keep track in realtime of the status of all the zone rooms in terms of users and spectators. In case many rooms are used and the zone handles a medium to high traffic, this notification can be turned off to reduce bandwidth consumption, since a message is broadcasted to all users in the zone each time a user enters or exits a room.
| SFSEvent..::.OnUserEnterRoomDelegate | Dispatched when another user joins the current room.
| SFSEvent..::.OnUserLeaveRoomDelegate | Dispatched when a user leaves the current room. This event is also dispatched when a user gets disconnected from the server.
| SFSEvent..::.OnUserVariablesUpdateDelegate | Dispatched when a user in the current room updates his/her User Variables.
| SFSEvent | SFSEvent is the class representing all events dispatched by the SmartFoxClient instance. The SFSEvent class uses delegates to callback on specific event types.
| SmartFoxClient | SmartFoxServer Silverlight client API SmartFoxClient is the main class in the SmartFoxServer API. This class is responsible for connecting to the server and handling all related events.