Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Variables

Const ERROR

ERROR: "error" = "error"

Const INFO

INFO: "info" = "info"

Const WARNING

WARNING: "warning" = "warning"

Functions

Const addSessionProperty

  • addSessionProperty(key: string, value: string, permanent: boolean): Promise<boolean>
  • Parameters

    • key: string
    • value: string
    • permanent: boolean

    Returns Promise<boolean>

Const clearAllUserPersonas

  • clearAllUserPersonas(): void
  • Returns void

Const clearUserAsPayer

  • clearUserAsPayer(): void
  • Returns void

Const clearUserEmail

  • clearUserEmail(): void
  • Returns void

Const clearUserIdentifier

  • clearUserIdentifier(): void
  • Returns void

Const clearUserPersona

  • clearUserPersona(persona: string): void
  • Parameters

    • persona: string

    Returns void

Const clearUsername

  • clearUsername(): void
  • Returns void

Const endAppStartup

  • endAppStartup(properties?: Map<string, any>): void
  • Parameters

    • Optional properties: Map<string, any>

    Returns void

Const endMoment

  • endMoment(name: string, identifier?: undefined | string, properties?: Map<string, any>): void
  • Parameters

    • name: string
    • Optional identifier: undefined | string
    • Optional properties: Map<string, any>

    Returns void

Const endSession

  • endSession(clearUserInfo?: boolean): any
  • Parameters

    • Default value clearUserInfo: boolean = false

    Returns any

Const endView

  • endView(view: string): void
  • Parameters

    • view: string

    Returns void

Const generateStackTrace

  • generateStackTrace(): string
  • Returns string

Const getSessionProperties

  • getSessionProperties(): any
  • Returns any

Const initialize

  • initialize(__namedParameters?: { patch: undefined | string }): void
  • Parameters

    • Default value __namedParameters: { patch: undefined | string } = {}
      • patch: undefined | string

    Returns void

Const logBreadcrumb

  • logBreadcrumb(message: string): void
  • Parameters

    • message: string

    Returns void

Const logHandledError

  • logHandledError(error: Error, properties?: Map<string, any>): void
  • Parameters

    • error: Error
    • Optional properties: Map<string, any>

    Returns void

Const logMessage

  • logMessage(message: string, severity?: "info" | "warning" | "error", properties?: Map<string, any>, allowScreenshot?: boolean): void
  • Parameters

    • message: string
    • Default value severity: "info" | "warning" | "error" = "error"
    • Optional properties: Map<string, any>
    • Default value allowScreenshot: boolean = false

    Returns void

Const logScreen

  • logScreen(screenName: string): void
  • Parameters

    • screenName: string

    Returns void

Const removeSessionProperty

  • removeSessionProperty(key: string): void
  • Parameters

    • key: string

    Returns void

Const setJavaScriptBundlePath

  • setJavaScriptBundlePath(path: string): void
  • Parameters

    • path: string

    Returns void

Const setJavaScriptPatch

  • setJavaScriptPatch(patch: string): void
  • Parameters

    • patch: string

    Returns void

Const setUserAsPayer

  • setUserAsPayer(): void
  • Returns void

Const setUserEmail

  • setUserEmail(userEmail: string): void
  • Parameters

    • userEmail: string

    Returns void

Const setUserIdentifier

  • setUserIdentifier(userIdentifier: string): void
  • Parameters

    • userIdentifier: string

    Returns void

Const setUserPersona

  • setUserPersona(persona: string): void
  • Parameters

    • persona: string

    Returns void

Const setUsername

  • setUsername(username: string): void
  • Parameters

    • username: string

    Returns void

Const startMoment

  • startMoment(name: string, identifier?: undefined | string, properties?: Map<string, any>): void
  • Parameters

    • name: string
    • Optional identifier: undefined | string
    • Optional properties: Map<string, any>

    Returns void

Const startMomentAllowingScreenshot

  • startMomentAllowingScreenshot(name: string, allowScreenshot: boolean, identifier?: undefined | string, properties?: Map<string, any>): void
  • Parameters

    • name: string
    • allowScreenshot: boolean
    • Optional identifier: undefined | string
    • Optional properties: Map<string, any>

    Returns void

Const startView

  • startView(view: string): void
  • Parameters

    • view: string

    Returns void

Legend

  • Variable
  • Function

Generated using TypeDoc