EngineSystemsService | @acaengine/ts-client

Hierarchy

EngineResourceService<EngineSystem>
- EngineSystemsService

Implements

ResourceService<EngineSystem>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new EngineSystemsService(http: EngineHttpClient): EngineSystemsService

Overrides EngineResourceService.constructor
- Defined in http/services/systems/systems.service.ts:12
Parameters
- http: EngineHttpClient
Returns EngineSystemsService

Properties

Protected _api_route

_api_route: string

API Route of the service

Protected _initialised

_initialised: boolean = false

Whether the service has initialised or not

Protected _intervals

_intervals: {}

Store for named intervals

Type declaration

[name: string]: number

Protected _last_total

_last_total: number = 0

Total number of items returned by the last index query

Protected _name

_name: string

Display name of the service

Protected _observers

_observers: {}

Map of observables for state variables

Type declaration

[key: string]: Observable<any>

Protected _promises

_promises: {}

Map of promises for Service

Type declaration

[key: string]: Promise<any>

Protected _subjects

_subjects: {}

Map of state variables for Service

Type declaration

[key: string]: BehaviorSubject<any> | Subject<any>

Protected _subscribers

_subscribers: {}

Map of poll subscribers for API endpoints

Type declaration

[key: string]: Subscriber<any>

Protected _subscriptions

_subscriptions: {}

Store for named subscription unsub callbacks

Type declaration

[name: string]: Subscription | (() => void)

Protected _timers

_timers: {}

Store for named timers

Type declaration

[name: string]: number

Protected _total

_total: number = 0

Total number of items returned by the last basic index query

Protected http

http: EngineHttpClient

Accessors

api_route

get api_route(): string

Inherited from EngineResourceService.api_route
- Defined in http/services/resources/resources.service.ts:19
API Route of the service

Returns string

initialised

get initialised(): boolean

Inherited from EngineResourceService.initialised
- Defined in http/services/resources/resources.service.ts:14
Whether service has been initialised

Returns boolean

last_total

get last_total(): number

Inherited from EngineResourceService.last_total
- Defined in http/services/resources/resources.service.ts:29
Total number of items returned by the last basic index query

Returns number

total

get total(): number

Inherited from EngineResourceService.total
- Defined in http/services/resources/resources.service.ts:24
Total number of items returned by the last basic index query

Returns number

Methods

add

add(form_data: HashMap, query_params?: HashMap): Promise<EngineSystem>

Inherited from EngineResourceService.add
- Defined in http/services/resources/resources.service.ts:138
Make post request for a new item to the service

Parameters
- form_data: HashMap
  
  Data to post to the server
- Default value query_params: HashMap = {}
  
  Map of query paramaters to add to the request URL
Returns Promise<EngineSystem>

Protected clearInterval

clearInterval(name: string): void

Inherited from EngineBaseClass.clearInterval
- Defined in utilities/base.class.ts:90
Clears the named interval

Parameters
- name: string
  
  Timer name
Returns void

Protected clearTimeout

clearTimeout(name: string): void

Inherited from EngineBaseClass.clearTimeout
- Defined in utilities/base.class.ts:60
Clears the named timer

Parameters
- name: string
  
  Timer name
Returns void

count

count(id: string, module: string): Promise<{ count: number }>

- Defined in http/services/systems/systems.service.ts:108
Occurances of a particular type of module in the given system

Parameters
- id: string
  
  System ID
- module: string
  
  Class name of the Module e.g. Display, Lighting etc.
Returns Promise<{ count: number }>

delete

delete(id: string, query_params?: HashMap): Promise<void>

Inherited from EngineResourceService.delete
- Defined in http/services/resources/resources.service.ts:284
Make delete request for the given item

Parameters
- id: string
  
  ID of item
- Default value query_params: HashMap = {}
Returns Promise<void>

destroy

destroy(): void

Inherited from EngineBaseClass.destroy
- Defined in utilities/base.class.ts:13
Perform any cleanup actions needed before the item is deleted

Returns void

