RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

PluginSettingsController

The RTU Plugin Settings Controller Class

Constructor

new PluginSettingsController()

Source

Methods

static

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

Create or Update Plugin Settings [POST /rtus/{rtuId}/plugin-settings/{id}]

Creates or Updates Settings for a Plugin

Parameters

  • rtuId number

    The RTU ID

  • id number

    The Plugin ID

  • objectData Object

    The Object Properties

Returns

  • Promise.<boolean>

Source

static

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

Delete a Plugin Setting [DELETE /rtus/{rtuId}/plugin-settings/{id}/{key}]

Deletes a specific Plugin Setting

Parameters

  • rtuId number

    The RTU ID

  • id number

    The Plugin ID

  • key string

    The Plugin Settings Key

Returns

  • Promise.<boolean>

Source

static

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

Retrieve all Plugin Settings [GET /rtus/{rtuId}/plugin-settings]

Retrieves all Plugin Settings

Parameters

  • rtuId number

    The RTU ID

Returns

  • Promise.<Object>

Source

static

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

Retrieve a Plugin Setting [GET /rtus/{rtuId}/plugin-settings/{id}/{key}]

Retrieves a specific Plugin Setting

Parameters

  • rtuId number

    The RTU ID

  • id number

    The Plugin ID

  • key string

    The Plugin Settings Key

Returns

  • Promise.<Object>

Source

static

getPlugin(rtuId, id) → {Promise.<Object>}

Retrieve Plugin Settings [GET /rtus/{rtuId}/plugin-settings/{id}]

Retrieves all Settings for a Plugin

Parameters

  • rtuId number

    The RTU ID

  • id number

    The Plugin ID

Returns

  • Promise.<Object>

Source