Skip to content

Commit

Permalink
Publish corrections in wix-application
Browse files Browse the repository at this point in the history 
* DocWorks for wix-application - 11 changes detected
changes:
Service wix-application operation getAppPageUrl has changed param pageId doc
Service wix-application operation getAppPageUrl.examples[0] has changed body
Service wix-application operation getDecodedAppInstance.examples[0] has changed body
Service wix-application operation openAppLightbox has changed return doc
Service wix-application operation openAppLightbox has changed description
Service wix-application operation openAppLightbox.examples[1] has changed body
Service wix-application operation openAppLightbox.examples[2] has changed title
Service wix-application operation openAppLightbox.examples[2] has changed body
Service wix-application operation openAppLightbox.examples[3] has changed title
Service wix-application operation openAppLightbox.examples[3] has changed body
Service wix-application message decodedAppInstance member expirationDate was removed

* Update wix-application.service.json

fixed typo

---------

Co-authored-by: daphneta <daphnet@wix.com>
Co-authored-by: daphneta <81904486+daphneta@users.noreply.github.com>
  • Loading branch information
@wix-docs-feds @daphneta
3 people authored Oct 2, 2023
1 parent e6337b4 commit 117fc8a
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions wix-application/wix-application.service.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@
"params":
[ { "name": "pageId",
"type": "string",
"doc": "The ID of the new page on which the widget is added, as defined in the Installation Settings." } ],
"doc": "The ID of the specified on which the widget is added, as defined in the Installation Settings." } ],
"ret":
{ "type":
{ "name": "Promise",
"typeParams":
[ "string" ] },
"doc": "Fulfilled - The page URL." },
"locations":
[ { "lineno": 50,
[ { "lineno": 37,
"filename": "application.js" } ],
"docs":
{ "summary": "Gets the URL of the new page that was added by a Blocks app, when installed on a site.",
Expand All @@ -55,11 +55,12 @@
"//...",
"",
"const url = await wixApplication.getAppPageUrl('Page ID');",
"\tif (!url) {",
"\t\tconsole.log('I CANNOT GO THERE'); ",
"\t\treturn;",
"\t}",
"\twixLocation.to(url);" ],
"",
"if (url) {",
"wixLocation.to(url);",
"} else {console.log(\"Page doesn't exist\"); ",
"return;",
"}" ],
"extra":
{ } } ],
"extra":
Expand Down Expand Up @@ -89,7 +90,7 @@
"examples":
[ { "title": "Retrieve the Vendor Product ID",
"body":
[ "import wixApplication from 'wix-application'",
[ "import wixApplication from 'wix-application';",
"",
"// ...",
"",
Expand Down Expand Up @@ -118,14 +119,14 @@
{ "name": "Promise",
"typeParams":
[ "Object" ] },
"doc": "Fulfilled - The returned data from the lightbox. Rejected - the error that caused the rejection." },
"doc": "Fulfilled - The returned data from the lightbox." },
"locations":
[ { "lineno": 63,
[ { "lineno": 50,
"filename": "application.js" } ],
"docs":
{ "summary": "Opens a lightbox that was added to a site by the Blocks app, during the app installation process and optionally passes it data.",
"description":
[ "The `openAppLightbox()` function returns a Promise that resolves to an object with data from the lightbox. Use it when a widget is installed as a lightbox. ",
[ "The `openAppLightbox()` function returns a Promise that resolves to an object with data from the lightbox, when the lightbox is closed. Use it when a widget is installed as a lightbox. ",
"Learn more about [app and widget installation settings](https://support.wix.com/en/article/wix-blocks-app-and-widget-installation-settings). ",
"",
"Note that to pass data back to the page that opened the lightbox, you must close the",
Expand Down Expand Up @@ -153,30 +154,32 @@
"",
"// ...",
"",
"const dataObj = {title: \"Widget Title\"};",
"wixApplication.openLightbox(\"lightboxId\", dataObj);" ],
"extra":
{ } },
{ "title": "Open a lightbox and receive data when it closed",
{ "title": "Open a lightbox and receive data when it closes",
"body":
[ "import wixApplication from 'wix-application';",
"",
"// ...",
"",
"wixApplication.openLightbox(\"lightboxId\")",
" .then( (data) => {",
" let receivedData = data;",
" .then( (data) => { ",
" let receivedData = data; // When the lightbox is closed, it returns this data",
" } );" ],
"extra":
{ } },
{ "title": "Open a lightbox, send it data and receive data back when it closed",
{ "title": "Open a lightbox, send it data and receive data back when it closes",
"body":
[ "import wixApplication from 'wix-application';",
"",
"// ...",
"",
"const dataObj = {title: \"My Title\"};",
"wixApplication.openLightbox(\"ligthboxId\", dataObj)",
" .then( (data) => {",
" let receivedData = data;",
" let receivedData = data; // When the lightbox is closed, it returns this data. ",
" } );" ],
"extra":
{ } } ],
Expand Down Expand Up @@ -205,12 +208,10 @@
"doc": "The ID of your app on this specific site." },
{ "name": "vendorProductId",
"type": "string",
"doc": "The Plan ID of the app purchased by the site." },
{ "name": "expirationDate",
"type": "string",
"doc": "The plan's expiration date." } ],
"doc": "The Plan ID of the app purchased by the site." } ],
"extra":
{ },
"labels": [] } ],
"labels":
[ "changed" ] } ],
"extra":
{ } }
{ } }

0 comments on commit 117fc8a

Please sign in to comment.