Difference between revisions of "Layer One API"
From Virtual World Web Wiki
(Documentation for the Layer One API class) |
(Documentation for the Layer One API class) |
||
| Line 31: | Line 31: | ||
: | : | ||
:An interface to the system-specific implementation of the Layer One Managers. | :An interface to the system-specific implementation of the Layer One Managers. | ||
| − | :Each system ([[Admin Web]], [[Service Provider]], [[Instance Host]]) provides its own implementation of the Layer One API which build on a set of base classes shared by all systems and which implemnt the Layer One API interfaces. | + | :Each system ([[Admin Web]], [[Service Provider]], [[Instance Host]], [[Web View]]) provides its own implementation of the [[Layer One API]] which build on a set of base classes shared by all systems and which implemnt the Layer One API interfaces. |
:Instances of these implmentations are created via a local implementation of the ManagerFactory class which is passed to the static [[LayerOne]] helper instance on startuup. | :Instances of these implmentations are created via a local implementation of the ManagerFactory class which is passed to the static [[LayerOne]] helper instance on startuup. | ||
:In practise, components access Layer One through the LayerOne helper class | :In practise, components access Layer One through the LayerOne helper class | ||
Revision as of 14:14, 16 October 2016
Contents
Layer One API
IChatSystem
- See Also: IChatSystem
- The chat system is a primary layer one interface. It provides methods for managing chat channels, and sending chat messages.
IComponentSystem
- See Also: IComponentSystem
- The component system is a primary layer one interface. It contains many useful utility methods for managing the component's lifetime, communicating with other components, communicating with root, and using the server transfer package system.
IEntitySystem
- See Also: IEntitySystem
- The entity system is a primary layer one interface. There are methods here for creating, managing and getting information about all kinds of Entities
IFinancialSystem
- See Also: IFinancialSystem
- The financial system is a primary layer one interface. It provides methods for working with currencies and transactions.
IInventorySystem
- See Also: IInventorySystem
- The inventory system is a primary layer one interface. It provides methods for working with runtime inventory.
- See also: IObjectSystem
IManagerFactory
- See Also: IManagerFactory
- An interface to the system-specific implementation of the Layer One Managers.
- Each system (Admin Web, Service Provider, Instance Host, Web View) provides its own implementation of the Layer One API which build on a set of base classes shared by all systems and which implemnt the Layer One API interfaces.
- Instances of these implmentations are created via a local implementation of the ManagerFactory class which is passed to the static LayerOne helper instance on startuup.
- In practise, components access Layer One through the LayerOne helper class
IObjectSystem
- See Also: IObjectSystem
- The object system is a primary layer one interface. It provides methods for working with Object Types, Object Templates and Containers.
IPermissionSystem
- See Also: IPermissionSystem
- The object system is a primary layer one interface. It provides methods for working with system permssions.
IResourceSystem
- See Also: IResourceSystem
- The object system is a primary layer one interface. It provides methods for managing resources and their metadata.
ISettingsSystem
- See Also: ISettingsSystem
- The settings system is a primary layer one interface. It provides methods for getting and setting component settings as well as registering admin configurable settings and some helpful system properties.
ITranslationSystem
- See Also: ITranslationSystem
- The translation system is a primary layer one interface. It provides methods for managing translation group subscriptions and local translation groups.
IUIScriptSystem
- See Also: IUIScriptSystem
- The UI script system is a primary layer one interface. It provides methods for working with UI scripts, sending them to clients, finding their instances, and releasing them.
IViewSystem
- See Also: IViewSystem
- The view system is a primary layer one interface. It provides methods for working with DOM Views (server hosted DOM documents)
IWorldspaceSystem
- See Also: IWorldspaceSystem
- The worldspace system is a primary layer one interface. It provides methods for working with Worldspace, Layouts and EditLayouts, and area groups
LayerOne
- See Also: LayerOne
- This is the main entry point to the server
- The LayerOne static class is initialized by the system when it starts up and provides the gateway to the layer one API. The API surface is split up into chunks to keep it logically separated.
- See also: Server API
- See also: IManagerFactory
