1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/ui Modules
  6. N/ui/message Module
  7. message.Type

message.Type

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.x documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Enum Description

Indicates the type of message to create, which specifies the background color of the message and other message indicators when the message is displayed.

Use this enum to set the value of the options.type parameter of the message.create(options) method.

Module

N/ui/message Module

Sibling Module Members

N/ui/message Members

Since

2016.1

Values

Value

Display characteristcs

CONFIRMATION

A green background with a checkmark icon.

This is an image of a Confirmation message.

INFORMATION

A blue background with an Information icon.

This is an image of an Information message.

WARNING

A yellow background with a Warning icon.

This is an image of a Warning message.

ERROR

A red background with an X icon.

This is an image of an Error message.

Syntax

Important:

The following code snippet shows the syntax for this member. It is not a functional example. For a complete script example, see N/ui/message Module Script Sample.

                 //Add additional code 
       ...
     var myMsg = message.create({
        title: "My Title", 
        message: "My Message", 
        type: message.Type.CONFIRMATION
    });
    myMsg.show();
    ...
       //Add additional code

General Notices