IMessenger | Matterport SDK
Usage of the SDK constitutes your agreement with the Matterport SDK Agreement. Email developers@matterport.com with any questions.

A messaging object to send and receive messages to and from your iframe sandbox.

Hierarchy

  • IMessenger

Index

Methods

Methods

off

  • off(eventType: string, eventHandler: function): void

  • Remove a handler for messages of type eventType from the iframe sandbox

    Parameters

    • eventType: string
    • eventHandler: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

on

  • on(eventType: string, eventHandler: function): void

  • Add a handler for messages of type eventType from the iframe sandbox

    Parameters

    • eventType: string
    • eventHandler: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

send

  • send(eventType: string, ...args: any[]): void

  • Send a messages of type eventType to the iframe sandbox with any optional data associated with the message

    Parameters

    • eventType: string
    • Rest ...args: any[]

    Returns void