Note
All code samples below refer to the skuid object.
In the v2 API, this object is not directly accessible when working within a browser console—or when referring to another Skuid page runtime.
If you are experiencing issues, use the skuid.runtime API to target the appropriate page context.
skuid.page¶
Good news, everyone!
We are currently writing more material for our Javascript API. All of the objects and functions you see below are part of Skuid’s public API, even if they aren’t fully documented yet. Feel free to experiment while we write about them—and check back later for updates.
Properties¶
-
skuid.page.currentSiteUrl¶ String
This value will vary depending on your platform of choice.
Skuid SFX The URL of the Force.com site or Salesforce community in which the Skuid page is running, up to and including the prefix—but not the information following it.
E.g. https://exampleorg.na30.force.com/partners/apex/SkuidCommunity would return https://exampleorg.na30.force.com/partners/.
Skuid NLX The URL of Skuid site in which the Skuid page is running, without including any app or route information.
E.g. https://example.skuidsite.com/marketing/calendar would return https://example.skuidsite.com.
Used to calculate the $Site.CurrentSiteUrl merge variable. Related to the $Site.CurrentSiteUrl Visualforce API.
-
skuid.page.editable¶ Boolean
Indicates whether the current user can edit this page.
-
skuid.page.id¶ String
The Salesforce Record ID for this page.
-
skuid.page.name¶ String
The name of the current page.
-
skuid.page.sitePrefix¶ String
The prefix for the Force.com site or community in which the Skuid page is running.
E.g. https://exampleorg.na30.force.com/partners/apex/SkuidCommunity would return /partners.
Used to calculate to the $Site.Prefix global merge variable. Related to the $Site.Prefix Visualforce API.
Note
This property will not return a value if the Skuid page isn’t running on a Force.com site or community—even when previewing the page from the Composer.