AlertRulesManagement | @signageos/sdk

Hierarchy

AlertRulesManagement

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new AlertRulesManagement(options: IOptions): AlertRulesManagement

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:9
Parameters
- options: IOptions
Returns AlertRulesManagement

Properties

Protected options

options: IOptions

Methods

archive

archive(alertRuleUid: string): Promise<void>

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:42
Parameters
- alertRuleUid: string
Returns Promise<void>

create

create(settings: IAlertRuleCreatable): Promise<IAlertRule>

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:25
Parameters
- settings: IAlertRuleCreatable
Returns Promise<IAlertRule>

get

get(alertRuleUid: string): Promise<IAlertRule>

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:19
Parameters
- alertRuleUid: string
Returns Promise<IAlertRule>

list

list(filter?: IAlertRuleFilter): Promise<IAlertRule[]>

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:13
Parameters
- Default value filter: IAlertRuleFilter = {}
Returns Promise<IAlertRule[]>

pause

pause(alertRuleUid: string): Promise<void>

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:46
Parameters
- alertRuleUid: string
Returns Promise<void>

unpause

unpause(alertRuleUid: string): Promise<void>

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:50
Parameters
- alertRuleUid: string
Returns Promise<void>

update

update(alertRuleUid: string, settings: IAlertRuleUpdateable): Promise<void>

- Defined in src/RestApi/Alerts/Rules/AlertRulesManagement.ts:38
Parameters
- alertRuleUid: string
- settings: IAlertRuleUpdateable
Returns Promise<void>

Generated using TypeDoc