Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
AnalyticsCloudComponentLayoutItem Class
ConsoleComponent Class
Container Class
CustomConsoleComponents Class
CustomMetadata Class
CustomMetadataValue Class
DeployCallback Interface
DeployCallbackContext Class
DeployContainer Class
DeployDetails Class
DeployMessage Class
DeployProblemType Enum
DeployResult Class
DeployStatus Enum
FeedItemTypeEnum Enum
FeedLayout Class
FeedLayoutComponent Class
FeedLayoutComponentType Enum
FeedLayoutFilter Class
FeedLayoutFilterPosition Enum
FeedLayoutFilterType Enum
Layout Class
LayoutColumn Class
LayoutHeader Enum
LayoutItem Class
LayoutSection Class
LayoutSectionStyle Enum
Metadata Class
MetadataType Enum
MetadataValue Class
MiniLayout Class
Operations Class
PlatformActionList Class
PlatformActionListContextEnum Enum
PlatformActionListItem Class
PlatformActionTypeEnum Enum
PrimaryTabComponents Class
QuickActionList Class
QuickActionListItem Class
RelatedContent Class
RelatedContentItem Class
RelatedList Class
RelatedListItem Class
ReportChartComponentLayoutItem Class
ReportChartComponentSize Enum
SidebarComponent Class
SidebarComponent Properties
SidebarComponent Methods
SortOrder Enum
StatusCode Enum
SubtabComponents Class
SummaryLayoutStyleEnum Enum
SummaryLayout Class
SummaryLayoutItem Class
UiBehavior Enum
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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