abstract ZipFile
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2745
Enthält eine Funktionssammlung für ZIP-Aktionen
Methoden
CreateFromDirectory()
static CreateFromDirectory(
directoryPath,
targetZipFilePath,
compressionLevel?,
includeBaseDirectory?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2787
Erstellt eine ZIP-Datei aus dem übergebenen Verzeichnis.
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Quellverzeichnis |
targetZipFilePath | string | Dateipfad der ZIP-Datei |
compressionLevel? | ZipCompressionLevel | Optional (Standardwert: Optimal ): Komprimierungsstufe |
includeBaseDirectory? | boolean | Optional (Standardwert: false ): Gibt an, ob das Quellverzeichnis als Basispfad der ZIP-Datei übernommen werden soll, oder ob lediglich die Inhalte des Ordners herangezogen werden. |
Rückgabewert
Promise<void>
Throws
ArgumentException
- directoryPath oder targetZipFilePath sind null oder haben die Länge 0
Throws
ArgumentNullException
- directoryPath oder targetZipFilePath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von directoryPath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- directoryPath oder targetZipFilePath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion createFromDirectoryAsync ersetzt wurde.
createFromDirectoryAsync()
static createFromDirectoryAsync(
directoryPath,
targetZipFilePath,
compressionLevel?,
includeBaseDirectory?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2828
Erstellt eine ZIP-Datei aus dem übergebenen Verzeichnis.
Parameter
| Parameter | Type | Description |
|---|---|---|
directoryPath | string | Quellverzeichnis |
targetZipFilePath | string | Dateipfad der ZIP-Datei |
compressionLevel? | ZipCompressionLevel | Optional (Standardwert: Optimal ): Komprimierungsstufe |
includeBaseDirectory? | boolean | Optional (Standardwert: false ): Gibt an, ob das Quellverzeichnis als Basispfad der ZIP-Datei übernommen werden soll, oder ob lediglich die Inhalte des Ordners herangezogen werden. |
Rückgabewert
Promise<void>
Throws
ArgumentException
- directoryPath oder targetZipFilePath sind null oder haben die Länge 0
Throws
ArgumentNullException
- directoryPath oder targetZipFilePath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von directoryPath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- directoryPath oder targetZipFilePath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
CreateOrAddFromFile()
static CreateOrAddFromFile(
filePath,
targetZipFilePath,
compressionLevel?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2948
Erstellt eine ZIP-Datei für die übergebe Datei oder fügt die übergebene Datei einer bestehenden ZIP-Datei hinzu
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Pfad zur Datei welche hinzugefügt werden soll |
targetZipFilePath | string | Dateipfad der ZIP-Datei |
compressionLevel? | ZipCompressionLevel | Optional (Standardwert: Optimal ): Komprimierungsstufe |
Rückgabewert
Promise<void>
Throws
ArgumentException
- filePath oder targetZipFilePath sind null oder haben die Länge 0
Throws
ArgumentNullException
- filePath oder targetZipFilePath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von filePath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- filePath oder targetZipFilePath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von targetZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion createOrAddFromFileAsync ersetzt wurde.
createOrAddFromFileAsync()
static createOrAddFromFileAsync(
filePath,
targetZipFilePath,
compressionLevel?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2989
Erstellt eine ZIP-Datei für die übergebe Datei oder fügt die übergebene Datei einer bestehenden ZIP-Datei hinzu
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Pfad zur Datei welche hinzugefügt werden soll |
targetZipFilePath | string | Dateipfad der ZIP-Datei |
compressionLevel? | ZipCompressionLevel | Optional (Standardwert: Optimal ): Komprimierungsstufe |
Rückgabewert
Promise<void>
Throws
ArgumentException
- filePath oder targetZipFilePath sind null oder haben die Länge 0
Throws
ArgumentNullException
- filePath oder targetZipFilePath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von filePath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- filePath oder targetZipFilePath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von targetZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig
ExtractToDirectory()
static ExtractToDirectory(
sourceZipFilePath,
destDirectoryPath,
overwriteFiles?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2873
Entpackt die angegebene ZIP-Datei in ein Verzeichnis.
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceZipFilePath | string | Dateipfad der ZIP-Datei |
destDirectoryPath | string | Zielverzeichnis |
overwriteFiles? | boolean | Optional (Standardwert: true ): Gibt an, ob Dateien im Zielverzeichnis überschrieben werden sollen, sofern diese bereits existieren. |
Rückgabewert
Promise<void>
Throws
ArgumentException
- sourceZipFilePath oder destDirectoryPath sind null oder haben die Länge 0
Throws
ArgumentNullException
- sourceZipFilePath oder destDirectoryPath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von destDirectoryPath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- sourceZipFilePath oder destDirectoryPath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von sourceZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion extractToDirectoryAsync ersetzt wurde.
extractToDirectoryAsync()
static extractToDirectoryAsync(
sourceZipFilePath,
destDirectoryPath,
overwriteFiles?): Promise<void>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:2910
Entpackt die angegebene ZIP-Datei in ein Verzeichnis.
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceZipFilePath | string | Dateipfad der ZIP-Datei |
destDirectoryPath | string | Zielverzeichnis |
overwriteFiles? | boolean | Optional (Standardwert: true ): Gibt an, ob Dateien im Zielverzeichnis überschrieben werden sollen, sofern diese bereits existieren. |
Rückgabewert
Promise<void>
Throws
ArgumentException
- sourceZipFilePath oder destDirectoryPath sind null oder haben die Länge 0
Throws
ArgumentNullException
- sourceZipFilePath oder destDirectoryPath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von destDirectoryPath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- sourceZipFilePath oder destDirectoryPath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von sourceZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig
ListEntries()
static ListEntries(targetZipFilePath): Promise<ZipArchiveEntry[]>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3029
Gibt eine Liste aller Elemente innerhalb der ZIP-Datei aus
Parameter
| Parameter | Type | Description |
|---|---|---|
targetZipFilePath | string | Dateipfad der ZIP-Datei |
Rückgabewert
Promise<ZipArchiveEntry[]>
Throws
ArgumentException
- targetZipFilePath ist null oder hat die Länge 0
Throws
ArgumentNullException
- targetZipFilePath ist null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von targetZipFilePath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- targetZipFilePath enthält ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von targetZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion listEntriesAsync ersetzt wurde.
listEntriesAsync()
static listEntriesAsync(targetZipFilePath): Promise<ZipArchiveEntry[]>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3066
Gibt eine Liste aller Elemente innerhalb der ZIP-Datei aus
Parameter
| Parameter | Type | Description |
|---|---|---|
targetZipFilePath | string | Dateipfad der ZIP-Datei |
Rückgabewert
Promise<ZipArchiveEntry[]>
Throws
ArgumentException
- targetZipFilePath ist null oder hat die Länge 0
Throws
ArgumentNullException
- targetZipFilePath ist null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von targetZipFilePath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- targetZipFilePath enthält ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von targetZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig
TryExtractToFile()
static TryExtractToFile(
sourceZipFilePath,
entryFullName,
destFilePath,
overwrite): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3107
Entpackt das angegebene Element aus einer ZIP-Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceZipFilePath | string | Dateipfad der ZIP-Datei |
entryFullName | string | Vollständiger Name des zu entpackenden Elements |
destFilePath | string | Zielpfad für die Datei |
overwrite | boolean | Optional (Standardwert: true ): Gibt an, ob die Datei überschrieben werden soll, sofern diese bereits existieren. |
Rückgabewert
Promise<boolean>
Throws
ArgumentException
- sourceZipFilePath oder destFilePath sind null oder haben die Länge 0
Throws
ArgumentNullException
- sourceZipFilePath oder destFilePath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von destFilePath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- sourceZipFilePath oder destFilePath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von sourceZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion tryExtractToFileAsync ersetzt wurde.
tryExtractToFileAsync()
static tryExtractToFileAsync(
sourceZipFilePath,
entryFullName,
destFilePath,
overwrite): Promise<boolean>;
Definiert in: sdk/cosmolink.SDK.FileSystem.ts:3138
Entpackt das angegebene Element aus einer ZIP-Datei
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceZipFilePath | string | Dateipfad der ZIP-Datei |
entryFullName | string | Vollständiger Name des zu entpackenden Elements |
destFilePath | string | Zielpfad für die Datei |
overwrite | boolean | Optional (Standardwert: true ): Gibt an, ob die Datei überschrieben werden soll, sofern diese bereits existieren. |
Rückgabewert
Promise<boolean>
Throws
ArgumentException
- sourceZipFilePath oder destFilePath sind null oder haben die Länge 0
Throws
ArgumentNullException
- sourceZipFilePath oder destFilePath sind null
Throws
PathTooLongException - Der angegebene Pfad und/oder der Dateiname überschreiten die vom System vorgegebene Höchstlänge. Beispielsweise dürfen auf Windows-Plattformen Pfade nicht länger als 247 Zeichen und Dateinamen nicht länger als 259 Zeichen sein.
Throws
DirectoryNotFoundException
- Der Pfad von destFilePath ist ungültig
Throws
IOException - Das durch path angegebene Verzeichnis ist schreibgeschützt.
Throws
UnauthorizedAccessException - Der Aufrufer verfügt nicht über die erforderliche Berechtigung.
Throws
NotSupportedException
- sourceZipFilePath oder destFilePath enthalten ein Doppelpunktzeichen (:), das nicht Bestandteil einer Laufwerksbezeichnung ist.
Throws
FileNotFoundException
- Der Pfad von sourceZipFilePath ist ungültig
Throws
InvalidDataException - Die ZIP-Datei ist ungültig