Zero Install .NET API 2.20.0
ZeroInstall.Model.Capabilities.Capability Class Referenceabstract

A capability tells the desktop environment what an application can do and in which fashion this can be represented to the user. More...

Inheritance diagram for ZeroInstall.Model.Capabilities.Capability:
ZeroInstall.Model.XmlUnknown NanoByte.Common.ICloneable< Capability > ZeroInstall.Model.Capabilities.AppRegistration ZeroInstall.Model.Capabilities.ComServer ZeroInstall.Model.Capabilities.DefaultCapability ZeroInstall.Model.Capabilities.IconCapability ZeroInstall.Model.Capabilities.AutoPlay ZeroInstall.Model.Capabilities.VerbCapability ZeroInstall.Model.Capabilities.ContextMenu ZeroInstall.Model.Capabilities.DefaultProgram ZeroInstall.Model.Capabilities.FileType ZeroInstall.Model.Capabilities.UrlProtocol

Public Member Functions

virtual void Normalize ()
 Converts legacy elements, sets default values, etc.. More...
 
abstract Capability Clone ()
 Creates a deep copy of this Capability instance. More...
 
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< Capability >
Capability Clone ()
 

Protected Member Functions

bool Equals (Capability? other)
 
- 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)
 

Properties

virtual bool WindowsMachineWideOnly [get]
 Indicates whether this capability can be registered only machine-wide and not per-user on Windows systems.
 
string ID = default! [getset]
 An ID that differentiates this capability from other capabilities of the same type within the feed. May only contain alphanumeric characters, spaces ( ), dots (.), underscores (_), hyphens (-) and plus signs (+). More...
 
abstract IEnumerable< string > ConflictIDs [get]
 Identifiers from a namespace global to all Capabilitys. Collisions in this namespace indicate that the concerned Capabilitys are in conflict cannot be registered on a single system at the same time. More...
 

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.
 

Detailed Description

A capability tells the desktop environment what an application can do and in which fashion this can be represented to the user.

Member Function Documentation

◆ Clone()

◆ Normalize()

virtual void ZeroInstall.Model.Capabilities.Capability.Normalize ( )
virtual

Converts legacy elements, sets default values, etc..

Exceptions
InvalidDataExceptionA required property is not set or invalid.

Reimplemented in ZeroInstall.Model.Capabilities.AppRegistration, ZeroInstall.Model.Capabilities.AutoPlay, ZeroInstall.Model.Capabilities.FileType, ZeroInstall.Model.Capabilities.UrlProtocol, and ZeroInstall.Model.Capabilities.VerbCapability.

Property Documentation

◆ ConflictIDs

abstract IEnumerable<string> ZeroInstall.Model.Capabilities.Capability.ConflictIDs
get

Identifiers from a namespace global to all Capabilitys. Collisions in this namespace indicate that the concerned Capabilitys are in conflict cannot be registered on a single system at the same time.

These identifiers are not guaranteed to stay the same between versions. They should not be stored in files but instead always generated on demand.

◆ ID

string ZeroInstall.Model.Capabilities.Capability.ID = default!
getset

An ID that differentiates this capability from other capabilities of the same type within the feed. May only contain alphanumeric characters, spaces ( ), dots (.), underscores (_), hyphens (-) and plus signs (+).

Also serves as a programmatic identifier within the desktop environment. In case of conflicts, the first capability listed with a specific ID will take precedence.


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