StaticChaynsApi

Implements

• ChaynsReactFunctions

Index

Constructors

• constructor

Properties

• addAccessTokenChangeListener
• addAnonymousAccount
• addDataListener
• addDialogClientEventListener
• addDialogHostEventListener
• addGeoLocationListener
• addScrollListener
• addToolbarChangeListener
• addVisibilityChangeListener
• addWindowMetricsListener
• closeDialog
• createDialog
• customCallbackFunction
• dispatchEventToDialogClient
• dispatchEventToDialogHost
• getAccessToken
• getAvailableSharingServices
• getCustomCookie
• getGeoLocation
• getScrollPosition
• getUserInfo
• getWindowMetrics
• invokeCall
• invokeDialogCall
• invokePaymentCall
• login
• logout
• navigateBack
• openDialog
• openImage
• openMedia
• openUrl
• openVideo
• ready
• redirect
• refreshAccessToken
• refreshData
• removeAccessTokenChangeListener
• removeDialogClientEventListener
• removeDialogHostEventListener
• removeGeoLocationListener
• removeScrollListener
• removeToolbarChangeListener
• removeVisibilityChangeListener
• removeWindowMetricsListener
• scrollByY
• scrollToY
• selectPage
• sendMessageToGroup
• sendMessageToPage
• sendMessageToUser
• setAdminMode
• setCustomCookie
• setDialogResult
• setDisplayTimeout
• setFloatingButton
• setHeight
• setOverlay
• setRefreshScrollEnabled
• setScanQrCode
• setTempDesignSettings
• setWaitCursor
• storageGetItem
• storageRemoveItem
• storageSetItem
• vibrate

Methods

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

Constructors

constructor

• new StaticChaynsApi(values?: ChaynsReactValues, functions?: ChaynsReactFunctions): StaticChaynsApi

• Parameters

  • optionalvalues: ChaynsReactValues

  • optionalfunctions: ChaynsReactFunctions

  Returns StaticChaynsApi

Properties

addAccessTokenChangeListener

