Triggering Status Updates

Triggering Status Updates
Prev	Chapter 4. Status Messages	Next

To display a status message you can do so in a similar fashion to displaying a loading message. The difference is that you trigger the infostart.status event, you must include the message to display, and you must specify the type of message.

Each message type will display in a different colour to indicate to the user whether an operation was successful or if some error occurred. The available types are as follows:

Recite_Status.Types.INFO. An informational message.
Recite_Status.Types.SUCCESS. Used to indicate success.
Recite_Status.Types.NOTICE. Used to indicate something worthwhile happened to the user. Typically this status type is used when an item is deleted.
Recite_Status.Types.WARN. Used to display some kind of warning.
Recite_Status.Types.ERR. Used to indicate an error occurred.
Recite_Status.Types.DEBUG. Used to display a debugging message.

For example to trigger a message that indicates success, you might use the following code:

Recite.Delegate.trigger(
   'info.status', 
   {
       msg  : 'Something good happened!', 
       type : Recite_Status.Types.SUCCESS
   }
);