Message Class
Namespace
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.
- 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)
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)
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)
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()
Signature
public String getComponentLabel()
Return Value
Type: String
getDetail()
Signature
public String getDetail()
Return Value
Type: String
getSeverity()
Signature
public ApexPages.Severity getSeverity()
Return Value
Type: ApexPages.Severity
getSummary()
Signature
public String getSummary()
Return Value
Type: String