Class TerminalSettings

the Settings for one terminal.

Inheritance

System.Object

TerminalSettings

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)

Namespace: SIX.TimApi

Assembly: TimApi.dll

Syntax

public class TerminalSettings

Remarks

The per terminal configuration can be done on two ways:

• In a configuration file "TimApi.cfg"
• With the API TerminalSettings done from the application.

TIMApi reads the configuration file when the first Terminal instance is created.

The class TerminalSettings allows the setting from Application. Each instance of the Terminal class is initialized using an own instance of TerminalSettings containing the configuration relevant for this terminal. The Terminal instances read only the configuration file section with the matching terminal identifier. Multiple terminals can be configured as long as their terminal identifier are different.

All configuration has to be done before an instance of TerminalSettings is used to create a Terminal class instance.

Defines also automatic behavior for interacting with EFT terminals. By default all automatic behaviors are enabled.

Constructors

TerminalSettings()

Initializes a new instance of the TerminalSettings class.

Declaration

public TerminalSettings()

TerminalSettings(String)

Initializes a new instance of the TerminalSettings class.

Declaration

public TerminalSettings(string deviceId)

Parameters

Type	Name	Description
System.String	deviceId	The device identifier.

Fields

AllowClosedCardInsert

Allow insert card before activation.

Declaration

public bool AllowClosedCardInsert

Field Value

Type	Description
System.Boolean

AutoCommit

Declaration

public bool? AutoCommit

Field Value

Type	Description
System.Nullable<System.Boolean>

AutoShiftManagement

Declaration

public bool AutoShiftManagement

Field Value

Type	Description
System.Boolean

AutoShutterManagement

Declaration

public bool AutoShutterManagement

Field Value

Type	Description
System.Boolean

BroadcastInterface

Gets or sets the broadcast interface.

Declaration

public string BroadcastInterface

Field Value

Type	Description
System.String

CardInsertionTimeout

Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.

Declaration

public int CardInsertionTimeout

Field Value

Type	Description
System.Int32	The card insertion timeout.

CardRemovalTimeout

Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.

Declaration

public int CardRemovalTimeout

Field Value

Type	Description
System.Int32	The card removal timeout.

CommitTimeout

Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received. Timer starts with response and is reset in case client enters information in the terminal.

Declaration

public int CommitTimeout

Field Value

Type	Description
System.Int32	The commit timeout.

ConnectionIPPort

Listening Port of the EFT terminal in case of ConnectionMode OnFixIP.

Declaration

public int ConnectionIPPort

Field Value

Type	Description
System.Int32	The connection ip port.

ConnectionIPString

IP address of the EFT terminal in case of ConnectionMode OnFixIP.

Declaration

public string ConnectionIPString

Field Value

Type	Description
System.String	The connection ip string.

ConnectionMode

Gets or sets the connection mode. default: Broadcast

Declaration

public ConnectionMode ConnectionMode

Field Value

Type	Description
ConnectionMode	The connection mode.

Dcc

Indicates if Dcc shall be supported.

Declaration

public bool Dcc

Field Value

Type	Description
System.Boolean	true if DCC; otherwise, false.

EnabledHacks

Enabled hacks. For internal use only.

Declaration

public List<int> EnabledHacks

Field Value

Type	Description
System.Collections.Generic.List<System.Int32>

EnableKeepAlive

Enable Keep-Alive handling. Default is true.

Declaration

public bool EnableKeepAlive

Field Value

Type	Description
System.Boolean

FastNtfMode

Set enable fast notification mode. This parameter is only used if {@link com.six.timapi.constants.Guides#AUSTRIAN_USE_CASES} is enabled.

Declaration

public bool FastNtfMode

Field Value

Type	Description
System.Boolean

FetchBrands

Declaration

public bool FetchBrands

Field Value

Type	Description
System.Boolean

Guides

Required guides. Login succeeds only if the terminal is able to provide all requested guides.

Declaration

public List<Guides> Guides

Field Value

Type	Description
System.Collections.Generic.List<Guides>	The guides.

IntegratorId

Gets or sets the integrator identifier.

Declaration

public string IntegratorId

Field Value

Type	Description
System.String	The integrator identifier.

LateCheckinTimeout

This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin.

Declaration

public int LateCheckinTimeout

Field Value

Type	Description
System.Int32

LogBackend

Gets or sets the log level for the backend module.

Declaration

public string LogBackend

Field Value

Type	Description
System.String	The log level.

LogComm

Gets or sets the log level for the commumication module.

Declaration

public string LogComm

Field Value

Type	Description
System.String	The log level.

LogDir

Defines where the Log File has to be generated. Overrides the LogDir defined in GlobalSettings.

Declaration

public string LogDir

Field Value

Type	Description
System.String	The log dir.

LogRetainArchiveCount

Number of log file archives to keep before deleting them. Use 0 to disable delete

Declaration

public int LogRetainArchiveCount

Field Value

Type	Description
System.Int32

LogStateMachine

Gets or sets the log level for the statemachine module.

Declaration

public string LogStateMachine

Field Value

Type	Description
System.String	The log level.

LogTerminal

Gets or sets the log level for the terminal module.

Declaration

public string LogTerminal

Field Value

Type	Description
System.String	The log level.

ManufacturerFlags

Gets or sets the manufacturer flags.

Declaration

public int ManufacturerFlags

Field Value

Type	Description
System.Int32	The manufacturer flags.

PartialApproval

Indicates if partial approval shall be supported.

Declaration

public bool PartialApproval

Field Value

Type	Description
System.Boolean	true if [partial approval]; otherwise, false.

ProceedTimeout

Timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.

Declaration

public int ProceedTimeout

Field Value

Type	Description
System.Int32	The proceed timeout.

ProtocolType

Protocol type.

Declaration

public ProtocolType ProtocolType

Field Value

Type	Description
ProtocolType	Protocol type.

RequestRepetition

Set number of send request repetitions or 0 to disable. Default is 0. Affects these functions:

• Commit
• Rollback

Declaration

public int RequestRepetition

Field Value

Type	Description
System.Int32

SaferpayBaseUrl

Saferpay: Base URL.

Declaration

public string SaferpayBaseUrl

Field Value

Type	Description
System.String

SaferpayCredentials

aferpay: Base64 encoded user name + password.

Declaration

public string SaferpayCredentials

Field Value

Type	Description
System.String

SaferpayCustomerId

Saferpay: Customer ID.

Declaration

public string SaferpayCustomerId

Field Value

Type	Description
System.String

SaferpayTerminalId

Saferpay: Terminal Id.

Declaration

public string SaferpayTerminalId

Field Value

Type	Description
System.String

SerialBaudrate

Gets or sets the serial baudrate.

Declaration

public int SerialBaudrate

Field Value

Type	Description
System.Int32	The serial baudrate.

SerialPort

Gets or sets the serial port.

Declaration

public string SerialPort

Field Value

Type	Description
System.String	The serial port.

TerminalId

Terminal ID to be broadcasted in case of ConnectionMode Broadcast.

Declaration

public string TerminalId

Field Value

Type	Description
System.String	The terminal identifier.

TipAllowed

Tip is allowed for purchase transactions. This parameter is only used if {@link com.six.timapi.constants.Guides#GASTRO} is enabled.

Declaration

public bool TipAllowed

Field Value

Type	Description
System.Boolean	true if [tip allowed]; otherwise, false.

Methods

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()