iframes

Documentation

Overview

Package iframes provides abstractions for inter-iframe communication

Index

• func Init()
• func RegisterListener(mtype string, lf ListenerFunc)
• func UnregisterIframe(iframeID string) error
• type ListenerFunc
• type Message
• type Respond
  • func RegisterIframe(iframeID, cardID string) (Respond, error)

Functions

func Init

func Init()

Init installs the event listener to receive messages from iframes.

func RegisterListener

func RegisterListener(mtype string, lf ListenerFunc)

RegisterListener registers a ListnerFunc to receive messages of the given type.

func UnregisterIframe

func UnregisterIframe(iframeID string) error

UnregisterIframe unregisters the iframe. This should be called whenever the iframe is removed from the DOM. Any Respond functions corresponding to this iframe will be invalidated.

Types

type ListenerFunc

type ListenerFunc func(cardID string, payload *js.Object, respond Respond) error

ListenerFunc is a function which responds to a parsed iframe message. It receives the original payload, and a function which may be called with a response to the original iframe.

A ListenerFunc is called as a JS callback, so it may not block.

type Message

type Message struct {
	*js.Object
	Type     string     `js:"type"`
	IframeID string     `js:"iframeID"`
	CardID   string     `js:"cardID"`
	Payload  *js.Object `js:"payload"`
}

Message is a message to be sent to or received from an iframe

type Respond

type Respond func(mtype string, payload interface{}, transferrable ...*js.Object) error

Respond sends a response to the iframe

func RegisterIframe

func RegisterIframe(iframeID, cardID string) (Respond, error)

RegisterIframe associates an iframe ID with a card ID so that requests can be served. A Responder is returned, which may then be used to send messages to the iframe.