execute

execute(id: string, module: string, index?: number, args?: any[]): Promise<HashMap>

- Defined in http/services/systems/systems.service.ts:69
Execute a function of the given system module

Parameters
- id: string
  
  System ID
- module: string
  
  Class name of the Module e.g. Display, Lighting etc.
- Default value index: number = 1
  
  Module index. Defaults to 1
- Default value args: any[] = []
  
  Array of arguments to pass to the executed method
Returns Promise<HashMap>

functionList

functionList(id: string, module: string, index?: number): Promise<EngineModuleFunctionMap>

- Defined in http/services/systems/systems.service.ts:95
Get the list of functions for the given system module

Parameters
- id: string
  
  System ID
- module: string
  
  Class name of the Module e.g. Display, Lighting etc.
- Default value index: number = 1
  
  Module index. Defaults to 1
Returns Promise<EngineModuleFunctionMap>

Protected interval

interval(name: string, fn: () => void, delay?: number): void

Inherited from EngineBaseClass.interval
- Defined in utilities/base.class.ts:73
Creates a named interval

Parameters
- name: string
  
  Name of the interval
- fn: () => void
  
  Callback function for the interval
  - - (): void
    - Returns void
- Default value delay: number = 300
  
  Callback delay
Returns void

poll

poll(id?: undefined | string, query_params?: HashMap, delay?: number): Observable<EngineSystem | EngineSystem[]>

Inherited from EngineResourceService.poll
- Defined in http/services/resources/resources.service.ts:206
Setup a poller for an index or show API endpoint

Parameters
- Optional id: undefined | string
  
  Show request ID. Leave blank to poll on the query endpoint
- Default value query_params: HashMap = {}
  
  Map of query paramaters to add to the polled URL
- Default value delay: number = 5000
  
  Delay between each poll event. Defaults to 5000 ms
Returns Observable<EngineSystem | EngineSystem[]>

Protected process

process(item: HashMap): EngineSystem

Overrides EngineResourceService.process
- Defined in http/services/systems/systems.service.ts:124
Convert API data into local interface

Parameters
- item: HashMap
  
  Raw API data
Returns EngineSystem

query

query(query_params?: EngineSystemsQueryOptions): Promise<EngineSystem[]>

Overrides EngineResourceService.query
- Defined in http/services/systems/systems.service.ts:24
Query the index of the API route associated with this service

Parameters
- Optional query_params: EngineSystemsQueryOptions
  
  Map of query paramaters to add to the request URL
Returns Promise<EngineSystem[]>

remove

remove(id: string, module_id: string): Promise<void>

- Defined in http/services/systems/systems.service.ts:42
Remove module from the given system

Parameters
- id: string
  
  System ID
- module_id: string
  
  ID of the module to remove
Returns Promise<void>

show

show(id: string, query_params?: EngineSystemShowOptions): Promise<EngineSystem>

Overrides EngineResourceService.show
- Defined in http/services/systems/systems.service.ts:33
Query the API route for a sepecific item

Parameters
- id: string
  
  ID of the item
- Optional query_params: EngineSystemShowOptions
  
  Map of query paramaters to add to the request URL
Returns Promise<EngineSystem>

start

start(id: string): Promise<void>

- Defined in http/services/systems/systems.service.ts:50
Start the given system and clears any existing caches

Parameters
- id: string
  
  System ID
Returns Promise<void>

state

state(id: string, module: string, index?: number, lookup?: undefined | string): Promise<HashMap>

- Defined in http/services/systems/systems.service.ts:85
Get the state of the given system module

Parameters
- id: string
  
  System ID
- module: string
  
  Class name of the Module e.g. Display, Lighting etc.
- Default value index: number = 1
  
  Module index. Defaults to 1
- Optional lookup: undefined | string
  
  Status variable of interest. If set it will return only the state of this variable
Returns Promise<HashMap>

stop

stop(id: string): Promise<void>

- Defined in http/services/systems/systems.service.ts:58
Stops all modules in the given system

