Skip to main content

chayns-api

Index

Classes

Enumerations

Event listener

Hooks

User functions

Functions

Interfaces

Namespaces

Type Aliases

Variables

Type Aliases

AccessToken

AccessToken: { external?: boolean }

Type declaration

  • optionalexternal?: boolean

AccessTokenResult

AccessTokenResult: { accessToken: string | undefined }

Type declaration

  • accessToken: string | undefined

AnonymousAccountResult

AnonymousAccountResult: { token: string }

Type declaration

  • token: string

ChaynsApiDevice

ChaynsApiDevice: { accessToken?: string; app?: { appVersion: number; callVersion: number; flavor: AppFlavor; name: AppName; storePackageName?: string; version: number }; browser?: { isWebPSupported: boolean; majorVersion: number; name?: IBrowser[name] | bot | null; version?: string | null }; engine?: IEngine; imei?: string; isTouch: boolean; os?: AIX | Amiga OS | Android OS | Arch | Bada | BeOS | BlackBerry | CentOS | Chromium OS | Contiki | Fedora | Firefox OS | FreeBSD | Debian | DragonFly | Gentoo | GNU | Haiku | Hurd | iOS | Joli | Linpus | Linux | Mac OS | Mageia | Mandriva | MeeGo | Minix | Mint | Morph OS | NetBSD | Nintendo | OpenBSD | OpenVMS | OS/2 | Palm | PCLinuxOS | Plan9 | Playstation | QNX | RedHat | RIM Tablet OS | RISC OS | Sailfish | Series40 | Slackware | Solaris | SUSE | Symbian | Tizen | Ubuntu | UNIX | VectorLinux | WebOS | Windows | Windows Phone | Windows Mobile | Zenwalk | null; osVersion?: string; screenSize: ScreenSize }

Type declaration

  • optionalaccessToken?: string
  • optionalapp?: { appVersion: number; callVersion: number; flavor: AppFlavor; name: AppName; storePackageName?: string; version: number }
    • appVersion: number

      the actual app version according to the app name

    • callVersion: number

      the version of the chayns call interface

    • flavor: AppFlavor

      the flavor of the app, e. g. all chayns apps including chat app, sidekick, team

    • name: AppName
    • optionalstorePackageName?: string
    • version: number
      @deprecated

      same value as callVersion

  • optionalbrowser?: { isWebPSupported: boolean; majorVersion: number; name?: IBrowser[name] | bot | null; version?: string | null }
    • isWebPSupported: boolean
    • majorVersion: number
    • optionalname?: IBrowser[name] | bot | null
    • optionalversion?: string | null
  • optionalengine?: IEngine
  • optionalimei?: string
  • isTouch: boolean
  • optionalos?: AIX | Amiga OS | Android OS | Arch | Bada | BeOS | BlackBerry | CentOS | Chromium OS | Contiki | Fedora | Firefox OS | FreeBSD | Debian | DragonFly | Gentoo | GNU | Haiku | Hurd | iOS | Joli | Linpus | Linux | Mac OS | Mageia | Mandriva | MeeGo | Minix | Mint | Morph OS | NetBSD | Nintendo | OpenBSD | OpenVMS | OS/2 | Palm | PCLinuxOS | Plan9 | Playstation | QNX | RedHat | RIM Tablet OS | RISC OS | Sailfish | Series40 | Slackware | Solaris | SUSE | Symbian | Tizen | Ubuntu | UNIX | VectorLinux | WebOS | Windows | Windows Phone | Windows Mobile | Zenwalk | null
  • optionalosVersion?: string
  • screenSize: ScreenSize

ChaynsApiSite

ChaynsApiSite: { color: string; colorMode: ColorMode; domain: string; dynamicFontSize: boolean; font: { dynamicFontSize: boolean; headlineFont: Font; id: Font }; icon: string; id: string; layoutDisposition: LayoutDisposition; locationId: number; locationPersonId: string; originSiteId?: string; title: string; url: string; urlHash: string }

