Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ApplicationContext Interface
CanvasLifecycleHandler Interface
ContextTypeEnum Enum
EnvironmentContext Interface
EnvironmentContext Methods
addEntityField(fieldName)
addEntityFields(fieldNames)
getDisplayLocation()
getEntityFields()
getLocationUrl()
getParametersAsJSON()
getSublocation()
setParametersAsJSON(jsonString)
RenderContext Interface
Test Class
Canvas Exceptions
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

getSublocation()

Retrieves the display sublocation where the canvas app is being called from.

Signature

public String getSublocation()

Return Value

Type: String

The return value can be one of the following strings:
  • S1MobileCardFullview—The canvas app was called from a mobile card.
  • S1MobileCardPreview—The canvas app was called from a mobile card preview. The user must click the preview to open the app.
  • S1RecordHomePreview—The canvas app was called from a record detail page preview.  The user must click the preview to open the app.
  • S1RecordHomeFullview—The canvas app was called from a page layout.

Usage

Use this method to obtain the display sublocation for the canvas app. Use only if the primary display location can be displayed on mobile devices.