|
Kanda Foundation 0.8.0
|
Classes | |
| class | CheckInPostRequest |
| Request to "check in" this device to Kanda Cloud. More... | |
| class | CheckInResponse |
| Response after checking in. More... | |
| class | CloudApiPage |
| Cloud responses for queries containing several items are paginated. This models the page serialization format and implements tools for easily getting subsequent pages. More... | |
| struct | CloudApiResponse |
| A wrapper for Cloud responses reducing the amount of boilerplate required to evaluate whether a request was successful and providing feedback when a request fails. More... | |
| class | CreateRoomContainerRequest |
| Request model for creating new Room Containers. More... | |
| class | CreateRoomInstanceRequest |
| Request model used when creating new Room Instances. More... | |
| class | CreateScenarioRequest |
| Request model for creating a new Scenario. More... | |
| interface | IResponseWithTags |
| Response models such as RoomContainerResponse and ScenarioResponse that contain tags can implement this interface to allow for more polymorphic handling of tags when dealing with objects fetched from the cloud API. Instead of. More... | |
| class | JoinRoomServerRequest |
| Request model used when joining a Room Server. More... | |
| class | LeaveRoomServerRequest |
| Request model used when leaving a server. More... | |
| class | LogoutRequest |
| Request model for logging out a user. More... | |
| class | RoomContainerBase |
| Room Containers represent a grouping of Room Instances. This represents a "Session" in the broader sense which may bundle one or more separate rooms. More... | |
| class | RoomContainerResponse |
| Response model when getting, creating or modifying Room Containers. More... | |
| class | RoomInstanceBase |
| Room Instances represent an individual room that can be joined. One room will typically be associated with one server running the session. More... | |
| class | RoomInstanceResponse |
| The response model when getting or modifying Room Instances. More... | |
| class | RoomServerHostingContext |
| This data is injected to dedicated servers when allocated by Kanda Cloud, assigning them credentials that allows for temporarily call cloud endpoints to update room server data. More... | |
| class | RoomServerResponse |
| Response model when joining, leaving or modifying Room Servers. More... | |
| class | ScenarioBase |
| Scenarios determine the content to be loaded for a given room instance. More... | |
| class | ScenarioResponse |
| Response model when getting or creating Scenarios. More... | |
| class | ScenarioVersion |
| Scenarios can be versioned, with different content for each version. More... | |
| class | TenantResponse |
| Response model for Tenants. These represent an organisation in Kanda Cloud and data is typically segregated by Tenant. More... | |
| class | UnityGameServerConfiguration |
| Used to let the joining app decide which server configuration to use when hosting with Unity Multiplay. More... | |
| class | UpdateRoomInstanceRequest |
| Request model used when modifying existing Room Instances. More... | |
| class | UpdateRoomServerRequest |
| Sent by room servers to update information about the currently running server instance. More... | |
| class | UpdateUserProfileRequest |
| Request model for updating User Profile. More... | |
| class | UserProfileBase |
| User Profiles contain information about the currently logged in user. More... | |
| class | UserProfileResponse |
| Response model for User Profiles. More... | |
Enumerations | |
| enum | RoomServerStatus { Unknown = 0 , Offline , Queued , Starting , Running , Stopping , Error } |
| Represents the current status of a Room Server. This is relevant when starting new servers, where we may wait for queueing, allocation and startup of the dedicated server. More... | |
| enum | HostType { ServerHosted } |
| Used to denote the desired hosting mode when joining a session. More... | |
| enum | ScenarioType { Unknown = 0 , BuiltInScenario = 1 } |
| Denotes the type of scenario for a given version. These have been renamed internally, but still match legacy naming in their JSON representation. More... | |
| enum | TargetPlatform { Unknown = 0 , OculusQuest = 1 , WindowsStandalone = 2 , MacStandalone = 3 , AppleVisionPro = 4 } |
| Denotes a target platform which can be supported on a Scenario Version. | |
| enum | UserRole { Unknown = 0 , Trainee = 1000 , Instructor = 1500 , Administrator = 2000 , SharedDataEditor = 2500 } |
| The role of the user in the current Tenant. | |
| enum HostType |
| enum RoomServerStatus |
Represents the current status of a Room Server. This is relevant when starting new servers, where we may wait for queueing, allocation and startup of the dedicated server.
| enum ScenarioType |