chayns-api

Index

Classes

• DialogHandler
• StaticChaynsApi

Enumerations

• AccessMode
• AppName
• BrowserName
• ColorMode
• DateType
• DeviceOs
• DialogAnimation
• DialogButtonType
• DialogIconType
• DialogInputType
• DialogSelectType
• DialogType
• Environment
• FloatingButtonAnimation
• FloatingButtonPosition
• Font
• Gender
• IconType
• Language
• MediaType
• RuntimeEnviroment
• ScanQrCodeCameraTypes
• ScanQrCodeCodeType
• ScreenSize
• SharingApp
• TappEvent
• ToastType
• WeekDayType

Functions

• addAnonymousAccount
• bindChaynsApi
• createDialog
• customCallbackFunction
• getAccessToken
• getAvailableSharingServices
• getClientDeviceInfo
• getCurrentPage
• getDevice
• getDeviceInfo
• getEnvironment
• getGeoLocation
• getLanguage
• getPage
• getPages
• getParameters
• getScreenSize
• getScrollPosition
• getSite
• getWindowMetrics
• isApp
• isAppCallSupported
• login
• logout
• navigateBack
• openImage
• openMedia
• openUrl
• openVideo
• refreshAccessToken
• refreshData
• scrollByY
• scrollToY
• selectPage
• sendMessageToGroup
• sendMessageToPage
• sendMessageToUser
• setAdminMode
• setDisplayTimeout
• setFloatingButton
• setHeight
• setOverlay
• setRefreshScrollEnabled
• setScanQrCode
• setTempDesignSettings
• setWaitCursor
• storageGetItem
• storageRemoveItem
• storageSetItem
• vibrate
• withCompatMode

Event listener

• addGeoLocationListener
• addScrollListener
• addToolbarChangeListener
• addVisibilityChangeListener
• addWindowMetricsListener
• removeGeoLocationListener
• removeScrollListener
• removeToolbarChangeListener
• removeVisibilityChangeListener
• removeWindowMetricsListener

Hooks

• useAccessToken
• useCurrentPage
• useCustomData
• useDevice
• useDialogData
• useDialogState
• useEnvironment
• useFunctions
• useGeoLocation
• useGeoLocationListener
• useIsAdminMode
• useLanguage
• usePage
• usePages
• useParameters
• useScrollListener
• useScrollOffsetBottom
• useScrollOffsetTop
• useScrollPosition
• useSite
• useUser
• useValues
• useWindowMetrics
• useWindowMetricsListener

Hooks Returns customCallbackFunction

• useCustomCallbackFunction

User functions

• getUser
• getUserInfo

Interfaces

• AdminMode
• AvailableSharingServices
• BaseDialog
• DesignSettings
• DialogAlert
• DialogConfirm
• DialogDate
• DialogFileSelect
• DialogIFrame
• DialogInput
• DialogModule
• DialogResultFile
• DialogSelect
• DialogSignature
• DialogToast
• DisplayTimeout
• FloatingButton
• GeoLocation
• IChaynsReact
• InvokeCall
• Login
• LoginResult
• OpenImage
• OpenUrl
• OpenVideo
• Page
• RefreshData
• RefreshScrollEnabled
• ScrollListenerResult
• SelectInput
• ShowOverlay
• ToolbarChangeListenerResult
• UserInfo
• Vibrate
• VisibilityChangeListenerResult
• WaitCursor
• WindowMetricsListenerResult

Namespaces

• dialog

Type Aliases

• AccessToken
• AccessTokenResult
• AnonymousAccountResult
• ChaynsApiDevice
• ChaynsApiSite
• ChaynsApiUser
• CleanupCallback
• DataChangeCallback
• DataChangeValue
• Dialog
• DialogButton
• DialogDataHookResult
• DialogHookResult
• DialogResult
• DialogSelectListItemType
• IntercomMessage
• OpenImageItem
• OpenMedia
• OpenMediaItem
• ScanQrCodeRequest
• ScanQrCodeResult
• SelectPage
• TaskList
• UserInfoQuery

