NICE DCV Guida per sviluppatori Web Client SDK
←
→
Trascrizione del contenuto della pagina
Se il tuo browser non visualizza correttamente la pagina, ti preghiamo di leggere il contenuto della pagina quaggiù
NICE DCV Guida per sviluppatori Web Client SDK
NICE DCV Guida per sviluppatori Web Client SDK NICE DCV: Guida per sviluppatori Web Client SDK Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved. I marchi e il trade dress di Amazon non possono essere utilizzati in relazione ad alcun prodotto o servizio che non sia di Amazon, in alcun modo che possa causare confusione tra i clienti, né in alcun modo che possa denigrare o screditare Amazon. Tutti gli altri marchi non di proprietà di Amazon sono di proprietà delle rispettive aziende, che possono o meno essere associate, collegate o sponsorizzate da Amazon.
NICE DCV Guida per sviluppatori Web Client SDK
Table of Contents
Cos'è NICE DCV Web Client SDK? ...................................................................................................... 1
Prerequisiti ................................................................................................................................ 1
Funzionalità supportate ................................................................................................................ 1
Supporto browser ....................................................................................................................... 2
Convenzione Versioni Versioni ..................................................................................................... 2
Nozioni di base .................................................................................................................................. 3
Connect a un server NICE DCV e ottieni il primo frame .................................................................... 4
Fase 1: Preparazione di una pagina HTML ............................................................................. 4
Fase 2: Autenticazione, connessione e ottieni il primo fotogramma ............................................. 4
bonus: Crea automaticamente un modulo di accesso HTML ...................................................... 6
Funziona con le funzioni NICE DCV .............................................................................................. 7
Informazioni sulla funzione di callback FeatureUpdate .............................................................. 7
Gestione degli aggiornamenti delle caratteristiche .................................................................... 7
Utilizzare l'SDK dell'interfaccia utente Web NICE DCV ..................................................................... 8
Prerequisiti ........................................................................................................................ 8
Fase 1: Preparazione di una pagina HTML ............................................................................. 9
Fase 2: Autenticazione, connessione e rendering delDCVViewerReact component. ...................... 9
Riferimento dell'SDK .......................................................................................................................... 13
Modulo DCV ............................................................................................................................ 13
Metodi ............................................................................................................................. 13
Membri ............................................................................................................................ 15
Definizioni di tipo e callback ............................................................................................... 18
Classe di connessione ............................................................................................................... 41
Metodi ............................................................................................................................. 13
Classe di autenticazione ............................................................................................................ 58
Metodi ............................................................................................................................. 13
SDK dell'interfaccia utente Web NICE DCV .................................................................................. 59
Componenti ...................................................................................................................... 59
Note di rilascio e cronologia dei documenti ........................................................................................... 64
Note di rilascio ......................................................................................................................... 64
1.1.1 — 23 marzo 2022 ..................................................................................................... 64
1.1.0 — 23 febbraio 2022 .................................................................................................. 64
1.0.4 — 20 dicembre 2021 ................................................................................................. 65
1.0.3 — 01 settembre 2021 ................................................................................................ 65
1.0.2 — 30 luglio 2021 ...................................................................................................... 66
1.0.1 — 31 maggio 2021 ................................................................................................... 66
1.0.0 — 24 marzo 2021 ..................................................................................................... 66
Cronologia dei documenti ........................................................................................................... 66
.................................................................................................................................................... lxvii
iiiNICE DCV Guida per sviluppatori Web Client SDK
Prerequisiti
Cos'è il NICE DCV Web Client SDK?
NICE DCV è un protocollo di visualizzazione remota ad alte prestazioni. Consente di distribuire in modo
sicuro desktop remoti e streaming di applicazioni da qualsiasi cloud o data center a qualsiasi dispositivo,
in condizioni di rete variabili. Utilizzando NICE DCV con Amazon EC2, è possibile eseguire applicazioni a
uso intensivo di grafica in remoto sulle istanze di Amazon EC2. È quindi possibile eseguire lo streaming dei
risultati su macchine client più modeste, eliminando così la necessità di costose workstation dedicate.
NICE DCV Web Client SDK è una libreria JavaScript che puoi utilizzare per sviluppare le tue applicazioni
client per browser Web NICE DCV. Gli utenti finali possono utilizzare queste applicazioni per connettersi e
interagire con una sessione DCV NICE in esecuzione.
Utilizzando NICE DCV Web Client SDK come elemento costitutivo, è possibile creare applicazioni Web
personalizzate che forniscano agli utenti un accesso immediato al desktop o alle applicazioni da qualsiasi
luogo, con prestazioni reattive e fluide quasi indistinguibili da un'applicazione installata in modo nativo.
Questa guida spiega come utilizzare NICE DCV Web Client SDK per creare applicazioni client
personalizzate per browser Web per interagire con le sessioni NICE DCV all'interno dei flussi di lavoro.
Argomenti
• Prerequisiti (p. 1)
• Funzionalità supportate (p. 1)
• Supporto browser (p. 2)
• Convenzione Versioni Versioni (p. 2)
Prerequisiti
Prima di iniziare a lavorare con NICE DCV Web Client SDK, assicurarsi di avere familiarità con le sessioni
NICE DCV e NICE DCV. Per ulteriori informazioni, consulta la .Guida dell'amministratore DCV NICE.
L'SDK NICE DCV Web Client supporta NICE DCV server versione 2020 e successive.
Funzionalità supportate
È possibile creare applicazioni client personalizzate per browser Web che supportano le seguenti
funzionalità NICE DCV:
• Connect ai server Windows NICE DCV
• Connect ai server DCV NICE Linux
• Gestione delle modalità di streaming
• Trasferimento dei file
• Stampa da sessioni
• Copia e incolla
• Riproduzione audio Stereo 2.0
• Registrazione audio Stereo 2.0 (su server Windows)
• Touchscreen
• Stilo (su server Linux, Windows 10 e Windows Server 2019)
1NICE DCV Guida per sviluppatori Web Client SDK
Supporto browser
• Supporto per più monitor
Per ulteriori informazioni su queste caratteristiche, consultaFunzionalità supportatenellaGuida utente DCV
NICE.
Supporto browser
NICE DCV Web Client SDK supporta JavaScript (ES6) e può essere utilizzato da applicazioni JavaScript o
TypeScript.
Il NICE DCV Web Client SDK supporta i seguenti browser Web:
Browser Versione
Google Chrome Le ultime tre versioni principali
Mozilla Firefox Le ultime tre versioni principali
Microsoft Edge Le ultime tre versioni principali
Apple Safari per macOS Le ultime tre versioni principali
Convenzione Versioni Versioni
La versione NICE DCV Web Client SDK è definita nel seguente formato: major.minor.patch. La
convenzione di controllo delle versioni generalmente aderisce allamodello di versionamento semantico.
Un cambiamento nella versione principale, come da1.x.xa2.x.x, indica che sono state introdotte
modifiche interrompenti che potrebbero richiedere modifiche al codice e una distribuzione pianificata. Un
cambiamento nella versione secondaria, come da1.1.xa1.2.x, è compatibile con le versioni precedenti,
ma potrebbe includere elementi deprecati.
2NICE DCV Guida per sviluppatori Web Client SDK
Introduzione a NICE Web Client SDK
Il NICE DCV Web Client SDK è composto da un principaledcv.jsfile e alcuni componenti ausiliari. Tutti i
file sono distribuiti all'interno di un archivio compresso che può essere scaricato dalSito web NICE.
Per iniziare a utilizzare NICE DCV Web Client SDK
1. L'archivio SDK NICE è firmato digitalmente con una firma GPG di NICE. Per verificare la firma
dell'archivio, è necessario importare la chiave GPG NICE. A questo scopo, apri una finestra del
terminale e importa la chiave GPG NICE.
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY
$ gpg --import NICE-GPG-KEY
2. Download diArchivio SDK NICE DCV Web Cliente laFirma dell'archivio NICE DCV Web Client
SDKdagliSito web NICE.
3. Verificare la firma dell'archivio NICE DCV Web Client SDK utilizzando la firma.
$ gpg --verify
signature_filename.zip.sign
archive_filename.zip
Ad esempio:
$ gpg --verify nice-dcv-web-client-sdk-1.1.1-309.zip.sign nice-dcv-web-client-
sdk-1.1.1-309.zip
4. Se la firma viene verificata correttamente, estrarre il contenuto dell'archivio NICE DCV Web Client SDK
e posizionare la directory estratta sul server Web. Ad esempio:
$ unzip
archive_filename.zip
-d /
path_to
/
server_directory
/
Important
• È necessario mantenere la struttura delle cartelle quando si distribuisce NICE DCV Web
Client SDK sul server Web.
• Quando si utilizza NICE DCV Web UI SDK, fare attenzione che ilDCVViewerIl componente
React si aspetta EULA.txt ethird-party-licensesfile.txt di questo pacchetto da essere
presenti nel percorso URL del server Web incorporato. Lathird-party-licensesIl file.txt deve
essere modificato per includere anche il contenuto del file corrispondente dal pacchetto
NICE DCV Web Client SDK e possibilmente qualsiasi altra informazione di licenza dalle
librerie utilizzate dall'applicazione utente che consuma.
3NICE DCV Guida per sviluppatori Web Client SDK
Connect a un server NICE DCV e ottieni il primo frame
Connect a un server NICE DCV e ottieni il primo
frame
Il seguente tutorial mostra come preparare la pagina HTML per il client Web personalizzato, come
autenticarsi e connettersi a un server NICE DCV e come ricevere il primo fotogramma di contenuti in
streaming dalla sessione NICE DCV.
Argomenti
• Fase 1: Preparazione di una pagina HTML (p. 4)
• Fase 2: Autenticazione, connessione e ottieni il primo fotogramma (p. 4)
• bonus: Crea automaticamente un modulo di accesso HTML (p. 6)
Fase 1: Preparazione di una pagina HTML
Nella tua pagina Web, è necessario caricare il necessarioJavaScriptmoduli e devi aggiungere
unelemento HTML con un validoiddove si desidera che NICE DCV Web Client SDK riceva il flusso
di contenuti dal server NICE DCV remoto.
Ad esempio:
DCV first connection
Fase 2: Autenticazione, connessione e ottieni il primo
fotogramma
Questa sezione mostra come completare il processo di autenticazione dell'utente, come collegare il server
NICE DCV e come ricevere il primo frame di contenuto dal server NICE DCV.
Innanzitutto, dalindex.jsimportare il NICE DCV Web Client SDK. Può essere importato come modulo
UMD (Universal Module Definition), in questo modo:
import "./dcvjs/dcv.js"
Altrimenti, a partire dalla versione1.1.0, può anche essere importato come modulo ECMAScript (ESM) dal
pacchetto corrispondente, in questo modo:
import dcv from "./dcvjs/dcv.js"
Definire le variabili da utilizzare per memorizzare l'oggetto Authentication, l'oggetto Connection e l'URL del
server NICE DCV.
4NICE DCV Guida per sviluppatori Web Client SDK
Fase 2: Autenticazione, connessione
e ottieni il primo fotogramma
let auth,
connection,
serverUrl;
Al caricamento dello script, registrare la versione NICE DCV Web Client SDK e, al caricamento della
pagina, chiamare ilmainfunzione.
console.log("Using NICE DCV Web Client SDK version " + dcv.version.versionStr);
document.addEventListener('DOMContentLoaded', main);
Lamainfunzione imposta il livello di registro e avvia il processo di autenticazione.
function main () {
console.log("Setting log level to INFO");
dcv.setLogLevel(dcv.LogLevel.INFO);
serverUrl = "https://your-dcv-server-url:port/";
console.log("Starting authentication with", serverUrl);
auth = dcv.authenticate(
serverUrl,
{
promptCredentials: onPromptCredentials,
error: onError,
success: onSuccess
}
);
}
LapromptCredentials,error, esuccessle funzioni sono funzioni di callback obbligatorie che devono
essere definite nel processo di autenticazione.
Se il server NICE DCV richiede le credenziali,promptCredentialsla funzione di callback riceve la
sfida delle credenziali richiesta dal server NICE DCV. Se il server NICE DCV è configurato per l'utilizzo
dell'autenticazione di sistema, le credenziali devono essere fornite sotto forma di nome utente e password.
I seguenti esempi di codice presuppongono che il nome utente siamy_dcv_usere che la password
èmy_password.
Se l'autenticazione non riesce,errorla funzione callback riceve un oggetto di errore dal server NICE DCV.
Se l'autenticazione ha esito positivo,successla funzione callback riceve una serie di coppie che
include l'id della sessione (sessionId) e token di autorizzazione (authToken) per ogni sessione che
ilmy_dcv_userl'utente è autorizzato a connettersi sul server NICE DCV. Il seguente esempio di codice
chiama la funzione connect e si connette alla prima sessione restituita nell'array.
function onPromptCredentials(auth, challenge) {
// Let's check if in challege we have a username and password request
if (challengeHasField(challenge, "username") && challengeHasField(challenge, "password"))
{
auth.sendCredentials({username: "my_dcv_user", password: "my_password"})
} else {
// Challenge is requesting something else...
}
}
function challengeHasField(challenge, field) {
return challenge.requiredCredentials.some(credential => credential.name === field);
}
5NICE DCV Guida per sviluppatori Web Client SDK
bonus: Crea automaticamente un modulo di accesso HTML
function onError(auth, error) {
console.log("Error during the authentication: " + error.message);
}
// We connect to the first session returned
function onSuccess(auth, result) {
let {sessionId, authToken} = {...result[0]};
connect(sessionId, authToken);
}
Connect al server DCV NICE. LafirstFrameil metodo di callback viene chiamato quando il primo
fotogramma viene ricevuto dal server NICE DCV.
function connect (sessionId, authToken) {
console.log(sessionId, authToken);
dcv.connect({
url: serverUrl,
sessionId: sessionId,
authToken: authToken,
divId: "dcv-display",
callbacks: {
firstFrame: () => console.log("First frame received")
}
}).then(function (conn) {
console.log("Connection established!");
connection= conn;
}).catch(function (error) {
console.log("Connection failed with error " + error.message);
});
}
bonus: Crea automaticamente un modulo di accesso
HTML
Lachallengel'oggetto viene restituito quando ilpromptCredentialsviene chiamata la funzione
callback. Include una proprietà denominatarequiredCredentialsè un array di oggetti - un oggetto per
credenziale richiesto dal server NICE DCV. Ogni oggetto include il nome e il tipo di credenziale richiesta.
Puoi utilizzare il pluginchallengeerequiredCredentialsoggetti per creare automaticamente un
modulo di accesso HTML.
L'esempio di codice seguente mostra come eseguire tale operazione.
let form,
fieldSet;
function submitCredentials (e) {
var credentials = {};
fieldSet.childNodes.forEach(input => credentials[input.id] = input.value);
auth.sendCredentials(credentials);
e.preventDefault();
}
function createLoginForm () {
var submitButton = document.createElement("button");
submitButton.type = "submit";
submitButton.textContent = "Login";
6NICE DCV Guida per sviluppatori Web Client SDK
Funziona con le funzioni NICE DCV
form = document.createElement("form");
fieldSet = document.createElement("fieldset");
form.onsubmit = submitCredentials;
form.appendChild(fieldSet);
form.appendChild(submitButton);
document.body.appendChild(form);
}
function addInput (name) {
var type = name === "password" ? "password" : "text";
var inputField = document.createElement("input");
inputField.name = name;
inputField.id = name;
inputField.placeholder = name;
inputField.type = type;
fieldSet.appendChild(inputField);
}
function onPromptCredentials (_, credentialsChallenge) {
createLoginForm();
credentialsChallenge.requiredCredentials.forEach(challenge => addInput(challenge.name));
}
Funziona con le funzioni NICE DCV
La disponibilità delle funzionalità di NICE DCV dipende dalle autorizzazioni configurate per la sessione
NICE DCV e dalle funzionalità del browser Web del client.
Le funzionalità disponibili in una sessione NICE DCV sono gestite dalle autorizzazioni specificate per
la sessione. Ciò significa che anche se una funzionalità è supportata da NICE DCV Web Client SDK,
l'accesso a tale funzione potrebbe essere impedito in base alle autorizzazioni definite dall'amministratore
della sessione. Per ulteriori informazioni, consultaConfigurazione dell'autorizzazione DCV NICEnellaGuida
all'amministratore NICE.
Informazioni sulla funzione di callback FeatureUpdate
Quando la disponibilità di una funzione in una sessione NICE DCV cambia, l'SDK NICE DCV Web Client
notifica l'utilizzo delfeaturesUpdatefunzione di callback specificata al momento della creazione della
connessione. Ad esempio:
featuresUpdate: function (connection, list) {
...
},
La funzione di callback notifica solo le funzionalità per le quali la disponibilità è cambiata. Lalistparametro
è un array di stringhe e include solo i nomi delle funzionalità aggiornate. Ad esempio, se la disponibilità
della funzione di ingresso audio cambia per la sessione, il parametro include solo["audio-in"]. Se in un
secondo momento, la disponibilità delle funzioni di copia e incolla degli appunti cambia per la sessione, il
parametro include solo["clipboard-copy", "clipboard-paste"].
Gestione degli aggiornamenti delle caratteristiche
LafeaturesUpdatela funzione di callback notifica solo che la disponibilità di una o più funzionalità è
cambiata. Per sapere quali funzionalità sono state aggiornate, è necessario eseguire una query sulla
7NICE DCV Guida per sviluppatori Web Client SDK
Utilizzare l'SDK dell'interfaccia utente Web NICE DCV
funzione utilizzando ilconnection.queryFeaturemetodo. Ciò può essere fatto in qualsiasi momento
dopo la ricezione della notifica di modifica. Questo metodo restituisce unPromiseche si risolve allo stato
aggiornato della funzione richiesta. Lastatusil valore è sempre associato e ha un valore booleano
(true|false) proprietà chiamataenabled. Alcune funzionalità potrebbero avere proprietà aggiuntive
nelstatusvalue. Se la disponibilità della funzione non è stata aggiornata, viene rifiutata.
Il codice di esempio seguente mostra come eseguire tale operazione.
// Connection callback called
function featuresUpdate (_, list) {
if (list.length > 0) {
list.forEach((feat) => {
connection.queryFeature(feat).then(status => console.log(feat, "is",
status.enabled)));
});
}
}
Utilizzare l'SDK dell'interfaccia utente Web NICE
DCV
Il seguente tutorial mostra come autenticarsi con il server NICE DCV, connettersi ad esso e renderizzare
ilDCVViewerReagire dal componente NICE DCV Web UI SDK.
Argomenti
• Prerequisiti (p. 8)
• Fase 1: Preparazione di una pagina HTML (p. 9)
• Fase 2: Autenticazione, connessione e rendering delDCVViewerReact component. (p. 9)
Prerequisiti
È necessario installareReact,ReactDOM,AWS UI Components React,AWS UI Global StyleseAWS
UI Design Tokens.
$ npm i react react-dom @awsui/components-react @awsui/global-styles @awsui/design-tokens
Dovresti anche scaricareNICE DCV Web Client SDK. Consulta .Introduzione a NICE Web Client
SDK (p. 3)per leggere ilstep-by-stepguida su come fare.
È necessario creare un alias per l'importazione didcvmodulo, poiché è una dipendenza esterna per NICE
DCV Web UI SDK. Ad esempio, se si utilizza il webpack per raggruppare la tua app web, puoi usare
ilrisolvi.aliasopzione in questo modo:
const path = require('path');
module.exports = {
//...
resolve: {
alias: {
dcv: path.resolve('path', 'to', 'dcv.js'),
},
},
8NICE DCV Guida per sviluppatori Web Client SDK
Fase 1: Preparazione di una pagina HTML
};
Se si utilizza il rollup per il bundling, è possibile installare@rollup /plugin-aliase usalo così:
import alias from '@rollup/plugin-alias';
const path = require('path');
module.exports = {
//...
plugins: [
alias({
entries: [
{ find: 'dcv', replacement: path.resolve('path', 'to', 'dcv.js') },
]
})
]
};
Fase 1: Preparazione di una pagina HTML
Nella tua pagina Web, è necessario caricare il necessarioJavaScriptmoduli e dovresti avere
unelemento HTML con un validoiddove verrà eseguito il rendering del componente di inserimento
della tua app.
Ad esempio:
DCV first connection
Fase 2: Autenticazione, connessione e rendering
delDCVViewerReact component.
Questa sezione mostra come completare il processo di autenticazione dell'utente, come connettere il
server NICE DCV e come eseguire il renderingDCVViewerReact component.
Innanzitutto, dalindex.jsfile, importReact,ReactDOMe il tuo livello superioreAppcomponente.
import React from "react";
import ReactDOM from 'react-dom';
import App from './App';
Esegui il rendering del nodo contenitore di livello superiore della tua app.
ReactDOM.render(
,
document.getElementById("root")
9NICE DCV Guida per sviluppatori Web Client SDK
Fase 2: Autenticazione, connessione e
rendering delDCVViewerReact component.
);
NellaApp.jsfile, importare il NICE DCV Web Client SDK come modulo ESM, ilDCVViewerComponente
reagire dall'SDK dell'interfaccia utente Web NICE DCV,Reacte laAWS UI Global Stylespacchetto.
import React from "react";
import dcv from "dcv";
import "@awsui/global-styles/index.css";
import {DCVViewer} from "./dcv-ui/dcv-ui.js";
Di seguito è riportato un esempio che mostra come autenticarsi con il server NICE DCV e eseguire il
rendering delDCVViewerComponente React da NICE DCV Web UI SDK, a condizione che l'autenticazione
abbia avuto esito positivo.
const LOG_LEVEL = dcv.LogLevel.INFO;
const SERVER_URL = "https://your-dcv-server-url:port/";
const BASE_URL = "/static/js/dcvjs";
let auth;
function App() {
const [authenticated, setAuthenticated] = React.useState(false);
const [sessionId, setSessionId] = React.useState('');
const [authToken, setAuthToken] = React.useState('');
const [credentials, setCredentials] = React.useState({});
const onSuccess = (_, result) => {
var { sessionId, authToken } = { ...result[0] };
console.log("Authentication successful.");
setSessionId(sessionId);
setAuthToken(authToken);
setAuthenticated(true);
setCredentials({});
}
const onPromptCredentials = (_, credentialsChallenge) => {
let requestedCredentials = {};
credentialsChallenge.requiredCredentials.forEach(challenge =>
requestedCredentials[challenge.name] = "");
setCredentials(requestedCredentials);
}
const authenticate = () => {
dcv.setLogLevel(LOG_LEVEL);
auth = dcv.authenticate(
SERVER_URL,
{
promptCredentials: onPromptCredentials,
error: onError,
success: onSuccess
}
);
}
const updateCredentials = (e) => {
const { name, value } = e.target;
setCredentials({
...credentials,
[name]: value
10NICE DCV Guida per sviluppatori Web Client SDK
Fase 2: Autenticazione, connessione e
rendering delDCVViewerReact component.
});
}
const submitCredentials = (e) => {
auth.sendCredentials(credentials);
e.preventDefault();
}
React.useEffect(() => {
if (!authenticated) {
authenticate();
}
}, [authenticated]);
const handleDisconnect = (reason) => {
console.log("Disconnected: " + reason.message + " (code: " + reason.code + ")");
auth.retry();
setAuthenticated(false);
}
return (
authenticated ?
:
{Object.keys(credentials).map((cred) => (
))}
11NICE DCV Guida per sviluppatori Web Client SDK
Fase 2: Autenticazione, connessione e
rendering delDCVViewerReact component.
Login
);
}
const onError = (_, error) => {
console.log("Error during the authentication: " + error.message);
}
export default App;
LapromptCredentials,error, esuccessle funzioni sono funzioni di callback obbligatorie che devono
essere definite nel processo di autenticazione.
Se il server NICE DCV richiede le credenziali,promptCredentialsla funzione di callback riceve la
sfida delle credenziali richiesta dal server NICE DCV. Se il server NICE DCV è configurato per l'utilizzo
dell'autenticazione di sistema, le credenziali devono essere fornite sotto forma di nome utente e password.
Se l'autenticazione non riesce,errorla funzione callback riceve un oggetto di errore dal server NICE DCV.
Se l'autenticazione ha esito positivo,successla funzione callback riceve una serie di coppie che include
l'id della sessione (sessionId) e token di autorizzazione (authToken) per ogni sessione a cui l'utente è
autorizzato a connettersi sul server NICE DCV. L'esempio di codice precedente aggiorna lo stato React per
il rendering delDCVViewercomponente sull'autenticazione riuscita.
Per saperne di più sulle proprietà accettate da questo componente, vedere ilRiferimento SDK NICE DCV
Web UI.
12NICE DCV Guida per sviluppatori Web Client SDK
Modulo DCV
Riferimento dell'SDK
In questa sezione vengono fornite descrizioni, sintassi ed esempi d'uso di NICE DCV Web Client SDK.
Argomenti
• Modulo DCV (p. 13)
• Classe di connessione (p. 41)
• Classe di autenticazione (p. 58)
• SDK dell'interfaccia utente Web NICE DCV (p. 59)
Modulo DCV
Un modulo che implementa il lato client del protocollo DCV.
EXPOSE
• Metodi (p. 13)
• Membri (p. 15)
• Definizioni di tipo e callback (p. 18)
Metodi
Elenco
• autenticare (url, callback) → {Autenticazione} (p. 13)
• connect (config) → {Promessa. |Promessa. < {code: ConnectionErrorCode, message:
string} >} (p. 14)
• setLogHandler(gestore) → {void} (p. 14)
• setLogLevel(livello) → {void} (p. 15)
autenticare (url, callback) → {Autenticazione (p. 58)}
Avvia il processo di autenticazione per l'endpoint server NICE DCV specificato.
Parametri:
Nome Tipo Descrizione
url string Il nome host e la porta del server
NICE DCV in esecuzione nel
seguente formato: https://
dcv_host_address:port. Ad
esempio:https://my-dcv-
server:8443.
callbacks Richiamate di I callback disponibili per essere
autenticazione (p. 19) richiamati durante il processo di
autenticazione.
13NICE DCV Guida per sviluppatori Web Client SDK
Metodi
Valori restituiti:
- L'oggetto Authentication.
Tipo
Autenticazione (p. 58)
connect (config) → {Promessa. |
Promessa. < {code: ConnectionErrorCode (p. 27), message:
string} >}
Si collega all'endpoint server NICE DCV specificato. Se la connessione viene eseguita correttamente,
restituisce un oggetto Connection. Se la connessione non riesce, restituisce un oggetto errore.
Parametri:
Nome Tipo Descrizione
config ConnectionConfig (p. 25) L'oggetto ConnectionConfig.
Valori restituiti:
- Un oggetto Connection o oggetto di errore.
Tipo
Promise. | Promessa. < codice: ConnectionErrorCode (p. 27), message:
string} >
setLogHandler(gestore) → {void}
Imposta una funzione di gestione log personalizzata. Quando si sovrascrive il gestore di log predefinito, la
posizione di immissione del registro originale andrà persa durante il debug con la console del browser.
Parametri:
Nome Tipo Descrizione
handler funzione La funzione di gestione log
personalizzata. La funzione
handler contiene level (number),
LevelName (stringa), dominio
(stringa) e messaggio (stringa).
Valori restituiti:
Tipo
void
14NICE DCV Guida per sviluppatori Web Client SDK
Membri
setLogLevel(livello) → {void}
Imposta il livello di log. È obbligatorio solo se viene utilizzato il gestore di log predefinito.
Parametri:
Nome Tipo Descrizione
level LogLevel (p. 36) Il livello di log da usare.
Valori restituiti:
Tipo
void
Membri
Elenco
• (costante)AudioError:AudioErrorCode (p. 15)
• (costante)AuthenticationError:AuthenticationErrorCode (p. 15)
• (costante)ChannelError:ChannelErrorCode (p. 16)
• (costante)ClosingReasonErrore:ClosingReasonErrorCode (p. 16)
• (costante)ConnectionError:ConnectionErrorCode (p. 16)
• (costante)CustomChannelErrore:CustomChannelErrorCode (p. 16)
• (costante)DisplayConfigErrore:DisplayConfigErrorCode (p. 16)
• (costante)FileStorageErrore:FileStorageErrorCode (p. 16)
• (costante)LogLevel:LogLevel (p. 16)
• (costante)MultiMonitorErrore:MultiMonitorErrorCode (p. 17)
• (costante)ResolutionError:ResolutionErrorCode (p. 17)
• versione (costante) (p. 17)
• (costante)WebcamError:WebcamErrorCode (p. 17)
(costante)AudioError:AudioErrorCode (p. 19)
LaAudioErrorcodici enum.
Type:
• AudioErrorCode (p. 19)
(costante)AuthenticationError:AuthenticationErrorCode (p. 19)
LaAuthenticationErrorcodici enum.
Type:
• AuthenticationErrorCode (p. 19)
15NICE DCV Guida per sviluppatori Web Client SDK
Membri
(costante)ChannelError:ChannelErrorCode (p. 22)
LaChannelErrorcodici enum.
Type:
• ChannelErrorCode (p. 22)
(costante)ClosingReasonErrore:ClosingReasonErrorCode (p. 23)
LaClosingReasonCodici di errore enum.
Type:
• ClosingReasonErrorCode (p. 23)
(costante)ConnectionError:ConnectionErrorCode (p. 27)
LaConnectionErrorcodici enum.
Type:
• ConnectionErrorCode (p. 27)
(costante)CustomChannelErrore:CustomChannelErrorCode (p. 28)
LaCustomChannelCodici di errore enum.
Type:
• CustomChannelErrorCode (p. 28)
(costante)DisplayConfigErrore:DisplayConfigErrorCode (p. 29)
LaDisplayConfigCodici di errore enum.
Type:
• DisplayConfigErrorCode (p. 29)
(costante)FileStorageErrore:FileStorageErrorCode (p. 33)
LaFileStorageCodici di errore enum.
Type:
• FileStorageErrorCode (p. 33)
(costante)LogLevel:LogLevel (p. 36)
I livelli di log SDK disponibili.
16NICE DCV Guida per sviluppatori Web Client SDK
Membri
Type:
• LogLevel (p. 36)
(costante)MultiMonitorErrore:MultiMonitorErrorCode (p. 37)
LaMultiMonitorCodici di errore enum.
Type:
• MultiMonitorErrorCode (p. 37)
(costante)ResolutionError:ResolutionErrorCode (p. 39)
LaResolutionErrorcodici enum.
Type:
• ResolutionErrorCode (p. 39)
versione (costante)
La versione NICE DCV con maggiore, minore, patch, revisione, estensione e versionStr.
Proprietà:
Nome Tipo Descrizione
major integer Il numero di versione principale.
minor integer Il numero di versione secondaria.
patch integer Il numero di versione della patch.
revision integer Il numero di revisione.
extended string La corda estesa.
versionStr string Una concatenazione dei
numeri principali, minori,
patch e revisioni nel
modulomajor.minor.patch
+build.revision.
(costante)WebcamError:WebcamErrorCode (p. 41)
LaWebcamErrorcodici enum.
Type:
• WebcamErrorCode (p. 41)
17NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Definizioni di tipo e callback
Elenco
• AudioErrorCode (p. 19)
• Richiamate di autenticazione (p. 19)
• AuthenticationErrorCode (p. 19)
• authErrorCallback(autenticazione, errore) (p. 20)
• authPromptCredentialsCallback (autenticazione, sfida) (p. 20)
• authSuccessCallback(autenticazione, dati di autenticazione) (p. 21)
• Canale (p. 21)
• ChannelErrorCode (p. 22)
• clipboardEventCallback(evento) (p. 22)
• ClosingReasonErrorCode (p. 23)
• ColorSpace (p. 23)
• Richiamate di connessione (p. 24)
• ConnectionConfig (p. 25)
• ConnectionErrorCode (p. 27)
• CreateDirectory (percorso) (p. 27)
• CustomChannelErrorCode (p. 28)
• dataChannelCallback(info) (p. 28)
• DeleteFile (percorso) (p. 28)
• deviceChangeEventCallback () (p. 28)
• Disconnect Callback (motivo) (p. 29)
• displayAvailabilityCallback(stato, DisplayID) (p. 29)
• DisplayConfigErrorCode (p. 29)
• displayLayoutCallback(Larghezza server, altezza server, testine) (p. 30)
• caratteristica (p. 30)
• featuresUpdateCallback(Elenco caratteristiche) (p. 30)
• fileDownloadCallback(File Resource) (p. 31)
• filePrintedCallback(Stampa risorsa) (p. 31)
• archiviazione file (p. 32)
• filestorageEnabledCallback(abilitato) (p. 33)
• FileStorageErrorCode (p. 33)
• firstFrameCallback(Resizeabilitato,relativeMouseModeAbilitato, DisplayID) (p. 34)
• idleWarningNotificationCallback (disconnectionDateTime) (p. 34)
• collaboratorListCallback(collaboratori) (p. 34)
• licenseNotificationCallback(notifica) (p. 35)
• list (percorso) (p. 36)
• LogLevel (p. 36)
• Monitorare (p. 36)
• MultiMonitorErrorCode (p. 37)
• qualityIndicatorStateCallback (stato) (p. 38)
• Rinomina directory (src, dest) (p. 38)
• RinomeFile (src, dest) (p. 39)
• ResolutionErrorCode (p. 39)
18NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
• RetrieveFile (percorso) (p. 39)
• Callback screenshot (screenshot) (p. 39)
• Informazioni sul server (p. 40)
• stats (p. 40)
• StoreFile (file, directory) (p. 41)
• WebcamErrorCode (p. 41)
AudioErrorCode
LaAudioErrorenumerazioni di codice disponibili nel modulo DCV
• SETTING_AUDIO_FAILED
• CHANNEL_NOT_AVAILABLE
Type:
• numero
Richiamate di autenticazione
Callback di autenticazione
Type:
• Oggetto
Proprietà:
Nome Tipo Descrizione
promptCredentials authPromptCredentialsRichiamata (p.
La20)
funzione di callback da
chiamare quando l'utente viene
contestato per le credenziali.
error authErrorCallback (p. 20) La funzione di callback da
chiamare quando l'autenticazione
non riesce.
success authSuccessCallback (p. 21) La funzione di callback da
chiamare quando l'autenticazione
ha esito positivo.
AuthenticationErrorCode
LaAuthenticationErrorenumerazioni di codice disponibili nel modulo DCV
• INVALID_MESSAGE
• UNKNOWN_AUTH_MODE
• SESSION_NOT_AVAILABLE
• NO_SESSIONS
• WRONG_CREDENTIALS
19NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
• SASL_CHALLENGE
• SASL_AUTH_MECHANISM
• FAILED_COMMUNICATION
• AUTHENTICATION_REJECTED
• GENERIC_ERROR
• WRONG_CREDENTIALS_FORMAT
• WRONG_CREDENTIALS_TYPE
• UNREQUESTED_CREDENTIALS
• MISSING_CREDENTIAL
Type:
• numero
authErrorCallback(autenticazione, errore)
La funzione di callback da chiamare quando l'autenticazione non riesce.
Parametri:
Nome Tipo Descrizione
authentication Autenticazione (p. 58) L'oggetto Authentication.
error Oggetto L'oggetto errore generato dal
processo di autenticazione.
Nome Tipo Descrizione
code AuthenticationErrorCode
Il codice (p. 19)
di errore.
message string Messaggio
di errore.
authPromptCredentialsCallback (autenticazione, sfida)
La funzione di callback da chiamare quando l'utente viene contestato per le credenziali. L'utente deve
rispondere alla sfida fornendo le credenziali richieste.
Parametri:
Nome Tipo Descrizione
authentication Autenticazione (p. 58) L'oggetto Authentication.
challenge Oggetto La sfida.
Nome Tipo Descrizione
Matrice. Un array
requiredCredentials
di oggetti
20NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Nome Tipo Descrizione
Nome Tipo Descrizione
credenziali
richiesti.
Nome
Tipo
Descrizione
string
name Nome
della
credenziale
richiesta.
string
type Il
tipo
di
credenziale
richiesta.
authSuccessCallback(autenticazione, dati di autenticazione)
La funzione di callback da chiamare quando l'autenticazione ha esito positivo.
Parametri:
Nome Tipo Descrizione
authentication Autenticazione (p. 58) L'oggetto Authentication.
authenticationData Matrice. Un array di oggetti che includono
ID di sessione NICE DCV e token
di autenticazione.
Nome Tipo Descrizione
sessionIdstring ID
sessione
NICE
DCV.
authTokenstring Il token
di
autenticazione
per la
sessione
NICE
DCV.
Canale
I canali disponibili che possono essere specificati.
21NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Type:
• «appunti» | «display» | «input» | «audio» | «filestorage»
ChannelErrorCode
LaChannelErrorenumerazioni di codice disponibili nel modulo DCV
• ALREADY_OPEN
• INITIALIZATION_FAILED
• REJECTED
Type:
• numero
clipboardEventCallback(evento)
La funzione di callback da chiamare quando aclipboardEventviene generato.
Parametri:
Nome Tipo Descrizione
event Oggetto Informazioni sull'evento degli
appunti.
Nome Tipo AttributesDescrizione
name stabilito Sempre
| presente.
copia Nome
| dell'evento.
incolla
|
dataSizeAlert|
autoCopyDone|
newDataAvailable|
autoPasteDone|
Errore
remoto
|
pasteAvailableData
Oggetto
clipboardData I dati
| negli
stringa appunti.
booleano
autoCopy Indica
se la
copia
automatica
dagli
22NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Nome Tipo Descrizione
Nome Tipo AttributesDescrizione
appunti
di
sessione
negli
appunti
del
client
locale
è
abilitata.
numero
maxDataSize La
quantità
massima
di dati
che è
possibile
inserire
negli
appunti.
error string
Informazioni
sull'errore,
se
applicabile.
ClosingReasonErrorCode
LaClosingReasonLe enumerazioni del codice di errore disponibili nel modulo DCV
• TRANSPORT_ERROR
• NO_ERROR
• GENERIC_ERROR
• INTERNAL_SERVER_ERROR
• PROTOCOL_ERROR
• AUTHORIZATION_DENIED
• AUTHORIZATION_REVOKED
• ACCESS_REJECTED
• IDLE_TIMEOUT_EXPIRED
• DISCONNECT_BY_OWNER
• DISCONNECT_BY_USER
Type:
• numero
ColorSpace
Gli spazi colore disponibili che possono essere specificati.
23NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Type:
• «RGB» | «YUV_REC601" | «YUV_REC709"
Richiamate di connessione
I callback disponibili per essere richiamati in caso di errore di connessione.
Type:
• Oggetto
Proprietà:
Nome Tipo Descrizione
disconnect Disconnetti la La funzione di callback da
richiamata (p. 29) chiamare al termine della
connessione.
displayLayout displayLayoutCallback (p. 30) La funzione di callback da
chiamare quando il layout o
la risoluzione dello schermo
vengono modificati.
displayAvailability displayAvailabilityCallback (p. 29) La funzione di callback da
chiamare quando cambia la
disponibilità di un display.
firstFrame firstFrameCallback (p. 34) La funzione di callback da
chiamare quando il primo
fotogramma viene ricevuto dal
server NICE DCV.
filePrinted filePrintedCallback (p. 31) La funzione di callback da
chiamare quando un file viene
stampato sul server NICE DCV.
fileDownload fileDownloadCallback (p. 31) La funzione di callback da
chiamare quando un file è pronto
per essere scaricato dal server
NICE DCV.
dataChannel dataChannelCallback (p. 28) La funzione di callback da
chiamare quando il server NICE
DCV invia una notifica sulla
disponibilità di un canale dati.
licenseNotification licenseNotificationCallback (p. 35) La funzione di callback da
chiamare quando il server NICE
DCV invia una notifica sullo stato
della licenza.
idleWarningNotification idleWarningNotificationRichiamata (p.
La34)
funzione di callback da
chiamare quando il server NICE
24NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Nome Tipo Descrizione
DCV invia un avviso di timeout
inattivo.
collaboratorList collaboratorListCallback (p. 34) La funzione di callback da
chiamare quando il server
NICE DCV invia l'elenco dei
collaboratori (a partire da NICE
DCV Web Client SDK versione
1.1.0).
qualityIndicatorState qualityIndicatorStateRichiamata (p. 38)
La funzione di callback da
chiamare quando l'indicatore di
qualità della connessione cambia
stato.
filestorageEnabled filestorageEnabledCallback (p. 33) La funzione di callback da
chiamare quando l'archiviazione
dei file è abilitata o disattivata.
featuresUpdate featuresUpdateCallback (p. 30) La funzione di callback da
chiamare quando cambia lo stato
di una feature.
clipboardEvent clipboardEventCallback (p. 22) La funzione di callback
da chiamare quando
aclipboardEventviene
generato.
deviceChangeEvent deviceChangeEventRichiamata (p. 28)
La funzione di callback
da chiamare quando
undeviceChangeviene attivato
l'evento.
screenshot Callback screenshot (p. 39) La funzione di callback
da chiamare quando
ascreenshotè disponibile.
ConnectionConfig
La configurazione per una connessione NICE DCV.
Type:
• Oggetto
Proprietà:
Nome Tipo Descrizione
url string Il nome host e la porta del server
NICE DCV in esecuzione nel
seguente formato: https://
dcv_host_address:port. Ad
25NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Nome Tipo Descrizione
esempio:https://my-dcv-
server:8443.
sessionId string ID sessione NICE DCV.
authToken string Il token di autenticazione da
utilizzare durante la connessione
al server.
baseUrl string URL assoluto o relativo da cui
caricare i file SDK.
resourceBaseUrl string L'URL assoluto o relativo da cui
accedere alle risorse DCV.
enabledChannels Matrice. Indica l'elenco dei canali che
possono essere abilitati. Se non
specificato o viene fornito un
array vuoto, viene impostato per
impostazione predefinita su tutti i
canali disponibili.
losslessColorspace ColorSpace (p. 23) Indica lo spazio colore che
verrà utilizzato. Se non viene
specificato, viene usato il valore
predefinito su «RGB».
divId string L'ID deldivoggetto nel DOM
HTML dove SDK dovrebbe
creare la tela con il flusso remoto.
volumeLevel integer Il livello di volume preferito.
L'intervallo valido è compreso tra
0 e 100.
clipboardAutoSync booleano Indica se la copia automatica
dagli appunti della sessione
NICE DCV negli appunti del client
locale è abilitata per i browser
Web compatibili.
dynamicAudioTuning booleano Indica se regolare
dinamicamente l'audio in base
alle impostazioni audio del server
NICE DCV quando viene stabilita
una connessione.
clientHiDpiScaling booleano Indica se ridimensionare la tela in
base al DPI del client.
highColorAccuracy booleano Indica se è necessario utilizzare
un'elevata precisione del colore,
se disponibile. Se non viene
specificato, viene usato il valore
predefinitofalse.
26NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Nome Tipo Descrizione
enableWebCodecs Booleano Indica seWebCodecsdovrebbe
essere usato se disponibile. Se
non specificato, viene usato il
valore predefinito false.
observers Richiamate di La funzione di callback consente
connessione (p. 24) di richiedere eventi correlati alla
connessione.
callbacks Richiamate di Lo stesso
connessione (p. 24) dellaobserversproprietà,
ma ogni richiamata include
ilConnessione (p. 41)oggetto
come primo parametro.
ConnectionErrorCode
LaConnectionErrorenumerazioni di codice disponibili nel modulo DCV
• ALREADY_OPEN
• INVALID_CONFIG
• INITIALIZATION_FAILED
• REJECTED
• MAIN_CHANNEL_ALREADY_OPEN
• GENERIC_ERROR(a partire da DCV Server 2021.0)
• INTERNAL_SERVER_ERROR(a partire da DCV Server 2021.0)
• AUTHENTICATION_FAILED(a partire da DCV Server 2021.0)
• PROTOCOL_ERROR(a partire da DCV Server 2021.0)
• INVALID_SESSION_ID(a partire da DCV Server 2021.0)
• INVALID_CONNECTION_ID(a partire da DCV Server 2021.0)
• CONNECTION_LIMIT_REACHED(a partire da DCV Server 2021.0)
Type:
• numero
CreateDirectory (percorso)
Parametri:
Nome Tipo Descrizione
path string Il percorso assoluto sul server
in cui vogliamo creare una
directory. Dovrebbe includere
anche il nome della directory di
destinazione.
27NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
CustomChannelErrorCode
LaCustomChannelLe enumerazioni del codice di errore disponibili nel modulo DCV
• TRANSPORT_ERROR
Type:
• numero
dataChannelCallback(info)
La funzione di callback da chiamare quando il server NICE DCV invia una notifica sulla disponibilità di un
canale dati.
Parametri:
Nome Tipo Descrizione
info Oggetto Le informazioni sul canale dati.
Nome Tipo Descrizione
name string Il nome
del
canale
dati.
token string Il token
di
autenticazione
per il
canale
dati.
DeleteFile (percorso)
Parametri:
Nome Tipo Descrizione
path string Il percorso assoluto sul server
che identifica il file che vogliamo
eliminare.
deviceChangeEventCallback ()
La funzione di callback da chiamare quando undeviceChangeviene attivato l'evento.
28NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Disconnect Callback (motivo)
La funzione di callback da chiamare al termine della connessione.
Parametri:
Nome Tipo Descrizione
reason Oggetto Il motivo della disconnessione.
Nome Tipo Descrizione
code numero Il codice
di
motivo.
message string Il
messaggio
motivo.
displayAvailabilityCallback(stato, DisplayID)
La funzione di callback da chiamare quando cambia la disponibilità di un display.
Parametri:
Nome Tipo Descrizione
status Oggetto Lo stato del display.
Nome Tipo Descrizione
enabled booleano Indica
se il
display è
abilitato.
closed booleano Indica se
il display
è chiuso.
displayId numero Identificatore per il display.
DisplayConfigErrorCode
LaDisplayConfigLe enumerazioni del codice di errore disponibili nel modulo DCV
• INVALID_ARGUMENT
• UNSUPPORTED_OPERATION
• NO_CHANNEL
29NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Type:
• numero
displayLayoutCallback(Larghezza server, altezza server, testine)
La funzione di callback da chiamare quando il layout o la risoluzione dello schermo vengono modificati.
Parametri:
Nome Tipo Descrizione
serverWidth numero Larghezza (in pixel) del display
principale.
serverHeight numero Altezza (in pixel) del display
principale.
heads Matrice. Le testine di visualizzazione
supportate dal server NICE DCV.
caratteristica
I valori delle feature.
• display- Indica la disponibilità di un flusso video a schermo singolo.
• display-multi- Indica la disponibilità di un flusso video multi-display.
• high-color-accuracy- Indica la disponibilità di elevata precisione del colore (dalla versione 1.1.0
dell'SDK NICE DCV Web Client).
• mouse- Indica la disponibilità della funzionalità del mouse.
• keyboard- Indica la disponibilità della funzionalità della tastiera.
• keyboard-sas- Indica la disponibilità della funzionalità della sequenza SAS (Control + Alt + Delete).
• relative-mouse- Indica la disponibilità della modalità mouse relativa.
• clipboard-copy- Indica la disponibilità della funzionalità di copia degli appunti dal server NICE DCV al
client.
• clipboard-paste- Indica la disponibilità della funzionalità di incolla degli appunti dal client al server
NICE DCV.
• audio-in- Indica la disponibilità della funzionalità di ingresso audio tramite il microfono.
• audio-out- Indica la disponibilità della funzionalità di riproduzione audio.
• webcam- Indica la disponibilità della funzionalità di streaming della webcam.
• file-download- Indica la disponibilità della funzionalità di download dei file dal server NICE DCV al
client.
• file-upload- Indica la disponibilità della funzionalità di caricamento dei file dal client al server NICE
DCV.
Type:
• string
featuresUpdateCallback(Elenco caratteristiche)
La funzione di callback da chiamare quando cambia lo stato di una feature.
30NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Parametri:
Nome Tipo Descrizione
featuresList Matrice. Una serie di funzionalità che
sono cambiate.
fileDownloadCallback(File Resource)
La funzione di callback da chiamare quando un file è pronto per essere scaricato dal server NICE DCV.
Parametri:
Nome Tipo Descrizione
fileResource Oggetto Informazioni sul file pronto per il
download.
Nome Tipo Descrizione
id string L'identificatore
per il file.
url string URL da
usare
per
scaricare
il file.
domain string Il
dominio
delle
risorse.
token string Il token
di
autenticazione
da
utilizzare
per
scaricare
il file. Il
token è
incluso
anche
nell'URL.
filePrintedCallback(Stampa risorsa)
La funzione di callback da chiamare quando un file viene stampato sul server NICE DCV.
31NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Parametri:
Nome Tipo Descrizione
printResource Oggetto Informazioni sul file stampato.
Nome Tipo Descrizione
id string Identificatore
per il file
stampato.
url string L'URL
da
utilizzare
per
scaricare
il file
stampato.
domain string Il
dominio
delle
risorse.
In
questo
caso,printer.
token string Il token
di
autenticazione
da
utilizzare
per
scaricare
il file
stampato.
Il token
è incluso
anche
nell'URL.
archiviazione file
Oggetto che consente di esplorare ed eseguire azioni sul file system.
Type:
• Oggetto
32NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
Proprietà:
Nome Tipo Descrizione
list lista (p. 36) Funzione che consente di
elencare gli elementi (file e
directory) presenti nel percorso
fornito sul server.
createDirectory CreateDirectory (p. 27) Funzione che consente di creare
una directory nel percorso
specificato sul server.
retrieveFile Recupera file (p. 39) Funzione che consente di
scaricare localmente un file nel
percorso specificato sul server.
deleteFile Elimina file (p. 28) Funzione che consente di
eliminare un file nel percorso
specificato sul server.
renameFile Rinomina file (p. 39) Funzione che consente di
rinominare un file dal percorso di
origine specificato al percorso di
destinazione specificato.
renameDirectory Rinomina directory (p. 38) Funzione che consente di
rinominare una directory dal
percorso di origine specificato
al percorso di destinazione
assoluto.
storeFile File Store (p. 41) Funzione che consente di
caricare un file locale sul
percorso fornito sul server.
filestorageEnabledCallback(abilitato)
La funzione di callback da chiamare quando l'archiviazione dei file è abilitata. Canale pigro solo su Internet
Explorer 11.
Parametri:
Nome Tipo Descrizione
enabled booleano Indica se l'archiviazione dei file è
abilitata.
FileStorageErrorCode
LaFileStorageLe enumerazioni del codice di errore disponibili nel modulo DCV
• CANCELLED
• ABORTED
33NICE DCV Guida per sviluppatori Web Client SDK
Definizioni di tipo e callback
• INVALID_ARGUMENT
• NOT_IMPLEMENTED
• ERROR
• ALREADY_EXIST
• NOT_FOUND
Type:
• numero
firstFrameCallback(Resizeabilitato,relativeMouseModeAbilitato,
DisplayID)
La funzione di callback da chiamare quando il primo fotogramma viene ricevuto dal server NICE DCV.
Emesso per ogni display.
Parametri:
Nome Tipo Descrizione
resizeEnabled booleano Indica se il server supporta il
ridimensionamento del layout di
visualizzazione del client.
relativeMouseModeEnabled booleano Indica se il server supporta la
modalità mouse relativa.
displayId numero Identificatore per il display.
idleWarningNotificationCallback (disconnectionDateTime)
La funzione di callback da chiamare quando il server NICE DCV invia un avviso di timeout inattivo.
Parametri:
Nome Tipo Descrizione
disconnectionDateTime Data La data e l'ora della
disconnessione.
collaboratorListCallback(collaboratori)
La funzione di callback da chiamare quando il server NICE DCV invia l'elenco dei collaboratori.
Parametri:
Nome Tipo Descrizione
collaborators Matrice. Un elenco di oggetti contenenti
informazioni sui collaboratori.
34Puoi anche leggere
