Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.


 ClassPackageDescription
 AddBuddyRequest
com.smartfoxserver.v2.requests.buddylist Adds a new buddy to the current user's buddies list.
 AdminMessageRequest
com.smartfoxserver.v2.requests Sends an administrator message to a specific user or a group of users.
 AirUDPManager 
com.smartfoxserver.v2.bitswarm The AirUDPManager class allows clients executed in the Adobe AIR runtime to communicate with SmartFoxServer 2X using the UDP protocol.
 BanMode
com.smartfoxserver.v2.requests The BanMode class contains the costants describing the possible banning modalities for a BanUserRequest.
 BanUserRequest
com.smartfoxserver.v2.requests Banishes a user from the server.
 BaseEvent
com.smartfoxserver.v2.core This is the base class of all the events dispatched by the SmartFoxServer 2X ActionScript 3 API.
 BaseVariable
com.smartfoxserver.v2.entities.variables The BaseVariable object is the base class for all SmartFoxServer Variable entities on the client.
 BlockBuddyRequest
com.smartfoxserver.v2.requests.buddylist Blocks or unblocks a buddy in the current user's buddies list.
 BoolMatch
com.smartfoxserver.v2.entities.match The BoolMatch class is used in matching expressions to check boolean conditions.
 Buddy
com.smartfoxserver.v2.entities The Buddy interface defines all the methods and properties that an object representing a SmartFoxServer Buddy entity exposes.
 BuddyMessageRequest
com.smartfoxserver.v2.requests.buddylist Sends a message to a buddy in the current user's buddies list.
 BuddyVariable
com.smartfoxserver.v2.entities.variables The BuddyVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Buddy Variable exposes.
 ChangeRoomCapacityRequest
com.smartfoxserver.v2.requests Changes the maximum number of users and/or spectators who can join a Room.
 ChangeRoomNameRequest
com.smartfoxserver.v2.requests Changes the name of a Room.
 ChangeRoomPasswordStateRequest
com.smartfoxserver.v2.requests Changes the password of a Room.
 ClientDisconnectionReason
com.smartfoxserver.v2.util The ClientDisconnectionReason class contains the costants describing the possible reasons why a disconnection from the server occurred.
 ConfigData
com.smartfoxserver.v2.util The ConfigData class stores the client configuration data loaded from an external XML file or passed directly to the deputy connect method.
 ConnectionMode
com.smartfoxserver.v2.util The ConnectionMode class contains the costants defining the possible connection modes of the client with the server.
 CreateRoomRequest
com.smartfoxserver.v2.requests Creates a new Room in the current Zone.
 CreateSFSGameRequest
com.smartfoxserver.v2.requests.game Creates a new public or private game, including player matching criteria, invitations settings and more.
 DefaultPacketEncrypter
com.smartfoxserver.v2.core 
 ExtensionRequest
com.smartfoxserver.v2.requests Sends a command to the server-side Extension attached to the Zone or to a Room.
 FindRoomsRequest
com.smartfoxserver.v2.requests Retrieves a list of Rooms from the server which match the specified criteria.
 FindUsersRequest
com.smartfoxserver.v2.requests Retrieves a list of users from the server which match the specified criteria.
 GoOnlineRequest
com.smartfoxserver.v2.requests.buddylist Toggles the current user's online/offline state as buddy in other users' buddies lists.
 IBuddyManager
com.smartfoxserver.v2.entities.managers The IBuddyManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Buddy List system.
 IMatcher
com.smartfoxserver.v2.entities.match The IMatcher interface defines the properties that an object representing a condition to be used in a matching expression exposes.
 IMMOItem
com.smartfoxserver.v2.entities The IMMOItem interface defines all the methods and properties that an object representing a SmartFoxServer MMOItem entity exposes.
 IMMOItemVariable
com.smartfoxserver.v2.entities.variables The IMMOItemVariable interface defines all the public methods and properties that an object representing a SmartFoxServer MMOItem Variable exposes.
 InitBuddyListRequest
com.smartfoxserver.v2.requests.buddylist Initializes the Buddy List system on the current client.
 Invitation
com.smartfoxserver.v2.entities.invitation The Invitation interface defines all the methods and properties that an object representing an invitation entity exposes.
 InvitationReply
com.smartfoxserver.v2.entities.invitation The InvitationReply class contains the constants describing the possible replies to an invitation.
 InvitationReplyRequest
com.smartfoxserver.v2.requests.game Replies to an invitation received by the current user.
 InviteUsersRequest
com.smartfoxserver.v2.requests.game Sends a generic invitation to a list of users.
 IPacketEncrypter
com.smartfoxserver.v2.core 
 IRoomManager
com.smartfoxserver.v2.entities.managers The IRoomManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer Room entities.
 ISFSArray
com.smartfoxserver.v2.entities.data The ISFSArray interface defines all the public methods and properties of the SFSArray class used by SmartFoxServer in client-server data transfer.
 ISFSObject
