Matrix/element-web-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2024-11-16 21:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update API data docs.

Browse Source
This commit is contained in:
Richard Lewis 2017-12-04 18:06:05 +00:00
parent df1fa80ff6
commit 8595053d28
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/WidgetMessaging.js
View File

@ -19,16 +19,18 @@ Listens for incoming postMessage requests from embedded widgets. The following A
{
api: "widget",
action: "content_loaded",
widgetId: $WIDGET_ID,
data: {}
// additional request fields
widgetId: $WIDGET_ID
}
The complete request object is returned to the caller with an additional "response" key like so:
{
api: "widget",
action: "content_loaded",
widgetId: $WIDGET_ID,
data: {},
// additional request fields
widgetId: $WIDGET_ID
response: { ... }
}
@ -36,6 +38,8 @@ The "api" field is required to use this API, and must be set to "widget" in all
The "action" determines the format of the request and response. All actions can return an error response.
Additional data can be sent as additional, abritrary fields. However, typically the data object should be used.
A success response is an object with zero or more keys.
An error response is a "response" object which consists of a sole "error" key to indicate an error.
@ -209,6 +213,7 @@ function onMessage(event) {
const action = event.data.action;
const widgetId = event.data.widgetId;
if (action === 'content_loaded') {
console.warn("Widget content loaded", widgetId);
dis.dispatch({
action: 'widget_content_loaded',
widgetId: widgetId,