Options
All
  • Public
  • Public/Protected
  • All
Menu

This module exposes utilities that can be used to embed individual Aiera modules into another web application via iframe.

Exposed into the global context as window.Aiera.Module.

Hierarchy

  • Module

Index

Constructors

  • new Module(modulePath: string, frameId: string): Module
  • Parameters

    • modulePath: string

      The URL for the embeddable module

    • frameId: string

      the id of the iframe in which to load the module, must be present in the document when load() is called

    Returns Module

Methods

  • load(): Promise<void>
  • Loads the module into the given iframe and sets up messaging between the frame and the parent window.

    Returns Promise<void>

    A promise that is resolved when the module is loaded into the frame.

  • Emit's an event into the module. Only use this if there is no dedicated method for the action you are taking.

    For example, prefer module.authenticate(...) on module.emit('authenticate', ...)

    Type Parameters

    Parameters

    Returns void

  • This method can be used to pass auth tokens directly to the module to bypass the login screen for a user.

    You must hit the login API on your own to exchange username/password credentials for user auth tokens which can then be passed here.

    See web/embed for more detailed examples.

    Parameters

    Returns void

  • authenticateApiKey(apiKey: string): void
  • configure(config: Config): void
  • This method can be used to pass a config object directly to the module

    Generally it should be used in the .load().then(-here-) callback so the settings are used from initialization

    Parameters

    Returns void

  • downloadScreenshot(): void
  • seekTranscriptSeconds(seconds: number): void
  • seekTranscriptTimestamp(timestamp: string): void
  • unload(): void

Generated using TypeDoc