Application

The Application object is a JSON-formatted object returned by the signed request in the Context object. The Application object contains specific canvas app information obtained after you’ve added your app as a connected app in Salesforce from Setup by entering Connected Apps in the Quick Find box, then selecting Connected Apps.

FieldDescription
applicationIdThe ID of the canvas app.
authTypeThe access method of the canvas app. You specify this value when you expose the canvas app by creating a connected app.
canvasUrlThe URL of the canvas app, for example: http://instance.salesforce.com:8080/canvas_app_path/canvas_app.jsp.
developerNameThe internal name of the canvas app. You specify this value in the API Name field when you expose the canvas app by creating a connected app.
nameThe name of the canvas app.
namespaceThe Salesforce namespace prefix associated with the canvas app.
optionsAn array that can contain one, two, or three of these values:
  • HideHeader—Hides the publisher header which contains the “What are you working on?” text. This value is only used when the canvas app appears in the publisher.
  • HideShare—Hides the publisher Share button. This value is only used when the canvas app appears in the publisher.
  • PersonalEnabled—Enables the canvas app to be installed by users as a canvas personal app.
referenceIdThe unique ID of the canvas app definition. Used internally.
versionThe version of the canvas app. This value changes after you update and re-publish a canvas app in an organization.

The following code snippet shows an example of the Application object.

1"application": 
2{
3    "applicationId":"06Px000000003ed", 
4    "authType":"SIGNED_REQUEST", 
5    "canvasUrl":"http://instance.salesforce.com:8080/canvas_app_path/canvas_app.jsp", 
6    "developerName":"my_java_app",    
7    "isInstalledPersonalApp": false, 
8    "name":"My Java App", 
9    "namespace":"org_namespace", 
10    "options":["HideShare", "HideHeader"],
11    "referenceId":"09HD00000000AUM", 
12    "samlInitiationMethod":"None",
13    "version":"1.0.0"
14}

See Also