Class SessionId
Represents the unique identifier passed to session operations.
Inherited Members
Namespace: MAT.Atlas.Automation.Api.Models
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
public sealed class SessionId : ModelBase, IExtensibleDataObject, IEquatable<SessionId>, ISessionId
Constructors
SessionId()
Declaration
public SessionId()
Fields
Empty
Empty session Id.
Declaration
public static readonly SessionId Empty
Field Value
Type | Description |
---|---|
SessionId |
Properties
CompositeSession
The unique identifier of a composite session.
Declaration
public ObjectId CompositeSession { get; set; }
Property Value
Type | Description |
---|---|
ObjectId |
Remarks
IsEmpty
Is this session id empty?
Declaration
public bool IsEmpty { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Session
The unique identifier of a session within the composite session.
Declaration
public ObjectId Session { get; set; }
Property Value
Type | Description |
---|---|
ObjectId |
Remarks
Set and CompositeSession must also be set.
Set
The unique identifier of a set.
Declaration
public ObjectId Set { get; set; }
Property Value
Type | Description |
---|---|
ObjectId |
Methods
Equals(SessionId)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(SessionId other)
Parameters
Type | Name | Description |
---|---|---|
SessionId | other | The object to compare with the current object. . |
Returns
Type | Description |
---|---|
System.Boolean | true if equal. |
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj |
Returns
Type | Description |
---|---|
System.Boolean |
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 |
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String |
Operators
Equality(SessionId, SessionId)
Operator equal.
Declaration
public static bool operator ==(SessionId left, SessionId right)
Parameters
Type | Name | Description |
---|---|---|
SessionId | left | Lhs. |
SessionId | right | Rhs. |
Returns
Type | Description |
---|---|
System.Boolean | true if equal. |
Inequality(SessionId, SessionId)
Operator not equal.
Declaration
public static bool operator !=(SessionId left, SessionId right)
Parameters
Type | Name | Description |
---|---|---|
SessionId | left | Lhs. |
SessionId | right | Rhs. |
Returns
Type | Description |
---|---|
System.Boolean | true if not equal. |
Implements
System.Runtime.Serialization.IExtensibleDataObject
System.IEquatable<>