RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

AlarmGroupController

Controller Class for Alarm Groups

Constructor

new AlarmGroupController()

Source

Methods

static

create(siteId, createData) → {Promise.<AlarmGroupModel>}

Create a Alarm Group [POST /sites/{siteId}/alarm-groups]

Parameters

  • siteId number

    The Site ID

  • createData AlarmGroupController.CreateData

    The Alarm Group Create Data

Returns

  • Promise.<AlarmGroupModel>

Source

static

delete(siteId, id) → {Promise.<boolean>}

Delete a Alarm Group [DELETE /sites/{siteId}/alarm-groups/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Alarm Group ID

Returns

  • Promise.<boolean>

Source

static

getAll(siteId, queryParametersopt) → {Promise.<Array.<AlarmGroupModel>>}

List all Alarm Groups [GET /sites/{siteId}/alarm-groups]

Parameters

  • siteId number

    The Site ID

  • queryParameters AlarmGroupController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<AlarmGroupModel>>

Source

static

getOne(siteId, id) → {Promise.<AlarmGroupModel>}

Retrieve a Alarm Group [GET /sites/{siteId}/alarm-groups/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Alarm Group ID

Returns

  • Promise.<AlarmGroupModel>

Source

static

update(siteId, id, updateData) → {Promise.<AlarmGroupModel>}

Update a Alarm Group [PATCH /sites/{siteId}/alarm-groups/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Alarm Group ID

  • updateData AlarmGroupController.UpdateData

    The Alarm Group Update Data

Returns

  • Promise.<AlarmGroupModel>

Source

Type Definitions

CreateData

The Create Data for a Alarm Group

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Alarm Group belongs to

  • name string

    The Alarm Group Name

  • resetPoint number

    The Boolean Point used to Reset this Alarm Group

  • externalResetPoints Array.<AlarmGroupController.ExternalResetPoint> <optional>

    An Array of Points and the States to be Written when this Alarm Group is Reset

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Alarm Group belongs to

  • name string <optional>

    The Alarm Group Name

  • resetPoint number <optional>

    The Boolean Point used to Reset this Alarm Group

Source

UpdateData

The Update Data for a Alarm Group

Type

  • Object

Properties

  • name string <optional>

    The Alarm Group Name

  • resetPoint number <optional>

    The Boolean Point used to Reset this Alarm Group

  • externalResetPoints Array.<AlarmGroupController.ExternalResetPoint> <optional>

    An Array of Points and the States to be Written when this Alarm Group is Reset

Source