StaticChaynsApi

Index

Constructors

• constructor

Properties

• addDataListener
• ready

Methods

• getCurrentPage
• getCustomFunction
• getDevice
• getEnvironment
• getLanguage
• getPages
• getParameters
• getSite
• getStyleSettings
• getUser

Constructors

constructor

• new StaticChaynsApi(values: any, functions: any): StaticChaynsApi

• Parameters

  • values: any

  • functions: any

  Returns StaticChaynsApi

Properties

addDataListener

addDataListener: (cb: DataChangeCallback) => () => void

Type declaration

• • (cb: DataChangeCallback): () => void

  • Parameters

    • cb: DataChangeCallback

    Returns () => void

    • • (): void

      • Returns void

ready

ready: Promise<void>

Methods

getCurrentPage

• getCurrentPage(): { id: number; identifier?: string | number; siteId: string }

• Returns { id: number; identifier?: string | number; siteId: string }

  • id: number

  • optionalidentifier?: string | number

  • siteId: string

getCustomFunction

• getCustomFunction(key: string): (...args: any[]) => Promise<any>

• Parameters

  • key: string

  Returns (...args: any[]) => Promise<any>

  • • (...args: any[]): Promise<any>

    • Parameters

      • rest...args: any[]

      Returns Promise<any>

getDevice

• getDevice(): ChaynsApiDevice

• Returns ChaynsApiDevice

getEnvironment

• getEnvironment(): { buildEnvironment: Environment; runtimeEnvironment: string | RuntimeEnviroment }

• Returns { buildEnvironment: Environment; runtimeEnvironment: string | RuntimeEnviroment }

  • buildEnvironment: Environment

  • runtimeEnvironment: string | RuntimeEnviroment

getLanguage

• getLanguage(): { active: Language; device: Language; site: Language; translation: null | Language; user: undefined | Language }

• Returns { active: Language; device: Language; site: Language; translation: null | Language; user: undefined | Language }

  • active: Language

  • device: Language

  • site: Language

  • translation: null | Language

  • user: undefined | Language

getPages

• getPages(): Page[]

• Returns Page[]

getParameters

• getParameters(): {}

• Returns {}

  • [key string | symbol]: string | string[]

getSite

• getSite(): ChaynsApiSite

• Returns ChaynsApiSite

getStyleSettings

• getStyleSettings(): undefined | ChaynsStyleSettings

• Returns undefined | ChaynsStyleSettings

getUser

• getUser(): undefined | ChaynsApiUser

• Returns undefined | ChaynsApiUser