Classe di connessione - NICE DCV
Metodi

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Classe di connessione

La classe di connessione ottenuta chiamando il connectmetodo deldcv modulo. Per un esempio che mostra come usarlo, consulta la sezione Guida introduttiva.

Espone

Metodi

Elenco

attachDisplay (win, displayConf) → {Promessa. <number>|Promessa. < {code: MultiMonitorErrorCode, messaggio: string} >}

Collega uno schermo specifico a una finestra. Non è possibile collegare il display principale. Se eseguito correttamente, la funzione restituiscedisplayId.

Parametri:

Nome Type (Tipo) Descrizione
win Oggetto La finestra a cui deve essere collegato il display.
displayConf Oggetto La configurazione del display.
Nome Type (Tipo) Attributi Descrizione
displayId numero <optional> L'ID del display.
displayDivName Il nome del div dello schermo.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa. <number>| Promessa. < {code: MultiMonitorErrorCode, messaggio: stringa} >

captureClipboardEvents(abilitato, win, displayID) → {void}

Avvia o interrompe l'ascolto degli eventi di copia-incolla. Nel caso degli appunti interattivi (sempre nel caso di incolla) dobbiamo iniziare ad ascoltare gli eventi di copia/incolla. Potrebbe essere utile avviare e interrompere l'ascolto solo quando è necessario, ad esempio quando viene mostrata una modalità.

Parametri:

Nome Type (Tipo) Attributi Descrizione
enabled booleano Per iniziare ad ascoltare gli eventi, specificatrue. Per interrompere l'ascolto degli eventi, specificarefalse.
win Oggetto <optional> La finestra in cui ascoltare gli eventi. Se omesso, viene utilizzata la finestra predefinita.
displayId numero <optional> L'ID del display che dovrebbe ascoltare gli eventi. Se omesso, viene utilizzata la visualizzazione predefinita della finestra.

Valori restituiti:

Type (Tipo)

void

DetachDisplay (displayID) → {void}

Scollega un display specifico. Il display principale non può essere rimosso.

Parametri:

Nome Type (Tipo) Descrizione
displayId numero L'ID del display da scollegare.

Valori restituiti:

Type (Tipo)

void

disconnetti () → {void}

Si disconnette dal server NICE DCV e chiude la connessione.

Valori restituiti:

Type (Tipo)

void

Disconnetti Collaborator (connectionId) → {void}

Richiede la disconnessione del collaboratore connesso con l'ID di connessione fornito (a partire dalla versione 1.1.0 di NICE DCV Web Client SDK).

Parametri:

Nome Type (Tipo) Descrizione
connectionId booleano L'id della connessione che verrà disconnessa.

Valori restituiti:

Type (Tipo)

void

enableDisplayQualityAggiornamenti (abilita) → {void}

Abilita o disabilita gli aggiornamenti della qualità dello schermo per le aree di streaming che non ricevono aggiornamenti. La disattivazione degli aggiornamenti della qualità del display riduce l'utilizzo della larghezza di banda, ma riduce anche la qualità dello schermo.

Parametri:

Nome Type (Tipo) Descrizione
enable booleano Per abilitare gli aggiornamenti della qualità del display, specificaretrue. Per disabilitare gli aggiornamenti della qualità del display, specificarefalse.

Valori restituiti:

Type (Tipo)

void

enableTimezoneRedirection(abilita) → {Promessa|Promessa. < {code: TimezoneRedirectionErrorCode, messaggio: string} >}

Consente di attivare o disattivare il reindirizzamento del fuso orario. Una volta abilitato, il client richiede al server di fare in modo che il fuso orario del desktop del server corrisponda al fuso orario del client.

Parametri:

Nome Type (Tipo) Descrizione
enable booleano Per abilitare il reindirizzamento del fuso orario, specificaretrue. Per disabilitare il reindirizzamento del fuso orario, specificarefalse.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa. <number>| Promessa. < {code: TimezoneRedirectionErrorCode, messaggio: stringa} >

enterRelativeMouseModalità () → {void}

Abilita la modalità relativa del mouse.

Valori restituiti:

Type (Tipo)

void

getConnectedDevices() → {Promessa. <Matrice. <MediaDeviceInfo >>|Promessa. < {message: string} >}

Richiede un elenco dei dispositivi multimediali collegati al computer client.

Valori restituiti:

In caso di successo, restituisce una promessa che si risolve in una serie di MediaDeviceInfo oggetti. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa. <Matrice. <MediaDeviceInfo >> | Promessa. < {message: string} >

getFileExplorer() → {Promessa. < archiviazione dei file >|Promessa. < {code: ChannelErrorCode, messaggio: string} >}

Ottiene un oggetto per gestire l'archiviazione dei file del server NICE DCV.

Valori restituiti:

Promessa. Si risolve nell'oggetto File Explorer se soddisfatto o in un oggetto di errore se rifiutato.

Type (Tipo)

Promessa. < filestorage > | Promessa. < {code: ChannelErrorCode, messaggio: stringa} >

getServerInfo() → {Informazioni sul server}

Restituisce informazioni sul server NICE DCV.

Valori restituiti:

Informazioni sul software del server.

Type (Tipo)

Informazioni sul server

getScreenshot () → {Promessa|Promessa. < {code: ScreenshotErrorCode, messaggio: string} >}

Recupera lo screenshot del desktop remoto in formato PNG. Lo screenshot verrà restituito nell'osservatore ScreenshotCallback. nullverranno invece restituiti in caso di guasti.

Valori restituiti:

Promessa che si risolve se la richiesta viene elaborata. Se rifiutato, riceviamo un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: ScreenshotErrorCode, messaggio: stringa} >

getStats () → {statistiche}

Ottiene statistiche sul server NICE DCV.

Valori restituiti:

Informazioni sulle statistiche di streaming.

Type (Tipo)

statistiche

latchModifierKey(chiave, posizione, isDown) → {boolean}

Invia una singola tastierakeydown okeyup evento per un modificatore consentito.

Parametri:

Nome Type (Tipo) Descrizione
key Controllo | Alt | AltGraph | Meta | Sistema operativo | Shift La chiave da inviare.
location KeyboardEvent.posizione La posizione della chiave. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent /location.
isDown booleano Se l'evento chiave da inserire è un keydown (true) o un keyup (false).

Valori restituiti:

Se la combinazione richiesta è valida, la funzione restituiscetrue, altrimentifalse.

Type (Tipo)

booleano

OpenChannel (nome, authToken, callback, namespace) → {Promise|Promessa. < {code: ChannelErrorCode, messaggio: string} >}

Apre un canale dati personalizzato sulla connessione se è stato creato sul server NICE DCV.

Parametri:

Nome Type (Tipo) Descrizione
name string Nome del canale.
authToken string Il token di autenticazione da utilizzare per connettersi al canale.
callbacks Oggetto Le funzioni di callback onMessage e onClose da chiamare.
namespace string Namespace del canale. Disponibile a partire da NICE DCV Web Client SDK 1.2.0 e NICE DCV Server 2022.1.

Valori restituiti:

Promessa. Se rifiutato, riceviamo un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: ChannelErrorCode, messaggio: stringa} >

QueryFeature (FeatureName) → {Promessa. < {abilitato: booleano, remoto? : stringa, AutoCopy? : booleano, autoPaste? : booleano, ServiceStatus? : stringa, disponibile? : boolean} >|Promessa. < {message: string} >}

Richiede lo stato di una funzionalità specifica del server NICE DCV.

Parametri:

Nome Type (Tipo) Descrizione
featureName caratteristica Il nome della funzionalità da eseguire la query.

Valori restituiti:

Promessa. Se risolta, la funzione restituisce unstatus oggetto che contiene sempre unaenabled proprietà e possibilmente anche altre proprietà. Se rifiutata, la funzione restituisce unerror oggetto.

Type (Tipo)

