Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiOptions

Hierarchy

Index

Properties

Properties

Optional apiVersion

apiVersion?: string

Current API version. By default, the compatible with the current setup version will be chosen.

Optional apiVersionHeader

apiVersionHeader?: string

API version header. By default, Accept-Version will be used.

Optional authorizationHeader

authorizationHeader?: string

Authorization header. By default, Authorization will be used.

Optional authorizationToken

authorizationToken?: string

Authorization token. By default, the SDK will try to extract the token from the request query string using authorizationQueryParameter option.

httpClient

httpClient: HttpClient<PageModel>

HTTP client that will be used to fetch the page model.

Optional request

request?: HttpRequest

Current user's request.

Optional serverId

serverId?: string

Cluster node identifier. By default, the SDK will try to extract the value from the request query string using serverIdQueryParameter option.

Optional serverIdHeader

serverIdHeader?: string

Header identifying the current cluster node. By default, Server-Id will be used.

Optional visitor

visitor?: Omit<Visitor, "new">

Current visitor. This parameter takes precedence over request.visitor.