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

Builds simple Feeds containing a single Implementation. More...

Inheritance diagram for ZeroInstall.Publish.FeedBuilder:

Public Member Functions

void Dispose ()
 Deletes the TemporaryDirectory.
 
void DetectCandidates (ITaskHandler handler)
 Detects Candidates in the ImplementationDirectory. More...
 
void GenerateCommands ()
 Generates Commands and EntryPoints bases on Candidates and MainCandidate. More...
 
void GenerateDigest (ITaskHandler handler)
 Generates the ID and ManifestDigest. More...
 
SignedFeed Build ()
 Generates a feed as described by the properties. More...
 

Properties

TemporaryDirectory?? TemporaryDirectory [getset]
 A temporary directory to prepare files for ImplementationDirectory. Not used by the FeedBuilder itself. More...
 
string? ImplementationDirectory [getset]
 Set the directory to search for Candidates and to generate the ManifestDigest from. Is usually a subdirectory of or equal to TemporaryDirectory.
 
IEnumerable< CandidateCandidates [get]
 Lists auto-detected candidates for EntryPoints.
 
CandidateMainCandidate [getset]
 Set the main entry point. Provides meta-data and startup instructions for the application. Should be one of the auto-detected Candidates.
 
List< CommandCommands = new() [get]
 Lists the Command derived from Candidates and MainCandidate.
 
List< EntryPointEntryPoints = new() [get]
 Lists the EntryPoints accompanying Commands.
 
string? ID [get]
 The value used for ImplementationBase.ID.
 
ManifestDigest ManifestDigest [get]
 The value used for ImplementationBase.ManifestDigest.
 
FeedUriUri [getset]
 Set to configure Feed.Uri.
 
ICollection< IconIcons [get]
 Set to configure Feed.Icons.
 
RetrievalMethodRetrievalMethod [getset]
 Set to configure Implementation.RetrievalMethods.
 
CapabilityListCapabilityList [getset]
 Set to configure Feed.CapabilityLists.
 
OpenPgpSecretKeySecretKey [getset]
 Set to configure SignedFeed.SecretKey.
 

Detailed Description

Builds simple Feeds containing a single Implementation.

Member Function Documentation

◆ Build()

SignedFeed ZeroInstall.Publish.FeedBuilder.Build ( )
inline

Generates a feed as described by the properties.

Exceptions
InvalidOperationExceptionRequired values have not been generated or set yet.

◆ DetectCandidates()

void ZeroInstall.Publish.FeedBuilder.DetectCandidates ( ITaskHandler  handler)
inline

Detects Candidates in the ImplementationDirectory.

Parameters
handlerA callback object used when the the user needs to be informed about IO tasks.
Exceptions
InvalidOperationExceptionImplementationDirectory is null or empty.
OperationCanceledExceptionThe user canceled the task.
IOExceptionThere was a problem generating the manifest or detecting the executables.
UnauthorizedAccessExceptionWrite access to temporary files was not permitted.

◆ GenerateCommands()

void ZeroInstall.Publish.FeedBuilder.GenerateCommands ( )
inline

Generates Commands and EntryPoints bases on Candidates and MainCandidate.

Exceptions
InvalidOperationExceptionMainCandidate is null.

◆ GenerateDigest()

void ZeroInstall.Publish.FeedBuilder.GenerateDigest ( ITaskHandler  handler)
inline

Generates the ID and ManifestDigest.

Parameters
handlerA callback object used when the the user needs to be informed about IO tasks.
Exceptions
InvalidOperationExceptionImplementationDirectory is null or empty.
OperationCanceledExceptionThe user canceled the task.
IOExceptionThere was a problem generating the manifest.
UnauthorizedAccessExceptionWrite access to temporary files was not permitted.

Property Documentation

◆ TemporaryDirectory

TemporaryDirectory?? ZeroInstall.Publish.FeedBuilder.TemporaryDirectory
getset

A temporary directory to prepare files for ImplementationDirectory. Not used by the FeedBuilder itself.

Setting a new value will automatically IDisposable.Dispose the previous one.


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