Web SDK documentation
  1. Injectables
  2. RemoteAccessService

File

remote-access/data/remote-access.service.ts

Index

Properties
Methods

Constructor

constructor(fetchClient: FetchClient, serviceRegistry: ServiceRegistry)
Parameters :
Name Type Optional
fetchClient FetchClient No
serviceRegistry ServiceRegistry No

Methods

Async addConfiguration
addConfiguration(deviceId: string, configuration: Omit)

Creates a new configuration for a given device.

Parameters :
Name Type Optional
deviceId string No
configuration Omit<RemoteAccessConfiguration | id> No
Returns : Promise<RemoteAccessConfiguration>
Async deleteConfiguration
deleteConfiguration(deviceId: string, configurationId: string)

Deletes a configuration for a given device.

Parameters :
Name Type Optional
deviceId string No
configurationId string No
Returns : any
Async generateKeyPair
generateKeyPair(hostname: string)

Generates a SSH key pair for a given hostname.

Parameters :
Name Type Optional
hostname string No
Returns : Promise<literal type>
getAuthQueryParamsForWebsocketConnection
getAuthQueryParamsForWebsocketConnection()

misses the leading ? for the query params

Returns : any
getProtocolProviders
getProtocolProviders()

Retrieves all available remote access protocol providers.

Returns : any
getWebSocketUri
getWebSocketUri(deviceId: K, configurationId: I)
Type parameters :
  • K
  • I

Returns the URI for the websocket connection to the remote access service.

Parameters :
Name Type Optional
deviceId K No
configurationId I No
Returns : `ws://${any}/service/remoteaccess/client/${K}/configurations/${I}` | `wss://${any}/service/remoteaccess/client/${K}/configurations/${I}` | `ws://${any}/service/remoteaccess/client/${K}/configurations/${I}?${any}` | `wss://${any}/service/remoteaccess/client/${K}/configurations/${I}?${any}`
isAvailable$
isAvailable$()

Verifies if the remote access service is available by sending a HEAD request to is's health endpoint.

Returns : Observable<boolean>

cached Observable that emits true if the service is available, false otherwise.
Async listConfigurations
listConfigurations(deviceId: string)

Retrieves all configurations for a given device.

Parameters :
Name Type Optional
deviceId string No
Returns : Promise<RemoteAccessConfiguration[]>
Async updateConfiguration
updateConfiguration(deviceId: string, configuration: RemoteAccessConfiguration)

Updates a configuration for a given device.

Parameters :
Name Type Optional
deviceId string No
configuration RemoteAccessConfiguration No
Returns : Promise<RemoteAccessConfiguration>

Properties

Readonly baseUrl
Type : string
Default value : '/service/remoteaccess'

results matching ""

    No results matching ""