Variables

• ChaynsHost
• ChaynsProvider
• WaitUntil
• default
• device
• environment
• language
• pages
• parameters
• site
• user

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; 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; 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

  • 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 }; 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

• id: string

• layoutDisposition: LayoutDisposition

• locationId: number

• locationPersonId: string

• optionaloriginSiteId?: string

• title: string

• url: string

• urlHash: string

ChaynsApiUser

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

Type declaration

• optionalfirstName?: string

• optionalgender?: Gender

• optionallastName?: string

• optionalnickName?: string

• optionalpersonId?: string

• optionaluacGroups?: UacGroup[]

• optionaluserId?: number

CleanupCallback

CleanupCallback: () => void

Type declaration

• • (): void

  • Returns void

DataChangeCallback

DataChangeCallback: (value: DataChangeValue) => void

Type declaration

• • (value: DataChangeValue): void

  • Parameters

    • value: DataChangeValue

    Returns void

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)

Type parameters

• T: any = object

DialogButton

DialogButton: { text?: string; type?: DialogButtonType }

Type declaration

• text: string

• type: DialogButtonType

DialogDataHookResult

DialogDataHookResult: {}

Type declaration

• [key string | symbol]: object

DialogHookResult

DialogHookResult: { addDataListener?: ChaynsReactFunctions[addDialogHostEventListener]; isClosingRequested?: boolean; sendData?: ChaynsReactFunctions[dispatchEventToDialogHost]; setResult?: ChaynsReactFunctions[setDialogResult] }

Type declaration

• addDataListener: ChaynsReactFunctions[addDialogHostEventListener]

• isClosingRequested: boolean

• sendData: ChaynsReactFunctions[dispatchEventToDialogHost]

• setResult: ChaynsReactFunctions[setDialogResult]

DialogResult

DialogResult: { close?: any; open?: any }

Type declaration

• close: function

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

  ---

  • Parameters

    • buttonType: DialogButtonType

    • data: any

    Returns Promise<void>

• open: function

  • open(): Promise<any>

  ---

  • Returns Promise<any>

DialogSelectListItemType

DialogSelectListItemType: { className?: string; disabled?: boolean; icon?: string; id?: number; isSelected?: boolean; name?: string; url?: string }

Type declaration

• optionalclassName?: string

  @deprecated

  Use icon instead

• optionaldisabled?: boolean

• optionalicon?: string

• id: number

• optionalisSelected?: boolean

• name: string

• optionalurl?: string

IntercomMessage

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

Type declaration

• optionalimages?: string[]

• text: 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

• items: [OpenMediaItem, ...OpenMediaItem[]]

• optionalstartIndex?: number

OpenMediaItem

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

Type declaration

• optionaldescription?: string

• mediaType: MediaType

• optionalpreventCache?: boolean

• optionaltitle?: string

• url: string

ScanQrCodeRequest

ScanQrCodeRequest: { cameraType?: ScanQrCodeCameraTypes; cancel?: boolean; ccAnimation?: boolean; codeFormats?: 4 | 5; codeType?: 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

• 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

constChaynsHost

ChaynsHost: FC<ChaynsHostType> = ...

constChaynsProvider

ChaynsProvider: React.FC<ChaynsProviderProps> = ...

constWaitUntil

WaitUntil: FC<{ children?: ReactNode; loadingComponent?: ReactNode; tasks?: TaskList }> = ...

default

default: { appVersion?: undefined | string; buildEnv?: undefined | string }

Type declaration

• appVersion: undefined | string

• buildEnv: undefined | string

constdevice

device: ChaynsApiDevice = ...

constenvironment

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

Type declaration

• buildEnvironment: Environment

• runtimeEnvironment: string | RuntimeEnviroment

constlanguage

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

Type declaration

• active: Language

• device: Language

• site: Language

• translation: null | Language

constpages

pages: Page[] = ...

constparameters

parameters: {} = ...

Type declaration

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

constsite

site: ChaynsApiSite = ...

constuser

user: UserInfo = ...