@aurahelper/languages

{ "id": "Canvas.environmentcontext", "nodeType": "interface", "name": "EnvironmentContext", "namespace": "Canvas", "startToken": { "type": "declaration.entity.name.class", "text": "EnvironmentContext", "textToLower": "environmentcontext", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.class_EnvironmentContext_-1:0" }, "order": 0, "memberOrder": 0, "accessModifier": { "type": "keyword.modifier.access", "text": "global", "textToLower": "global", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "keyword.modifier.access_global_-1:0" }, "sharingModifier": { "type": "keyword.modifier.sharing", "text": "without sharing", "textToLower": "without sharing", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "keyword.modifier.sharing_without sharing_-1:0" }, "description": "Use this interface to retrieve environment context information, such as the app display location or the configuration parameters.", "documentation": "https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_interface_canvas_EnvironmentContext.htm", "classes": {}, "interfaces": {}, "enums": {}, "variables": {}, "methods": { "addentityfield(string)": { "id": "Canvas.environmentcontext.method.addentityfield(string)", "nodeType": "method", "name": "addEntityField", "startToken": { "type": "declaration.entity.name.function", "text": "addEntityField", "textToLower": "addentityfield", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_addEntityField_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 1, "memberOrder": 1, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public void addEntityField(String fieldName)", "overrideSignature": "public override void addEntityField(String fieldName)", "simplifiedSignature": "addEntityField(String)", "datatype": { "id": "Canvas.environmentcontext.addentityfield.datatype.void", "nodeType": "datatype", "name": "void", "startToken": { "type": "datatype.primitive", "text": "void", "textToLower": "void", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 11 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_void_0:7" }, "parentId": "Canvas.environmentcontext.addentityfield", "order": 0, "memberOrder": 0, "type": "void" }, "description": "Adds a field to the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object.", "parentName": "EnvironmentContext", "variables": {}, "params": { "fieldname": { "id": "Canvas.environmentcontext.method.addentityfield(string).varParam.fieldname", "nodeType": "variable", "name": "fieldName", "startToken": { "type": "declaration.entity.name.variable", "text": "fieldName", "textToLower": "fieldname", "isAux": false, "range": { "start": { "line": 0, "character": 34 }, "end": { "line": 0, "character": 43 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_fieldName_0:34" }, "endToken": { "type": "declaration.entity.name.variable", "text": "fieldName", "textToLower": "fieldname", "isAux": false, "range": { "start": { "line": 0, "character": 34 }, "end": { "line": 0, "character": 43 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_fieldName_0:34" }, "parentId": "Canvas.environmentcontext.method.addentityfield(string)", "order": 1, "memberOrder": 1, "datatype": { "id": "Canvas.environmentcontext.addentityfield.datatype.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 27 }, "end": { "line": 0, "character": 33 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:27" }, "parentId": "Canvas.environmentcontext.addentityfield", "order": 0, "memberOrder": 0, "type": "String" }, "description": "The object field name that you need to add to the list of returned fields., Using ‘*’ adds all fields that the user has permission to view.", "scope": null } }, "queries": [], "exceptions": [] }, "addentityfields(set<string>)": { "id": "Canvas.environmentcontext.method.addentityfields(set<string>)", "nodeType": "method", "name": "addEntityFields", "startToken": { "type": "declaration.entity.name.function", "text": "addEntityFields", "textToLower": "addentityfields", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_addEntityFields_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 2, "memberOrder": 2, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public void addEntityFields(Set<String> fieldNames)", "overrideSignature": "public override void addEntityFields(Set<String> fieldNames)", "simplifiedSignature": "addEntityFields(Set<String>)", "datatype": { "id": "Canvas.environmentcontext.addentityfields.datatype.void", "nodeType": "datatype", "name": "void", "startToken": { "type": "datatype.primitive", "text": "void", "textToLower": "void", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 11 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_void_0:7" }, "parentId": "Canvas.environmentcontext.addentityfields", "order": 0, "memberOrder": 0, "type": "void" }, "description": "Adds a set of fields to the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object.", "parentName": "EnvironmentContext", "variables": {}, "params": { "fieldnames": { "id": "Canvas.environmentcontext.method.addentityfields(set<string>).varParam.fieldnames", "nodeType": "variable", "name": "fieldNames", "startToken": { "type": "declaration.entity.name.variable", "text": "fieldNames", "textToLower": "fieldnames", "isAux": false, "range": { "start": { "line": 0, "character": 40 }, "end": { "line": 0, "character": 50 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_fieldNames_0:40" }, "endToken": { "type": "declaration.entity.name.variable", "text": "fieldNames", "textToLower": "fieldnames", "isAux": false, "range": { "start": { "line": 0, "character": 40 }, "end": { "line": 0, "character": 50 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_fieldNames_0:40" }, "parentId": "Canvas.environmentcontext.method.addentityfields(set<string>)", "order": 1, "memberOrder": 1, "datatype": { "id": "Canvas.environmentcontext.addentityfields.datatype.Set<String>", "nodeType": "datatype", "name": "Set<String>", "startToken": { "type": "datatype.collection", "text": "Set", "textToLower": "set", "isAux": false, "range": { "start": { "line": 0, "character": 28 }, "end": { "line": 0, "character": 31 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_Set_0:28" }, "parentId": "Canvas.environmentcontext.addentityfields", "order": 0, "memberOrder": 0, "type": "Set", "value": { "id": "Canvas.environmentcontext.addentityfields.datatype.Set<String>.value.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 32 }, "end": { "line": 0, "character": 38 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:32" }, "order": 0, "memberOrder": 0, "type": "String" } }, "description": "The set of object field names that you need to add to the list of returned fields. If an item in the set is ‘*’, all fields that the user has permission to view are added.", "scope": null } }, "queries": [], "exceptions": [] }, "getdisplaylocation()": { "id": "Canvas.environmentcontext.method.getdisplaylocation()", "nodeType": "method", "name": "getDisplayLocation", "startToken": { "type": "declaration.entity.name.function", "text": "getDisplayLocation", "textToLower": "getdisplaylocation", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_getDisplayLocation_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 3, "memberOrder": 3, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public String getDisplayLocation()", "overrideSignature": "public override String getDisplayLocation()", "simplifiedSignature": "getDisplayLocation()", "datatype": { "id": "Canvas.environmentcontext.getdisplaylocation.datatype.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 13 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:7" }, "parentId": "Canvas.environmentcontext.getdisplaylocation", "order": 0, "memberOrder": 0, "type": "String" }, "description": "Retrieves the display location where the canvas app is being called from. For example, a value of Visualforce page.", "parentName": "EnvironmentContext", "variables": {}, "params": {}, "queries": [], "exceptions": [] }, "getentityfields()": { "id": "Canvas.environmentcontext.method.getentityfields()", "nodeType": "method", "name": "getEntityFields", "startToken": { "type": "declaration.entity.name.function", "text": "getEntityFields", "textToLower": "getentityfields", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_getEntityFields_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 4, "memberOrder": 4, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public List<String> getEntityFields()", "overrideSignature": "public override List<String> getEntityFields()", "simplifiedSignature": "getEntityFields()", "datatype": { "id": "Canvas.environmentcontext.getentityfields.datatype.List<String>", "nodeType": "datatype", "name": "List<String>", "startToken": { "type": "datatype.collection", "text": "List", "textToLower": "list", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 11 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_List_0:7" }, "parentId": "Canvas.environmentcontext.getentityfields", "order": 0, "memberOrder": 0, "type": "List", "value": { "id": "Canvas.environmentcontext.getentityfields.datatype.List<String>.value.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 12 }, "end": { "line": 0, "character": 18 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:12" }, "order": 0, "memberOrder": 0, "type": "String" } }, "description": "Retrieves the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object.", "parentName": "EnvironmentContext", "variables": {}, "params": {}, "queries": [], "exceptions": [] }, "getlocationurl()": { "id": "Canvas.environmentcontext.method.getlocationurl()", "nodeType": "method", "name": "getLocationUrl", "startToken": { "type": "declaration.entity.name.function", "text": "getLocationUrl", "textToLower": "getlocationurl", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_getLocationUrl_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 5, "memberOrder": 5, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public String getLocationUrl()", "overrideSignature": "public override String getLocationUrl()", "simplifiedSignature": "getLocationUrl()", "datatype": { "id": "Canvas.environmentcontext.getlocationurl.datatype.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 13 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:7" }, "parentId": "Canvas.environmentcontext.getlocationurl", "order": 0, "memberOrder": 0, "type": "String" }, "description": "Retrieves the location URL of the canvas app.", "parentName": "EnvironmentContext", "variables": {}, "params": {}, "queries": [], "exceptions": [] }, "getparametersasjson()": { "id": "Canvas.environmentcontext.method.getparametersasjson()", "nodeType": "method", "name": "getParametersAsJSON", "startToken": { "type": "declaration.entity.name.function", "text": "getParametersAsJSON", "textToLower": "getparametersasjson", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_getParametersAsJSON_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 6, "memberOrder": 6, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public String getParametersAsJSON()", "overrideSignature": "public override String getParametersAsJSON()", "simplifiedSignature": "getParametersAsJSON()", "datatype": { "id": "Canvas.environmentcontext.getparametersasjson.datatype.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 13 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:7" }, "parentId": "Canvas.environmentcontext.getparametersasjson", "order": 0, "memberOrder": 0, "type": "String" }, "description": "Retrieves the current custom parameters for the canvas app. Parameters are returned as a JSON string.", "parentName": "EnvironmentContext", "variables": {}, "params": {}, "queries": [], "exceptions": [] }, "getsublocation()": { "id": "Canvas.environmentcontext.method.getsublocation()", "nodeType": "method", "name": "getSublocation", "startToken": { "type": "declaration.entity.name.function", "text": "getSublocation", "textToLower": "getsublocation", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_getSublocation_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 7, "memberOrder": 7, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public String getSublocation()", "overrideSignature": "public override String getSublocation()", "simplifiedSignature": "getSublocation()", "datatype": { "id": "Canvas.environmentcontext.getsublocation.datatype.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 13 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:7" }, "parentId": "Canvas.environmentcontext.getsublocation", "order": 0, "memberOrder": 0, "type": "String" }, "description": "Retrieves the display sublocation where the canvas app is being called from.", "parentName": "EnvironmentContext", "variables": {}, "params": {}, "queries": [], "exceptions": [] }, "setparametersasjson(string)": { "id": "Canvas.environmentcontext.method.setparametersasjson(string)", "nodeType": "method", "name": "setParametersAsJSON", "startToken": { "type": "declaration.entity.name.function", "text": "setParametersAsJSON", "textToLower": "setparametersasjson", "isAux": false, "range": { "start": { "line": -1, "character": 0 }, "end": { "line": -1, "character": 0 }, "isEmpty": true, "isSingleLine": true }, "id": "declaration.entity.name.function_setParametersAsJSON_-1:0" }, "parentId": "Canvas.environmentcontext", "order": 8, "memberOrder": 8, "accessModifier": { "type": "keyword.modifier.access", "text": "public", "textToLower": "public", "isAux": false, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 0, "character": 6 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_public_0:0" }, "signature": "public void setParametersAsJSON(String jsonString)", "overrideSignature": "public override void setParametersAsJSON(String jsonString)", "simplifiedSignature": "setParametersAsJSON(String)", "datatype": { "id": "Canvas.environmentcontext.setparametersasjson.datatype.void", "nodeType": "datatype", "name": "void", "startToken": { "type": "datatype.primitive", "text": "void", "textToLower": "void", "isAux": false, "range": { "start": { "line": 0, "character": 7 }, "end": { "line": 0, "character": 11 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_void_0:7" }, "parentId": "Canvas.environmentcontext.setparametersasjson", "order": 0, "memberOrder": 0, "type": "void" }, "description": "Sets the custom parameters for the canvas app.", "parentName": "EnvironmentContext", "variables": {}, "params": { "jsonstring": { "id": "Canvas.environmentcontext.method.setparametersasjson(string).varParam.jsonstring", "nodeType": "variable", "name": "jsonString", "startToken": { "type": "declaration.entity.name.variable", "text": "jsonString", "textToLower": "jsonstring", "isAux": false, "range": { "start": { "line": 0, "character": 39 }, "end": { "line": 0, "character": 49 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_jsonString_0:39" }, "endToken": { "type": "declaration.entity.name.variable", "text": "jsonString", "textToLower": "jsonstring", "isAux": false, "range": { "start": { "line": 0, "character": 39 }, "end": { "line": 0, "character": 49 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_jsonString_0:39" }, "parentId": "Canvas.environmentcontext.method.setparametersasjson(string)", "order": 1, "memberOrder": 1, "datatype": { "id": "Canvas.environmentcontext.setparametersasjson.datatype.String", "nodeType": "datatype", "name": "String", "startToken": { "type": "datatype.primitive", "text": "String", "textToLower": "string", "isAux": false, "range": { "start": { "line": 0, "character": 32 }, "end": { "line": 0, "character": 38 }, "isEmpty": false, "isSingleLine": true }, "id": "token.type.identifier_String_0:32" }, "parentId": "Canvas.environmentcontext.setparametersasjson", "order": 0, "memberOrder": 0, "type": "String" }, "description": "The custom parameters that you need to set, serialized into a JSON format string.", "scope": null } }, "queries": [], "exceptions": [] } }, "constructors": {}, "extendsType": "", "implementTypes": [], "implements": {}, "totalMembers": 8, "queries": [] }