Interface AlarmRaiseOptions

interface AlarmRaiseOptions {
    message: string;
    state: ALARM_STATE;
    context?: Context;
    data?: Record<string, Value>;
    idInPath?: boolean;
    includeCreatedAt?: boolean;
    includePosition?: boolean;
    path?: Path;
}

Properties

message: string

Message to display or speak

Alarm State value to apply

context?: Context

Context to assign to the Notification (default = self)

data?: Record<string, Value>

Additional information provided in key | value pairs

idInPath?: boolean

Set true to append the notificationId to the Notification path (default = false)

includeCreatedAt?: boolean

Set true to include the time in the Notification (default = false)

includePosition?: boolean

Set true to include the vessel position in the Notification (default = false)

path?: Path

Path to assign to the Notification (default = notifications.{notificationId})