Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bugfender

Hierarchy

  • Bugfender

Index

Methods

error

  • error(obj: any, ...objs: any): void
  • error(msg: string, ...subst: any): void
  • Parameters

    • obj: any

      A JavaScript value to output

    • Rest ...objs: any

      List of optional JavaScript values to output

    Returns void

  • String message with optional substitutions. This mimicks que the window.console template messages. Learn more in MDN.

    Parameters

    • msg: string

      Message with optional % placeholders

    • Rest ...subst: any

      Optional substitutions list

    Returns void

fatal

  • fatal(obj: any, ...objs: any): void
  • fatal(msg: string, ...subst: any): void
  • Parameters

    • obj: any

      A JavaScript value to output

    • Rest ...objs: any

      List of optional JavaScript values to output

    Returns void

  • String message with optional substitutions. This mimicks que the window.console template messages. Learn more in MDN.

    Parameters

    • msg: string

      Message with optional % placeholders

    • Rest ...subst: any

      Optional substitutions list

    Returns void

getDeviceURL

  • getDeviceURL(): string
  • Returns string

    Bugfender dashboard URL for the device

getSessionURL

  • getSessionURL(): string
  • Returns string

    Bugfender dashboard URL for the current session

info

  • info(obj: any, ...objs: any): void
  • info(msg: string, ...subst: any): void
  • Parameters

    • obj: any

      A JavaScript value to output

    • Rest ...objs: any

      List of optional JavaScript values to output

    Returns void

  • String message with optional substitutions. This mimicks que the window.console template messages. Learn more in MDN.

    Parameters

    • msg: string

      Message with optional % placeholders

    • Rest ...subst: any

      Optional substitutions list

    Returns void

init

  • Initialize Bugfender SDK

    Before calling any other method the SDK must be initilized using this method. Only after initialization the global error handler (registerErrorHandler) and window.console overrides (overrideConsoleMethods) will be available.

    Parameters

    • options: ISDKOptions

      Options object. The only required property is appKey.

    Returns Promise<void>

log

  • log(obj: any, ...objs: any): void
  • log(msg: string, ...subst: any): void
  • Parameters

    • obj: any

      A JavaScript value to output

    • Rest ...objs: any

      List of optional JavaScript values to output

    Returns void

  • String message with optional substitutions. This mimicks que the window.console template messages. Learn more in MDN.

    Parameters

    • msg: string

      Message with optional % placeholders

    • Rest ...subst: any

      Optional substitutions list

    Returns void

removeDeviceKey

  • removeDeviceKey(key: string): void
  • Remove a device associated key-value pair. Learn more.

    Parameters

    • key: string

      Key identifier

    Returns void

sendCrash

  • sendCrash(title: string, text: string): string
  • Send a crash report.

    Parameters

    • title: string

      Title

    • text: string

      Text content

    Returns string

    Bugfender dashboard URL for the crash.

sendIssue

  • sendIssue(title: string, text: string): string
  • Send an issue.

    Parameters

    • title: string

      Title

    • text: string

      Text content

    Returns string

    Bugfender dashboard URL for the issue.

sendIssueMarkdown

  • sendIssueMarkdown(title: string, markdown: string): string
  • Send issue with content in markdown format.

    Parameters

    • title: string

      Title

    • markdown: string

      Content in markdown format

    Returns string

    Bugfender dashboard URL for the issue.

sendLog

  • Use this method if you need more control over the data sent while logging. See ILogEntry interface reference to see all the accepted properties.

    Parameters

    • log: ILogEntry

      Log object that complies with ILogEntry interface.

    Returns void

sendUserFeedback

  • sendUserFeedback(title: string, markdown: string): string
  • Send an user feedback.

    Parameters

    • title: string

      Title/Subject

    • markdown: string

      Feedback text in markdown format

    Returns string

    Bugfender dashboard URL for the feedback.

setDeviceKey

  • setDeviceKey(key: string, value: DeviceKeyValue): void
  • Set a device associated key-value pair. Learn more.

    Parameters

    • key: string

      Key identifier.

    • value: DeviceKeyValue

      Value.

    Returns void

trace

  • trace(obj: any, ...objs: any): void
  • trace(msg: string, ...subst: any): void
  • Parameters

    • obj: any

      A JavaScript value to output

    • Rest ...objs: any

      List of optional JavaScript values to output

    Returns void

  • String message with optional substitutions. This mimicks que the window.console template messages. Learn more in MDN.

    Parameters

    • msg: string

      Message with optional % placeholders

    • Rest ...subst: any

      Optional substitutions list

    Returns void

warn

  • warn(obj: any, ...objs: any): void
  • warn(msg: string, ...subst: any): void
  • Parameters

    • obj: any

      A JavaScript value to output

    • Rest ...objs: any

      List of optional JavaScript values to output

    Returns void

  • String message with optional substitutions. This mimicks que the window.console template messages. Learn more in MDN.

    Parameters

    • msg: string

      Message with optional % placeholders

    • Rest ...subst: any

      Optional substitutions list

    Returns void

Generated using TypeDoc