Wix.Dashboard

closeWindow

Closes the modal endpoint.

Syntax:

1
closeWindow(\[message\])

Parameters:

Example:

1
var  message = {"reason": "button-clicked"};
2
Wix.Dashboard.closeWindow(message);

getEditorUrl

Retrieves a URL for the app in the Editor. If your app is installed on more than one page, the first page that contains your app will be opened. If the user didn’t install the Site component yet, this will return a URL to the Wix Editor that will open the App Market with your app in pending.

Syntax:

1
getEditorUrl(callback)

Parameters:

Value passed to callback: The URL that directs users to the app in the Wix Editor. Note that:

• If your app is installed on more than one page, the URL directs to the first page that contains your app.
• If the user didn’t install the Site component yet, the URL directs to the App Market in the Wix Editor, with your app in pending.

Example:

1
Wix.Dashboard.getEditorUrl(function(url) {
2
    //Editor url as a callback parameter
3
});

getProducts

Returns a json with pricing information for all of your app’s packages – premium plans and in-app purchase packages.

Syntax:

1
getProducts(onSuccess, \[onError\])

Parameters:

Example:

1
Wix.Dashboard.getProducts(OnSuccess, OnError);
2

3
//Here is an example of the response
4
"packages": [
5
    {
6
        "id": "Premium1",
7
        "name": "Comments Premium Package",
8
        "price": "4.95",
9
        "is_active": true,
10
        "freeMonth": true,
11
        "currencyCode": "USD",
12
        "currencySymbol": "US$"
13
        "monthly": {
14
            "price": "4.95",
15
            “Link”: "https://premium.wix.com/wix/api/tpaStartPurchase?appInstanceId=aaa-bbb&appDefinitionId=a1a2a-b3b4b&paymentCycle=MONTHLY&vendorProductId=package1"
16
        },
17
        "yearly": {
18
            "price": "3.97",
19
             “Link”: "https://premium.wix.com/wix/api/tpaStartPurchase?appInstanceId=aaa-bbb&appDefinitionId=a1a2a-b3b4b&paymentCycle=YEARLY&vendorProductId=package2"
20
        },
21
        "oneTime": {
22
            "price": "5.99",
23
             “Link”: "https://premium.wix.com/wix/api/tpaStartPurchase?appInstanceId=aaa-bbb&appDefinitionId=a1a2a-b3b4b&paymentCycle=ONE_TIME&vendorProductId=package3"
24
        },
25
        "bestSellingFeature": "",
26
        "discountPercent": 20
27
    }
28
]

getSiteViewUrl

Retrieves the live site’s base URL.

Syntax:

1
getSiteViewUrl(onSuccess)

Parameters:

Value passed to callback:

An object with the base URL of the live site. For example: {base : “http://www.wix.com”}

Example:

1
var onSuccess = function(data) {
2
    // do something with base url
3
};
4

5
Wix.Dashboard.getSiteViewUrl(onSuccess);

openBillingPage

Allows the app to open the Wix billing page.

Syntax:

1
openBillingPage( )

Example:

1
Wix.Dashboard.openBillingPage();

openMediaDialog

This method opens the Wix Media Manager, which allows users to choose an existing item from the Wix media galleries or upload a new file.

Once the user selects a media item, a callback function returns a metadata descriptor with details about it.

To access the media item, use one of the Wix.Utils.Media.get* methods to construct the item’s full URL. You’ll need the item’s relativeUri, which is returned in the callback function.

Syntax:

1
openMediaDialog(mediaType, multiSelect, onSuccess, \[onCancel\])

Parameters:

Value passed to onSuccess callback:

An object or an array of objects (for multiple media items).

Each object contains metadata about a specific media item.

Example:

1
Wix.Dashboard.openMediaDialog(Wix.Settings.MediaType.IMAGE, false, 
2
    function(data) {
3
        let imageurl = Wix.Utils.Media.getImageUrl(data.relativeUri);
4
    }
5
);

openModal

Opens a lightbox-style modal window over your app in the Wix Dashboard. You can only open this modal from the Wix Dashboard.

Here’s how the modal works:

• The modal is a singleton – every new modal closes the previous one.
• Users can close the modal by clicking the lightbox or pressing the close button. You can close the modal by calling Wix.closeWindow from within the modal iframe.

Syntax:

1
openModal(url, width, height, \[onClose\], \[theme\])

Parameters:

Example:

1
var onClose = function(message) { console.log("modal closed", message); }
2

3
Wix.Dashboard.openModal("https://static.parastorage.com/services/js-sdk/1.90.0/HTML/modal.HTML", 400, 400, onClose);

pushState

Enables AJAX style Page apps to inform the Wix platform about a change in the app internal state. The new state will be reflected in the site/page URL. Once you call the pushState method, the browser’s top window URL will change the ‘app-state’ path part to the new state you provide with the pushState method (similar to the browser history API). Read more about deep linking for a full explanation.

Syntax:

1
pushState(state)

Parameters:

Example:

1
Wix.Dashboard.pushState("app-state");

revalidateSession

Verifies that the session is secure. If the session is secure, this method returns a newly-signed app instance.

Use this method before displaying sensitive information or performing an action that requires a secure session.

Syntax:

1
revalidateSession(onSuccess, \[onFailure\])

Parameters:

Example:

1
Wix.Dashboard.revalidateSession(
2
    function(instanceData){
3
        //handle success use-case
4
    },  
5
    function(error){
6
        //Handle error use-case
7
    }
8
);

Deprecated

openModal

Opens a lightbox-style modal window over your app in the Wix Dashboard. You can only open this modal from the Wix Dashboard.

Here’s how the modal works:

• The modal is a singleton – every new modal closes the previous one.
• Users can close the modal by clicking the lightbox or pressing the close button. You can close the modal by calling Wix.closeWindow from within the modal iframe.

Syntax:

1
openModal(url, width, height, \[onClose\], \[theme\])

Parameters:

Example:

1
var onClose = function(message) { console.log("modal closed", message); }
2

3
Wix.Dashboard.openModal("https://static.parastorage.com/services/js-sdk/1.90.0/HTML/modal.HTML", 400, 400, onClose);

setHeight (height)

Requests the hosting Wix platform to change the iframe’s height inside the side dashboard

Parameters:

Example:

1
Wix.Dashboard.setHeight(height);