HomePageComponent

Represents a home page component.

Version 

Introduced in API version 35.0.

Supported SOAP API Calls 

describeSObjects(), query(), retrieve(), search()

Supported REST API Methods 

GET, HEAD, Query

Fields 

Body 

• Type: textarea

• Required: No

• Properties: Nillable

• Description: If this component is an HTML page component, this field is the body of the HTML.

Height 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Required for Visualforce Area components. Indicates the height (in pixels) of the component.

ManageableState 

• Type: picklist

• Required: No

• 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

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Name 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: The name of the home page component.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A unique string to distinguish this type from any others.

ShowLabel 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: ID of the home page layout.

• Default value: false

ShowScrollbars 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: ID of the home page layout.

• Default value: false