Sfs2X.Requests Namespace |
Classes| Class | Description | |
|---|---|---|
  | AdminMessageRequest |
Sends an administrator message to a specific user or a group of users.
|
| BanUserRequest |
Banishes a user from the server.
|
| ChangeRoomCapacityRequest |
Changes the maximum number of users and/or spectators who can join a Room.
|
| ChangeRoomNameRequest |
Changes the name of a Room.
|
| ChangeRoomPasswordStateRequest |
Changes the password of a Room.
|
| CreateRoomRequest |
Creates a new Room in the current Zone.
|
| ExtensionRequest |
Sends a command to the server-side Extension attached to the Zone or to a Room.
|
| FindRoomsRequest |
Retrieves a list of Rooms from the server which match the specified criteria.
|
| FindUsersRequest |
Retrieves a list of users from the server which match the specified criteria.
|
| JoinRoomRequest |
Joins the current user in a Room.
|
| KickUserRequest |
Kicks a user out of the server.
|
| LeaveRoomRequest |
Leaves one of the Rooms joined by the current user.
|
| LoginRequest |
Logs the current user in one of the server Zones.
|
| LogoutRequest |
Logs the user out of the current server Zone.
|
| MessageRecipientMode |
The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages.
|
| ModeratorMessageRequest |
Sends a moderator message to a specific user or a group of users.
|
| ObjectMessageRequest |
Sends an object containing custom data to all users in a Room, or a subset of them.
|
| PlayerToSpectatorRequest |
Turns the current user from player to spectator in a Game Room.
|
| PrivateMessageRequest |
Sends a private chat message.
|
| PublicMessageRequest |
Sends a public chat message.
|
| QuickJoinOrCreateRoomRequest |
Quickly joins the current user in a public Room, or creates a new Room if none is found.
|
| RoomEvents |
The RoomEvents class contains a specific subset of the RoomSettings required to create a Room.
|
| RoomExtension |
The RoomExtension class contains a specific subset of the RoomSettings required to create a Room.
|
| RoomPermissions |
The RoomPermissions class contains a specific subset of the RoomSettings required to create a Room.
|
| RoomSettings |
The RoomSettings class is a container for the settings required to create a Room.
|
| SetRoomVariablesRequest |
Sets one or more custom Room Variables in a Room.
|
| SetUserVariablesRequest |
Sets one or more custom User Variables for the current user.
|
| SpectatorToPlayerRequest |
Turns the current user from spectator to player in a Game Room.
|
| SubscribeRoomGroupRequest |
Subscribes the current user to Room-related events occurring in the specified Group.
|
| UnsubscribeRoomGroupRequest |
Unsubscribes the current user to Room-related events occurring in the specified Group.
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | BanMode |
The BanMode enumeration contains the costants describing the possible banning modalities for a BanUserRequest.
|
| MessageRecipientType |
The possible message recipient modes for ModeratorMessageRequest and AdminMessageRequest requests.
|