Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Glue42Api

Provides full and comprehensive run-time access to the Glue42 Plugin.

Hierarchy

  • Glue42Api

Index

Methods

clearGlue42InternalState

  • clearGlue42InternalState(): void

getCurrentLiveGlue42Report

getGlue42Schedules

getGlue42State

isGlue42Available

  • isGlue42Available(): boolean

isGlue42Running

  • isGlue42Running(): boolean
  • Returns true if the Glue42 plugin is loaded AND the user has logged into Glue42

    Returns boolean

loginToGlue42

  • loginToGlue42(userName: string, password: string): void
  • Logs in the User to Glue42 using the given UserName and Password

    Parameters

    • userName: string

      userName of Glue42 user

    • password: string

      password of Glue42 user

    Returns void

logoutFromGlue42

  • logoutFromGlue42(): void

sendSnapshotToDo

  • Starts a Snapshot as opposed to a Live report

    Note: This is not available in AdapTable version 7

    Parameters

    Returns void

setGlue42AvailableOff

  • setGlue42AvailableOff(): void

setGlue42AvailableOn

  • setGlue42AvailableOn(): void

setGlue42LoginErrorMessage

  • setGlue42LoginErrorMessage(loginErrorMessage: string): void
  • Sets an Error Message returned from Glue42 if login fails

    For internal use only

    Parameters

    • loginErrorMessage: string

      errorMessage to display

    Returns void

setGlue42RunningOff

  • setGlue42RunningOff(): void

setGlue42RunningOn

  • setGlue42RunningOn(): void

startLiveData

  • Starts a "Live" report (ie. one which updates as the data ticks)

    Note: This is not available in AdapTable version 7

    Parameters

    • glue42Report: Glue42Report

      report to run in Live Data mode

    Returns void

stopLiveData

  • stopLiveData(): void
  • Stops a "Live" report (ie. one which updates as the data ticks)

    Note: This is not available in AdapTable version 7

    Returns void

Generated using TypeDoc