Class NetworkConnectionService

Network connection service

Hierarchy (View Summary)

BaseService
- NetworkConnectionService

Index

Constructors

Properties

apiClient axiosInstance

Methods

connect create delete disconnect get list update

Constructors

constructor

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

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

connect

connect(uuid: string, interfaceName?: null | string): Promise<void>
Connects to the network connection
Parameters
- uuid: string
  Network connection UUID
- interfaceName: null | string = null
  Network interface name
Returns Promise<void>
- Defined in services/Network/NetworkConnectionService.ts:94

create

create(
configuration: NetworkConnectionConfiguration,
): Promise<NetworkConnectionCreated>
Creates a new network connection
Parameters
- configuration: NetworkConnectionConfiguration
  Network connection configuration
Returns Promise<NetworkConnectionCreated>
Created network connection
- Defined in services/Network/NetworkConnectionService.ts:55

delete

delete(uuid: string): Promise<void>
Deletes the network connection configuration
Parameters
- uuid: string
  Network connection UUID
Returns Promise<void>
- Defined in services/Network/NetworkConnectionService.ts:85

disconnect

disconnect(uuid: string): Promise<void>
Disconnects from the network connection
Parameters
- uuid: string
  Network connection UUID
Returns Promise<void>
- Defined in services/Network/NetworkConnectionService.ts:106

get

get(uuid: string): Promise<NetworkConnectionConfiguration>
Retrieves the network connection configuration
Parameters
- uuid: string
  Network connection UUID
Returns Promise<NetworkConnectionConfiguration>
Network connection configuration
- Defined in services/Network/NetworkConnectionService.ts:66

list

list(type?: null | NetworkConnectionType): Promise<NetworkConnectionListEntry[]>
Lists available network connections
Parameters
- type: null | NetworkConnectionType = null
  Network connection type
Returns Promise<NetworkConnectionListEntry[]>
List of network connections
- Defined in services/Network/NetworkConnectionService.ts:40

update

update(
uuid: string,
configuration: NetworkConnectionConfiguration,
): Promise<void>
Updates the network connection configuration
Parameters
- uuid: string
  Network connection UUID
- configuration: NetworkConnectionConfiguration
  Network connection configuration
Returns Promise<void>
- Defined in services/Network/NetworkConnectionService.ts:77