RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

GlobalSettingsController

The RTU Global Settings Controller Class

Constructor

new GlobalSettingsController()

Source

Methods

static

create(rtuId, objectData) → {Promise.<boolean>}

Create or Update Global Settings [POST /rtus/{rtuId}/global-settings]

Creates or Updates Global Settings

Parameters

  • rtuId number

    The RTU ID

  • objectData Object

    The Object Properties

Returns

  • Promise.<boolean>

Source

static

delete(rtuId, key) → {Promise.<boolean>}

Delete Global Setting [DELETE /rtus/{rtuId}/global-settings/{key}]

Deletes a specific Global Setting

Parameters

  • rtuId number

    The RTU ID

  • key string

    The Global Settings Key

Returns

  • Promise.<boolean>

Source

static

getAll(rtuId) → {Promise.<Object>}

Retrieve all Global Settings [GET /rtus/{rtuId}/global-settings]

Retrieves all Global Settings

Parameters

  • rtuId number

    The RTU ID

Returns

  • Promise.<Object>

Source

static

getOne(rtuId, key) → {Promise.<Object>}

Retrieve Global Setting [GET /rtus/{rtuId}/global-settings/{key}]

Retrieves a specific Global Setting

Parameters

  • rtuId number

    The RTU ID

  • key string

    The Global Settings Key

Returns

  • Promise.<Object>

Source