Web SDK documentation
  1. Injectables
  2. VNCRemoteAccessProtocolProviderService

File

remote-access/vnc/index.ts

Index

Properties
Methods

Constructor

constructor(remoteAccess: RemoteAccessService, bsModalService: BsModalService)
Parameters :
Name Type Optional
remoteAccess RemoteAccessService No
bsModalService BsModalService No

Methods

Async addEndpoint
addEndpoint(deviceId: string)
Parameters :
Name Type Optional
deviceId string No
Returns : Promise<RemoteAccessConfiguration>
Async connectEndpointHref
connectEndpointHref(deviceId: string, configuration: RemoteAccessConfiguration)
Parameters :
Name Type Optional
deviceId string No
configuration RemoteAccessConfiguration No
Returns : Promise<string>
Async editEndpoint
editEndpoint(deviceId: string, currentEndpointConfig: RemoteAccessConfiguration)
Parameters :
Name Type Optional
deviceId string No
currentEndpointConfig RemoteAccessConfiguration No
Returns : Promise<RemoteAccessConfiguration>
Async getDefaultEndpointConfiguration
getDefaultEndpointConfiguration()
Returns : Promise<Partial<RemoteAccessConfiguration>>
Protected Async openVNCEndpointModal
openVNCEndpointModal(currentConfiguration: Partial)
Parameters :
Name Type Optional
currentConfiguration Partial<RemoteAccessConfiguration> No
Returns : Promise<RemoteAccessConfiguration | null>
removeEndpoint
removeEndpoint(deviceId: string, currentEndpointConfig: RemoteAccessConfiguration)
Parameters :
Name Type Optional
deviceId string No
currentEndpointConfig RemoteAccessConfiguration No
Returns : Promise<void>

Properties

protocolDescription
Default value : gettext('Allows to connect to a VNC service.')
protocolIcon
Default value : 'laptop' as const
protocolLabel
Default value : gettext('VNC')
protocolName
Type : string
Default value : 'VNC'

results matching ""

    No results matching ""