Variable: EmbedMessage

const EmbedMessage: object;

Iframe message names, prefixed with ridge: to distinguish them from other window messages. Grouped by direction: messages sent by the host page, then messages sent by the embed.

Type Declaration

error

readonly error: "ridge:error" = "ridge:error";

embed → host: a state update was rejected and did not take effect.

Sent once per rejected component id. Other updates in the batch may succeed. setState does not send a separate reply.

getState

readonly getState: "ridge:getState" = "ridge:getState";

host → embed: ask for the current state.

getStateSchema

readonly getStateSchema: "ridge:getStateSchema" = "ridge:getStateSchema";

host → embed: ask for the complete component state schema.

ready

readonly ready: "ridge:ready" = "ridge:ready";

embed → host: ready to receive state requests, with the complete state schema.

setState

readonly setState: "ridge:setState" = "ridge:setState";

host → embed: merge this state, per id and per key. null clears a key.

state

readonly state: "ridge:state" = "ridge:state";

embed → host: reply to getState.

stateChange

readonly stateChange: "ridge:stateChange" = "ridge:stateChange";

embed → host: state changed through a user edit or a non-silent setState.

stateSchema

readonly stateSchema: "ridge:stateSchema" = "ridge:stateSchema";

embed → host: reply to getStateSchema.