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

192 lines
8.5 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"wsdl_segment",
"field_reference"
],
"title": "ChatterExtension - Data API",
"description": "Represents a Rich Publisher App thats integrated with the Chatter publisher. This object is available in API version 41.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"CompositionComponentEnumOrId": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The ID of the composition component for the Rich Publisher App. This field requires a value."
},
"Description": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The description of your custom Rich Publisher App. This field requires a value."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The name of the developer who is responsible for the app. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"ExtensionName": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of your extension. This field requires a value."
},
"HeaderText": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The text to show in the header of your app composer. Header text is required for Lightning type extensions."
},
"HoverText": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The text to show when a user mouses over your extensions icon. Mouse-over text is required for Lightning type extensions."
},
"IconId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The icon to show in the Chatter publisher. Use an existing file asset ID from your org. This field requires a value. This is a relationship field.",
"relationship_name": "Icon",
"relationship_type": "Lookup",
"refers_to": "ContentAsset"
},
"IsProtected": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "An auto-generated value. It currently has no impact."
},
"Language": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The language used for this instance of the ChatterExtension. This field requires a value."
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The master label for the ChatterExtension object. This field requires a value."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The prefix to use for the extensions namespace."
},
"RenderComponentEnumOrId": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The rendering component of the Rich Publisher App that you provide. Its comprised of the lightning:availableForChatterExtensionRenderer interface. This field requires a value."
},
"Type": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "Describes the type of the extension. Currently, the only value supported is Lightning. Included to allow for other possible types in the future."
}
},
"wsdl_segment": "```xml\n<complexType name=\"ChatterExtension\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"CompositionComponentEnumOrId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ExtensionName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"HeaderText\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"HoverText\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Icon\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContentAsset\"/>\n <element name=\"IconId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsProtected\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Language\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"RenderComponentEnumOrId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Type\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n```",
"field_reference": {
"CompositionComponentEnumOrId": {
"field_label": "Aura Component Bundle ID",
"type": "picklist",
"length": "255"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Description": {
"field_label": "Description",
"type": "string",
"length": "255"
},
"DeveloperName": {
"field_label": "Name",
"type": "string",
"length": "80"
},
"ExtensionName": {
"field_label": "Name",
"type": "string",
"length": "32"
},
"HeaderText": {
"field_label": "Header Text",
"type": "string",
"length": "255"
},
"HoverText": {
"field_label": "Hover Text",
"type": "string",
"length": "255"
},
"IconId": {
"field_label": "Asset File ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Extension ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsProtected": {
"field_label": "Protected Component",
"type": "boolean"
},
"Language": {
"field_label": "Master Language",
"type": "picklist",
"length": "40"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"MasterLabel": {
"field_label": "Label",
"type": "string",
"length": "80"
},
"NamespacePrefix": {
"field_label": "Namespace Prefix",
"type": "string",
"length": "15"
},
"RenderComponentEnumOrId": {
"field_label": "Aura Component Bundle ID",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Type": {
"field_label": "Type",
"type": "picklist",
"length": "255"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}