Type declaration

  • color: string
  • colorMode: ColorMode
  • domain: string
  • dynamicFontSize: boolean
  • font: { dynamicFontSize: boolean; headlineFont: Font; id: Font }
    • dynamicFontSize: boolean
    • headlineFont: Font
    • id: Font
  • icon: string
  • id: string
  • layoutDisposition: LayoutDisposition
  • locationId: number
  • locationPersonId: string
  • optionaloriginSiteId?: string
  • title: string
  • url: string
  • urlHash: string

ChaynsApiUser

ChaynsApiUser: { firstName?: string; gender?: Gender; isAnonymous?: boolean; lastName?: string; nickName?: string; personId?: string; uacGroups?: UacGroup[]; userId?: number }

Type declaration

  • optionalfirstName?: string
  • optionalgender?: Gender
  • optionalisAnonymous?: boolean
  • optionallastName?: string
  • optionalnickName?: string
  • optionalpersonId?: string
  • optionaluacGroups?: UacGroup[]
  • optionaluserId?: number

ChaynsHistoryActionResult

ChaynsHistoryActionResult: { isOk: true } | { error?: unknown; isOk: false; reason: blocked | stale | destroyed | error }

ChaynsHistoryBlockOptions

ChaynsHistoryBlockOptions: { isBeforeUnload?: boolean; scope?: local | global }

Type declaration

  • optionalisBeforeUnload?: boolean
  • optionalscope?: local | global

ChaynsHistoryLayerEvent

ChaynsHistoryLayerEvent: { hash: string; layerId: string; params: Record<string, string>; segments: string[]; state: Record<string, unknown>; type: change | popstate }

Type declaration

  • hash: string
  • layerId: string
  • params: Record<string, string>
  • segments: string[]
  • state: Record<string, unknown>
  • type: change | popstate

ChaynsHistoryLayerStateNode

ChaynsHistoryLayerStateNode: { activeChild?: string; childState?: ChaynsHistoryLayerStateNode }

Type declaration

ChaynsHistoryNavigateOptions

ChaynsHistoryNavigateOptions: ChaynsHistoryNavigationCommitOptions & { hash?: string; params?: Record<string, string> }

ChaynsHistoryNavigationCommitOptions

ChaynsHistoryNavigationCommitOptions: { isReplace?: boolean }

Type declaration

  • optionalisReplace?: boolean

ChaynsProviderProps

ChaynsProviderProps: { chaynsApiId?: string; children?: ReactNode; customFunctions?: IChaynsReact[customFunctions]; data?: ChaynsReactValues; functions?: ChaynsReactFunctions; history?: { segmentCount?: number; url?: string }; historyLayer?: ChaynsHistoryLayer; isHistoryEnabled?: boolean; isModule?: boolean; renderedByServer?: boolean; segmentCount?: number }

Type declaration

  • optionalchaynsApiId?: string
  • optionalchildren?: ReactNode
  • optionalcustomFunctions?: IChaynsReact[customFunctions]
  • optionaldata?: ChaynsReactValues
  • optionalfunctions?: ChaynsReactFunctions
  • optionalhistory?: { segmentCount?: number; url?: string }

    Initial history configuration for the root layer. Ignored when layer is provided explicitly.

    • url: Current page URL — browser defaults to window.location.pathname; for SSR pass the request URL (e.g. req.url or router.asPath).
    • segmentCount: Number of URL path segments this application claims. E.g. segmentCount: 2 on /shop/products/detail → getLayer().getRoute() → ['shop', 'products'].
    • optionalsegmentCount?: number
    • optionalurl?: string
  • optionalhistoryLayer?: ChaynsHistoryLayer

    Explicit history layer to provide to the React subtree. When set this layer is used directly and no root layer is auto-initialised. Use this when the parent already owns a layer and wants to scope children to it.

  • optionalisHistoryEnabled?: boolean

    When true, enables the history layer for this provider. Defaults to false for safety in federated module scenarios.

  • optionalisModule?: boolean
  • optionalrenderedByServer?: boolean
  • optionalsegmentCount?: number

ChaynsReactCustomFunctions

ChaynsReactCustomFunctions: {}

Type declaration

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

ChaynsStyleSettings

ChaynsStyleSettings: { designSettings: ChaynsDesignSettings; paragraphFormats: ChaynsParagraphFormat[] }

Type declaration

CleanupCallback

