Zero Install .NET API 2.20.0
ZeroInstall.Publish.EntryPoints.Candidate Class Referenceabstract

Collects information about a potential candidate for an entry point. The subclass type determines the type of executable (native binary, interpreted script, etc.). More...

Inheritance diagram for ZeroInstall.Publish.EntryPoints.Candidate:
ZeroInstall.Publish.EntryPoints.DotNetCoreApp ZeroInstall.Publish.EntryPoints.InterpretedScript ZeroInstall.Publish.EntryPoints.Java ZeroInstall.Publish.EntryPoints.NativeExecutable ZeroInstall.Publish.EntryPoints.BashScript ZeroInstall.Publish.EntryPoints.PerlScript ZeroInstall.Publish.EntryPoints.PhpScript ZeroInstall.Publish.EntryPoints.PowerShellScript ZeroInstall.Publish.EntryPoints.PythonScript ZeroInstall.Publish.EntryPoints.RubyScript ZeroInstall.Publish.EntryPoints.JavaClass ZeroInstall.Publish.EntryPoints.JavaJar ZeroInstall.Publish.EntryPoints.PosixExecutable ZeroInstall.Publish.EntryPoints.WindowsBatch ZeroInstall.Publish.EntryPoints.WindowsExe

Public Member Functions

abstract Command CreateCommand ()
 Creates a Command to launch this entry point. More...
 
override string ToString ()
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 

Protected Member Functions

bool IsExecutable (string path)
 Determines whether a file is executable.
 
bool Equals (Candidate? other)
 

Package Functions

virtual bool Analyze (DirectoryInfo baseDirectory, FileInfo file)
 Analyzes a file to determine whether it matches this candidate type and extracts meta data. More...
 

Properties

DirectoryInfo? BaseDirectory [get]
 The base directory containing the entire application.
 
string? RelativePath [getset]
 The path of this entry point relative to BaseDirectory.
 
string? Name [getset]
 The application's name. More...
 
string? Summary [getset]
 Short one-line description; the first word should not be upper-case unless it is a proper noun (e.g. "cures all ills"). More...
 
bool NeedsTerminal [getset]
 A suggestion for Feed.NeedsTerminal.
 
ImplementationVersionVersion [getset]
 The application's current version. More...
 
Architecture Architecture [getset]
 A suggestion for TargetBase.Architecture.
 
string? Category [getset]
 The main category of the application. May influence the placement in the start menu.
 
string CommandName [get]
 The Command.Name used by CreateCommand.
 

Detailed Description

Collects information about a potential candidate for an entry point. The subclass type determines the type of executable (native binary, interpreted script, etc.).

Member Function Documentation

◆ Analyze()

virtual bool ZeroInstall.Publish.EntryPoints.Candidate.Analyze ( DirectoryInfo  baseDirectory,
FileInfo  file 
)
inlinepackagevirtual

Analyzes a file to determine whether it matches this candidate type and extracts meta data.

Parameters
baseDirectoryThe base directory containing the entire application.
fileThe file to be analyzed. Must be located within the baseDirectory or a subdirectory.
Returns
true if file matches this candidate type. The object will then contain all available metadata. false if file does not match this candidate type. The object will then be in an inconsistent state. Do not reuse!

Reimplemented in ZeroInstall.Publish.EntryPoints.BashScript, ZeroInstall.Publish.EntryPoints.DotNetCoreApp, ZeroInstall.Publish.EntryPoints.InterpretedScript, ZeroInstall.Publish.EntryPoints.JavaClass, ZeroInstall.Publish.EntryPoints.JavaJar, ZeroInstall.Publish.EntryPoints.MacOSApp, ZeroInstall.Publish.EntryPoints.PerlScript, ZeroInstall.Publish.EntryPoints.PhpScript, ZeroInstall.Publish.EntryPoints.PosixBinary, ZeroInstall.Publish.EntryPoints.PosixExecutable, ZeroInstall.Publish.EntryPoints.PosixScript, ZeroInstall.Publish.EntryPoints.PowerShellScript, ZeroInstall.Publish.EntryPoints.PythonScript, ZeroInstall.Publish.EntryPoints.RubyScript, ZeroInstall.Publish.EntryPoints.WindowsBatch, and ZeroInstall.Publish.EntryPoints.WindowsExe.

◆ CreateCommand()

Property Documentation

◆ Name

string? ZeroInstall.Publish.EntryPoints.Candidate.Name
getset

The application's name.

A suggestion for Feed.Name.

◆ Summary

string? ZeroInstall.Publish.EntryPoints.Candidate.Summary
getset

Short one-line description; the first word should not be upper-case unless it is a proper noun (e.g. "cures all ills").

A suggestion for Feed.Summaries.

◆ Version

ImplementationVersion? ZeroInstall.Publish.EntryPoints.Candidate.Version
getset

The application's current version.

A suggestion for Element.Version.


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