Zero Install .NET API 2.20.0
ZeroInstall.DesktopIntegration.AppEntry Class Reference

Represents an application in the AppList identified by its interface URI. More...

Inheritance diagram for ZeroInstall.DesktopIntegration.AppEntry:
ZeroInstall.Model.XmlUnknown NanoByte.Common.Dispatch.IMergeable< AppEntry > NanoByte.Common.ICloneable< AppEntry >

Public Member Functions

LookupCapability< T > (string id)
 Retrieves the first Capability that matches a specific type and ID and is compatible with Architecture.CurrentSystem. More...
 
override string ToString ()
 Creates string representation suitable for console output.
 
AppEntry Clone ()
 Creates a deep copy of this AppEntry instance. More...
 
bool Equals (AppEntry? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.XmlUnknown
string ToShortXml ()
 Returns a shortened XML representation (with attributes but without child elements). More...
 
override int GetHashCode ()
 
- Public Member Functions inherited from NanoByte.Common.ICloneable< AppEntry >
AppEntry Clone ()
 

Properties

FeedUri InterfaceUri = default! [getset]
 The URI or local path of the interface defining the application or the pet-name if Requirements is set.
 
string Name = default! [getset]
 The name of the application. Usually equal to Feed.Name.
 
RequirementsRequirements [getset]
 A set of requirements/restrictions imposed by the user on the implementation selection process.
 
Requirements EffectiveRequirements [get]
 The Requirements if it is set, otherwise a basic reference to InterfaceUri.
 
string? InterfaceUriString [getset]
 Used for XML serialization. More...
 
string??? RequirementsJson [getset]
 Used for XML+JSON serialization. More...
 
List< CapabilityListCapabilityLists = new() [get]
 A set of Capability lists to be registered in the desktop environment. Only compatible architectures are handled.
 
AccessPointListAccessPoints [getset]
 A set of AccessPointss to be registered in the desktop environment. Is null if no desktop integration has been performed yet.
 
bool AutoUpdate = true [getset]
 Set to true to automatically download the newest available version of the application as a regular background task. Update checks will still be performed when the application is launched when set to false.
 
string? Hostname [getset]
 A regular expression a computer's hostname must match for this entry to be applied. Enables machine-specific entry filtering.
 
DateTime Timestamp [getset]
 
long TimestampUnix [getset]
 The time this entry was last modified encoded as Unix time (number of seconds since the epoch). More...
 
- Properties inherited from NanoByte.Common.Dispatch.IMergeable< AppEntry >
string MergeID
 
DateTime Timestamp
 

Additional Inherited Members

- Public Attributes inherited from ZeroInstall.Model.XmlUnknown
XmlAttribute?[] UnknownAttributes
 Contains any unknown additional XML attributes.
 
XmlElement?[] UnknownElements
 Contains any unknown additional XML elements.
 
- Protected Member Functions inherited from ZeroInstall.Model.XmlUnknown
void EnsureAttribute (object? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null). More...
 
void EnsureAttributeSafeID (string? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null) and only contains alphanumeric characters, spaces ( ), dots (.), underscores (_), hyphens (-) and plus signs (+). More...
 
bool Equals (XmlUnknown? other)
 

Detailed Description

Represents an application in the AppList identified by its interface URI.

Member Function Documentation

◆ Clone()

AppEntry ZeroInstall.DesktopIntegration.AppEntry.Clone ( )
inline

Creates a deep copy of this AppEntry instance.

Returns
The new copy of the AppEntry.

◆ LookupCapability< T >()

T ZeroInstall.DesktopIntegration.AppEntry.LookupCapability< T > ( string  id)
inline

Retrieves the first Capability that matches a specific type and ID and is compatible with Architecture.CurrentSystem.

Template Parameters
TThe capability type to match.
Parameters
idThe Capability.ID to match.
Returns
The first matching Capability.
Exceptions
KeyNotFoundExceptionNo capability matching id and T was found.
Type Constraints
T :Capability 

Property Documentation

◆ InterfaceUriString

string? ZeroInstall.DesktopIntegration.AppEntry.InterfaceUriString
getset

Used for XML serialization.

See also
InterfaceUri

◆ RequirementsJson

string??? ZeroInstall.DesktopIntegration.AppEntry.RequirementsJson
getset

Used for XML+JSON serialization.

See also
Requirements

◆ TimestampUnix

long ZeroInstall.DesktopIntegration.AppEntry.TimestampUnix
getset

The time this entry was last modified encoded as Unix time (number of seconds since the epoch).

This value is ignored by clone and equality methods.


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