Class SessionIdentifier

Represents a Session Identifier.

Inheritance

System.Object

SessionIdentifier

Implements

System.IFormattable

System.IComparable

System.IComparable<SessionIdentifier>

System.IEquatable<SessionIdentifier>

Namespace: MAT.Atlas.Api.Core.Sessions

Assembly: MAT.Atlas.Api.Core.dll

Syntax

public sealed class SessionIdentifier : ValueType, IFormattable, IComparable, IComparable<SessionIdentifier>, IEquatable<SessionIdentifier>

Constructors

SessionIdentifier(Guid)

Initializes a new instance of the SessionIdentifier struct.

Declaration

public SessionIdentifier(Guid guid)

Parameters

Type	Name	Description
System.Guid	guid	The SessionIdentifier as a Guid.

SessionIdentifier(String)

Initializes a new instance of the SessionIdentifier struct.

Declaration

public SessionIdentifier(string guid)

Parameters

Type	Name	Description
System.String	guid	The SessionIdentifier as a string.

Fields

Empty

A read-only instance of the SessionIdentifier structure whose value is all zeros.

Declaration

public static readonly SessionIdentifier Empty

Field Value

Type	Description
SessionIdentifier

Methods

CompareTo(SessionIdentifier)

Compares a SessionIdentifier to a SessionIdentifier.

Declaration

public int CompareTo(SessionIdentifier other)

Parameters

Type	Name	Description
SessionIdentifier	other	The other SessionIdentifier.

Returns

Type	Description
System.Int32	The compare result.

CompareTo(Object)

Compares a SessionIdentifier to an object.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object.

Returns

Type	Description
System.Int32	The compare result.

Equals(SessionIdentifier)

Checks equality between SessionIdentifiers.

Declaration

public bool Equals(SessionIdentifier other)

Parameters

Type	Name	Description
SessionIdentifier	other	The other SessionIdentifier.

Returns

Type	Description
System.Boolean	True if the two values are equal.

Equals(Object)

Determines whether the specified System.Object, is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The System.Object to compare with this instance.

Returns

Type	Description
System.Boolean	true if the specified System.Object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

NewIdentifier()

Returns a new unique SessionIdentifier.

Declaration

public static SessionIdentifier NewIdentifier()

Returns

Type	Description
SessionIdentifier	A new unique SessionIdentifier.

Parse(String)

Parses the specified input string.

Declaration

public static SessionIdentifier Parse(string input)

Parameters

Type	Name	Description
System.String	input	The input string.

Returns

Type	Description
SessionIdentifier	The SessionIdentifier.

ToString()

Returns a System.String that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

ToString(String)

Returns a System.String that represents this instance.

Declaration

public string ToString(string format)

Parameters

Type	Name	Description
System.String	format	The format.

Returns

Type	Description
System.String	A System.String that represents this instance.

ToString(String, IFormatProvider)

Returns a System.String that represents this instance.

Declaration

public string ToString(string format, IFormatProvider formatProvider)

Parameters

Type	Name	Description
System.String	format	The format.
System.IFormatProvider	formatProvider	The format provider.

Returns

Type	Description
System.String	A System.String that represents this instance.

Operators

Equality(SessionIdentifier, SessionIdentifier)

Implements the operator ==.

Declaration

public static bool operator ==(SessionIdentifier identifier1, SessionIdentifier identifier2)

Parameters

Type	Name	Description
SessionIdentifier	identifier1	The identifier1.
SessionIdentifier	identifier2	The identifier2.

Returns

Type	Description
System.Boolean	The result of the operator.

Explicit(SessionIdentifier to Guid)

Performs an explicit conversion from SessionIdentifier to System.Guid.

Declaration

public static explicit operator Guid(SessionIdentifier instance)

Parameters

Type	Name	Description
SessionIdentifier	instance	The SessionIdentifier instance.

Returns

Type	Description
System.Guid	The result of the conversion.

Explicit(Guid to SessionIdentifier)

Performs an explicit conversion from System.Guid to SessionIdentifier.

Declaration

public static explicit operator SessionIdentifier(Guid value)

Parameters

Type	Name	Description
System.Guid	value	The Guid value.

Returns

Type	Description
SessionIdentifier	The result of the conversion.

Inequality(SessionIdentifier, SessionIdentifier)

Implements the operator !=.

Declaration

public static bool operator !=(SessionIdentifier identifier1, SessionIdentifier identifier2)

Parameters

Type	Name	Description
SessionIdentifier	identifier1	The identifier1.
SessionIdentifier	identifier2	The identifier2.

Returns

Type	Description
System.Boolean	The result of the operator.

Implements

System.IFormattable

System.IComparable

System.IComparable<>

System.IEquatable<>

See Also

System.IFormattable

System.IComparable