LocationManagement | @signageos/sdk

Hierarchy

LocationManagement

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new LocationManagement(options: IOptions): LocationManagement

- Defined in src/RestApi/Location/LocationManagement.ts:12
Parameters
- options: IOptions
Returns LocationManagement

Properties

Private options

options: IOptions

Methods

addAttachment

addAttachment(uid: ILocation["uid"], attachment: Buffer): Promise<void>

- Defined in src/RestApi/Location/LocationManagement.ts:49
Parameters
- uid: ILocation["uid"]
- attachment: Buffer
  
  Buffer. Accept only file with extension .png, jpeg, .jpg or .gif
Returns Promise<void>

create

create(location: ILocationCreate): Promise<Location>

- Defined in src/RestApi/Location/LocationManagement.ts:15
Parameters
- location: ILocationCreate
Returns Promise<Location>

delete

delete(uid: ILocation["uid"]): Promise<void>

- Defined in src/RestApi/Location/LocationManagement.ts:69
Parameters
- uid: ILocation["uid"]
Returns Promise<void>

get

get(uid: ILocation["uid"], filter?: ILocationFilter): Promise<Location>

- Defined in src/RestApi/Location/LocationManagement.ts:36
Parameters
- uid: ILocation["uid"]
- Default value filter: ILocationFilter = {}
Returns Promise<Location>

list

list(filter?: ILocationFilter): Promise<Location[]>

- Defined in src/RestApi/Location/LocationManagement.ts:29
Parameters
- Default value filter: ILocationFilter = {}
Returns Promise<Location[]>

removeAttachments

removeAttachments(uid: ILocation["uid"], attachments: ILocation["attachments"]): Promise<void>

- Defined in src/RestApi/Location/LocationManagement.ts:61
Parameters
- uid: ILocation["uid"]
- attachments: ILocation["attachments"]
  
  string[]. Attachments must be taken from the Location entity. And can't be anyhow edited
Returns Promise<void>

update

update(uid: ILocation["uid"], location: ILocationUpdate): Promise<void>

- Defined in src/RestApi/Location/LocationManagement.ts:42
Parameters
- uid: ILocation["uid"]
- location: ILocationUpdate
Returns Promise<void>

Generated using TypeDoc