{Promessa. < {abilitato: booleano, remoto? : stringa, AutoCopy? : booleano, autoPaste? : booleano, ServiceStatus? : stringa, disponibile? : boolean} > | Promessa. < {message: string} >

registerKeyboardShortcuts(scelte rapide) → {void}

Consente di registrare le scelte rapide da tastiera.

Parametri:

Nome Type (Tipo) Descrizione
shortcuts Array. <Object> La serie di chiavi e mappature da registrare.
Nome Type (Tipo) Descrizione
sequence Array. <Object> La scorciatoia da tastiera per la registrazione.
Nome Type (Tipo) Descrizione
key KeyboardEvent.chiave Il valore del tasto premuto dall'utente. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent /key.
location KeyboardEvent.posizione L'array di chiavi da inviare. La posizione del tasto sulla tastiera. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent /location.
output Array. <Object> L'azione prevista da eseguire con la scorciatoia.
Nome Type (Tipo) Descrizione
key KeyboardEvent.chiave Il valore del tasto premuto dall'utente. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent /key.
location KeyboardEvent.posizione L'array di chiavi da inviare. La posizione del tasto sulla tastiera. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent /location.

Valori restituiti:

Type (Tipo)

void

requestDisplayConfig(highColorAccuracy) → {Promessa|Promessa. < {code: DisplayConfigErrorCode, messaggio: string} >}

Richiede una configurazione di visualizzazione aggiornata dal server NICE DCV. Disponibile a partire da NICE DCV Web Client SDK 1.1.0 e NICE DCV Server 2022.0.

Parametri:

Nome Type (Tipo) Descrizione
highColorAccuracy booleano Se è necessario richiedere o meno un'elevata precisione del colore.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: DisplayConfigErrorCode, messaggio: stringa} >

requestDisplayLayout(layout) → {Promessa|Promessa. < {code: ResolutionErrorCode, messaggio: string} >}

Richiede un layout di visualizzazione aggiornato per la connessione.

Parametri:

Nome Type (Tipo) Descrizione
layout Array. < Monitora > La richiesta viene visualizzata nel layout.

Valori restituiti:

Promessa. Se rifiutato, riceviamo un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: ResolutionErrorCode, messaggio: stringa} >

RequestResolution (larghezza, altezza) → {Promessa | Promessa. < {code: ResolutionErrorCode, messaggio: string} >}

Richiede una risoluzione dello schermo aggiornata dal server NICE DCV.

Parametri:

Nome Type (Tipo) Descrizione
width numero La larghezza da richiedere in pixel. Il valore minimo consentito è0.
height numero L'altezza da richiedere in pixel. Il valore minimo consentito è0.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: ResolutionErrorCode, messaggio: stringa} >

sendKeyboardEvent(evento) → {booleano}

Invia un evento scelta rapida da tastiera. Per ulteriori informazioni sugli eventi da tastiera, vedere https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent. Gli eventi validi della tastiera includono:keydownkeypress, ekeyup. Per ulteriori informazioni su questi eventi, vedere https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent #events.

Parametri:

Nome Type (Tipo) Descrizione
event KeyboardEvent L'evento da tastiera da inviare.

Valori restituiti:

Se l'evento non è valido, la funzione ritornafalse. Se l'evento è valido, la funzione restituiscetrue.

Type (Tipo)

booleano

sendKeyboardShortcut(scorciatoia) → {void}

Consente di inviare la scelta rapida da tastiera. Utilizzate questa funzione per inviare un completokeydown o unakeyup sequenza. Ad esempio, l'invio di Ctrl + Alt + Del invia glikeydown eventi per tutte le chiavi seguite daglikeyup eventi. Usa questa funzione anche se desideri inviare una sola chiave.

Parametri:

Nome Type (Tipo) Descrizione
shortcut Array. <Object> L'array di chiavi da inviare.
Nome Type (Tipo) Descrizione
key KeyboardEvent.chiave Il valore del tasto premuto dall'utente. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent /key.
location KeyboardEvent.posizione L'array di chiavi da inviare. La posizione del tasto sulla tastiera. Per ulteriori informazioni,,, consulta https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent /location.

Valori restituiti:

Type (Tipo)

void

setDisplayQuality(min, max opt) → {void}

Imposta la qualità dell'immagine da utilizzare per la connessione. L'intervallo valido è0 pari a100, con1 la qualità dell'immagine più bassa e100 la qualità dell'immagine più alta. Specifica0 per mantenere il valore corrente.

Parametri:

Nome Type (Tipo) Attributi Descrizione
min numero La qualità minima dell'immagine.
max numero <optional> La massima qualità dell'immagine.

Valori restituiti:

Type (Tipo)

void

setDisplayScale(ScaleRatio, DisplayID) → {Promessa | Promessa. < {code: ResolutionErrorCode, message: string} >} (OBSOLETO)

Obsoleto dalla versione 1.3.0. Non è più necessario impostare la scala di visualizzazione. Le coordinate del mouse verranno gestite automaticamente internamente.

Notifica al NICE DCV che il display è ridimensionato sul lato client. Usalo per notificare al server che deve ridimensionare gli eventi del mouse in modo che corrispondano al rapporto di visualizzazione del client.

Parametri:

Nome Type (Tipo) Descrizione
scaleRatio float Il rapporto di scala da utilizzare. Deve essere un numero strettamente positivo.
displayId numero L'ID del display da ridimensionare.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: ResolutionErrorCode, messaggio: stringa} >

setKeyboardQuirks(stranezze) → {void}

Imposta le stranezze della tastiera per il computer client.

Parametri:

Nome Type (Tipo) Descrizione
quirks Oggetto La tastiera si comporta in modo strano per abilitare o disabilitare.
Nome Type (Tipo) Descrizione
macOptionToAlt booleano Per mappare il tasto Opzione su Alt per macOS, specificatrue. In caso contrario, specificare false.
macCommandToControl booleano Per mappare il tasto Comando su Ctrl per macOS, specificatrue. In caso contrario, specificare false.

Valori restituiti:

Type (Tipo)

void

setMaxDisplayRisoluzione (larghezza massima, altezza massima) → {void}

Imposta la risoluzione massima dello schermo da utilizzare per la connessione.

Parametri:

Nome Type (Tipo) Descrizione
maxWidth numero Larghezza massima dello schermo in pixel. Il valore minimo consentito è0.
maxHeight numero L'altezza massima dello schermo in pixel. Il valore minimo consentito è0.

Valori restituiti:

Type (Tipo)

void

setMicrophone (abilita) → {Promessa|Promessa. < {code: AudioErrorCode, messaggio: string} >}

Consente di attivare o disattivare il microfono.

Parametri:

Nome Type (Tipo) Descrizione
enable booleano Per abilitare il microfono, specificaretrue. Per disattivare il microfono, specificarefalse.

Valori restituiti:

Promessa. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: AudioErrorCode, messaggio: stringa} >

setMinDisplayRisoluzione (larghezza minima, altezza minima) → {void}

Imposta la risoluzione minima dello schermo da utilizzare per la connessione. Alcune applicazioni potrebbero richiedere una risoluzione minima dello schermo. Se la risoluzione minima richiesta è maggiore della risoluzione massima supportata dal client, viene utilizzata una strategia di ridimensionamento. Usa questa funzione con attenzione. La strategia di ridimensionamento potrebbe causare un sistema di input tattile e mouse meno preciso.

Parametri:

Nome Type (Tipo) Descrizione
minWidth numero La larghezza minima dello schermo in pixel. Il valore minimo consentito è0.
minHeight numero L'altezza minima dello schermo in pixel. Il valore minimo consentito è0.

Valori restituiti:

Type (Tipo)

void

setUploadBandwidth(valore) → {numero}

Imposta la larghezza di banda massima da utilizzare per caricare i file sul server NICE DCV.

Parametri:

Nome Type (Tipo) Descrizione
value numero Il limite massimo di larghezza di banda in kbps. L'intervallo valido è compreso tra 1024 kbps e 102400 kbps.

Valori restituiti:

- Il limite di larghezza di banda impostato. nullse la funzionalità di archiviazione dei file è disattivata sul server.

Type (Tipo)

numero

setVolume (volume) → {void}

Imposta il livello del volume da utilizzare per l'audio. L'intervallo valido è compreso tra 0 e 100, dove 0 è il volume più basso e 100 il volume più alto.

Parametri:

Nome Type (Tipo) Descrizione
volume numero Il livello del volume da utilizzare.

Valori restituiti:

Type (Tipo)

void

setWebcam (abilita, ID dispositivo) → {Promessa | Promessa. < {code: WebcamErrorCode, messaggio: string} >}

Consente di attivare o disattivare la webcam.

Parametri:

Nome Type (Tipo) Descrizione
enable booleano Per abilitare la webcam, specificaretrue. Per disattivare la webcam, specificarefalse.
deviceId string L'ID del dispositivo della webcam.

Valori restituiti:

Prometti che, in caso di successo, si risolve nel DeviceID della webcam allegata/scollegata. Se rifiutata, la promessa restituisce un oggetto di errore.

Type (Tipo)

Promessa | Promessa. < {code: WebcamErrorCode, messaggio: stringa} >

syncClipBoards () → {booleano}

Sincronizza gli appunti del client locale con gli appunti del server NICE DCV remoto. La copia automatica deve essere supportata dal browser.

Valori restituiti:

Se gli appunti sono stati sincronizzati, la funzione ritornatrue. Se gli appunti non sono stati sincronizzati o se il browser non supporta la copia automatica, la funzione ritornafalse.

Type (Tipo)

booleano