SiteResponse | WebHare Platform SDK

Class SiteResponse<T>

Deprecated

WH6.0 will drop this in favor of pageBuilder:

Type Parameters

T extends object = object

Index

Constructors

Properties

contents pageConfig settings siteRequest

Methods

appendHTML finish getSupportedLanguages insertAt setFrontendData

Constructors

constructor

new SiteResponse<T extends object = object>(
    pageConfig: T,
    siteRequest: SiteRequest,
    settings: SiteResponseSettings,
): SiteResponse<T>
Type Parameters
- T extends object = object
Parameters
- pageConfig: T
- siteRequest: SiteRequest
- settings: SiteResponseSettings
Returns SiteResponse<T>
- Defined in jssdk/router/src/sitereponse.ts:55

Properties

`Protected`contents

contents: string = ""

pageConfig

pageConfig: T

The pageConfig. Not protected because we assume that if you know it's type T, its on you if you access it

settings

settings: SiteResponseSettings

siteRequest

siteRequest: SiteRequest

Methods

appendHTML

appendHTML(text: string): void
Append the specified text
Parameters
- text: string
Returns void
- Defined in jssdk/router/src/sitereponse.ts:63

finish

finish(): Promise<WebResponse>
Returns Promise<WebResponse>
- Defined in jssdk/router/src/sitereponse.ts:87

getSupportedLanguages

getSupportedLanguages(): Record<string, boolean>
Returns Record<string, boolean>
- Defined in jssdk/router/src/sitereponse.ts:72

insertAt

insertAt(where: InsertPoints, what: Insertable): void
Insert a callback for use during rendering
Parameters
- where: InsertPoints
- what: Insertable
Returns void
- Defined in jssdk/router/src/sitereponse.ts:77

setFrontendData

setFrontendData<Type extends keyof FrontendDataTypes>(
dataObject: Type,
data: FrontendDataTypes[Type],
): void
Set data associated with a plugin
Type Parameters
- Type extends keyof FrontendDataTypes
Parameters
- dataObject: Type
- data: FrontendDataTypes[Type]
Returns void
- Defined in jssdk/router/src/sitereponse.ts:68