Session Class

Represents a session that contains information about an active user.

Inheritance Hierarchy

System.Object
  TcHmiSrv.Core.Session
Namespace:  TcHmiSrv.Core
Assembly:  TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 1.3.0.0

Syntax

C#

public class Session : ICopyable<Session>, 
    IDeepCopyable<Session>, IShallowCopyable<Session>, IEquatable<Session>

The Session type exposes the following members.

Constructors

 

Name

Description

Session Class 1:

Session

Initializes a new instance of the Session class.

Properties

 

Name

Description

Session Class 2:

EndpointInfo

Contains the EndpointInfo the Session.

Session Class 3:

Id

Contains the identifier of the Session.

Session Class 4:

Locale

Contains the locale of the active user in BCP 47 representation.

Session Class 5:

SocketId

Contains the numeric identifier of the WebSocket of the Session.

Session Class 6:

User

Contains the name of the active user.

Methods

 

Name

Description

Session Class 7:

DeepCopy

Creates a new object that is a deep copy of the current Session.

Session Class 8:

Equals(Object)

Determines whether the specified Object is equal to the current Session. (Overrides Object.Equals(Object).)

Session Class 9:

Equals(Session)

Indicates whether the current Session is equal to another Session.

Session Class 10:

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Session Class 11:

GetHashCode

Serves as the default hash function. (Overrides Object.GetHashCode..)

Session Class 12:

GetType

Gets the Type of the current instance. (Inherited from Object.)

Session Class 13:

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Session Class 14:

ShallowCopy

Creates a new Session that is a shallow copy of the current Session.

Session Class 15:

ToString

Returns a string that represents the current object. (Inherited from Object.)

Operators

 

Name

Description

Session Class 16:

Session Class 17:

Equality

Determines whether two instances of the Session class are equal.

Session Class 18:

Session Class 19:

Inequality

Determines whether two instances of the Session class are not equal.

Extension Methods

 

Name

Description

Session Class 20:

ToJson.

Overloaded.

Returns an unformatted JSON String that represents the current Session. (Defined by SessionExtensions.)

Session Class 21:

ToJson(Boolean)

Overloaded.

Returns a JSON String that represents the current Session. (Defined by SessionExtensions.)

Reference

TcHmiSrv.Core Namespace