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

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "wsdl_segment"
  ],
  "title": "EmbeddedServiceBranding - Tooling API",
  "description": "Represents branding for each Embedded Service deployment. Available in Tooling API version 39.0 and later.",
  "supported_soap_calls": "`create()`, `delete()`, `describe()`, `query()`, `retrieve()`, `update()`",
  "supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `PUT`, `Query`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ContrastInvertedColor": {
      "type": "string",
      "properties": "Filter, Group, Nillable Sort",
      "description": "Accent branding color used in the embedded component, displayed as a hexadecimal value. Changes made to this field in the API aren’t reflected in the embedded component. Available in API version 43.0 and later."
    },
    "ContrastPrimaryColor": {
      "type": "string",
      "properties": "Filter, Group, Nillable Sort",
      "description": "Accent branding color used in the embedded component, displayed as a hexadecimal value."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The unique name of the branding component. 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."
    },
    "Font": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Font used in the text of the embedded component."
    },
    "FullName": {
      "type": "string",
      "properties": "Create, Group, Nillable",
      "description": "The full name of the associated EmbeddedServiceBranding 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."
    },
    "Language": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The language of the embedded component. 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": "ManageableState enumerated list",
      "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 component."
    },
    "Metadata": {
      "type": "EmbeddedServiceBranding",
      "properties": "Create, Nillable, Update",
      "description": "The embedded service branding'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."
    },
    "NavBarColor": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Color used for the navigation bar in the embedded component."
    },
    "NavBarTextColor": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Color used for the text and icons in the header in the embedded component, displayed as a hexadecimal value. Available in API version 49.0 and later."
    },
    "PrimaryColor": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Primary branding color used in the embedded component."
    },
    "SecondaryColor": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Secondary branding color used in the embedded component."
    },
    "SecondaryNavBarColor": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Secondary branding color used for the header in the embedded component, displayed as a hexadecimal value. It applies to the header in the chat feature when it's trying to reconnect because of lost internet connection. Available in API version 49.0 and later."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"EmbeddedServiceBranding\">\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:EmbeddedServiceBranding\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"EmbeddedServiceBranding\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"contrastInvertedColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"contrastPrimaryColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"embeddedServiceConfig\" type=\"xsd:string\"/>\n        <xsd:element name=\"font\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"height\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"navBarColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"navBarTextColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"primaryColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"secondaryColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"secondaryNavBarColor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"width\" minOccurs=\"0\" type=\"xsd:int\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```"
}