Apex Reference Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
Action Class
Component Class
IdeaStandardController Class
IdeaStandardSetController Class
KnowledgeArticleVersionStandardController Class
Message Class
Message Constructors
Message Methods
StandardController Class
StandardSetController Class
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Message Class

Contains validation errors that occur when the user saves the page that uses a standard controller.

Namespace

ApexPages

Usage

When using a standard controller, all validation errors, both custom and standard, that occur when the user saves the page are automatically added to the page error collections. If an inputField component is bound to the field with an error, the message is added to the component’s error collection. All messages are added to the page’s error collection. For more information, see Validation Rules and Standard Controllers in the Visualforce Developer's Guide.

If your application uses a custom controller or extension, you must use the message class for collecting errors.

Instantiation

In a custom controller or controller extension, you can instantiate a Message in one of these ways:

  • ApexPages.Message myMsg = new ApexPages.Message(ApexPages.severity, summary);

    where ApexPages.severity is the enum that determines how severe a message is, and summary is the String used to summarize the message. For example:

    ApexPages.Message myMsg = new ApexPages.Message(ApexPages.Severity.FATAL, 'my error msg');
  • ApexPages.Message myMsg = new ApexPages.Message(ApexPages.severity, summary, detail);

    where ApexPages. severity is the enum that determines how severe a message is, summary is the String used to summarize the message, and detail is the String used to provide more detailed information about the error.

ApexPages.Severity Enum

To specify the severity of the message, use the ApexPages.Severity enum values. The following are the valid values:
  • CONFIRM
  • ERROR
  • FATAL
  • INFO
  • WARNING

All enums have access to standard methods, such as name and value.

Message Constructors

The following are constructors for Message.

Message(severity, summary)

Creates a new instance of the ApexPages.Message class using the specified message severity and summary.

Signature

public Message(ApexPages.Severity severity, String summary)

Parameters

severity
Type: ApexPages.Severity
The severity of a Visualforce message.
summary
Type: String
The summary Visualforce message.

Message(severity, summary, detail)

Creates a new instance of the ApexPages.Message class using the specified message severity, summary, and message detail.

Signature

public Message(ApexPages.Severity severity, String summary, String detail)

Parameters

severity
Type: ApexPages.Severity
The severity of a Visualforce message.
summary
Type: String
The summary Visualforce message.
detail
Type: String
The detailed Visualforce message.

Message(severity, summary, detail, id)

Creates a new instance of the ApexPages.Message class using the specified severity, summary, detail, and component ID.

Signature

public Message(ApexPages.Severity severity, String summary, String detail, String id)

Parameters

severity
Type: ApexPages.Severity
The severity of a Visualforce message.
summary
Type: String
The summary Visualforce message.
detail
Type: String
The detailed Visualforce message.
id
Type: String
The ID of the Visualforce component to associate with the message, for example, a form field with an error.

Message Methods

The following are methods for Message. All are instance methods.

getComponentLabel()

Returns the label of the associated inputField component. If no label is defined, this method returns null.

Signature

public String getComponentLabel()

Return Value

Type: String

getDetail()

Returns the value of the detail parameter used to create the message. If no detail String was specified, this method returns null.

Signature

public String getDetail()

Return Value

Type: String

getSeverity()

Returns the severity enum used to create the message.

Signature

public ApexPages.Severity getSeverity()

Return Value

Type: ApexPages.Severity

getSummary()

Returns the summary String used to create the message.

Signature

public String getSummary()

Return Value

Type: String