FTPProvider

FTP-Provider

Implementiert

• Disposable

Konstruktoren

new FTPProvider()

new FTPProvider(connectionSettings): FTPProvider

Initialisiert einen neuen FTP Provider

Parameter

Parameter	Type	Description
connectionSettings	FTPConnectionSettings	Verbindungsoptionen

Rückgabewert

FTPProvider

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:256

Methoden

Dispose()

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:816

---

[dispose]()

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:822

---

copyFile()

copyFile(sourceFilePath, targetFilePath, options)

copyFile(
   sourceFilePath, 
   targetFilePath, 
   options?): void

Kopiert eine bereits auf dem Server liegende Datei

Parameter

Parameter	Type	Description
sourceFilePath	string	Quellpfad
targetFilePath	string	Zielpfad
options?	object	Optionen
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite

Rückgabewert

void

Throws

Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:270

copyFile(sourceDirectoryPath, sourceFileName, targetDirectoryPath, targetFileName, options)

copyFile(
   sourceDirectoryPath, 
   sourceFileName, 
   targetDirectoryPath, 
   targetFileName, 
   options?): void

Kopiert eine bereits auf dem Server liegende Datei

Parameter

Parameter	Type	Description
sourceDirectoryPath	string	Quellverzeichnis
sourceFileName	string	Quelldateiname
targetDirectoryPath	string	Zielverzeichnis
targetFileName	string	Zieldateiname
options?	object	Optionen
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite

Rückgabewert

void

Throws

Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:291

---

createDirectory()

createDirectory(directoryPath, options?): boolean

Erstellt ein neuen Ordner

Parameter

Parameter	Type	Description
directoryPath	string	Server - Verzeichnis
options?	object	Optionen
options.force?	boolean	Wenn true , wird versucht die komplette Verzeichnisskette anzulegen. Standardwert: true

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:385

---

deleteDirectory()

deleteDirectory(directoryPath): void

Löscht ein Verzeichnis

Parameter

Parameter	Type	Description
directoryPath	string	Verzeichnis

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:550

---

deleteFile()

deleteFile(filePath)

deleteFile(filePath): void

Löscht eine Datei

Parameter

Parameter	Type	Description
filePath	string	Dateipfad

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:560

deleteFile(filePath, fileName)

deleteFile(filePath, fileName): void

Löscht eine Datei

Parameter

Parameter	Type	Description
filePath	string	Verzeichnis
fileName	string	Dateiname

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:568

---

downloadFile()

downloadFile(remotePath, localPath, options)

downloadFile(
   remotePath, 
   localPath, 
   options?): void

Lädt eine Datei in einen bestimmten Pfad herunter

Parameter

Parameter	Type	Description
remotePath	string	Server - Dateipfad
localPath	string	Lokaler Zielpfad
options?	object	Downloadoptionen
options.localExistsOption?	FtpLocalExistsOption	Bestimmt die Handhabung des Vorgangs falls die Zieldatei bereits auf dem lokalen System existiert Standardwert: overwrite
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Downloads überwachen zu können
options.verifyOption?	FtpVerifyOption	Bestimmt den Verifizierungsprozess des Downloads Standardwert: none

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:618

downloadFile(remoteDirectoryPath, remoteFileName, localPath, options)

downloadFile(
   remoteDirectoryPath, 
   remoteFileName, 
   localPath, 
   options?): void

Lädt eine Datei in einen bestimmten Pfad herunter

Parameter

Parameter	Type	Description
remoteDirectoryPath	string	Server - Verzeichnis
remoteFileName	string	Server - Dateiname
localPath	string	Lokaler Zielpfad
options?	object	Optionen
options.localExistsOption?	FtpLocalExistsOption	Bestimmt die Handhabung des Vorgangs falls die Zieldatei bereits auf dem lokalen System existiert Standardwert: overwrite
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Downloads überwachen zu können
options.verifyOption?	FtpVerifyOption	Bestimmt den Verifizierungsprozess des Downloads Standardwert: none

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:649

---

downloadFileBytes()

downloadFileBytes(remotePath, options)

downloadFileBytes(remotePath, options?): Uint8Array

Lädt eine Datei als Bytes herunter

Parameter

Parameter	Type	Description
remotePath	string	Server - Dateipfad
options?	object	Optionen
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Downloads überwachen zu können
options.restartPosition?	number	Die Größe der vorhandenen Datei in Bytes, oder 0, wenn unbekannt. Der Download wird ab diesem Byte-Index fortgesetzt. Standardwert: 0
options.stopPosition?	number	Der letzte Byte-Index, der heruntergeladen werden soll, oder 0, wenn die gesamte Datei heruntergeladen werden soll. Standardwert: 0

Rückgabewert

Uint8Array

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:694

downloadFileBytes(remoteDirectoryPath, remoteFileName, options)

downloadFileBytes(
   remoteDirectoryPath, 
   remoteFileName, 
   options?): Uint8Array

