Web SDK documentation
  1. Pipes
  2. AuditChangesMessagePipe

File

alarms/audit-changes-message.pipe.ts

Description

A pipe for transforming audit record data into localized messages. It specifically addresses changes in the audit records, with an emphasis on status changes.

Metadata

Name auditChangesMessage

Methods

transform
transform(record: IAuditRecord)

Transforms an IAuditRecord into a localized string message. If the record contains changes, and if the first change is related to the 'status' attribute, it formats a message indicating the status change. Otherwise, it returns a general activity message. Example when there is a status change: "Alarm status changed from ACKNOWLEDGED to ACTIVE". Example when record does not have a status attribute: "Alarm updated".

Example :
              particularly focusing on status changes if applicable.
Parameters :
Name Type Optional Description
record IAuditRecord No
  • The audit record to be transformed.
Returns : string

The localized message describing the audit record, particularly focusing on status changes if applicable.

results matching ""

    No results matching ""