PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Fix comments.

Browse source
This commit is contained in:
Richard Lewis 2017-12-19 17:11:36 +00:00
parent 8e5c3f01b4
commit 536d4efc40
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/WidgetMessaging.js
View file

@ -54,7 +54,7 @@ The "message" key should be a human-friendly string.
INBOUND ACTIONS INBOUND ACTIONS
=============== ===============
** All actions must include an "api" field with valie "widget".** ** All actions must include an "api" field with value of "widget".**
All actions can return an error response instead of the response outlined below. All actions can return an error response instead of the response outlined below.
content_loaded content_loaded
@ -66,7 +66,7 @@ Request:
- No additional fields. - No additional fields.
Response: Response:
{ {
success: true success: "true"
} }
Example: Example:
{ {
@ -114,7 +114,7 @@ OUTBOUND ACTIONS
================ ================
In addition to listening for inbound requests, the API can be used to initiate In addition to listening for inbound requests, the API can be used to initiate
actionss in the widget iframe, and request data from the widget instance. actions in the widget iframe, and request data from the widget instance.
Outbound actions use the "widget_client" API key / name, which must be included Outbound actions use the "widget_client" API key / name, which must be included
on all requests. on all requests.
@ -135,11 +135,13 @@ Request a screenshot from the widget (if supported).
This can only be supported by widgets that have access to all of their DOM tree. This can only be supported by widgets that have access to all of their DOM tree.
For example, widgets that nest further levels of iframes can not support this. For example, widgets that nest further levels of iframes can not support this.
The screenshot is returned as a Blob object.
Request: Request:
- No additional fields. - No additional fields.
Response: Response:
{ {
screenshot: {data...} screenshot: {<Blob>data...}
} }
Example: Example:
{ {