afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/FunctionReference.json

53 lines
3.9 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"usage"
],
"title": "FunctionReference - Data API",
"description": "Represents a deployed Salesforce Function associated with an org. This object is available in API version 52.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Access": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The label for whether managed components can access across namespaces. Possible values are: Global—The managed components can access across namespaces. Public—The managed components can access within the same namespace. The default value is Public."
},
"Description": {
"type": "textarea",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The description of the Function."
},
"FunctionName": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The developer name of the Function. This name is case sensitive and uses the format “project name-function name”. This field is unique within your organization."
},
"ImageReference": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "Stores details about an image associated with a function. This is internal only, used by packaging only, and should not be editable or set by the customer."
},
"Language": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The language code for the Function, such as “en_US”."
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The master label for the Function."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace prefix that is associated with this object. This object is available in API version 53.0 and later. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This fields value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
}
},
"usage": "Treat FunctionReference records as read-only records used to get information about a specific Function associated with your org. To invoke Functions, use the Apex functions.Function class invoke methods. To deploy and associate Functions with your org, use Salesforce CLI commands associated with Functions, as described in the Salesforce Functions developer documentation. FunctionReference is not supported in Trialforce templates or org snapshots.\n\nTreat FunctionReference records as read-only records used to get information about a specific Function associated with your org. To invoke Functions, use the Apex functions.Function class invoke methods. To deploy and associate Functions with your org, use Salesforce CLI commands associated with Functions, as described in the Salesforce Functions developer documentation.\n\nFunctionReference is not supported in Trialforce templates or org snapshots."
}