SidebarComponent Class

Represents a specific custom console component to display in a container that hosts multiple components in one of the sidebars of the Salesforce console.

Namespace

Metadata

Usage

Use this class when accessing Metadata.Layout metadata components. For more information, see “SidebarComponent” in the Metadata API Developer Guide.

SidebarComponent Properties

The following are properties for SidebarComponent.

componentType

Specifies the component type. Valid values are “KnowledgeOne”, “Lookup”, “Milestones”, “RelatedList”, “Topics”, “Files”, and “CaseExperts”.

Signature

public String componentType {get; set;}

Property Value

Type: String

createAction

If the component is a lookup field, the name of the quick action used to create a record.

Signature

public String createAction {get; set;}

Property Value

Type: String

enableLinking

If the component is a lookup field, lets users associate a record with this field.

Signature

public Boolean enableLinking {get; set;}

Property Value

Type: Boolean

height

The height of the component in the container. The unit property determines the unit of measurement, in pixels or percent.

Signature

public Integer height {get; set;}

Property Value

Type: Integer

knowledgeOneEnable

Indicates if the component is enabled for Knowledge One.

Signature

public Boolean knowledgeOneEnable {get; set;}

Property Value

Type: Boolean

label

The name of the component as it displays to console users. Available for components in a container with the style of tabs or accordion.

Signature

public String label {get; set;}

Property Value

Type: String

lookup

If the component is a lookup field, the name of the field.

Signature

public String lookup {get; set;}

Property Value

Type: String

page_x

If the component is a Visualforce page, the name of the Visualforce page.

Signature

public String page_x {get; set;}

Property Value

Type: String

relatedLists

If the component is a related list component, the list of related list names.

Signature

public List<Metadata.RelatedList> relatedLists {get; set;}

Property Value

Type: List<Metadata.RelatedList>

unit

The unit of measurement (pixels or percent) for the height and width of the component in the container.

Signature

public String unit {get; set;}

Property Value

Type: String

updateAction

If the component is a lookup field, the name of the quick action used to update a record.

Signature

public String updateAction {get; set;}

Property Value

Type: String

width

The width of the component in the container. The unit property determines the unit of measurement, in pixels or percent.

Signature

public Integer width {get; set;}

Property Value

Type: Integer

SidebarComponent Methods

The following are methods for SidebarComponent.

clone()

Makes a duplicate copy of the Metadata.SidebarComponent.

Signature

public Object clone()

Return Value

Type: Object