Bei dem Session-Objekt handelt es sich um den Hauptzugriffspunkt für die Interaktion mit dem Host. Es enthält Funktionen zum Herstellen und Trennen einer Verbindung und zum Abrufen des PresentationSpace-Objekts.
Tabelle 5-32 Funktionen des Session-Objekts
|
METHODEN |
|
|---|---|
|
connect() |
Stellt die Verbindung zum konfigurierten Host her. Verwenden Sie ggf. wait.forConnect(), um die Makroausführung zu blockieren, bis die Verbindung hergestellt wurde. Ausgabe Keine |
|
disconnect() |
Trennt die Sitzung zum konfigurierten Host. Verwenden Sie ggf. wait.forDisconnect(), um die Makroausführung zu blockieren, bis die Verbindung hergestellt wurde. Ausgabe Keine |
|
isConnected() |
Gibt an, ob eine Verbindung zum Host besteht. Ausgabe {Boolean} 'True', wenn die Hostverbindung hergestellt wurde, 'False', wenn keine Verbindung besteht. |
|
getPresentationSpace() |
Gewährt Zugriff auf die PresentationSpace-Instanz für diese Sitzung. Ausgabe {PresentationSpace} Instanz, die dieser Sitzung zugeordnet ist. |
|
getDeviceName() |
Gibt für eine verbundene Sitzung den Gerätenamen zurück und gibt für eine getrennte Sitzung oder Sitzung ohne Gerätenamen eine leere Zeichenkette zurück. Ausgabe {Zeichenkette}Der Name des verbundenen Geräts. |
|
getType() |
Gibt den Typ der Hostsitzung zurück. Weitere Informationen hierzu finden Sie in SessionType. Ausgabe {String} Der Typ der Hostsitzung. |
|
setDeviceName() |
Bietet eine Möglichkeit, in einer Sitzungsinstanz den Gerätenamen zu ändern. Parameter {String} name Gerätename, der bei der Herstellung einer Verbindung zu einem Host verwendet werden soll. Ergebnis {Error} Wenn während einer hergestellten Sitzung versucht wurde, den Gerätenamen einzurichten. |
|
getOIA() |
Gewährt Zugriff auf die OIA-Instanz für diese Sitzung. Ausgabe {OIA} Ist dieser Sitzung zugeordnet. |