Parameters
- id: string
  
  System ID
Returns Promise<void>

stopPoll

stopPoll(id?: undefined | string, query_params?: HashMap): void

Inherited from EngineResourceService.stopPoll
- Defined in http/services/resources/resources.service.ts:240
Destroy poller

Parameters
- Optional id: undefined | string
  
  ID used for poll creation
- Default value query_params: HashMap = {}
  
  Map of query parameters used for poll creation
Returns void

Protected subscription

subscription(name: string, unsub: Subscription | (() => void)): void

Inherited from EngineBaseClass.subscription
- Defined in utilities/base.class.ts:102
Store named subscription

Parameters
- name: string
  
  Name of the subscription
- unsub: Subscription | (() => void)
  
  Unsubscribe callback or Subscription object
Returns void

task

task<U>(id: string, task_name: string, form_data?: HashMap, method?: "post" | "get"): Promise<U>

Inherited from EngineResourceService.task
- Defined in http/services/resources/resources.service.ts:166
Perform API task for the given item ID

Type parameters
- U
Parameters
- id: string
  
  ID of the item
- task_name: string
  
  Name of the task
- Default value form_data: HashMap = {}
  
  Map of data to pass to the API
- Default value method: "post" | "get" = "post"
  
  Verb to use for request
Returns Promise<U>

Protected timeout

timeout(name: string, fn: () => void, delay?: number): void

Inherited from EngineBaseClass.timeout
- Defined in utilities/base.class.ts:40
Creates a named timer

Parameters
- name: string
  
  Name of the timer
- fn: () => void
  
  Callback function for the timer
  - - (): void
    - Returns void
- Default value delay: number = 300
  
  Callback delay
Returns void

types

types(id: string): Promise<HashMap<number>>

- Defined in http/services/systems/systems.service.ts:116
List types of modules and counts in the given system

Parameters
- id: string
  
  System ID
Returns Promise<HashMap<number>>

Protected unsub

unsub(name: string): void

Inherited from EngineBaseClass.unsub
- Defined in utilities/base.class.ts:111
Call unsubscribe callback with the given name

Parameters
- name: string
  
  Name of the subscription
Returns void

update

update(id: string, form_data: HashMap, query_params?: HashMap, type?: "put" | "patch"): Promise<EngineSystem>

Inherited from EngineResourceService.update
- Defined in http/services/resources/resources.service.ts:256
Make put request for changes to the item with the given id

Parameters
- id: string
  
  ID of the item being updated
- form_data: HashMap
  
  New values for the item
- Default value query_params: HashMap = {}
  
  Map of query paramaters to add to the request URL
- Default value type: "put" | "patch" = "patch"
Returns Promise<EngineSystem>

Generated using TypeDoc

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

http: EngineHttpClient

Returns EngineSystemsService

Properties

Protected _api_route

Protected _initialised

Protected _intervals

Type declaration

[name: string]: number

Protected _last_total

Protected _name

Protected _observers

Type declaration

[key: string]: Observable<any>

Protected _promises

Type declaration

[key: string]: Promise<any>

Protected _subjects

Type declaration

[key: string]: BehaviorSubject<any> | Subject<any>

Protected _subscribers

Type declaration

[key: string]: Subscriber<any>

Protected _subscriptions

Type declaration

[name: string]: Subscription | (() => void)

Protected _timers

Type declaration

[name: string]: number

Protected _total

Protected http

Accessors

api_route

Returns string

initialised

Returns boolean

last_total

Returns number

total

Returns number

Methods

add

Parameters

form_data: HashMap

Default value query_params: HashMap = {}

Returns Promise<EngineSystem>

Protected clearInterval

Parameters

name: string

Returns void

Protected clearTimeout

Parameters

name: string

Returns void

count

Parameters

id: string

module: string

Returns Promise<{ count: number }>

delete

Parameters

id: string

Default value query_params: HashMap = {}

Returns Promise<void>

destroy

Returns void

execute

Parameters

id: string

module: string

Default value index: number = 1