Classes
| Class | Description | |
|---|---|---|
| AddBuddyRequest |
Add a new Buddy to the current Buddy List
| |
| AdminMessageRequest |
Send a Admin Message to a specific User or groups of Users
| |
| BanUserRequest |
Banish a User from the system (for moderators and admins only)
| |
| BaseRequest | ||
| BlockBuddyRequest |
Block/Unblock a Buddy in the User's BuddyList
| |
| BuddyMessageRequest |
BuddyMessage(s) are similar to private chat messages but are specifically designed for the Buddy List system.
| |
| ChangeRoomCapacityRequest |
Change the capacity of a Room (maxUsers and maxSpectators) at runtime.
| |
| ChangeRoomNameRequest |
Change the name of a Room at runtime.
| |
| ChangeRoomPasswordStateRequest |
Changes the password of a Room at runtime.
| |
| CreateRoomRequest |
Creates a new Room in the current Zone
| |
| ExtensionRequest |
Sends a request to a Zone or Room Extension.
| |
| FindRoomsRequest |
Search Rooms in the system by matching their variables and properties against a MatchExpression
| |
| FindUsersRequest |
Search Users in the system by matching their variables and properties against a MatchExpression
| |
| GenericMessageRequest | ||
| GoOnlineRequest |
Toggles the Buddy ONLINE status of the User.
| |
| HandshakeRequest |
This request is used by the API sub-system at connection time. It's not intended for other uses.
| |
| InitBuddyListRequest |
Initializes the BuddyList system.
| |
| JoinRoomRequest |
Join the current User in a Room.
| |
| KickUserRequest |
Kicks a User out of the server (for moderators and admins only)
| |
| LeaveRoomRequest |
Leaves a currently joined Room
| |
| LoginRequest |
Join one of the Zones in the Server.
| |
| LogoutRequest |
Log out of the current Zone
| |
| ManualDisconnectionRequest |
This is used by the system. Never send this directly.
| |
| MessageRecipientMode |
This class is used to specify the recipient mode for Moderator Messages and Administrator Message.
| |
| ModeratorMessageRequest |
Send a Moderator Message to a specific User or groups of Users
| |
| ObjectMessageRequest |
Send a custom data Object to all users in a Room or a sub-selection of them
| |
| PingPongRequest |
Sends a ping-pong request in order to measure the current lag
| |
| PlayerToSpectatorRequest |
Attempt to turn the current User from Player to a Spectator (in a Game Room)
| |
| PrivateMessageRequest |
Send a chat Private Message to another User
| |
| PublicMessageRequest |
Sends a chat Public Message to other users in the Room
| |
| RemoveBuddyRequest |
Remove a new Buddy fron the current Buddy List
| |
| RoomEvents |
This class provides Room event settings that can be specified when creating a new Room via the CreateRoomRequest | |
| RoomExtension |
This object is part of the RoomSettings parameters used for creating a new Room.
| |
| RoomPermissions |
This object is part of the RoomSettings parameters used for creating a new Room.
| |
| RoomSettings |
This class provides the Room settings that you can pass to a CreateRoomRequest | |
| SetBuddyVariablesRequest |
Sets one or more BuddyVariables for the current User. This will update all Users in the Zona who have this User as Buddy in their Buddy Lists.
| |
| SetRoomVariablesRequest |
Set custom Room Variables in a Room
| |
| SetUserVariablesRequest |
Set custom User Variables for the current User
| |
| SpectatorToPlayerRequest |
Attempt to turn the current User from Spectator into a Player (in a Game Room)
| |
| SubscribeRoomGroupRequest |
Subscribe to the events of a Room Group
| |
| UnsubscribeRoomGroupRequest |
Stop listening to events of a specific Room Group
|
Interfaces
| Interface | Description | |
|---|---|---|
| IRequest |
Enumerations
| Enumeration | Description | |
|---|---|---|
| BanMode |
The class contains constants to specify the banishmen modality for a BanUserRequest
| |
| MessageRecipientType |