Class Monitor

Implements

BasicMonitor

Index

Constructors

Properties

attributes id monitorManager originalAttributes relationships type

Methods

changePausedState load moveToGroup pause resume save

Constructors

constructor

new Monitor(monitorManager, id, attributes, relationships?): Monitor
Parameters
- monitorManager: MonitorManager
- id: string
- attributes: MonitorAttributes
- Optional relationships: MonitorRelationships
Returns Monitor
- Defined in monitors/Monitor.ts:18

Properties

attributes

attributes: MonitorAttributes

`Readonly` id

id: string

`Private` monitorManager

monitorManager: MonitorManager

`Private` originalAttributes

originalAttributes: MonitorAttributes

`Readonly` relationships

relationships: undefined | MonitorRelationships

type

type: "monitor" = ...

Methods

`Private` changePausedState

changePausedState(paused): Promise<void>
Parameters
- paused: boolean
Returns Promise<void>
- Defined in monitors/Monitor.ts:49

load

load(): Promise<boolean>
Loads monitor's attributes fresh from the API

Returns Promise<boolean>
Was the operation succesful?
- Defined in monitors/Monitor.ts:77

moveToGroup

moveToGroup(group): Promise<boolean>
Moves the monitor to a monitor group
Parameters
- group: null | string
  Monitor group ID, or null to remove from group.
Returns Promise<boolean>
- Defined in monitors/Monitor.ts:68

pause

pause(): Promise<boolean>
Pauses the monitoring

Returns Promise<boolean>
- Defined in monitors/Monitor.ts:35

resume

resume(): Promise<boolean>
Resumes the monitoring

Returns Promise<boolean>
- Defined in monitors/Monitor.ts:44

save

save(): Promise<boolean>
Saves changes to the API

Returns Promise<boolean>
Was the operation succesful?
- Defined in monitors/Monitor.ts:91

Generated using TypeDoc