Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Messaging

A class that provides ability to interact with the window.postMessage API.

Under the hood, Remixer is appending an HTML iFrame to the body of a client's page. The main purpose of this Message class is to simply wrap the window.postMessage API to simplify passing messages between the root window and the Remixer iFrame.

Hierarchy

  • Messaging

Index

Properties

Methods

Properties

Static type

type: MessagingType = MessagingType

The avaiable messaging types.

static
type

{MessagingType}

Methods

Static postToFrame

  • Sends a message from main app window to Remixer iFrame window.

    Parameters

    Returns void

Static register

  • register(callback?: Function): void

  • Registers an event listener to allow listening for window messages.

    static

    Parameters

    • Optional callback: Function

      A callback to invoke after registration.

    Returns void

Static unregister

  • unregister(callback?: Function): void

  • Unregisters an event listener that allowed listening for window messages.

    static

    Parameters

    • Optional callback: Function

      A callback to invoke after unregistration.

    Returns void

Generated using TypeDoc