Messages (DEPRECATED)

Message is no longer supported. Use Flag instead.

Messages are the primary method for providing system feedback in the product user interface. Messages include notifications of various kinds: alerts, confirmations, notices, warnings, info and errors.

For visual examples of each kind please see the Design guide.

Example

1
2
3
4
5
AP.require("messages", function(messages){
  //create a message
  var message = messages.info('plain text title', 'plain text body');
});

Classes

MessageOptions

Properties

NameTypeDescription
closeableBooleanAdds a control allowing the user to close the message, removing it from the page
fadeoutBooleanToggles the fade away on the message
delay Number Time to wait (in ms) before starting fadeout animation (ignored if fadeout==false)
durationNumberFadeout animation duration in milliseconds (ignored if fadeout==false)

Methods

clear (id)

Clear a message.

Parameters

NameTypeDescription
idStringThe ID that was returned when the message was created

Example

1
2
AP.require("messages", function(messages){
  //create a message
  var message = messages.info('title', 'body');
  setTimeout(function(){
    messages.clear(message);
  }, 2000);
});

error (title, body, options)

Show an error message.

Parameters

NameTypeDescription
titleStringSets the title text of the message
bodyStringThe main content of the message
optionsMessageOptionsMessage Options

Returns: the ID to be used when clearing the message; String.

Example

1
2
AP.require("messages", function(messages){
  //create a message
  var message = messages.error('title', 'error message example');
});

generic (title, body, options)

Show a generic message.

Parameters

NameTypeDescription
title String Sets the title text of the message
bodyStringThe main content of the message
optionsMessageOptionsMessage Options

Returns: the ID to be used when clearing the message; String.

Example

1
2
AP.require("messages", function(messages){
  //create a message
  var message = messages.generic('title', 'generic message example');
});

hint (title, body, options) → {String}

Show a hint message.

Parameters

NameTypeDescription
titleStringSets the title text of the message
bodyStringThe main content of the message
options MessageOptions Message Options

Returns: the ID to be used when clearing the message; String.

Example

1
2
AP.require("messages", function(messages){
  //create a message
  var message = messages.hint('title', 'hint message example');
});

info (title, body, options) → {String}

Show an info message.

Parameters

NameTypeDescription
titleStringSets the title text of the message
bodyStringThe main content of the message
optionsMessageOptionsMessage Options

Returns: the ID to be used when clearing the message; String.

Example

1
2
AP.require("messages", function(messages){
  //create a message
  var message = messages.info('title', 'info message example');
});

success (title, body, options)

Show a success message.

Parameters

NameTypeDescription
titleStringSets the title text of the message
bodyStringThe main content of the message
optionsMessageOptionsMessage Options

Returns: the ID to be used when clearing the message; String.

Example

1
2
AP.require("messages", function(messages){
  //create a message
  var message = messages.success('title', 'success message example');
});

warning (title, body, options) → {String}

Show a warning message.

Parameters

NameTypeDescription
titleStringSets the title text of the message
bodyStringThe main content of the message
optionsMessageOptions

Message Options

Returns: the ID to be used when clearing the message; String.

Example

1
2
AP.require("messages", function(messages){
  //create a message
  var message = messages.warning('title', 'warning message example');
});

Rate this page: