Class TerminalEnvironment

Encapsulates terminal's operating environment and major parameters

Inheritance

System.Object

TerminalEnvironment

Inherited Members

System.Object.Equals(System.Object)

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

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

System.Object.ToString()

Namespace: Westpay.Epas

Assembly: EpasClientLibrary.dll

Syntax

public class TerminalEnvironment

Constructors

View Source

TerminalEnvironment()

Constructor

Declaration

public TerminalEnvironment()

Fields

View Source

LangDanish

ISO639-1 two-character language code for Danish

Declaration

public const string LangDanish = "da"

Field Value

Type	Description
System.String

View Source

LangEnglish

ISO639-1 two-character language code for English

Declaration

public const string LangEnglish = "en"

Field Value

Type	Description
System.String

View Source

LangFinnish

ISO639-1 two-character language code for Finnish

Declaration

public const string LangFinnish = "fi"

Field Value

Type	Description
System.String

View Source

LangGerman

ISO639-1 two-character language code for German

Declaration

public const string LangGerman = "de"

Field Value

Type	Description
System.String

View Source

LangNorwegian

ISO639-1 two-character language code for Norwegian

Declaration

public const string LangNorwegian = "no"

Field Value

Type	Description
System.String

View Source

LangPolish

ISO639-1 two-character language code for Polish

Declaration

public const string LangPolish = "pl"

Field Value

Type	Description
System.String

View Source

LangSwedish

ISO639-1 two-character language code for Swedish

Declaration

public const string LangSwedish = "sv"

Field Value

Type	Description
System.String

Properties

View Source

AuthorisationServer

Connection details of the authorisation server. This is optional and if left null the terminal will use the authorisation server details that it obtains from the configuration server.

Declaration

public IPEndPoint AuthorisationServer { get; set; }

Property Value

Type	Description
System.Net.IPEndPoint

Remarks

The authorisation server is the server that the terminal will communicate with to authorise transactions. If this is left as null then the terminal will use the authorisation server details found in the downloaded configuration files.

In normal usage the ECR should set this property to identify the correct server details if possible.

View Source

ConfigurationServer

Connection details of the configuration server

Declaration

public IPEndPoint ConfigurationServer { get; set; }

Property Value

Type	Description
System.Net.IPEndPoint

View Source

ISO639_1_LanguageCode

ISO639-1 two-letter language code that identifies the ECR's operating language. The constant strings, e.g. LangSwedish, LangEnglish, etc., can be used here.

Declaration

public string ISO639_1_LanguageCode { get; set; }

Property Value

Type	Description
System.String	The default is LangSwedish

Remarks

This property selects the language that the ECR texts should be translated to. The TerminalEnvironment class defines several language constants that can be used here: Note: The selected language must have been enabled in the terminal configuration

View Source

OperatorId

Operator / cashier ID

Declaration

public string OperatorId { get; set; }

Property Value

Type	Description
System.String

Remarks

The operator ID identifies the cashier. This is not used by the terminal, but the value given is included in the receipt data for transactions.

View Source

SecondaryTerminalIds

Secondary terminal IDs.

Declaration

public string[] SecondaryTerminalIds { get; set; }

Property Value

Type	Description
System.String[]	An array of 8-digit terminal IDs

Remarks

If the terminal supports Multi-TID, then this property can be filled with secondary terminal IDs. These terminal IDs can then be used to set to specify that a transaction should be for a specific terminal ID. See TerminalId.

If the terminal does not support Multi-TID, then the only way to use different terminal IDs for different transactions is to logout and login again with the new terminal ID between the transactions.

View Source

StoreId

Store ID

Declaration

public string StoreId { get; set; }

Property Value

Type	Description
System.String

Remarks

This property must be set by the ECR.

View Source

TerminalId

Terminal ID

Declaration

public string TerminalId { get; set; }

Property Value

Type	Description
System.String	An 8-digit terminal ID

Remarks

The Terminal ID is assigned by the terminal provider. The ID is used by the terminal to download configuration data, to identify itself in transactions, and to provide traceability in the case of transaction investigations.

This property must be set by the ECR.

View Source

WorkstationId

Workstation ID

Declaration

public string WorkstationId { get; set; }

Property Value

Type	Description
System.String

Remarks

This property must be set by the ECR.