From 536d4efc4059127c6e407524436e1ea034057a99 Mon Sep 17 00:00:00 2001 From: Richard Lewis Date: Tue, 19 Dec 2017 17:11:36 +0000 Subject: [PATCH] Fix comments. --- src/WidgetMessaging.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/WidgetMessaging.js b/src/WidgetMessaging.js index d71d86f8f5..2ca8589b54 100644 --- a/src/WidgetMessaging.js +++ b/src/WidgetMessaging.js @@ -54,7 +54,7 @@ The "message" key should be a human-friendly string. 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. content_loaded @@ -66,7 +66,7 @@ Request: - No additional fields. Response: { - success: true + success: "true" } Example: { @@ -114,7 +114,7 @@ OUTBOUND ACTIONS ================ 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 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. For example, widgets that nest further levels of iframes can not support this. +The screenshot is returned as a Blob object. + Request: - No additional fields. Response: { - screenshot: {data...} + screenshot: {data...} } Example: {