Class CompositeSessionIdentifier
Represents a Composite Session Identifier
Inheritance
Implements
Namespace: MAT.Atlas.Api.Core.Sessions
Assembly: MAT.Atlas.Api.Core.dll
Syntax
public sealed class CompositeSessionIdentifier : ValueType, IFormattable, IComparable, IComparable<CompositeSessionIdentifier>, IEquatable<CompositeSessionIdentifier>
Constructors
CompositeSessionIdentifier(Guid)
Initializes a new instance of the CompositeSessionIdentifier struct.
Declaration
public CompositeSessionIdentifier(Guid guid)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | guid | The CompositeSessionIdentifier as a Guid. |
CompositeSessionIdentifier(String)
Initializes a new instance of the CompositeSessionIdentifier struct.
Declaration
public CompositeSessionIdentifier(string guid)
Parameters
Type | Name | Description |
---|---|---|
System.String | guid | The CompositeSessionIdentifier as a string. |
Fields
Empty
A read-only instance of the CompositeSessionIdentifier structure whose value is all zeros.
Declaration
public static readonly CompositeSessionIdentifier Empty
Field Value
Type | Description |
---|---|
CompositeSessionIdentifier |
Methods
CompareTo(CompositeSessionIdentifier)
Compares a CompositeSessionIdentifier to a CompositeSessionIdentifier.
Declaration
public int CompareTo(CompositeSessionIdentifier other)
Parameters
Type | Name | Description |
---|---|---|
CompositeSessionIdentifier | other | The other CompositeSessionIdentifier. |
Returns
Type | Description |
---|---|
System.Int32 | The compare result. |
CompareTo(Object)
Compares a CompositeSessionIdentifier 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(CompositeSessionIdentifier)
Checks equality between CompositeSessionIdentifier.
Declaration
public bool Equals(CompositeSessionIdentifier other)
Parameters
Type | Name | Description |
---|---|---|
CompositeSessionIdentifier | other | The other CompositeSessionIdentifier. |
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 |
|
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 CompositeSessionIdentifier.
Declaration
public static CompositeSessionIdentifier NewIdentifier()
Returns
Type | Description |
---|---|
CompositeSessionIdentifier | A new unique CompositeSessionIdentifier. |
Parse(String)
Parses the specified input string.
Declaration
public static CompositeSessionIdentifier Parse(string input)
Parameters
Type | Name | Description |
---|---|---|
System.String | input | The input string. |
Returns
Type | Description |
---|---|
CompositeSessionIdentifier |
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(CompositeSessionIdentifier, CompositeSessionIdentifier)
Implements the operator ==.
Declaration
public static bool operator ==(CompositeSessionIdentifier identifier1, CompositeSessionIdentifier identifier2)
Parameters
Type | Name | Description |
---|---|---|
CompositeSessionIdentifier | identifier1 | The identifier1. |
CompositeSessionIdentifier | identifier2 | The identifier2. |
Returns
Type | Description |
---|---|
System.Boolean | The result of the operator. |
Implicit(CompositeSessionIdentifier to Guid)
Performs an explicit conversion from CompositeSessionIdentifier to System.Guid.
Declaration
public static implicit operator Guid(CompositeSessionIdentifier instance)
Parameters
Type | Name | Description |
---|---|---|
CompositeSessionIdentifier | instance | The CompositeSessionIdentifier instance. |
Returns
Type | Description |
---|---|
System.Guid | The result of the conversion. |
Implicit(Guid to CompositeSessionIdentifier)
Performs an explicit conversion from System.Guid to CompositeSessionIdentifier.
Declaration
public static implicit operator CompositeSessionIdentifier(Guid value)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | value | The Guid value. |
Returns
Type | Description |
---|---|
CompositeSessionIdentifier | The result of the conversion. |
Inequality(CompositeSessionIdentifier, CompositeSessionIdentifier)
Implements the operator !=.
Declaration
public static bool operator !=(CompositeSessionIdentifier identifier1, CompositeSessionIdentifier identifier2)
Parameters
Type | Name | Description |
---|---|---|
CompositeSessionIdentifier | identifier1 | The identifier1. |
CompositeSessionIdentifier | identifier2 | The identifier2. |
Returns
Type | Description |
---|---|
System.Boolean | The result of the operator. |