Reference
The Reference section is the source of truth for every public class, configuration value, and HTTP endpoint. Pages are deliberately terse: signature, parameters, return value, one short example. For the why of each concept and full how-to recipes, read the linked Concepts and Development pages.
Reference is per-SDK #
Orchesty supports more than one SDK and we expect the list to grow. Instead of forcing a single page to juggle multiple languages, each SDK has its own subtree mirroring its actual class structure. A small mapping table below makes it easy to find the equivalent class in the other SDK.
Subsections #
- Node.js: the
@orchesty/nodejs-sdkpackage (source on GitHub). - PHP: the
orchesty/php-sdkpackage and Symfony bundle (source on GitHub). - Platform: environment variables, the worker REST API, and error codes shared by all SDKs.
Concept-to-class index #
Use this table to find the class implementing a given concept in your SDK of choice.
| Concept | Node.js | PHP |
|---|---|---|
| Application (root abstract) | AApplication | ApplicationAbstract |
| Application (no auth / API key) | ABasicApplication | BasicApplicationAbstract |
| Application (OAuth1) | not supported | OAuth1ApplicationAbstract |
| Application (OAuth2) | AOAuth2Application | OAuth2ApplicationAbstract |
| Connector | AConnector / ACommonConnector | ConnectorAbstract |
| Custom node | extension of ACommonNode | CommonNodeAbstract |
| Batch node | ABatchNode | BatchAbstract |
| Per-message context | ProcessDto | ProcessDto |
| Per-message context (batch) | BatchProcessDto | BatchProcessDto |
| Outbound HTTP request | RequestDto | (folded into ConnectorAbstract) |
| Application install (configured instance) | ApplicationInstall | ApplicationInstall |
| Settings forms | FormStack / Form / Field | FormStack / Form / Field |
| Field type enum | FieldType | Field::TYPE_* constants |
| Reserved form keys | CoreFormsEnum | (constants in Form) |
| Dependency container | DIContainer | Symfony bundle |
Page conventions #
Every per-class page follows the same skeleton: intro, class signature, public API methods (each with parameters, return value, and one short inline example), inheritance, and a "See also" footer that points back into Concepts and Development.