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
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
LxScheduler 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

getParametersAsJSON()

Retrieves the current custom parameters for the canvas app. Parameters are returned as a JSON string.

Signature

public String getParametersAsJSON()

Return Value

Type: String

Usage

Use this method to get the current custom parameters for the canvas app. The parameters are returned in a JSON string that can be de-serialized by using the System.JSON.deserializeUntyped(jsonString) method.

Custom parameters can be modified by using the Canvas.EnvironmentContext.setParametersAsJSON(jsonString) string.

Example

This example gets the current custom parameters, de-serializes them into a map, and prints the results to the debug log.