Classes

  ClassDescription
Public classAdminMessageRequest
Sends an administrator message to a specific user or a group of users.
Public classBanUserRequest
Banishes a user from the server.
Public classChangeRoomCapacityRequest
Changes the maximum number of users and/or spectators who can join a Room.
Public classChangeRoomNameRequest
Changes the name of a Room.
Public classChangeRoomPasswordStateRequest
Changes the password of a Room.
Public classCreateRoomRequest
Creates a new Room in the current Zone.
Public classExtensionRequest
Sends a command to the server-side Extension attached to the Zone or to a Room.
Public classFindRoomsRequest
Retrieves a list of Rooms from the server which match the specified criteria.
Public classFindUsersRequest
Retrieves a list of users from the server which match the specified criteria.
Public classJoinRoomRequest
Joins the current user in a Room.
Public classKickUserRequest
Kicks a user out of the server.
Public classLeaveRoomRequest
Leaves one of the Rooms joined by the current user.
Public classLoginRequest
Logs the current user in one of the server Zones.
Public classLogoutRequest
Logs the user out of the current server Zone.
Public classMessageRecipientMode
The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages.
Public classModeratorMessageRequest
Sends a moderator message to a specific user or a group of users.
Public classObjectMessageRequest
Sends an object containing custom data to all users in a Room, or a subset of them.
Public classPlayerToSpectatorRequest
Turns the current user from player to spectator in a Game Room.
Public classPrivateMessageRequest
Sends a private chat message.
Public classPublicMessageRequest
Sends a public chat message.
Public classRoomEvents
The RoomEvents class contains a specific subset of the RoomSettings required to create a Room.
Public classRoomExtension
The RoomExtension class contains a specific subset of the RoomSettings required to create a Room.
Public classRoomPermissions
The RoomPermissions class contains a specific subset of the RoomSettings required to create a Room.
Public classRoomSettings
The RoomSettings class is a container for the settings required to create a Room.
Public classSetRoomVariablesRequest
Sets one or more custom Room Variables in a Room.
Public classSetUserVariablesRequest
Sets one or more custom User Variables for the current user.
Public classSpectatorToPlayerRequest
Turns the current user from spectator to player in a Game Room.
Public classSubscribeRoomGroupRequest
Subscribes the current user to Room-related events occurring in the specified Group.
Public classUnsubscribeRoomGroupRequest
Unsubscribes the current user to Room-related events occurring in the specified Group.

Enumerations

  EnumerationDescription
Public enumerationBanMode
The BanMode enumeration contains the costants describing the possible banning modalities for a BanUserRequest.
Public enumerationMessageRecipientType
The possible message recipient modes for ModeratorMessageRequest and AdminMessageRequest requests.