CleanupCallback: () => void

Type declaration

    • (): void

    • Returns void

DataChangeCallback

DataChangeCallback: (value: DataChangeValue) => void

Type declaration

DataChangeValue

DataChangeValue: { type: page; value: Page[] } | { type: user; value: ChaynsApiUser | undefined } | { type: site; value: ChaynsApiSite } | { type: isAdminModeActive; value: ChaynsReactValues[isAdminModeActive] }

Dialog

Dialog<T>: BaseDialog & (DialogAlert | DialogConfirm | DialogInput | DialogModule<T> | DialogIFrame<T> | DialogSelect | DialogDate | DialogToast | DialogSignature | DialogFileSelect | DialogFileExplorer)

Type parameters

  • T = object

DialogButton

DialogButton: { text: string; type: DialogButtonType }

Type declaration

DialogButtonType

DialogButtonType: typeof DialogButtonType[keyof typeof DialogButtonType]

DialogCloseRequestReason

DialogCloseRequestReason: backdrop | esc

DialogHookResult

DialogHookResult: { addCloseRequestListener: (listener: (event: DialogCloseRequestEvent) => void) => () => void; addDataListener: ChaynsReactFunctions[addDialogHostEventListener]; isClosingRequested: boolean; sendData: ChaynsReactFunctions[dispatchEventToDialogHost]; setResult: ChaynsReactFunctions[setDialogResult] }

Type declaration

  • addCloseRequestListener: (listener: (event: DialogCloseRequestEvent) => void) => () => void

    Adds a listener which is invoked instead of closing the dialog when the user clicks the backdrop or presses escape. While at least one listener is registered the dialog will not be closed automatically. Listeners are invoked in reverse registration order (LIFO) until stopPropagation is called.

    @returns

    function to remove the listener

  • addDataListener: ChaynsReactFunctions[addDialogHostEventListener]
  • isClosingRequested: boolean
  • sendData: ChaynsReactFunctions[dispatchEventToDialogHost]
  • setResult: ChaynsReactFunctions[setDialogResult]

DialogResult

DialogResult: { close: (buttonType: DialogButtonType, data: any) => Promise<void>; open: () => Promise<any> }

Type declaration

  • close: (buttonType: DialogButtonType, data: any) => Promise<void>
  • open: () => Promise<any>
      • (): Promise<any>

      • Returns Promise<any>

DialogSelectListItemType

DialogSelectListItemType<T>: { className?: string; disabled?: boolean; icon?: string; id: T; isSelected?: boolean; name: string; subtitle?: string; url?: string }

Type parameters

  • T: number | string = number | string

Type declaration

  • optionalclassName?: string
    @deprecated

    Use icon instead

  • optionaldisabled?: boolean
  • optionalicon?: string
  • id: T
  • optionalisSelected?: boolean
  • name: string
  • optionalsubtitle?: string
  • optionalurl?: string

FileExplorerItem

FileExplorerItem: FileExplorerFolder | FileExplorerFile

HydrationContextValueType

HydrationContextValueType<T>: {}

Type parameters

  • T

Type declaration

  • [key string]: StoreLikeValue<T>

IntercomMessage

IntercomMessage: { images?: string[]; text: string }

Type declaration

  • optionalimages?: string[]
  • text: string

Login

Login: BaseDialog & DialogModule<{ preventLogin?: boolean; restore?: number; tokenLocationId?: number; tokenSiteId?: string; tokenType?: number }>

ModuleContextValueType

ModuleContextValueType: Record<string, { modules: Set<string>; url: string }>

OpenImageItem

OpenImageItem: { description?: string; preventCache?: boolean; title?: string; url: string }

Type declaration

  • optionaldescription?: string
  • optionalpreventCache?: boolean
  • optionaltitle?: string
  • url: string

OpenMedia

OpenMedia: { items: [OpenMediaItem, ...OpenMediaItem[]]; startIndex?: number }

Type declaration

OpenMediaItem

OpenMediaItem: { description?: string; mediaType: MediaType; preventCache?: boolean; title?: string; url: string }

Type declaration

  • optionaldescription?: string
  • mediaType: MediaType
  • optionalpreventCache?: boolean
  • optionaltitle?: string
  • url: string

