Zero Install .NET API 2.20.0
ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint Class Referenceabstract

An access point represents changes to the desktop environment's UI which the user explicitly requested. More...

Inheritance diagram for ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint:
ZeroInstall.Model.XmlUnknown NanoByte.Common.ICloneable< AccessPoint > ZeroInstall.DesktopIntegration.AccessPoints.CapabilityRegistration ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint ZeroInstall.DesktopIntegration.AccessPoints.DefaultAccessPoint ZeroInstall.DesktopIntegration.AccessPoints.AppAlias ZeroInstall.DesktopIntegration.AccessPoints.AutoStart ZeroInstall.DesktopIntegration.AccessPoints.IconAccessPoint ZeroInstall.DesktopIntegration.AccessPoints.AutoPlay ZeroInstall.DesktopIntegration.AccessPoints.ContextMenu ZeroInstall.DesktopIntegration.AccessPoints.DefaultProgram ZeroInstall.DesktopIntegration.AccessPoints.FileType ZeroInstall.DesktopIntegration.AccessPoints.MockAccessPoint ZeroInstall.DesktopIntegration.AccessPoints.UrlProtocol

Public Member Functions

abstract IEnumerable< string > GetConflictIDs (AppEntry appEntry)
 Retrieves identifiers from a namespace global to all AccessPoints. Collisions in this namespace indicate that the respective AccessPoints are in conflict cannot be applied on a system at the same time. More...
 
abstract void Apply (AppEntry appEntry, Feed feed, IIconStore iconStore, bool machineWide)
 Applies this access point to the current machine. More...
 
abstract void Unapply (AppEntry appEntry, bool machineWide)
 Unapply this access point on the current machine. More...
 
abstract AccessPoint Clone ()
 Creates a deep copy of this AccessPoint instance. More...
 
- 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< AccessPoint >
AccessPoint Clone ()
 

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

An access point represents changes to the desktop environment's UI which the user explicitly requested.

Member Function Documentation

◆ Apply()

abstract void ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint.Apply ( AppEntry  appEntry,
Feed  feed,
IIconStore  iconStore,
bool  machineWide 
)
pure virtual

Applies this access point to the current machine.

Parameters
appEntryThe application being integrated.
feedThe feed providing additional metadata, icons, etc. for the application.
iconStoreStores icon files downloaded from the web as local files.
machineWideApply the configuration machine-wide instead of just for the current user.
Exceptions
KeyNotFoundExceptionAn AccessPoint reference to a Capability is invalid.
OperationCanceledExceptionThe user canceled the task.
IOExceptionA problem occurred while writing to the filesystem or registry.
WebExceptionA problem occurred while downloading additional data (such as icons).
UnauthorizedAccessExceptionWrite access to the filesystem or registry is not permitted.

Implemented in ZeroInstall.DesktopIntegration.AccessPoints.AppAlias, ZeroInstall.DesktopIntegration.AccessPoints.AutoPlay, ZeroInstall.DesktopIntegration.AccessPoints.AutoStart, ZeroInstall.DesktopIntegration.AccessPoints.CapabilityRegistration, ZeroInstall.DesktopIntegration.AccessPoints.ContextMenu, ZeroInstall.DesktopIntegration.AccessPoints.DefaultProgram, ZeroInstall.DesktopIntegration.AccessPoints.DesktopIcon, ZeroInstall.DesktopIntegration.AccessPoints.FileType, ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry, ZeroInstall.DesktopIntegration.AccessPoints.MockAccessPoint, ZeroInstall.DesktopIntegration.AccessPoints.QuickLaunch, ZeroInstall.DesktopIntegration.AccessPoints.SendTo, and ZeroInstall.DesktopIntegration.AccessPoints.UrlProtocol.

◆ Clone()

◆ GetConflictIDs()

abstract IEnumerable< string > ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint.GetConflictIDs ( AppEntry  appEntry)
pure virtual

Retrieves identifiers from a namespace global to all AccessPoints. Collisions in this namespace indicate that the respective AccessPoints are in conflict cannot be applied on a system at the same time.

Parameters
appEntryThe application entry containing this access point.
Exceptions
KeyNotFoundExceptionAn AccessPoint reference to a Capability is invalid.

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

Implemented in ZeroInstall.DesktopIntegration.AccessPoints.AppAlias, ZeroInstall.DesktopIntegration.AccessPoints.AutoPlay, ZeroInstall.DesktopIntegration.AccessPoints.AutoStart, ZeroInstall.DesktopIntegration.AccessPoints.CapabilityRegistration, ZeroInstall.DesktopIntegration.AccessPoints.ContextMenu, ZeroInstall.DesktopIntegration.AccessPoints.DefaultProgram, ZeroInstall.DesktopIntegration.AccessPoints.DesktopIcon, ZeroInstall.DesktopIntegration.AccessPoints.FileType, ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry, ZeroInstall.DesktopIntegration.AccessPoints.MockAccessPoint, ZeroInstall.DesktopIntegration.AccessPoints.QuickLaunch, ZeroInstall.DesktopIntegration.AccessPoints.SendTo, and ZeroInstall.DesktopIntegration.AccessPoints.UrlProtocol.

◆ Unapply()

abstract void ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint.Unapply ( AppEntry  appEntry,
bool  machineWide 
)
pure virtual

Unapply this access point on the current machine.

Parameters
appEntryThe application entry containing this access point.
machineWideApply the configuration machine-wide instead of just for the current user.
Exceptions
KeyNotFoundExceptionAn AccessPoint reference to a Capability is invalid.
IOExceptionA problem occurred while writing to the filesystem or registry.
UnauthorizedAccessExceptionWrite access to the filesystem or registry is not permitted.

Implemented in ZeroInstall.DesktopIntegration.AccessPoints.AppAlias, ZeroInstall.DesktopIntegration.AccessPoints.AutoPlay, ZeroInstall.DesktopIntegration.AccessPoints.AutoStart, ZeroInstall.DesktopIntegration.AccessPoints.CapabilityRegistration, ZeroInstall.DesktopIntegration.AccessPoints.ContextMenu, ZeroInstall.DesktopIntegration.AccessPoints.DefaultProgram, ZeroInstall.DesktopIntegration.AccessPoints.DesktopIcon, ZeroInstall.DesktopIntegration.AccessPoints.FileType, ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry, ZeroInstall.DesktopIntegration.AccessPoints.MockAccessPoint, ZeroInstall.DesktopIntegration.AccessPoints.QuickLaunch, ZeroInstall.DesktopIntegration.AccessPoints.SendTo, and ZeroInstall.DesktopIntegration.AccessPoints.UrlProtocol.


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