afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/EmbeddedServiceMenuSettings.json

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "special_access_rules",
    "wsdl_segment"
  ],
  "title": "EmbeddedServiceMenuSettings - Tooling API",
  "description": "Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This object is available in API version 47.0 and later.",
  "supported_soap_calls": "`create()`, `delete()`, `describeLayout()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "BrandingId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The developer name of the associated BrandingSet."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The unique name for the embedded service menu settings. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "FullName": {
      "type": "string",
      "properties": "Create, Group, Nillable",
      "description": "The full name of the associated EmbeddedServiceMenuSettings in Metadata API. The full name can include a namespaceprefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
    },
    "IsEnabled": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Specifies whether the channel menu is deployed (true) or not (false)."
    },
    "Language": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The language of the embedded service menu. Possible values are: ar—Arabic da—Danish de—German en_US—English es—Spanish fi—Finnish fr—French iw—Hebrew ja—Japanese ko—Korean nl_BE—Dutch (Belgium) no—Norwegian pt_BR—Portuguese (Brazil) ru—Russian sv—Swedish th—Thai ur—Urdu zh_CN—Chinese (Simplified) zh_TW—Chinese (Traditional)"
    },
    "ManageableState": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "Label for the embedded service menu setting. In the UI, this field is Channel Menu Deployment Name."
    },
    "Metadata": {
      "type": "EmbeddedServiceMenuSettings",
      "properties": "Create, Nillable, Update",
      "description": "The EmbeddedServiceMenuSettings's metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix that is associated with this object. 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 field’s 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."
    }
  },
  "special_access_rules": "This type is available only if Salesforce Experiences and Salesforce Sites are enabled in your org. To access this type, you need the Customize Application user permission.",
  "wsdl_segment": "```xml\n<xsd:complexType name=\"EmbeddedServiceMenuSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:EmbeddedServiceMenuSettings\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"EmbeddedServiceMenuSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"branding\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"isEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"masterLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"site\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```"
}