confirmAlarm

[ Function ]

public static confirmAlarm(
    alarm: Events.Alarm,
    callback?: (data: TcHmi.IResultObject) => void
): void;

Acknowledges an alarm.

Parameter

Name

Type

Description

alarm

Alarm

The alarm to be acknowledged

callback [ optional ]

(data: TcHmi.IResultObject) => void

Asynchronous callback function that is triggered once the action is completed.

Return value

Type

Description

void

No return value

Sample - JavaScript

TcHmi.Server.Events.confirmAlarm(myAlarms[0], function (data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Success
    } else {
        // Error
    }
});
confirmAlarm 1:

Available from version 1.10