Interface IReadOnlyExtractedPacz

Namespace: Phoenix.PaczAPI
Assembly: Phoenix.PaczAPI.dll

This interface represents a Pacz that has been extracted to a local file on disk for use by a live component. Depending on whether the source is local or remote, and whether the source is a compressed or uncompressed pacz, it may point to a local temporary directory or to the actual source files.

public interface IReadOnlyExtractedPacz : IDisposable

Implements

IDisposable

Properties

Config

The current config file from the local extraction folder

ExternalMetadata

Metadata about the Pacz from an external source. For example, the remote ID of the Pacz file for Paczs hosted on a remote server.

ExtractionFolder

The folder where the files exist. May be a temporary folder, or the original source

PaczSource

The IPacz that was the source of these files

Methods

ExportAsLocalFilesAsync(string)

Exports the current pacz to an uncompressed folder. This has the side-effect of forcing any current state in Phoenix.PaczAPI.IExtractedPacz.Config to the extraction folder but otherwise does not affect this object or Phoenix.PaczAPI.IReadOnlyExtractedPacz.PaczSource.

ExportAsLocalPaczAsync(string)

Exports the current pacz to a compressed .pacz file. The metadata and extracted files are saved into the compressed .pacz. This has the side-effect of forcing any current state in Phoenix.PaczAPI.IExtractedPacz.Config to the extraction folder but otherwise does not affect this object or Phoenix.PaczAPI.IReadOnlyExtractedPacz.PaczSource.

KeepFolderOnDispose()

If the Phoenix.PaczAPI.IReadOnlyExtractedPacz.ExtractionFolder is a temporary folder, it would normally be deleted on dispose. Calling this method causes this not to happen and the files will be left behind. Generally you should not use this function.