Lädt eine Datei als Bytes herunter

Parameter

Parameter	Type	Description
remoteDirectoryPath	string	Server - Verzeichnis
remoteFileName	string	Server - Dateiname
options?	object	Optionen
options.localExistsOption?	FtpLocalExistsOption	Bestimmt die Handhabung des Vorgangs falls die Zieldatei bereits auf dem lokalen System existiert Standardwert: overwrite
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Downloads überwachen zu können
options.verifyOption?	FtpVerifyOption	Bestimmt den Verifizierungsprozess des Downloads Standardwert: none

Rückgabewert

Uint8Array

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:724

---

fileExists()

fileExists(filePath)

fileExists(filePath): boolean

Pürft ob eine Datei existiert

Parameter

Parameter	Type	Description
filePath	string	Dateipfad

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:588

fileExists(directoryPath, fileName)

fileExists(directoryPath, fileName): boolean

Pürft ob eine Datei existiert

Parameter

Parameter	Type	Description
directoryPath	string	Verzeichnis
fileName	string	Dateiname

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:596

---

getWorkingDirectory()

getWorkingDirectory(): string

Gibt das aktuelle WorkingDirectory aus

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:801

---

listFiles()

listFiles(directory, options?): FileInfo[]

Gibt Auflistung der Dateien im Verzeichnis zurück

Parameter

Parameter	Type	Description
directory	string	Verzeichnis
options?	object	Optionen
options.filter?	(arg0) => boolean	Filter
options.listOption?	FtpListOption	Bestimmt die Verzeichnistiefe für die Suche Standardwert: topDirectoryOnly

Rückgabewert

FileInfo[]

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:769

---

moveFile()

moveFile(sourceFilePath, targetFilePath, options)

moveFile(
   sourceFilePath, 
   targetFilePath, 
   options?): void

Verschiebt eine bereits auf dem Server liegende Datei

Parameter

Parameter	Type	Description
sourceFilePath	string	Quellpfad
targetFilePath	string	Zielpfad
options?	object	Optionen
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Verschiebevorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite

Rückgabewert

void

Throws

Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:329

moveFile(sourceDirectoryPath, sourceFileName, targetDirectoryPath, targetFileName, options)

moveFile(
   sourceDirectoryPath, 
   sourceFileName, 
   targetDirectoryPath, 
   targetFileName, 
   options?): void

Verschiebt eine bereits auf dem Server liegende Datei

Parameter

Parameter	Type	Description
sourceDirectoryPath	string	Quellverzeichnis
sourceFileName	string	Quelldateiname
targetDirectoryPath	string	Zielverzeichnis
targetFileName	string	Zieldateiname
options?	object	Optionen
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Verschiebevorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite

Rückgabewert

void

Throws

Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:350

---

test()

test(): void

Testet die Verbindung mit dem Server

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:810

---

uploadFile()

uploadFile(localPath, remotePath, options)

uploadFile(
   localPath, 
   remotePath, 
   options?): void

Lädt eine Datei auf den Server

Parameter

Parameter	Type	Description
localPath	string	Lokaler Dateipfad
remotePath	string	Zielpfad
options?	object	Optionen
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite
options.verifyOption?	FtpVerifyOption	Bestimmt den Verifizierungsprozess des Uploads Standardwert: none

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:412

uploadFile(localPath, remoteDirectoryPath, remoteFileName, options)

uploadFile(
   localPath, 
   remoteDirectoryPath, 
   remoteFileName, 
   options?): void

Lädt eine Datei auf den Server

Parameter

Parameter	Type	Description
localPath	string	Lokaler Dateipfad
remoteDirectoryPath	string	Server - Verzeichnis
remoteFileName	string	Server - Dateiname
options?	object	Optionen
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite
options.verifyOption?	FtpVerifyOption	Bestimmt den Verifizierungsprozess des Uploads Standardwert: none

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:443

---

uploadFileBytes()

uploadFileBytes(bytes, remotePath, options)

uploadFileBytes(
   bytes, 
   remotePath, 
   options?): void

Lädt eine Datei auf den Server

Parameter

Parameter	Type	Description
bytes	Uint8Array	Dateibytes
remotePath	string	Server - Dateipfad
options?	object	Optionen
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:489

uploadFileBytes(bytes, remoteDirectoryPath, remoteFileName, options)

uploadFileBytes(
   bytes, 
   remoteDirectoryPath, 
   remoteFileName, 
   options?): void

Lädt eine Datei auf den Server

Parameter

Parameter	Type	Description
bytes	Uint8Array	Dateibytes
remoteDirectoryPath	string	Server - Verzeichnis
remoteFileName	string	Server - Dateiname
options?	object	Optionen
options.progressAction?	(arg0) => void	Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können
options.remoteExistsOption?	FtpRemoteExistsOption	Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite

Rückgabewert

void

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:513

---

[hasInstance]()

static hasInstance: boolean

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

Parameter	Type
value	any

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.FTP.ts:830