Class ClientBuilder

Constructors

constructor

new ClientBuilder(): ClientBuilder
Returns ClientBuilder

Properties

`Private` afterMiddleware

afterMiddleware: Middleware

`Private` authMiddleware

authMiddleware: Middleware

`Private` beforeMiddleware

beforeMiddleware: Middleware

`Private` correlationIdMiddleware

correlationIdMiddleware: Middleware

`Private` httpMiddleware

httpMiddleware: Middleware

`Private` loggerMiddleware

loggerMiddleware: Middleware

`Private` middlewares

middlewares: Middleware[] = []

`Private` projectKey

projectKey: string

`Private` queueMiddleware

queueMiddleware: Middleware

`Private` telemetryMiddleware

telemetryMiddleware: Middleware

`Private` userAgentMiddleware

userAgentMiddleware: Middleware

Methods

build

build(): Client
Returns Client
- Defined in client-builder/ClientBuilder.ts:230

defaultClient

defaultClient(baseUri, credentials, oauthUri?, projectKey?): ClientBuilder
Parameters
- baseUri: string
- credentials: Credentials
- Optional oauthUri: string
- Optional projectKey: string
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:55

withAfterExecutionMiddleware

withAfterExecutionMiddleware(options): ClientBuilder
Parameters
- options: AfterExecutionMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:224

withAnonymousSessionFlow

withAnonymousSessionFlow(options): ClientBuilder
Parameters
- options: AnonymousAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:120

withAuthMiddleware

withAuthMiddleware(authMiddleware): ClientBuilder
Parameters
- authMiddleware: Middleware
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:74

withBeforeExecutionMiddleware

withBeforeExecutionMiddleware(options): ClientBuilder
Parameters
- options: BeforeExecutionMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:218

withClientCredentialsFlow

withClientCredentialsFlow(options): ClientBuilder
Parameters
- options: AuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:84

withCorrelationIdMiddleware

withCorrelationIdMiddleware(options): ClientBuilder
Parameters
- options: CorrelationIdMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:196

withExistingTokenFlow

withExistingTokenFlow(authorization, options?): ClientBuilder
Parameters
- authorization: string
- Optional options: ExistingTokenMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:154

withHttpMiddleware

withHttpMiddleware(options): ClientBuilder
Parameters
- options: HttpMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:166

withLoggerMiddleware

withLoggerMiddleware(options?): ClientBuilder
Parameters
- Optional options: LoggerMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:188

withMiddleware

withMiddleware(middleware): ClientBuilder
Parameters
- middleware: Middleware
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:79

withPasswordFlow

withPasswordFlow(options): ClientBuilder
Parameters
- options: PasswordAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:101

withProjectKey

withProjectKey(key): ClientBuilder
Parameters
- key: string
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:50

withQueueMiddleware

withQueueMiddleware(options): ClientBuilder
Parameters
- options: QueueMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:180

withRefreshTokenFlow

withRefreshTokenFlow(options): ClientBuilder
Parameters
- options: RefreshAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:138

withTelemetryMiddleware

withTelemetryMiddleware<T>(options): ClientBuilder
Type Parameters
- T extends TelemetryOptions
Parameters
- options: T
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:206

withUserAgentMiddleware

withUserAgentMiddleware(options?): ClientBuilder
Parameters
- Optional options: HttpUserAgentOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:175