Class: AlertMessage

iotcs.message.Message.AlertMessage()

Helpers for building alert messages.

Constructor

new AlertMessage()

Classes

Severity

Methods

(static) buildAlertMessage(format, description, severity) → {iotcs.message.Message}

Helper method used for building alert messages to be sent to the server. The severity is defined in the AlertMessage.Severity enumeration. If an invalid value is given an exception is thrown.
Parameters:
Name Type Description
format string The format added in the payload of the generated message.
description string The description added in the payload of the generated message.
severity string The severity added in the payload of the generated message.
See:
Returns:
The instance of the alert message built based on the given parameters, or null if the message could not be built.
Type
iotcs.message.Message

Home