Class IqrfGatewayDaemonService

IQRF Gateway Daemon configuration service

Hierarchy (View Summary)

BaseService
- IqrfGatewayDaemonService

Index

Constructors

constructor

new IqrfGatewayDaemonService(apiClient: Client): IqrfGatewayDaemonService
Constructor
Parameters
- apiClient: Client
  API client
Returns IqrfGatewayDaemonService
Inherited from BaseService.constructor
- Defined in services/BaseService.ts:42

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

createInstance

createInstance<C extends IqrfGatewayDaemonComponentName>(
component: C,
configuration: IqrfGatewayDaemonComponentInstanceConfiguration<C>,
): Promise<void>
Creates new component instance
Type Parameters
- C extends IqrfGatewayDaemonComponentName
  Component name
Parameters
- component: C
  Daemon component name
- configuration: IqrfGatewayDaemonComponentInstanceConfiguration<C>
  Daemon component instance configuration
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:68

createMapping

createMapping(mapping: IqrfGatewayDaemonMapping): Promise<void>
Creates IQRF Gateway Daemon mapping
Parameters
- mapping: IqrfGatewayDaemonMapping
  IQRF Gateway Daemon mapping
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:154

deleteInstance

deleteInstance(
component: IqrfGatewayDaemonComponentName,
instance: string,
): Promise<void>
Deletes component instance
Parameters
- component: IqrfGatewayDaemonComponentName
  Daemon component name
- instance: string
  Daemon component instance name
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:112

deleteMapping

deleteMapping(id: number): Promise<void>
Deletes IQRF Gateway Daemon mapping
Parameters
- id: number
  IQRF Gateway Daemon mapping ID
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:173

exportScheduler

exportScheduler(): Promise<FileResponse<Blob>>
Exports scheduler tasks

Returns Promise<FileResponse<Blob>>
Scheduler task ZIP archive
- Defined in services/Config/IqrfGatewayDaemonService.ts:189

getComponent

getComponent<C extends IqrfGatewayDaemonComponentName>(
component: C,
): Promise<IqrfGatewayDaemonComponent<C>>
Retrieves IQRF Gateway Daemon component configuration and instances
Type Parameters
- C extends IqrfGatewayDaemonComponentName
  Component name
Parameters
- component: C
  Component name
Returns Promise<IqrfGatewayDaemonComponent<C>>
IQRF Gateway Daemon component configuration with instances
- Defined in services/Config/IqrfGatewayDaemonService.ts:54

getConfig

getConfig(): Promise<IqrfGatewayDaemonConfig>
Retrieves IQRF Gateway Daemon main configuration

Returns Promise<IqrfGatewayDaemonConfig>
IQRF Gateway Daemon main configuration
- Defined in services/Config/IqrfGatewayDaemonService.ts:43

getInstance

getInstance<C extends IqrfGatewayDaemonComponentName>(
component: C,
instance: string,
): Promise<IqrfGatewayDaemonComponentInstanceConfiguration<C>>
Retrieves IQRF Gateway Daemon component instance configuration
Type Parameters
- C extends IqrfGatewayDaemonComponentName
  Component name
Parameters
- component: C
  Component name
- instance: string
  Daemon component instance name
Returns Promise<IqrfGatewayDaemonComponentInstanceConfiguration<C>>
IQRF Gateway Daemon component configuration with instances
- Defined in services/Config/IqrfGatewayDaemonService.ts:82

getMapping

getMapping(id: number): Promise<IqrfGatewayDaemonMapping>
Retrieves IQRF Gateway Daemon mapping
Parameters
- id: number
  IQRF Gateway Daemon mapping ID
Returns Promise<IqrfGatewayDaemonMapping>
IQRF Gateway Daemon mapping
- Defined in services/Config/IqrfGatewayDaemonService.ts:144

getSchedulerMessagings

getSchedulerMessagings(): Promise<IqrfGatewayDaemonSchedulerMessagings>
Retrieves scheduler messaging instances

Returns Promise<IqrfGatewayDaemonSchedulerMessagings>
Scheduler task suitable messaging instances
- Defined in services/Config/IqrfGatewayDaemonService.ts:199

importScheduler

importScheduler(data: File): Promise<void>
Imports scheduler tasks
Parameters
- data: File
  Scheduler task JSON file or ZIP archive
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:181

listMappings

listMappings(
interfaceType?: null | MappingType,
): Promise<IqrfGatewayDaemonMapping[]>
Lists IQRF Gateway Daemon mappings
Parameters
- interfaceType: null | MappingType = null
  Mapping interface type
Returns Promise<IqrfGatewayDaemonMapping[]>
IQRF Gateway Daemon mappings
- Defined in services/Config/IqrfGatewayDaemonService.ts:132

updateEnabledComponents

updateEnabledComponents(
components: IqrfGatewayDaemonComponentState[],
): Promise<void>
Updates component(s) state
Parameters
- components: IqrfGatewayDaemonComponentState[]
  Component state configuration
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:123

updateInstance

updateInstance<C extends IqrfGatewayDaemonComponentName>(
    component: C,
    instance: string,
    configuration: IqrfGatewayDaemonComponentInstanceConfiguration<C>,
): Promise<void>
Updates the component instance configuration
Type Parameters
- C extends IqrfGatewayDaemonComponentName
  Component name
Parameters
- component: C
  Daemon component name
- instance: string
  Daemon component instance name
- configuration: IqrfGatewayDaemonComponentInstanceConfiguration<C>
  Daemon component instance configuration
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:98

updateMapping

updateMapping(id: number, mapping: IqrfGatewayDaemonMapping): Promise<void>
Updates IQRF Gateway Daemon mapping
Parameters
- id: number
  IQRF Gateway Daemon mapping ID
- mapping: IqrfGatewayDaemonMapping
  IQRF Gateway Daemon mapping
Returns Promise<void>
- Defined in services/Config/IqrfGatewayDaemonService.ts:164

Class IqrfGatewayDaemonService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IqrfGatewayDaemonService

Properties

Protected ReadonlyapiClient

Protected ReadonlyaxiosInstance

Methods

createInstance

Type Parameters

Parameters

Returns Promise<void>

createMapping

Parameters

Returns Promise<void>

deleteInstance

Parameters

Returns Promise<void>

deleteMapping

Parameters

Returns Promise<void>

exportScheduler

Returns Promise<FileResponse<Blob>>

getComponent

Type Parameters

Parameters

Returns Promise<IqrfGatewayDaemonComponent<C>>

getConfig

Returns Promise<IqrfGatewayDaemonConfig>

getInstance

Type Parameters

Parameters

Returns Promise<IqrfGatewayDaemonComponentInstanceConfiguration<C>>

getMapping

Parameters

Returns Promise<IqrfGatewayDaemonMapping>

getSchedulerMessagings

Returns Promise<IqrfGatewayDaemonSchedulerMessagings>

importScheduler

Parameters

Returns Promise<void>

listMappings

Parameters

Returns Promise<IqrfGatewayDaemonMapping[]>

updateEnabledComponents

Parameters

Returns Promise<void>

updateInstance

Type Parameters

Parameters

Returns Promise<void>

updateMapping

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`apiClient

`Protected` `Readonly`axiosInstance