Difference between revisions of "IRemoteComponentSystem"
From Virtual World Web Wiki
(Documentation for the IRemoteComponentSystem class) |
(Documentation for the IRemoteComponentSystem class) |
||
| Line 5: | Line 5: | ||
===Methods=== | ===Methods=== | ||
| − | :{{CSharp|bool CreateComponent(Guid componentID | + | :{{CSharp|bool CreateComponent(Guid componentID, Byte[] fileCollection)}} |
:: | :: | ||
| − | :: | + | ::Writes the provided file collection to the components folder and triggers a scan for new provisional components which can then be managed from the admin. |
| + | |||
| + | :{{CSharp|bool DisableComponent(Guid componentID)}} | ||
| + | :: | ||
| + | ::Disables this component from loading for the next system restart, and stops if from processing messages immediately. | ||
| + | |||
| + | :{{CSharp|bool EnableComponent(Guid componentID)}} | ||
| + | :: | ||
| + | ::Enables a component to load at next system start. If the component is currently marked provisional, this flag will be removed. | ||
:{{CSharp|ComponentInfo GetComponentInfo(Guid componentID)}} | :{{CSharp|ComponentInfo GetComponentInfo(Guid componentID)}} | ||
| Line 21: | Line 29: | ||
::Tests if your connection to the API endpoint is working | ::Tests if your connection to the API endpoint is working | ||
| − | :{{CSharp|void UpdateComponent(Guid componentID, Byte[] fileCollection, int? minorVersion {{=}} NULL, int? buildNumber {{=}} NULL)}} | + | :{{CSharp|void SystemRestart()}} |
| + | :: | ||
| + | ::Requests a full system restart. | ||
| + | |||
| + | :{{CSharp|bool UpdateComponent(Guid componentID, Byte[] fileCollection, int? minorVersion {{=}} NULL, int? buildNumber {{=}} NULL)}} | ||
:: | :: | ||
::Updates a component's binary files | ::Updates a component's binary files | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ | ||
Revision as of 19:22, 5 February 2019
Exposes some of the functionality of IComponentSystem to outside applications with appropriate consumer credentials
Remarks [edit]
Methods
- bool CreateComponent(Guid componentID, Byte[] fileCollection)
- Writes the provided file collection to the components folder and triggers a scan for new provisional components which can then be managed from the admin.
- bool DisableComponent(Guid componentID)
- Disables this component from loading for the next system restart, and stops if from processing messages immediately.
- bool EnableComponent(Guid componentID)
- Enables a component to load at next system start. If the component is currently marked provisional, this flag will be removed.
- ComponentInfo GetComponentInfo(Guid componentID)
- Gets information about a single component
- ComponentInfo[] GetComponentInfos()
- Gets information about all installed components
- bool Ping()
- Tests if your connection to the API endpoint is working
- void SystemRestart()
- Requests a full system restart.
- bool UpdateComponent(Guid componentID, Byte[] fileCollection, int? minorVersion = NULL, int? buildNumber = NULL)
- Updates a component's binary files
