Class UrlProtocol

Namespace

ZeroInstall.Model.Capabilities

Assembly

ZeroInstall.Model.dll

An application's ability to handle a certain URL protocol such as HTTP.

[Serializable]
[Equatable]
public sealed class UrlProtocol : VerbCapability, IEquatable<XmlUnknown>, ICloneable<Capability>, IEquatable<Capability>, IEquatable<DefaultCapability>, IIconContainer, IDescriptionContainer, IEquatable<IconCapability>, IEquatable<VerbCapability>, IEquatable<UrlProtocol>

Inheritance

object

XmlUnknown

Capability

DefaultCapability

IconCapability

VerbCapability

UrlProtocol

Implements

IEquatable<XmlUnknown>

ICloneable<Capability>

IEquatable<Capability>

IEquatable<DefaultCapability>

IIconContainer

IDescriptionContainer

IEquatable<IconCapability>

IEquatable<VerbCapability>

IEquatable<UrlProtocol>

Inherited Members

VerbCapability.Verbs

IconCapability.Descriptions

IconCapability.Icons

IconCapability.GetIcon(string)

DefaultCapability.ExplicitOnly

Capability.WindowsMachineWideOnly

Capability.ID

XmlUnknown.UnknownAttributes

XmlUnknown.UnknownElements

XmlUnknown.ToShortXml()

XmlUnknown.Equals(XmlUnknown)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ConflictIDs

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.

[Browsable(false)]
[IgnoreEquality]
public override IEnumerable<string> ConflictIDs { get; }

Property Value

IEnumerable<string>

Remarks

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

KnownPrefixes

A well-known protocol prefix such as "http". Should be empty and set in ID instead if it is a custom protocol.

[Browsable(false)]
[OrderedEquality]
public List<KnownProtocolPrefix> KnownPrefixes { get; }

Property Value

List<KnownProtocolPrefix>

Methods

Clone()

Creates a deep copy of this Capability instance.

public override Capability Clone()

Returns

Capability

The new copy of the Capability.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Normalize()

Converts legacy elements, sets default values, etc..

public override void Normalize()

Exceptions

InvalidDataException

A required property is not set or invalid.

ToString()

Returns the capability in the form "ID". Not safe for parsing!

public override string ToString()

Returns

string

Operators

operator ==(UrlProtocol?, UrlProtocol?)

Indicates whether the object on the left is equal to the object on the right.

public static bool operator ==(UrlProtocol? left, UrlProtocol? right)

Parameters

left UrlProtocol

The left object

right UrlProtocol

The right object

Returns

bool

true if the objects are equal; otherwise, false.

operator !=(UrlProtocol?, UrlProtocol?)

Indicates whether the object on the left is not equal to the object on the right.

public static bool operator !=(UrlProtocol? left, UrlProtocol? right)

Parameters

left UrlProtocol

The left object

right UrlProtocol

The right object

Returns

bool

true if the objects are not equal; otherwise, false.