com.smartfoxserver.v2.entities.data The ISFSObject interface defines all the public methods and properties of the SFSObject class used by SmartFoxServer in client-server data transfer.
 IUserManager
com.smartfoxserver.v2.entities.managers The IUserManager interface defines all the methods and properties exposed by the client-side manager of the SmartFoxServer User entities.
 JoinRoomInvitationRequest
com.smartfoxserver.v2.requests.game Sends an invitation to other users/players to join a specific Room.
 JoinRoomRequest
com.smartfoxserver.v2.requests Joins the current user in a Room.
 KickUserRequest
com.smartfoxserver.v2.requests Kicks a user out of the server.
 LeaveRoomRequest
com.smartfoxserver.v2.requests Leaves one of the Rooms joined by the current user.
 Logger
com.smartfoxserver.v2.logging The internal logger used by the SmartFoxServer 2X client API.
 LoggerEvent
com.smartfoxserver.v2.logging LoggerEvent is the class representing all the events dispatched by the SmartFoxServer 2X ActionScript 3 API internal logger.
 LogicOperator
com.smartfoxserver.v2.entities.match The LogicOperator class is used to concatenate two matching expressions using the AND or OR logical operator.
 LoginRequest
com.smartfoxserver.v2.requests Logs the current user in one of the server Zones.
 LogLevel
com.smartfoxserver.v2.logging The LogLevel class contains the costants describing the importance levels of logged messages.
 LogoutRequest
com.smartfoxserver.v2.requests Logs the user out of the current server Zone.
 MapLimits
com.smartfoxserver.v2.requests.mmo The MapLimits class is used to set the limits of the virtual environment represented by an MMORoom when creating it.
 MatchExpression
com.smartfoxserver.v2.entities.match The MatchExpression class represents a matching expression used to compare custom variables or predefined properties when searching for users or Rooms.
 MessageRecipientMode
com.smartfoxserver.v2.requests The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages.
 MMOItem
com.smartfoxserver.v2.entities An MMOItem represents an active non-player entity inside an MMORoom.
 MMOItemVariable
com.smartfoxserver.v2.entities.variables The MMOItemVariable object represents a SmartFoxServer MMOItem Variable entity on the client.
 MMORoom
com.smartfoxserver.v2.entities The MMORoom object represents a specialized type of Room entity on the client.
 MMORoomSettings
com.smartfoxserver.v2.requests.mmo The MMORoomSettings class is a container for the settings required to create an MMORoom using the CreateRoomRequest request.
 ModeratorMessageRequest
com.smartfoxserver.v2.requests Sends a moderator message to a specific user or a group of users.
 NumberMatch
com.smartfoxserver.v2.entities.match The NumberMatch class is used in matching expressions to check numeric conditions.
 ObjectMessageRequest
com.smartfoxserver.v2.requests Sends an object containing custom data to all users in a Room, or a subset of them.
 PasswordUtil
com.smartfoxserver.v2.util Helper class for logging in with a pre-hashed password.
 PlayerToSpectatorRequest
com.smartfoxserver.v2.requests Turns the current user from player to spectator in a Game Room.
 PrivateMessageRequest
com.smartfoxserver.v2.requests Sends a private chat message.
 PublicMessageRequest
com.smartfoxserver.v2.requests Sends a public chat message.
 QuickJoinGameRequest
com.smartfoxserver.v2.requests.game Quickly joins the current user in a public game.
 RemoveBuddyRequest
com.smartfoxserver.v2.requests.buddylist Removes a buddy from the current user's buddies list.
 ReservedBuddyVariables
com.smartfoxserver.v2.entities.variables The ReservedBuddyVariables class contains the constants describing the SmartFoxServer API reserved Buddy Variable names.
 ReservedRoomVariables
com.smartfoxserver.v2.entities.variables The ReservedRoomVariables class contains the constants describing the SmartFoxServer API reserved Room Variable names.
 Room
com.smartfoxserver.v2.entities The Room interface defines all the methods and properties that an object representing a SmartFoxServer Room entity exposes.
 RoomEvents
com.smartfoxserver.v2.requests The RoomEvents class contains a specific subset of the RoomSettings required to create a Room.
 RoomExtension
com.smartfoxserver.v2.requests The RoomExtension class contains a specific subset of the RoomSettings required to create a Room.
 RoomPermissions
com.smartfoxserver.v2.requests The RoomPermissions class contains a specific subset of the RoomSettings required to create a Room.
 RoomProperties
com.smartfoxserver.v2.entities.match The RoomProperties class contains the names of predefined properties that can be used in matching expressions to search/filter Rooms.
 RoomSettings
com.smartfoxserver.v2.requests The RoomSettings class is a container for the settings required to create a Room using the CreateRoomRequest request.
 RoomVariable
