Wix.Utils
getCacheKiller
Returns a String which is the cacheKiller query parameter.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getCompId
Returns a String which represents the component’s iframe component ID.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Dashboard, Modal, Popup
Note:
Trying to use this method in the settings endpoint? To get the compId of the component that opened the settings endpoint, use getOrigCompId.
Syntax:
1
Example:
1
getCurrentConsentPolicy
Returns an object containing the user's current policy.
SDK Version: SDK 1.425.0
Display: Live Site
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Important:
Use this method in the live site only. Although it works in the Editor/Preview, and will not return the real policy of the user.
Syntax:
1
Object Data:
1
Example:
1
getDeviceType
Returns a String which represents the current device type: Desktop or Mobile
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getInstanceId
Returns a String which represents the app instance ID.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getInstanceValue
Returns the current value of the requested key. If the key does not exist, null is returned.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getLocale
Returns a String which represents the current locale of the website or editor (en (English), es (Spanish), fr (French), it (Italian), etc.).
SDK Version: SDK 1.14.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
A locale is an abbreviated language tag that defines the user’s language, country and any special variant preference of the user interface (e.g. Number format, Date format, etc.).
Syntax:
1
Example:
1
getOrigCompId
Returns a String which represents the iframe’s component id which opened the App Settings panel.
SDK Version: SDK 1.14.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getPermissions
Returns a String which represents the user’s permissions (decoded property of the instance query parameter).
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getSectionUrl
This method returns the URL of your page component in the live site, for example: mysite.com/my-store-app. You’ll use this URL to build the URLs for the app’s internal pages, for example: mysite.com/my-store-app/product1.
SDK Version: SDK 1.37.0+
Display: Live Site
Components: Page
Use this method if you have a page component and you’re using server-side rendering to create deep links for internal pages.
Syntax:
1
Important:
Use this method in the live site only. Although it works in the Editor/Preview, it returns the URL of the iframe itself – not the page URL in the site.
Parameters:
| Name | Type | Description |
|---|---|---|
| sectionIdentifier | Object | To get the URL of a specific page component, specify its ID (as well as a callback function). If you don’t specify the ID, this method returns the URL of the current page component. |
| sectionIdentifier.sectionId | String | ID of the page component, as specified in the Developers Center |
| callback | Function | (Required if you specified the sectionId) A callback function that returns the URL of the page component (the section-url query parameter). |
Example:
1
getSignDate
Returns a string which represents the signDate of the app instance.
SDK Version: SDK 1.13.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getSiteOwnerId
Returns a string that represents the site owner’s ID.
SDK Version: SDK 1.52.0+
Editor Version: New Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Returns:
The site owner’s ID.
Example:
1
getTarget
Returns a string which is the target query parameter (for the section-url). If it does not exist, returns null.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getUid
Returns a string which represents the user identifier.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Example:
1
getViewMode
Returns a string which represents the current view mode.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Modal, Popup
Syntax:
1
Example:
1
getWidth
Returns a number which represents the iframe’s width.
SDK Version: SDK 1.12.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Modal, Popup
Syntax:
1
Example:
1
navigateToSection
Navigates to your page component – either to the page component itself or to one of your app’s internal pages.
SDK Version: SDK 1.95.0+
Editor Version: New Editor
Display: Live Site, Preview
Components: Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Modal, Popup
To navigate to a widget or fixed-position widget, use Wix.navigateToComponent instead.
Syntax:
1
Parameters:
| Name | Type | Description |
|---|---|---|
| options (required) | Object | ID of the page component to navigate to, as well as optional parameters for this method |
| options.sectionId (required) | String | ID of the page component, as specified in the Developers Center |
| options.appDefinitionId | String | If navigating to a page component in a different app, enter that app’s ID (specified in the Developers Center) |
| options.queryParams | Object | Query parameters to add to the page URL when navigating to it, in key value pairs. For example: {param1:value1, param2:value2,...}. These query params are included in the iframe URL (e.g., ?param1=value1¶m2=value2). |
| options.state | String | The new app's state to push into the editor history stack |
| options.shouldRefreshIframe | Boolean | Indicates if the app iframe should be refreshed when navigating to the page. Default value is true. When queryParams are defined, shouldRefreshIframealways defaults to true. |
| options.noTransition | Boolean | Indicates if there should be a transition when navigating to the page. Default value is false. |
| onFailure (required) | Function | This will be called if the hosting site does not include the section app, or if the caller's application does not include a section |
Example:
1
Note:
This method is not available from the Dashboard endpoint.
getOnConsentPolicyChanged
Retrieves the user's new policy.
SDK Version: SDK 1.425.0
Display: Live Site
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Important:
Use this method in the live site only. Although it may work in the Editor/Preview, it will not give you real data.
Syntax:
1
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | function | Callback function to receive the new policy |
Example:
1
toWixDate
Converts a JavaScript Date object into the correct format, ISO 8601, used by Wix APIs when dealing with dates.
SDK Version: SDK 1.28.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Media.getAudioUrl
Constructs the absolute URL for an audio file in the Wix Media Manager.
SDK Version: SDK 1.17.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Warning:
Use this method each time you access the media item, to prevent broken links.
Parameters:
| Name | Type | Description |
|---|---|---|
| relativeUri (required) | String | URI of the audio item (relative to Wix media gallery) |
Returns:
A full URL pointing to the audio file hosted on Wix static servers.
Example:
1
Media.getDocumentUrl
Constructs a URL for a media item of type document.
SDK Version: SDK 1.17.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Warning:
Use this method each time you access the media item, to prevent broken links.
Parameters:
| Name | Type | Description |
|---|---|---|
| relativeUri (required) | String | Document item uri (relative to Wix media gallery) |
Returns:
A full URL pointing to the Wix static servers of a document media file with the default dimensions.
Example:
1
Media.getImageUrl
Constructs a URL for a media item of type image.
SDK Version: SDK 1.17.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
On the live site, we recommend using Media.getResizedImageUrl instead (for better performance).
Syntax:
1
Warning:
Use this method each time you access the media item, to prevent broken links.
Parameters:
| Name | Type | Description |
|---|---|---|
| Image (required) | String | Item uri (relative to Wix media gallery). |
Returns:
A full URL pointing to the Wix static servers of an image with the default dimensions – width and height.
Example:
1
Media.getResizedImageUrl
Constructs a URL for a media item of type image. You can change the image dimensions as well as its sharpening properties. Learn more about sharpening.
SDK Version: SDK 1.17.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Warning:
Use this method each time you access the media item, to prevent broken links.
Parameters:
| Name | Type | Description |
|---|---|---|
| relativeUrl (required) | String | Static image url provided by the media dialog |
| width (required) | Number | Desired image width |
| height (required) | Number | Desired image height |
| sharpParams | Object | Image sharpening properties |
| sharpParams.quality (required) | Number | JPEG quality, leave as is (75) unless image size is important for your app |
| sharpParams.filter (required) | Number | Resize filter |
| sharpParams.usm_r (required) | Number | Unsharp mask radius |
| sharpParams.usm_a (required) | Number | Unsharp mask amount (percentage) |
| sharpParams.usm_t (required) | Number | Unsharp mask threshold |
Returns:
A full URL pointing to the Wix static servers of an image with the custom dimension parameters.
Example:
1
Media.getSwfUrl
Constructs a URL for a media item of type swf.
SDK Version: SDK 1.17.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Settings Panel, Settings Modal, Dashboard, Modal, Popup
Syntax:
1
Warning:
Use this method each time you access the media item, to prevent broken links.
Parameters:
| Name | Type | Description |
|---|---|---|
| relativeUri (required) | String | Swf item uri (relative to Wix media gallery) |
Returns:
A full URL pointing to the Wix static servers of a swf media file with the default dimensions.
Example:
1
Deprecated
getIpAndPort
Returns a String which represents the app IP and port.
SDK Version: Deprecated
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Wix Dashboard, Widget, Pinned (aka Fixed-Position) Widget, Page, Dashboard, Modal, Popup
Syntax:
1
Example:
1