Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

apiVersion?: string

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

apiVersionHeader?: string

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

authorizationHeader?: string

Authorization header. By default, Authorization will be used.

authorizationToken?: string

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

httpClient: HttpClient<PageModel>

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

refPrefix?: string

API query parameter that contains a string which is used to prefix $ref values. For example, if the value of this parameter is //, a reference to a component within the page model will look like $ref: '//u{$uuid}'. If the parameter is not set, the default prefix /page/ will be used or whichever default prefix is configured in the CMS.

request?: HttpRequest

Current user's request.

serverId?: string

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

serverIdHeader?: string

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

visitor?: Omit<Visitor, "new">

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