com.smartfoxserver.v2.entities.variables The RoomVariable interface defines all the public methods and properties that an object representing a SmartFoxServer Room Variable exposes.
 SetBuddyVariablesRequest
com.smartfoxserver.v2.requests.buddylist Sets one or more Buddy Variables for the current user.
 SetRoomVariablesRequest
com.smartfoxserver.v2.requests Sets one or more custom Room Variables in a Room.
 SetUserPositionRequest
com.smartfoxserver.v2.requests.mmo Updates the User position inside an MMORoom.
 SetUserVariablesRequest
com.smartfoxserver.v2.requests Sets one or more custom User Variables for the current user.
 SFSArray
com.smartfoxserver.v2.entities.data The SFSArray class is used by SmartFoxServer in client-server data transfer.
 SFSBuddy
com.smartfoxserver.v2.entities The SFSBuddy object represents a buddy in the current user's buddies list.
 SFSBuddyEvent
com.smartfoxserver.v2.core SFSBuddyEvent is the class representing all the events related to the Buddy List system dispatched by the SmartFoxServer 2X ActionScript 3 API.
 SFSBuddyManager
com.smartfoxserver.v2.entities.managers The SFSBuddyManager class is the entity in charge of managing the current user's Buddy List system.
 SFSBuddyVariable
com.smartfoxserver.v2.entities.variables The SFSBuddyVariable object represents a SmartFoxServer Buddy Variable entity on the client.
 SFSDataType
com.smartfoxserver.v2.entities.data The SFSDataType class contains the costants defining the data types supported by SFSObject and SFSArray classes.
 SFSErrorCodes
com.smartfoxserver.v2.util The SFSErrorCodes class provides a mean of translation between server error codes and their relative error messages.
 SFSEvent
com.smartfoxserver.v2.core SFSEvent is the class representing most of the events dispatched by the SmartFoxServer 2X ActionScript 3 API.
 SFSGameSettings
com.smartfoxserver.v2.requests.game The SFSGameSettings class is a container for the settings required to create a Game Room using the CreateSFSGameRequest request.
 SFSInvitation
com.smartfoxserver.v2.entities.invitation The SFSInvitation object contains all the informations about an invitation received by the current user.
 SFSObject
com.smartfoxserver.v2.entities.data The SFSObject class is used by SmartFoxServer in client-server data transfer.
 SFSRoom
com.smartfoxserver.v2.entities The SFSRoom object represents a SmartFoxServer Room entity on the client.
 SFSRoomManager
com.smartfoxserver.v2.entities.managers The SFSRoomManager class is the entity in charge of managing the client-side Rooms list.
 SFSRoomVariable
com.smartfoxserver.v2.entities.variables The SFSRoomVariable object represents a SmartFoxServer Room Variable entity on the client.
 SFSUser
com.smartfoxserver.v2.entities The SFSUser object represents a client logged in SmartFoxServer.
 SFSUserManager
com.smartfoxserver.v2.entities.managers The SFSUserManager class is the entity in charge of managing the local (client-side) users list.
 SFSUserVariable
com.smartfoxserver.v2.entities.variables The SFSUserVariable object represents a SmartFoxServer User Variable entity on the client.
 SmartFox
com.smartfoxserver.v2 SmartFox is the main class of the SmartFoxServer 2X API.
 SpectatorToPlayerRequest
com.smartfoxserver.v2.requests Turns the current user from spectator to player in a Game Room.
 StringMatch
com.smartfoxserver.v2.entities.match The StringMatch class is used in matching expressions to check string conditions.
 SubscribeRoomGroupRequest
com.smartfoxserver.v2.requests Subscribes the current user to Room-related events occurring in the specified Group.
 UnsubscribeRoomGroupRequest
com.smartfoxserver.v2.requests Unsubscribes the current user to Room-related events occurring in the specified Group.
 User
com.smartfoxserver.v2.entities The User interface defines all the methods and properties that an object representing a SmartFoxServer User entity exposes.
 UserPrivileges
com.smartfoxserver.v2.entities The UserPrivileges class contains the costants describing the default user types known by SmartFoxServer.
 UserProperties
com.smartfoxserver.v2.entities.match The UserProperties class contains the names of predefined properties that can be used in matching expressions to search/filter users.
 UserVariable
com.smartfoxserver.v2.entities.variables The UserVariable interface defines all the public methods and properties that an object representing a SmartFoxServer User Variable exposes.
 Variable
com.smartfoxserver.v2.entities.variables The Variable interface defines all the default public methods and properties that an object representing a SmartFoxServer Room/User/Buddy Variable exposes.
 VariableType
com.smartfoxserver.v2.entities.variables The VariableType class contains the constants defining the valid types of User, Room and Buddy Variables to be passed to their constructors.
 Vec3D
com.smartfoxserver.v2.entities.data The Vec3D object represents a position in a 2D or 3D space.