FTPProvider
Definiert in: sdk/cosmolink.SDK.FTP.ts:248
FTP-Provider
Implementiert
Disposable
Konstruktoren
Konstruktor
new FTPProvider(connectionSettings): FTPProvider;
Definiert in: sdk/cosmolink.SDK.FTP.ts:267
Initialisiert einen neuen FTP Provider
Parameter
| Parameter | Type | Description |
|---|---|---|
connectionSettings | FTPConnectionSettings | Verbindungsoptionen |
Rückgabewert
FTPProvider
Methoden
[dispose]()
dispose: void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:835
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
copyFile()
Aufrufsignatur
copyFile(
sourceFilePath,
targetFilePath,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:285
Kopiert eine bereits auf dem Server liegende Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Quellpfad |
targetFilePath | string | Zielpfad |
options? | { remoteExistsOption?: FtpRemoteExistsOption; } | 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
Aufrufsignatur
copyFile(
sourceDirectoryPath,
sourceFileName,
targetDirectoryPath,
targetFileName,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:306
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? | { remoteExistsOption?: FtpRemoteExistsOption; } | 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
createDirectory()
createDirectory(directoryPath, options?): boolean;
Definiert in: sdk/cosmolink.SDK.FTP.ts:400
Erstellt ein neuen Ordner
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Server - Verzeichnis |
options? | { force: boolean; } | Optionen |
options.force? | boolean | Wenn true , wird versucht die komplette Verzeichnisskette anzulegen. Standardwert: true |
Rückgabewert
boolean
deleteDirectory()
deleteDirectory(directoryPath): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:565
Löscht ein Verzeichnis
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Verzeichnis |
Rückgabewert
void
deleteFile()
Aufrufsignatur
deleteFile(filePath): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:575
Löscht eine Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Dateipfad |
Rückgabewert
void
Aufrufsignatur
deleteFile(filePath, fileName): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:583
Löscht eine Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Verzeichnis |
fileName | string | Dateiname |
Rückgabewert
void
Dispose()
Dispose(): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:829
Standardimplementierung des Dispose
Rückgabewert
void
downloadFile()
Aufrufsignatur
downloadFile(
remotePath,
localPath,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:633
Lädt eine Datei in einen bestimmten Pfad herunter
Parameter
| Parameter | Type | Description |
|---|---|---|
remotePath | string | Server - Dateipfad |
localPath | string | Lokaler Zielpfad |
options? | { localExistsOption?: FtpLocalExistsOption; progressAction?: (arg0) => void; verifyOption?: FtpVerifyOption; } | 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
Aufrufsignatur
downloadFile(
remoteDirectoryPath,
remoteFileName,
localPath,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:664
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? | { localExistsOption?: FtpLocalExistsOption; progressAction?: (arg0) => void; verifyOption?: FtpVerifyOption; } | 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
downloadFileBytes()
Aufrufsignatur
downloadFileBytes(remotePath, options?): Uint8Array;
Definiert in: sdk/cosmolink.SDK.FTP.ts:709
Lädt eine Datei als Bytes herunter
Parameter
| Parameter | Type | Description |
|---|---|---|
remotePath | string | Server - Dateipfad |
options? | { progressAction?: (arg0) => void; restartPosition: number; stopPosition: number; } | 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
Aufrufsignatur
downloadFileBytes(
remoteDirectoryPath,
remoteFileName,
options?): Uint8Array;
Definiert in: sdk/cosmolink.SDK.FTP.ts:739
Lädt eine Datei als Bytes herunter
Parameter
| Parameter | Type | Description |
|---|---|---|
remoteDirectoryPath | string | Server - Verzeichnis |
remoteFileName | string | Server - Dateiname |
options? | { localExistsOption?: FtpLocalExistsOption; progressAction?: (arg0) => void; verifyOption?: FtpVerifyOption; } | 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
fileExists()
Aufrufsignatur
fileExists(filePath): boolean;
Definiert in: sdk/cosmolink.SDK.FTP.ts:603
Pürft ob eine Datei existiert
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Dateipfad |
Rückgabewert
boolean
Aufrufsignatur
fileExists(directoryPath, fileName): boolean;
Definiert in: sdk/cosmolink.SDK.FTP.ts:611
Pürft ob eine Datei existiert
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Verzeichnis |
fileName | string | Dateiname |
Rückgabewert
boolean
getWorkingDirectory()
getWorkingDirectory(): string;
Definiert in: sdk/cosmolink.SDK.FTP.ts:814
Gibt das aktuelle WorkingDirectory aus
Rückgabewert
string
listFiles()
listFiles(directory, options?): FileInfo[];
Definiert in: sdk/cosmolink.SDK.FTP.ts:784
Gibt Auflistung der Dateien im Verzeichnis zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
directory | string | Verzeichnis |
options? | { filter?: (arg0) => boolean; listOption?: FtpListOption; } | Optionen |
options.filter? | (arg0) => boolean | Filter |
options.listOption? | FtpListOption | Bestimmt die Verzeichnistiefe für die Suche Standardwert: topDirectoryOnly |
Rückgabewert
FileInfo[]
moveFile()
Aufrufsignatur
moveFile(
sourceFilePath,
targetFilePath,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:344
Verschiebt eine bereits auf dem Server liegende Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Quellpfad |
targetFilePath | string | Zielpfad |
options? | { remoteExistsOption?: FtpRemoteExistsOption; } | 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
Aufrufsignatur
moveFile(
sourceDirectoryPath,
sourceFileName,
targetDirectoryPath,
targetFileName,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:365
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? | { remoteExistsOption?: FtpRemoteExistsOption; } | 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
test()
test(): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:823
Testet die Verbindung mit dem Server
Rückgabewert
void
uploadFile()
Aufrufsignatur
uploadFile(
localPath,
remotePath,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:427
Lädt eine Datei auf den Server
Parameter
| Parameter | Type | Description |
|---|---|---|
localPath | string | Lokaler Dateipfad |
remotePath | string | Zielpfad |
options? | { progressAction?: (arg0) => void; remoteExistsOption?: FtpRemoteExistsOption; verifyOption?: FtpVerifyOption; } | 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
Aufrufsignatur
uploadFile(
localPath,
remoteDirectoryPath,
remoteFileName,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:458
Lädt eine Datei auf den Server
Parameter
| Parameter | Type | Description |
|---|---|---|
localPath | string | Lokaler Dateipfad |
remoteDirectoryPath | string | Server - Verzeichnis |
remoteFileName | string | Server - Dateiname |
options? | { progressAction?: (arg0) => void; remoteExistsOption?: FtpRemoteExistsOption; verifyOption?: FtpVerifyOption; } | 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
uploadFileBytes()
Aufrufsignatur
uploadFileBytes(
bytes,
remotePath,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:504
Lädt eine Datei auf den Server
Parameter
| Parameter | Type | Description |
|---|---|---|
bytes | Uint8Array | Dateibytes |
remotePath | string | Server - Dateipfad |
options? | { progressAction?: (arg0) => void; remoteExistsOption?: FtpRemoteExistsOption; } | 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
Aufrufsignatur
uploadFileBytes(
bytes,
remoteDirectoryPath,
remoteFileName,
options?): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:528
Lädt eine Datei auf den Server
Parameter
| Parameter | Type | Description |
|---|---|---|
bytes | Uint8Array | Dateibytes |
remoteDirectoryPath | string | Server - Verzeichnis |
remoteFileName | string | Server - Dateiname |
options? | { progressAction?: (arg0) => void; remoteExistsOption?: FtpRemoteExistsOption; } | 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
[hasInstance]()
static hasInstance: boolean;
Definiert in: sdk/cosmolink.SDK.FTP.ts:843
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean