SFTPProvider
Definiert in: sdk/cosmolink.SDK.FTP.ts:853
SFTP-Provider
Implementiert
Disposable
Konstruktoren
Konstruktor
new SFTPProvider(connectionSettings): SFTPProvider;
Definiert in: sdk/cosmolink.SDK.FTP.ts:872
Initialisiert einen neuen FTP Provider
Parameter
| Parameter | Type | Description |
|---|---|---|
connectionSettings | SFTPConnectionSettings | Verbindungsoptionen |
Rückgabewert
SFTPProvider
Methoden
[dispose]()
dispose: void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1375
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
copyFileAsync()
Aufrufsignatur
copyFileAsync(
sourceFilePath,
targetFilePath,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:890
Kopiert eine bereits auf dem Server liegende Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Quellpfad |
targetFilePath | string | Zielpfad |
options? | { remoteExistsOption?: SFtpRemoteExistsOption; } | Optionen |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Throws
Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte
Aufrufsignatur
copyFileAsync(
sourceDirectoryPath,
sourceFileName,
targetDirectoryPath,
targetFileName,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:911
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?: SFtpRemoteExistsOption; } | Optionen |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Throws
Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte
createDirectoryAsync()
createDirectoryAsync(directoryPath): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1004
Erstellt ein neuen Ordner
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Server - Verzeichnis |
Rückgabewert
Promise<void>
deleteDirectoryAsync()
deleteDirectoryAsync(directoryPath): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1140
Löscht ein Verzeichnis
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Server - Verzeichnis |
Rückgabewert
Promise<void>
deleteFileAsync()
Aufrufsignatur
deleteFileAsync(filePath): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1150
Löscht eine Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Server - Dateipfad |
Rückgabewert
Promise<void>
Aufrufsignatur
deleteFileAsync(filePath, fileName): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1158
Löscht eine Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Verzeichnis |
fileName | string | Dateiname |
Rückgabewert
Promise<void>
Dispose()
Dispose(): void;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1369
Standardimplementierung des Dispose
Rückgabewert
void
downloadFileAsync()
Aufrufsignatur
downloadFileAsync(
remotePath,
localPath,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1208
Lädt eine Datei in einen bestimmten Pfad herunter
Parameter
| Parameter | Type | Description |
|---|---|---|
remotePath | string | Server - Dateipfad |
localPath | string | Lokaler Zielpfad |
options? | { localExistsOption?: SFtpLocalExistsOption; progressAction?: (arg0) => void; } | Downloadoptionen |
options.localExistsOption? | SFtpLocalExistsOption | 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 |
Rückgabewert
Promise<void>
Aufrufsignatur
downloadFileAsync(
remoteDirectoryPath,
remoteFileName,
localPath,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1232
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?: SFtpLocalExistsOption; progressAction?: (arg0) => void; } | Optionen |
options.localExistsOption? | SFtpLocalExistsOption | 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 |
Rückgabewert
Promise<void>
downloadFileBytesAsync()
Aufrufsignatur
downloadFileBytesAsync(remotePath, options?): Promise<Uint8Array<ArrayBufferLike>>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1270
Lädt eine Datei als Bytes herunter
Parameter
| Parameter | Type | Description |
|---|---|---|
remotePath | string | Server - Dateipfad |
options? | { progressAction?: (arg0) => void; } | Optionen |
options.progressAction? | (arg0) => void | Aktion die ausgeführt wird um den Fortschritt des Downloads überwachen zu können |
Rückgabewert
Promise<Uint8Array<ArrayBufferLike>>
Aufrufsignatur
downloadFileBytesAsync(
remoteDirectoryPath,
remoteFileName,
options?): Promise<Uint8Array<ArrayBufferLike>>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1286
Lädt eine Datei als Bytes herunter
Parameter
| Parameter | Type | Description |
|---|---|---|
remoteDirectoryPath | string | Server - Verzeichnis |
remoteFileName | string | Server - Dateiname |
options? | { localExistsOption?: SFtpLocalExistsOption; progressAction?: (arg0) => void; } | Optionen |
options.localExistsOption? | SFtpLocalExistsOption | 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 |
Rückgabewert
Promise<Uint8Array<ArrayBufferLike>>
fileExistsAsync()
Aufrufsignatur
fileExistsAsync(filePath): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1178
Pürft ob eine Datei existiert
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Server - Dateipfad |
Rückgabewert
Promise<boolean>
Aufrufsignatur
fileExistsAsync(directoryPath, fileName): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1186
Pürft ob eine Datei existiert
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Verzeichnis |
fileName | string | Dateiname |
Rückgabewert
Promise<boolean>
getWorkingDirectory()
getWorkingDirectory(): string;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1354
Gibt das aktuelle WorkingDirectory aus
Rückgabewert
string
listFilesAsync()
listFilesAsync(directoryPath, options?): Promise<FileInfo[]>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1324
Gibt Auflistung der Dateien im Verzeichnis zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Verzeichnis |
options? | { filter?: (arg0) => boolean; listOption?: SFtpListOption; } | Optionen |
options.filter? | (arg0) => boolean | Filter |
options.listOption? | SFtpListOption | Bestimmt die Verzeichnistiefe für die Suche Standardwert: topDirectoryOnly |
Rückgabewert
Promise<FileInfo[]>
moveFileAsync()
Aufrufsignatur
moveFileAsync(
sourceFilePath,
targetFilePath,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:949
Verschiebt eine bereits auf dem Server liegende Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Quellpfad |
targetFilePath | string | Zielpfad |
options? | { remoteExistsOption?: SFtpRemoteExistsOption; } | Optionen |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Verschiebevorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Throws
Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte
Aufrufsignatur
moveFileAsync(
sourceDirectoryPath,
sourceFileName,
targetDirectoryPath,
targetFileName,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:970
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?: SFtpRemoteExistsOption; } | Optionen |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Verschiebevorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Throws
Exception - Löst eine Exception aus, wenn der Vorgang nicht abgeschlossen werden konnte
testAsync()
testAsync(): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1363
Testet die Verbindung mit dem Server
Rückgabewert
Promise<void>
uploadFileAsync()
Aufrufsignatur
uploadFileAsync(
localPath,
remotePath,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1016
Lädt eine Datei auf den Server
Parameter
| Parameter | Type | Description |
|---|---|---|
localPath | string | Lokaler Dateipfad |
remotePath | string | Server - Dateipfad |
options? | { progressAction?: (arg0) => void; remoteExistsOption?: SFtpRemoteExistsOption; } | Optionen |
options.progressAction? | (arg0) => void | Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Aufrufsignatur
uploadFileAsync(
localPath,
remoteDirectoryPath,
remoteFileName,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1040
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?: SFtpRemoteExistsOption; } | Optionen |
options.progressAction? | (arg0) => void | Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
uploadFileBytesAsync()
Aufrufsignatur
uploadFileBytesAsync(
bytes,
remotePath,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1079
Lädt eine Datei auf den Server
Parameter
| Parameter | Type | Description |
|---|---|---|
bytes | Uint8Array | Dateibytes |
remotePath | string | Server - Dateipfad |
options? | { progressAction?: (arg0) => void; remoteExistsOption?: SFtpRemoteExistsOption; } | Optionen |
options.progressAction? | (arg0) => void | Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Aufrufsignatur
uploadFileBytesAsync(
bytes,
remoteDirectoryPath,
remoteFileName,
options?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1103
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?: SFtpRemoteExistsOption; } | Optionen |
options.progressAction? | (arg0) => void | Aktion die ausgeführt wird um den Fortschritt des Uploads überwachen zu können |
options.remoteExistsOption? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
[hasInstance]()
static hasInstance: boolean;
Definiert in: sdk/cosmolink.SDK.FTP.ts:1383
Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.
Parameter
| Parameter | Type |
|---|---|
value | any |
Rückgabewert
boolean