Class IqrfGatewayControllerService

IQRF Gateway Controller configuration service

Hierarchy (View Summary)

BaseService
- IqrfGatewayControllerService

Index

Constructors

Properties

apiClient axiosInstance

Methods

createMapping deleteMapping getConfig getMapping listMappings updateConfig updateMapping

Constructors

constructor

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

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

createMapping

createMapping(mapping: IqrfGatewayControllerMapping): Promise<void>
Creates IQRF Gateway Controller mapping
Parameters
- mapping: IqrfGatewayControllerMapping
  IQRF Gateway Controller mapping to create
Returns Promise<void>
- Defined in services/Config/IqrfGatewayControllerService.ts:73

deleteMapping

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

getConfig

getConfig(): Promise<IqrfGatewayControllerConfig>
Retrieves IQRF Gateway Controller configuration

Returns Promise<IqrfGatewayControllerConfig>
IQRF Gateway Controller configuration
- Defined in services/Config/IqrfGatewayControllerService.ts:34

getMapping

getMapping(id: number): Promise<IqrfGatewayControllerMapping>
Retrieves IQRF Gateway Controller mapping
Parameters
- id: number
  IQRF Gateway Controller mapping ID
Returns Promise<IqrfGatewayControllerMapping>
IQRF Gateway Controller mapping
- Defined in services/Config/IqrfGatewayControllerService.ts:63

listMappings

listMappings(): Promise<IqrfGatewayControllerMapping[]>
Lists IQRF Gateway Controller mappings

Returns Promise<IqrfGatewayControllerMapping[]>
IQRF Gateway Controller mappings
- Defined in services/Config/IqrfGatewayControllerService.ts:52

updateConfig

updateConfig(config: IqrfGatewayControllerConfig): Promise<void>
Updates IQRF Gateway Controller configuration
Parameters
- config: IqrfGatewayControllerConfig
  IQRF Gateway Controller configuration
Returns Promise<void>
- Defined in services/Config/IqrfGatewayControllerService.ts:44

updateMapping

updateMapping(id: number, mapping: IqrfGatewayControllerMapping): Promise<void>
Updates IQRF Gateway Controller mapping
Parameters
- id: number
  IQRF Gateway Controller mapping ID
- mapping: IqrfGatewayControllerMapping
  IQRF Gateway Controller mapping to edit
Returns Promise<void>
- Defined in services/Config/IqrfGatewayControllerService.ts:91