PolicyManagement | @signageos/sdk

Hierarchy

PolicyManagement

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PolicyManagement(options: IOptions): PolicyManagement

- Defined in src/RestApi/Policy/PolicyManagement.ts:9
Parameters
- options: IOptions
Returns PolicyManagement

Properties

Private options

options: IOptions

Static Readonly RESOURCE

RESOURCE: string = "policy"

Methods

archive

archive(policyUid: string): Promise<void>

- Defined in src/RestApi/Policy/PolicyManagement.ts:42
Parameters
- policyUid: string
Returns Promise<void>

clone

clone(policyUid: string, settings: IPolicyClonable): Promise<Policy>

- Defined in src/RestApi/Policy/PolicyManagement.ts:33
Parameters
- policyUid: string
- settings: IPolicyClonable
Returns Promise<Policy>

create

create(settings: IPolicyCreatable): Promise<Policy>

- Defined in src/RestApi/Policy/PolicyManagement.ts:24
Parameters
- settings: IPolicyCreatable
Returns Promise<Policy>

Private extractLocationFromHeader

extractLocationFromHeader(headers: Headers, message: string): Promise<Policy>

- Defined in src/RestApi/Policy/PolicyManagement.ts:50
Parameters
- headers: Headers
- message: string
Returns Promise<Policy>

get

get(policyUid: string): Promise<Policy>

- Defined in src/RestApi/Policy/PolicyManagement.ts:19
Parameters
- policyUid: string
Returns Promise<Policy>

list

list(filter?: IPolicyFilter): Promise<Policy[]>

- Defined in src/RestApi/Policy/PolicyManagement.ts:13
Parameters
- Default value filter: IPolicyFilter = {}
Returns Promise<Policy[]>

set

set(policyUid: string, settings: IPolicyUpdatable): Promise<void>

- Defined in src/RestApi/Policy/PolicyManagement.ts:29
Parameters
- policyUid: string
- settings: IPolicyUpdatable
Returns Promise<void>

unarchive

unarchive(policyUid: string): Promise<void>

- Defined in src/RestApi/Policy/PolicyManagement.ts:46
Parameters
- policyUid: string
Returns Promise<void>

Generated using TypeDoc