Options
All
  • Public
  • Public/Protected
  • All
Menu

Configuration of the SPA SDK using the JWT token-based setup and the Page Model API v0.9.

Hierarchy

Index

Properties

NBRMode?: boolean

The NBRMode parameter used to indicate whether the children of the BrPage component should be rendered immediatly or wait with rendering until the Page model has been retrieved and parsed. By default, the option is false.

apiBaseUrl?: string

Base URL to fetch the page model from. The default URL is cmsBaseUrl + /resourceapi.

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.

authorizationQueryParameter?: string

The query string parameter used to pass authorization header value. By default, token parameter is used.

authorizationToken?: string

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

cmsBaseUrl?: string

Base URL of the CMS.

debug?: boolean

The option enabling debug mode.

httpClient: HttpClient<PageModel>

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

origin?: string

The brXM origin to verify an integration with the Experience Manager. This option should be used when the brXM is accessible from a host other than the Page Model API. By default, the origin from the apiBaseUrl or endpoint parameters is used.

path?: string

The path part of the URL, including a query string if present. For example: '/path/to/page?foo=1'. The path always starts with '/'.

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.

serverIdQueryParameter?: string

The query string parameter used to pass a cluster node identifier. By default, server-id parameter is used.

spaBaseUrl?: string

Base URL of the SPA. Everything after it will be interpreted as a route into the page model. The default base url is an empty string.

visitor?: Omit<Visitor, "new">

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

window?: Window

The window reference for the CMS integration. By default the global window object will be used.