Class ClientMetadata

Client Metadata.

Inheritance

System.Object

ClientMetadata

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Gee.External.Browsing.Clients

Assembly: Gee.External.Browsing.dll

Syntax

public sealed class ClientMetadata

Constructors

ClientMetadata(String, Int32, Int32, Int32)

Create a Client Metadata.

Declaration

public ClientMetadata(string id, int majorVersion, int minorVersion, int patchVersion)

Parameters

Type	Name	Description
System.String	id	A unique identifier identifying the client.
System.Int32	majorVersion	The client's major version.
System.Int32	minorVersion	The client's minor version.
System.Int32	patchVersion	The client's patch version.

Exceptions

Type	Condition
System.ArgumentException	Thrown if id consists exclusively of whitespace characters.
System.ArgumentNullException	Thrown if id is a null reference.
System.ArgumentOutOfRangeException	Thrown if majorVersion is less than 0, or if minorVersion is less than 0, or if patchVersion is less than 0.

ClientMetadata(String, Version)

Create a Client Metadata.

Declaration

public ClientMetadata(string id, Version version)

Parameters

Type	Name	Description
System.String	id	A unique identifier identifying the client.
System.Version	version	The client's version.

Exceptions

Type	Condition
System.ArgumentException	Thrown if id consists exclusively of whitespace characters.
System.ArgumentNullException	Thrown if id is a null reference, or if version is a null reference.

Fields

Default

Default Client Metadata.

Declaration

public static readonly ClientMetadata Default

Field Value

Type
ClientMetadata

Properties

Id

Get Client's Unique Identifier.

Declaration

public string Id { get; }

Property Value

Type
System.String

Remarks

Represents the unique identifier identifying the client.

Version

Get Client's Version.

Declaration

public Version Version { get; }

Property Value

Type
System.Version

Remarks

Represents the client's version.

Methods

Equals(Object)

Determine if This Object is Equal to Another Object.

Declaration

public override bool Equals(object object)

Parameters

Type	Name	Description
System.Object	object	An object to compare to.

Returns

Type	Description
System.Boolean	A boolean true if this object is equal to object. A boolean false otherwise.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Get Object's Hash Code.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	The object's hash code.

Overrides

System.Object.GetHashCode()

ToString()

Get Object's String Representation.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The object's string representation.

Overrides

System.Object.ToString()