addAccessTokenChangeListener: (options: { external?: boolean }, callback: (result: { accessToken: string }) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addAccessTokenChangeListener

Type declaration

• • (options: { external?: boolean }, callback: (result: { accessToken: string }) => void): Promise<number>

  • Parameters

    • options: { external?: boolean }

    • optionalexternal: boolean

    • callback: (result: { accessToken: string }) => void

    Returns Promise<number>

addAnonymousAccount

addAnonymousAccount: () => Promise<AnonymousAccountResult>

Implementation of ChaynsReactFunctions.addAnonymousAccount

Type declaration

• • (): Promise<AnonymousAccountResult>

  • Returns Promise<AnonymousAccountResult>

addDataListener

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

Type declaration

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

  • Parameters

    • cb: DataChangeCallback

    Returns () => void

    • • (): void

      • Returns void

addDialogClientEventListener

addDialogClientEventListener: (dialogId: number, callback: (data: object) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addDialogClientEventListener

Type declaration

• • (dialogId: number, callback: (data: object) => void): Promise<number>

  • Parameters

    • dialogId: number

    • callback: (data: object) => void

    Returns Promise<number>

addDialogHostEventListener

addDialogHostEventListener: (callback: (data: object) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addDialogHostEventListener

Type declaration

• • (callback: (data: object) => void): Promise<number>

  • Parameters

    • callback: (data: object) => void

    Returns Promise<number>

addGeoLocationListener

addGeoLocationListener: (value: { silent?: boolean; timeout?: number }, callback: (geoLocation: GeoLocation) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addGeoLocationListener

Type declaration

• • (value: { silent?: boolean; timeout?: number }, callback: (geoLocation: GeoLocation) => void): Promise<number>

  • Parameters

    • value: { silent?: boolean; timeout?: number }

    • optionalsilent: boolean

    • optionaltimeout: number

    • callback: (geoLocation: GeoLocation) => void

    Returns Promise<number>

addScrollListener

addScrollListener: (value: { throttle?: number }, callback: (result: ScrollListenerResult) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addScrollListener

Type declaration

• • (value: { throttle?: number }, callback: (result: ScrollListenerResult) => void): Promise<number>

  • Parameters

    • value: { throttle?: number }

    • optionalthrottle: number

    • callback: (result: ScrollListenerResult) => void

    Returns Promise<number>

addToolbarChangeListener

addToolbarChangeListener: (callback: (result: ToolbarChangeListenerResult) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addToolbarChangeListener

Type declaration

• • (callback: (result: ToolbarChangeListenerResult) => void): Promise<number>

  • Parameters

    • callback: (result: ToolbarChangeListenerResult) => void

    Returns Promise<number>

addVisibilityChangeListener

addVisibilityChangeListener: (callback: (result: VisibilityChangeListenerResult) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addVisibilityChangeListener

Type declaration

• • (callback: (result: VisibilityChangeListenerResult) => void): Promise<number>

  • Parameters

    • callback: (result: VisibilityChangeListenerResult) => void

    Returns Promise<number>

addWindowMetricsListener

addWindowMetricsListener: (callback: (result: WindowMetricsListenerResult) => void) => Promise<number>

Implementation of ChaynsReactFunctions.addWindowMetricsListener

Type declaration

• • (callback: (result: WindowMetricsListenerResult) => void): Promise<number>

  • Parameters

    • callback: (result: WindowMetricsListenerResult) => void

    Returns Promise<number>

closeDialog

closeDialog: (dialogId: number) => Promise<void>

Implementation of ChaynsReactFunctions.closeDialog

Type declaration

• • (dialogId: number): Promise<void>

  • Parameters

    • dialogId: number

    Returns Promise<void>

createDialog

createDialog: { (config: BaseDialog & (DialogAlert | DialogConfirm | DialogToast)): default<void>; (config: BaseDialog & (DialogInput | DialogSignature)): default<string>; <T>(config: BaseDialog & DialogSelect<T>): default<T[]>; (config: BaseDialog & DialogDate & ({ multiselect: true } | { interval: true })): default<Date[]>; (config: BaseDialog & DialogDate): default<Date>; (config: BaseDialog & DialogFileSelect): default<DialogResultFile[]>; <Input, Result>(config: BaseDialog & (DialogModule<Input> | DialogIFrame<Input>)): default<Result>; <Input, Result>(config: BaseDialog & (DialogAlert | DialogConfirm | DialogToast | DialogInput | DialogSignature | DialogDate | DialogFileSelect | DialogSelect<string | number> | DialogIFrame<Input> | DialogModule<Input>)): any }

Implementation of ChaynsReactFunctions.createDialog

Type declaration

• • (config: BaseDialog & (DialogAlert | DialogConfirm | DialogToast)): default<void>
  • (config: BaseDialog & (DialogInput | DialogSignature)): default<string>
  • <T>(config: BaseDialog & DialogSelect<T>): default<T[]>
  • (config: BaseDialog & DialogDate & ({ multiselect: true } | { interval: true })): default<Date[]>
  • (config: BaseDialog & DialogDate): default<Date>
  • (config: BaseDialog & DialogFileSelect): default<DialogResultFile[]>
  • <Input, Result>(config: BaseDialog & (DialogModule<Input> | DialogIFrame<Input>)): default<Result>
  • <Input, Result>(config: BaseDialog & (DialogAlert | DialogConfirm | DialogToast | DialogInput | DialogSignature | DialogDate | DialogFileSelect | DialogSelect<string | number> | DialogIFrame<Input> | DialogModule<Input>)): any

  • Parameters

    • config: BaseDialog & (DialogAlert | DialogConfirm | DialogToast)

    Returns default<void>

  • Parameters

    • config: BaseDialog & (DialogInput | DialogSignature)

    Returns default<string>

  • Type parameters

    • T: string | number = string | number

    Parameters

    • config: BaseDialog & DialogSelect<T>

    Returns default<T[]>

  • Parameters

    • config: BaseDialog & DialogDate & ({ multiselect: true } | { interval: true })

    Returns default<Date[]>

  • Parameters

    • config: BaseDialog & DialogDate

    Returns default<Date>

  • Parameters

    • config: BaseDialog & DialogFileSelect

    Returns default<DialogResultFile[]>

  • Type parameters

    • Input = any
    • Result = unknown

    Parameters

    • config: BaseDialog & (DialogModule<Input> | DialogIFrame<Input>)

    Returns default<Result>

  • Type parameters

    • Input = any
    • Result = unknown

    Parameters

    • config: BaseDialog & (DialogAlert | DialogConfirm | DialogToast | DialogInput | DialogSignature | DialogDate | DialogFileSelect | DialogSelect<string | number> | DialogIFrame<Input> | DialogModule<Input>)

    Returns any

customCallbackFunction

customCallbackFunction: (type: string, data: unknown) => Promise<unknown>

Implementation of ChaynsReactFunctions.customCallbackFunction

Type declaration

• • (type: string, data: unknown): Promise<unknown>

  • Parameters

    • type: string

    • data: unknown

    Returns Promise<unknown>

dispatchEventToDialogClient

dispatchEventToDialogClient: (dialogId: number, data: object) => Promise<void>

Implementation of ChaynsReactFunctions.dispatchEventToDialogClient

Type declaration

• • (dialogId: number, data: object): Promise<void>

  • Parameters

    • dialogId: number

    • data: object

    Returns Promise<void>

dispatchEventToDialogHost

dispatchEventToDialogHost: (data: object) => Promise<void>

Implementation of ChaynsReactFunctions.dispatchEventToDialogHost

Type declaration

• • (data: object): Promise<void>

  • Parameters

    • data: object

    Returns Promise<void>

getAccessToken

getAccessToken: (value?: AccessToken) => Promise<AccessTokenResult>

Implementation of ChaynsReactFunctions.getAccessToken

Type declaration

• • (value?: AccessToken): Promise<AccessTokenResult>

  • Parameters

    • optionalvalue: AccessToken

    Returns Promise<AccessTokenResult>

getAvailableSharingServices

getAvailableSharingServices: () => Promise<AvailableSharingServices>

Implementation of ChaynsReactFunctions.getAvailableSharingServices

Type declaration

• • (): Promise<AvailableSharingServices>

  • Returns Promise<AvailableSharingServices>

getCustomCookie

getCustomCookie: (value: { name: string }) => Promise<undefined | string>

Implementation of ChaynsReactFunctions.getCustomCookie

Type declaration

• • (value: { name: string }): Promise<undefined | string>

  • Parameters

    • value: { name: string }

    • name: string

    Returns Promise<undefined | string>

getGeoLocation

getGeoLocation: (value: { silent?: boolean; timeout?: number }) => Promise<GeoLocation>

Implementation of ChaynsReactFunctions.getGeoLocation

Type declaration

• • (value: { silent?: boolean; timeout?: number }): Promise<GeoLocation>

  • Parameters

    • value: { silent?: boolean; timeout?: number }

    • optionalsilent: boolean

    • optionaltimeout: number

    Returns Promise<GeoLocation>

getScrollPosition

getScrollPosition: () => Promise<ScrollListenerResult>

Implementation of ChaynsReactFunctions.getScrollPosition

Type declaration

• • (): Promise<ScrollListenerResult>

  • Returns Promise<ScrollListenerResult>

getUserInfo

getUserInfo: (value: UserInfoQuery) => Promise<null | UserInfo>

Implementation of ChaynsReactFunctions.getUserInfo

Type declaration

• • (value: UserInfoQuery): Promise<null | UserInfo>

  • Parameters

    • value: UserInfoQuery

    Returns Promise<null | UserInfo>

getWindowMetrics

getWindowMetrics: () => Promise<WindowMetricsListenerResult>

Implementation of ChaynsReactFunctions.getWindowMetrics

Type declaration

• • (): Promise<WindowMetricsListenerResult>

  • Returns Promise<WindowMetricsListenerResult>

invokeCall

invokeCall: (value: InvokeCall, callback?: (result: any) => void) => Promise<any>

Implementation of ChaynsReactFunctions.invokeCall

Type declaration

• • (value: InvokeCall, callback?: (result: any) => void): Promise<any>

  • Parameters

    • value: InvokeCall

    • optionalcallback: (result: any) => void

    Returns Promise<any>

invokeDialogCall

invokeDialogCall: (value: InvokeCall, callback?: (result: any) => void) => Promise<any>

Implementation of ChaynsReactFunctions.invokeDialogCall

Type declaration

• • (value: InvokeCall, callback?: (result: any) => void): Promise<any>

  • Parameters

    • value: InvokeCall

    • optionalcallback: (result: any) => void

    Returns Promise<any>

invokePaymentCall

invokePaymentCall: <T>(value: InvokeCall, callback?: (result: T) => void) => Promise<T>

Implementation of ChaynsReactFunctions.invokePaymentCall

Type declaration

• • <T>(value: InvokeCall, callback?: (result: T) => void): Promise<T>

  • Type parameters

    • T

    Parameters

    • value: InvokeCall

    • optionalcallback: (result: T) => void

    Returns Promise<T>

login

login: (value?: Login, callback?: (result: boolean) => void, closeCallback?: () => void) => Promise<LoginResult>

Implementation of ChaynsReactFunctions.login

Type declaration

• • (value?: Login, callback?: (result: boolean) => void, closeCallback?: () => void): Promise<LoginResult>

  • Parameters

    • optionalvalue: Login

    • optionalcallback: (result: boolean) => void

    • optionalcloseCallback: () => void

    Returns Promise<LoginResult>

logout

logout: () => Promise<void>

Implementation of ChaynsReactFunctions.logout

Type declaration

• • (): Promise<void>

  • Returns Promise<void>

navigateBack

navigateBack: () => Promise<void>

Implementation of ChaynsReactFunctions.navigateBack

Type declaration

• • (): Promise<void>

  • Returns Promise<void>

openDialog

openDialog: (value: any, callback: (data: any) => any) => Promise<any>

Implementation of ChaynsReactFunctions.openDialog

Type declaration

• • (value: any, callback: (data: any) => any): Promise<any>

  • Parameters

    • value: any

    • callback: (data: any) => any

    Returns Promise<any>

openImage

openImage: (value: OpenImage) => Promise<void>

Implementation of ChaynsReactFunctions.openImage

Type declaration

• • (value: OpenImage): Promise<void>

  • Parameters

    • value: OpenImage

    Returns Promise<void>

openMedia

openMedia: (value: OpenMedia) => Promise<void>

Implementation of ChaynsReactFunctions.openMedia

Type declaration

• • (value: OpenMedia): Promise<void>

  • Parameters

    • value: OpenMedia

    Returns Promise<void>

openUrl

openUrl: (value: OpenUrl) => Promise<void>

Implementation of ChaynsReactFunctions.openUrl

Type declaration

• • (value: OpenUrl): Promise<void>

  • Parameters

    • value: OpenUrl

    Returns Promise<void>

openVideo

openVideo: (value: OpenVideo) => Promise<void>

Implementation of ChaynsReactFunctions.openVideo

Type declaration

• • (value: OpenVideo): Promise<void>

  • Parameters

    • value: OpenVideo

    Returns Promise<void>

ready

ready: Promise<void>

redirect

redirect: (options: { destination: string; isPermanent?: boolean }) => Promise<void>

Implementation of ChaynsReactFunctions.redirect

Type declaration

• • (options: { destination: string; isPermanent?: boolean }): Promise<void>

  • Parameters

    • options: { destination: string; isPermanent?: boolean }

    • destination: string

    • optionalisPermanent: boolean

    Returns Promise<void>

refreshAccessToken

refreshAccessToken: () => Promise<void>

Implementation of ChaynsReactFunctions.refreshAccessToken

Type declaration

• • (): Promise<void>

  • Returns Promise<void>

refreshData

refreshData: (value: RefreshData) => Promise<void>

Implementation of ChaynsReactFunctions.refreshData

Type declaration

• • (value: RefreshData): Promise<void>

  • Parameters

    • value: RefreshData

    Returns Promise<void>

removeAccessTokenChangeListener

removeAccessTokenChangeListener: (id: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeAccessTokenChangeListener

Type declaration

• • (id: number): Promise<void>

  • Parameters

    • id: number

    Returns Promise<void>

removeDialogClientEventListener

removeDialogClientEventListener: (dialogId: number, id: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeDialogClientEventListener

Type declaration

• • (dialogId: number, id: number): Promise<void>

  • Parameters

    • dialogId: number

    • id: number

    Returns Promise<void>

removeDialogHostEventListener

removeDialogHostEventListener: (id: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeDialogHostEventListener

Type declaration

• • (id: number): Promise<void>

  • Parameters

    • id: number

    Returns Promise<void>

removeGeoLocationListener

removeGeoLocationListener: (value: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeGeoLocationListener

Type declaration

• • (value: number): Promise<void>

  • Parameters

    • value: number

    Returns Promise<void>

removeScrollListener

removeScrollListener: (value: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeScrollListener

Type declaration

• • (value: number): Promise<void>

  • Parameters

    • value: number

    Returns Promise<void>

removeToolbarChangeListener

removeToolbarChangeListener: (value: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeToolbarChangeListener

Type declaration

• • (value: number): Promise<void>

  • Parameters

    • value: number

    Returns Promise<void>

removeVisibilityChangeListener

removeVisibilityChangeListener: (value: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeVisibilityChangeListener

Type declaration

• • (value: number): Promise<void>

  • Parameters

    • value: number

    Returns Promise<void>

removeWindowMetricsListener

removeWindowMetricsListener: (value: number) => Promise<void>

Implementation of ChaynsReactFunctions.removeWindowMetricsListener

Type declaration

• • (value: number): Promise<void>

  • Parameters

    • value: number

    Returns Promise<void>

scrollByY

scrollByY: (position: number, duration?: number) => Promise<void>

Implementation of ChaynsReactFunctions.scrollByY

Type declaration

• • (position: number, duration?: number): Promise<void>

  • Parameters

    • position: number

    • optionalduration: number

    Returns Promise<void>

scrollToY

scrollToY: (position: number, duration: number) => Promise<void>

Implementation of ChaynsReactFunctions.scrollToY

Type declaration

• • (position: number, duration: number): Promise<void>

  • Parameters

    • position: number

    • duration: number

    Returns Promise<void>

selectPage

selectPage: (value: SelectPage) => Promise<void>

Implementation of ChaynsReactFunctions.selectPage

Type declaration

• • (value: SelectPage): Promise<void>

  • Parameters

    • value: SelectPage

    Returns Promise<void>

sendMessageToGroup

sendMessageToGroup: (groupId: number, message: IntercomMessage) => Promise<Response>

Implementation of ChaynsReactFunctions.sendMessageToGroup

Type declaration

• • (groupId: number, message: IntercomMessage): Promise<Response>

  • Parameters

    • groupId: number

    • message: IntercomMessage

    Returns Promise<Response>

sendMessageToPage

sendMessageToPage: (message: IntercomMessage) => Promise<Response>

Implementation of ChaynsReactFunctions.sendMessageToPage

Type declaration

• • (message: IntercomMessage): Promise<Response>

  • Parameters

    • message: IntercomMessage

    Returns Promise<Response>

sendMessageToUser

sendMessageToUser: (userId: number, message: IntercomMessage) => Promise<Response>

Implementation of ChaynsReactFunctions.sendMessageToUser

Type declaration

• • (userId: number, message: IntercomMessage): Promise<Response>

  • Parameters

    • userId: number

    • message: IntercomMessage

    Returns Promise<Response>

setAdminMode

setAdminMode: (enabled: boolean) => Promise<void>

Implementation of ChaynsReactFunctions.setAdminMode

Type declaration

• • (enabled: boolean): Promise<void>

  • Parameters

    • enabled: boolean

    Returns Promise<void>

setCustomCookie

setCustomCookie: (value: { expireDate?: string | number | Date; name: string; value: null | string }) => Promise<void>

Implementation of ChaynsReactFunctions.setCustomCookie

Type declaration

• • (value: { expireDate?: string | number | Date; name: string; value: null | string }): Promise<void>

  • Parameters

    • value: { expireDate?: string | number | Date; name: string; value: null | string }

    • optionalexpireDate: string | number | Date

    • name: string

    • value: null | string

    Returns Promise<void>

setDialogResult

setDialogResult: (buttonType: DialogButtonType, result: any) => Promise<void>

Implementation of ChaynsReactFunctions.setDialogResult

Type declaration

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

  • Parameters

    • buttonType: DialogButtonType

    • result: any

    Returns Promise<void>

setDisplayTimeout

setDisplayTimeout: (enabled: boolean) => Promise<DisplayTimeout>

Implementation of ChaynsReactFunctions.setDisplayTimeout

Type declaration

• • (enabled: boolean): Promise<DisplayTimeout>

  • Parameters

    • enabled: boolean

    Returns Promise<DisplayTimeout>

setFloatingButton

setFloatingButton: (value: FloatingButton, callback: () => void) => Promise<void>

Implementation of ChaynsReactFunctions.setFloatingButton

Type declaration

• • (value: FloatingButton, callback: () => void): Promise<void>

  • Parameters

    • value: FloatingButton

    • callback: () => void

    Returns Promise<void>

setHeight

setHeight: (height: number) => Promise<void>

Implementation of ChaynsReactFunctions.setHeight

Type declaration

• • (height: number): Promise<void>

  • Parameters

    • height: number

    Returns Promise<void>

setOverlay

setOverlay: (value: ShowOverlay, callback: () => void) => Promise<void>

Implementation of ChaynsReactFunctions.setOverlay

Type declaration

• • (value: ShowOverlay, callback: () => void): Promise<void>

  • Parameters

    • value: ShowOverlay

    • callback: () => void

    Returns Promise<void>

setRefreshScrollEnabled

setRefreshScrollEnabled: (enabled: boolean) => Promise<RefreshScrollEnabled>

Implementation of ChaynsReactFunctions.setRefreshScrollEnabled

Type declaration

• • (enabled: boolean): Promise<RefreshScrollEnabled>

  • Parameters

    • enabled: boolean

    Returns Promise<RefreshScrollEnabled>

setScanQrCode

setScanQrCode: (value: ScanQrCodeRequest) => Promise<ScanQrCodeResult>

Implementation of ChaynsReactFunctions.setScanQrCode

Type declaration

• • (value: ScanQrCodeRequest): Promise<ScanQrCodeResult>

  • Parameters

    • value: ScanQrCodeRequest

    Returns Promise<ScanQrCodeResult>

setTempDesignSettings

setTempDesignSettings: (value: DesignSettings) => Promise<void>

Implementation of ChaynsReactFunctions.setTempDesignSettings

Type declaration

• • (value: DesignSettings): Promise<void>

  • Parameters

    • value: DesignSettings

    Returns Promise<void>

setWaitCursor

setWaitCursor: (value: WaitCursor) => Promise<void>

Implementation of ChaynsReactFunctions.setWaitCursor

Type declaration

• • (value: WaitCursor): Promise<void>

  • Parameters

    • value: WaitCursor

    Returns Promise<void>

storageGetItem

storageGetItem: <T>(key: string, accessMode?: AccessMode) => Promise<undefined | T>

Implementation of ChaynsReactFunctions.storageGetItem

Type declaration

• • <T>(key: string, accessMode?: AccessMode): Promise<undefined | T>

  • Type parameters

    • T: string | number | object

    Parameters

    • key: string

    • optionalaccessMode: AccessMode

    Returns Promise<undefined | T>

storageRemoveItem

storageRemoveItem: (key: string, accessMode?: AccessMode) => Promise<void>

Implementation of ChaynsReactFunctions.storageRemoveItem

Type declaration

• • (key: string, accessMode?: AccessMode): Promise<void>

  • Parameters

    • key: string

    • optionalaccessMode: AccessMode

    Returns Promise<void>

storageSetItem

storageSetItem: <T>(key: string, value: T, accessMode?: AccessMode, tappIds?: number[]) => Promise<void>

Implementation of ChaynsReactFunctions.storageSetItem

Type declaration

• • <T>(key: string, value: T, accessMode?: AccessMode, tappIds?: number[]): Promise<void>

  • Type parameters

    • T: string | number | object

    Parameters

    • key: string

    • value: T

    • optionalaccessMode: AccessMode

    • optionaltappIds: number[]

    Returns Promise<void>

vibrate

vibrate: (value: Vibrate) => Promise<void>

Implementation of ChaynsReactFunctions.vibrate

Type declaration

• • (value: Vibrate): Promise<void>

  • Parameters

    • value: Vibrate

    Returns 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

getDialogInput

• getDialogInput<T>(): T

• Type parameters

  • T

  Returns T

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