Class Camunda8

A single point of configuration for all Camunda Platform 8 clients.

This class is a facade for all the clients in the Camunda Platform 8 SDK.

Example

import { Camunda8 } from '@camunda8/sdk'

const c8 = new Camunda8()
const zeebe = c8.getZeebeGrpcApiClient()
const operate = c8.getOperateApiClient()
const optimize = c8.getOptimizeApiClient()
const tasklist = c8.getTasklistApiClient()
const modeler = c8.getModelerApiClient()
const admin = c8.getAdminApiClient()
const c8Rest = c8.getCamundaRestClient()

Constructors

constructor

new Camunda8(config?): Camunda8
All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself.
Parameters
- config: Camunda8ClientConfiguration = {}
Returns Camunda8
- Defined in src/c8/index.ts:53

Properties

`Private` `Optional` adminApiClient

adminApiClient?: AdminApiClient

`Private` `Optional` camundaRestClient

camundaRestClient?: CamundaRestClient

`Private` configuration

configuration: CamundaPlatform8Configuration

log

log: Logger

`Private` `Optional` modelerApiClient

modelerApiClient?: ModelerApiClient

`Private` oAuthProvider

oAuthProvider: IOAuthProvider

`Private` `Optional` operateApiClient

operateApiClient?: OperateApiClient

`Private` `Optional` optimizeApiClient

optimizeApiClient?: OptimizeApiClient

`Private` `Optional` tasklistApiClient

tasklistApiClient?: TasklistApiClient

`Private` `Optional` zeebeGrpcApiClient

zeebeGrpcApiClient?: ZeebeGrpcClient

`Private` `Optional` zeebeRestClient

zeebeRestClient?: ZeebeRestClient

Methods

getAdminApiClient

getAdminApiClient(config?): AdminApiClient
Parameters
- config: Camunda8ClientConfiguration = {}
Returns AdminApiClient
- Defined in src/c8/index.ts:72

getZeebeGrpcApiClient

getZeebeGrpcApiClient(config?): ZeebeGrpcClient
Parameters
- config: Camunda8ClientConfiguration = {}
Returns ZeebeGrpcClient
- Defined in src/c8/index.ts:120

getZeebeRestClient

getZeebeRestClient(config?): ZeebeRestClient
Parameters
- config: Camunda8ClientConfiguration = {}
Returns ZeebeRestClient
Deprecated
from 8.6.0. Please use getCamundaRestClient() instead.
- Defined in src/c8/index.ts:135

Class Camunda8

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Camunda8

Properties

Private Optional adminApiClient

Private Optional camundaRestClient

Private configuration

log

Private Optional modelerApiClient

Private oAuthProvider

Private Optional operateApiClient

Private Optional optimizeApiClient

Private Optional tasklistApiClient

Private Optional zeebeGrpcApiClient

Private Optional zeebeRestClient

Methods

getAdminApiClient

Parameters

Returns AdminApiClient

getCamundaRestClient

Parameters

Returns CamundaRestClient

getModelerApiClient

Parameters

Returns ModelerApiClient

getOperateApiClient

Parameters

Returns OperateApiClient

getOptimizeApiClient

Parameters

Returns OptimizeApiClient

getTasklistApiClient

Parameters

Returns TasklistApiClient

getZeebeGrpcApiClient

Parameters

Returns ZeebeGrpcClient

getZeebeRestClient

Parameters

Returns ZeebeRestClient

Deprecated

Settings

Member Visibility

Theme

On This Page

`Private` `Optional` adminApiClient

`Private` `Optional` camundaRestClient

`Private` configuration

`Private` `Optional` modelerApiClient

`Private` oAuthProvider

`Private` `Optional` operateApiClient

`Private` `Optional` optimizeApiClient

`Private` `Optional` tasklistApiClient

`Private` `Optional` zeebeGrpcApiClient

`Private` `Optional` zeebeRestClient