Zero Install .NET API 2.20.0
ZeroInstall.Publish.BuilderExtensions Class Reference

Helpers for adding RetrievalMethods to IBuilders and setting missing properties. More...

Static Public Member Functions

static void Add (this IBuilder builder, RetrievalMethod retrievalMethod, ICommandExecutor executor, ITaskHandler handler)
 Applies a retrieval method to the implementation. Sets missing properties in the process. More...
 
static void Add (this IBuilder builder, DownloadRetrievalMethod retrievalMethod, ICommandExecutor executor, ITaskHandler handler, string? localPath=null)
 Applies a retrieval method to the implementation. Sets missing properties in the process. More...
 
static void CopyFrom (this IBuilder builder, CopyFromStep metadata, ITaskHandler handler)
 Copies files or directories from another implementation fetched by an external 0install process. More...
 

Detailed Description

Helpers for adding RetrievalMethods to IBuilders and setting missing properties.

Member Function Documentation

◆ Add() [1/2]

static void ZeroInstall.Publish.BuilderExtensions.Add ( this IBuilder  builder,
DownloadRetrievalMethod  retrievalMethod,
ICommandExecutor  executor,
ITaskHandler  handler,
string?  localPath = null 
)
inlinestatic

Applies a retrieval method to the implementation. Sets missing properties in the process.

Parameters
builderThe builder.
retrievalMethodThe retrieval method.
executorUsed to modify properties in an undoable fashion.
handlerA callback object used when the the user needs to be informed about IO tasks.
localPathAn optional local file path where the retrievalMethod has already been downloaded.
Exceptions
OperationCanceledExceptionThe user canceled the task.
WebExceptionA file could not be downloaded from the internet.
IOExceptionThere is a problem accessing localPath .
UnauthorizedAccessExceptionRead access to localPath is not permitted.

◆ Add() [2/2]

static void ZeroInstall.Publish.BuilderExtensions.Add ( this IBuilder  builder,
RetrievalMethod  retrievalMethod,
ICommandExecutor  executor,
ITaskHandler  handler 
)
inlinestatic

Applies a retrieval method to the implementation. Sets missing properties in the process.

Parameters
builderThe builder.
retrievalMethodThe retrieval method.
executorUsed to modify properties in an undoable fashion.
handlerA callback object used when the the user needs to be informed about IO tasks.
Exceptions
OperationCanceledExceptionThe user canceled the task.
WebExceptionA file could not be downloaded from the internet.

◆ CopyFrom()

static void ZeroInstall.Publish.BuilderExtensions.CopyFrom ( this IBuilder  builder,
CopyFromStep  metadata,
ITaskHandler  handler 
)
inlinestatic

Copies files or directories from another implementation fetched by an external 0install process.

Parameters
builderThe builder.
metadataThe path of the source and destination file or directory.
handlerA callback object used when the the user needs to be informed about IO tasks.
Exceptions
UnauthorizedAccessExceptionAccess to a resource was denied.
IOExceptionAn IO operation failed.

The documentation for this class was generated from the following file: