Retrieves the display location where
the canvas app is being called from. For example, a value of Visualforce indicates that the canvas app was called from a Visualforce page.
Signature
public String getDisplayLocation()
Return Value
Type: String
The return value can be one of the following strings:
- Chatter—The canvas app was called from the Chatter tab.
- ChatterFeed—The canvas app was called from a Chatter canvas feed item.
- MobileNav—The canvas app was called from the navigation
menu in Salesforce1.
- OpenCTI—The canvas app was called from an Open CTI component.
- PageLayout—The canvas app was called from an element within
a page layout. If the displayLocation is PageLayout, one of the subLocation
values might be returned.
- Publisher—The canvas app was called from a canvas custom quick action.
- ServiceDesk—The canvas app was called from a Salesforce Console component.
- Visualforce—The canvas app was called from a Visualforce page.
- None—The canvas app was called from the Canvas App Previewer.
Usage
Use this method to obtain
the display location for the canvas app.