PageMainGroupType

PageMainGroupType: { Administration: 2; Id: 1; User: 3 }

Type declaration

  • Administration: 2
  • Id: 1
  • User: 3

ScanQrCodeRequest

ScanQrCodeRequest: { cameraType?: ScanQrCodeCameraTypes; cancel?: boolean; ccAnimation?: boolean; codeFormats?: 4 | 5; codeType?: ScanQrCodeCodeType; codeTypes?: ScanQrCodeCodeType[]; dialogSubtitle?: string; dialogTitle?: string; enableCameraSwitch?: boolean; enableFlashToggle?: boolean; geoLocation?: boolean; showInput?: boolean; timeout?: number }

Type declaration

  • optionalcameraType?: ScanQrCodeCameraTypes
  • optionalcancel?: boolean
  • optionalccAnimation?: boolean
  • optionalcodeFormats?: 4 | 5
  • optionalcodeType?: ScanQrCodeCodeType
    @deprecated

    Use codeTypes instead *

  • optionalcodeTypes?: ScanQrCodeCodeType[]
  • optionaldialogSubtitle?: string
  • optionaldialogTitle?: string
  • optionalenableCameraSwitch?: boolean
  • optionalenableFlashToggle?: boolean
  • optionalgeoLocation?: boolean
  • optionalshowInput?: boolean
  • optionaltimeout?: number

ScanQrCodeResult

ScanQrCodeResult: { geoLocation?: { latitude: number; longitude: number; speed: number }; qrCode: string; resultType: number; status: number }

Type declaration

  • optionalgeoLocation?: { latitude: number; longitude: number; speed: number }
    • latitude: number
    • longitude: number
    • speed: number
  • qrCode: string
  • resultType: number
  • status: number

SelectPage

SelectPage: { forceSelect?: boolean; id?: number; isAdminMode?: boolean; params?: {}; path?: string; position?: number; preventHistory?: boolean; showName?: string; siteId?: string }

Type declaration

  • optionalforceSelect?: boolean
  • optionalid?: number
  • optionalisAdminMode?: boolean
  • optionalparams?: {}
    • [key string]: string
  • optionalpath?: string
  • optionalposition?: number
  • optionalpreventHistory?: boolean
  • optionalshowName?: string
  • optionalsiteId?: string

TaskList

TaskList: (TaskList | Promise<unknown> | () => Promise<unknown>)[]

UserInfoQuery

UserInfoQuery: { personId: string; userId?: never } | { personId?: string; userId: number }

Variables

constDefaultLoginDialogOptions

DefaultLoginDialogOptions: { buttons: never[]; dialogInput: {}; hideDragHandle: boolean; minHeight: number; seamless: boolean; system: { module: string; scope: string; url: string }; type: string } = ...

Type declaration

  • buttons: never[]
  • dialogInput: {}
    • hideDragHandle: boolean
    • minHeight: number
    • seamless: boolean
    • system: { module: string; scope: string; url: string }
      • module: string
      • scope: string
      • url: string
    • type: string

    constDialogButtonType

    DialogButtonType: { CANCEL: -1; NEGATIVE: 0; OK: 1 } = ...

    Type declaration

    • readonlyCANCEL: -1
    • readonlyNEGATIVE: 0
    • readonlyOK: 1

    HydrationContext

    HydrationContext: React.Context<HydrationContextValueType<object>>

    ModuleContext

    ModuleContext: React.Context<ModuleContextValueType>

    constRuntimeEnviroment

    RuntimeEnviroment: typeof RuntimeEnvironment = RuntimeEnvironment

    constdevice

    device: ChaynsApiDevice = ...

    constenvironment

    environment: { buildEnvironment: Environment; runtimeEnvironment: string | RuntimeEnvironment } = ...

    Type declaration

    constlanguage

    language: { active: Language; device: Language; site: Language; translation: null | Language; user: undefined | Language } = ...

    Type declaration

    constpages

    pages: Page[] = ...

    constparameters

    parameters: {} = ...

    Type declaration

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

    constsite

    site: ChaynsApiSite = ...

    constuser

    user: UserInfo = ...
    Page Options