SFTPProvider
SFTP-Provider
Implementiert
Disposable
Konstruktoren
new SFTPProvider()
new SFTPProvider(connectionSettings): SFTPProvider
Initialisiert einen neuen FTP Provider
Parameter
| Parameter | Type | Description |
|---|---|---|
connectionSettings | SFTPConnectionSettings | Verbindungsoptionen |
Rückgabewert
Definiert in
cosmolink.SDK.FTP.ts:872
Methoden
Dispose()
Dispose(): void
Standardimplementierung des Dispose
Rückgabewert
void
Definiert in
cosmolink.SDK.FTP.ts:1369
[dispose]()
dispose: void
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
Definiert in
cosmolink.SDK.FTP.ts:1375
copyFileAsync()
copyFileAsync(sourceFilePath, targetFilePath, options)
copyFileAsync(
sourceFilePath,
targetFilePath,
options?): Promise<void>
Kopiert eine bereits auf dem Server liegende Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Quellpfad |
targetFilePath | string | Zielpfad |
options? | object | 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
Definiert in
cosmolink.SDK.FTP.ts:890
copyFileAsync(sourceDirectoryPath, sourceFileName, targetDirectoryPath, targetFileName, options)
copyFileAsync(
sourceDirectoryPath,
sourceFileName,
targetDirectoryPath,
targetFileName,
options?): Promise<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? | 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
Definiert in
cosmolink.SDK.FTP.ts:911
createDirectoryAsync()
createDirectoryAsync(directoryPath): Promise<void>
Erstellt ein neuen Ordner
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Server - Verzeichnis |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1004
deleteDirectoryAsync()
deleteDirectoryAsync(directoryPath): Promise<void>
Löscht ein Verzeichnis
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Server - Verzeichnis |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1140
deleteFileAsync()
deleteFileAsync(filePath)
deleteFileAsync(filePath): Promise<void>
Löscht eine Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Server - Dateipfad |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1150
deleteFileAsync(filePath, fileName)
deleteFileAsync(filePath, fileName): Promise<void>
Löscht eine Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Verzeichnis |
fileName | string | Dateiname |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1158
downloadFileAsync()
downloadFileAsync(remotePath, localPath, options)
downloadFileAsync(
remotePath,
localPath,
options?): Promise<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? | 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>
Definiert in
cosmolink.SDK.FTP.ts:1208
downloadFileAsync(remoteDirectoryPath, remoteFileName, localPath, options)
downloadFileAsync(
remoteDirectoryPath,
remoteFileName,
localPath,
options?): Promise<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? | 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>
Definiert in
cosmolink.SDK.FTP.ts:1232
downloadFileBytesAsync()
downloadFileBytesAsync(remotePath, options)
downloadFileBytesAsync(remotePath, options?): Promise<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 |
Rückgabewert
Promise<Uint8Array>
Definiert in
cosmolink.SDK.FTP.ts:1270
downloadFileBytesAsync(remoteDirectoryPath, remoteFileName, options)
downloadFileBytesAsync(
remoteDirectoryPath,
remoteFileName,
options?): Promise<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? | 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>
Definiert in
cosmolink.SDK.FTP.ts:1286
fileExistsAsync()
fileExistsAsync(filePath)
fileExistsAsync(filePath): Promise<boolean>
Pürft ob eine Datei existiert
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Server - Dateipfad |
Rückgabewert
Promise<boolean>
Definiert in
cosmolink.SDK.FTP.ts:1178
fileExistsAsync(directoryPath, fileName)
fileExistsAsync(directoryPath, fileName): Promise<boolean>
Pürft ob eine Datei existiert
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Verzeichnis |
fileName | string | Dateiname |
Rückgabewert
Promise<boolean>
Definiert in
cosmolink.SDK.FTP.ts:1186
getWorkingDirectory()
getWorkingDirectory(): string
Gibt das aktuelle WorkingDirectory aus
Rückgabewert
string
Definiert in
cosmolink.SDK.FTP.ts:1354
listFilesAsync()
listFilesAsync(directoryPath, options?): Promise<FileInfo[]>
Gibt Auflistung der Dateien im Verzeichnis zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Verzeichnis |
options? | object | Optionen |
options.filter? | (arg0) => boolean | Filter |
options.listOption? | SFtpListOption | Bestimmt die Verzeichnistiefe für die Suche Standardwert: topDirectoryOnly |
Rückgabewert
Promise<FileInfo[]>
Definiert in
cosmolink.SDK.FTP.ts:1324
moveFileAsync()
moveFileAsync(sourceFilePath, targetFilePath, options)
moveFileAsync(
sourceFilePath,
targetFilePath,
options?): Promise<void>
Verschiebt eine bereits auf dem Server liegende Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Quellpfad |
targetFilePath | string | Zielpfad |
options? | object | 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
Definiert in
cosmolink.SDK.FTP.ts:949
moveFileAsync(sourceDirectoryPath, sourceFileName, targetDirectoryPath, targetFileName, options)
moveFileAsync(
sourceDirectoryPath,
sourceFileName,
targetDirectoryPath,
targetFileName,
options?): Promise<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? | 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
Definiert in
cosmolink.SDK.FTP.ts:970
testAsync()
testAsync(): Promise<void>
Testet die Verbindung mit dem Server
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1363
uploadFileAsync()
uploadFileAsync(localPath, remotePath, options)
uploadFileAsync(
localPath,
remotePath,
options?): Promise<void>
Lädt eine Datei auf den Server
Parameter
| Parameter | Type | Description |
|---|---|---|
localPath | string | Lokaler Dateipfad |
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? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1016
uploadFileAsync(localPath, remoteDirectoryPath, remoteFileName, options)
uploadFileAsync(
localPath,
remoteDirectoryPath,
remoteFileName,
options?): Promise<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? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1040
uploadFileBytesAsync()
uploadFileBytesAsync(bytes, remotePath, options)
uploadFileBytesAsync(
bytes,
remotePath,
options?): Promise<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? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1079
uploadFileBytesAsync(bytes, remoteDirectoryPath, remoteFileName, options)
uploadFileBytesAsync(
bytes,
remoteDirectoryPath,
remoteFileName,
options?): Promise<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? | SFtpRemoteExistsOption | Bestimmt die Handhabung des Kopiervorgangs falls die Zieldatei bereits auf dem Server existiert Standardwert: overwrite |
Rückgabewert
Promise<void>
Definiert in
cosmolink.SDK.FTP.ts:1103
[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
cosmolink.SDK.FTP.ts:1383