AApplication
Abstract base class for any Application. Subclass this (or one of its descendants such as ABasicApplication / AOAuth2Application) to expose a third-party service to your topologies.
import AApplication from '@orchesty/nodejs-sdk/dist/lib/Application/Base/AApplication';
Inheritance #
AApplication -> ABasicApplication | AOAuth2Application
Methods you implement #
| Method | Returns | Purpose |
|---|---|---|
getName() | string | Stable internal identifier, lowercase kebab/snake. |
getPublicName() | string | Display name in the Admin UI. |
getDescription() | string | Short description shown in the Admin UI. |
getFormStack() | FormStack | Settings + authorization form definitions. |
getRequestDto(dto, install, method, url?, data?) | RequestDto | Build an outbound HTTP request with auth attached. |
Methods provided #
| Method | Returns | Purpose |
|---|---|---|
getApplicationType() | ApplicationTypeEnum | The flavour reported to the platform. |
isAuthorized(install) | boolean | Default check: required auth fields present. |
getApplicationForm(install) | object | Resolves the form, pre-filled with the install. |
Example #
See the worked example in Development: Basic Application.