Class TimException

Class TimException.

Inheritance

System.Object

System.Exception

TimException

Implements

System.Runtime.InteropServices._Exception

System.Runtime.Serialization.ISerializable

Inherited Members

System.Exception.GetBaseException()

System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)

System.Exception.GetType()

System.Exception.Data

System.Exception.HelpLink

System.Exception.HResult

System.Exception.InnerException

System.Exception.Message

System.Exception.Source

System.Exception.StackTrace

System.Exception.TargetSite

System.Object.Equals(System.Object)

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

System.Object.GetHashCode()

System.Object.MemberwiseClone()

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

Namespace: SIX.TimApi

Assembly: TimApi.dll

Syntax

public class TimException : Exception, _Exception, ISerializable

Constructors

TimException(ResultCode)

Declaration

public TimException(ResultCode resultCode)

Parameters

Type	Name	Description
ResultCode	resultCode

TimException(ResultCode, String, NativeError, PpInfo, Dictionary<String, String>, PrintData, Basket)

Declaration

public TimException(ResultCode resultCode, string errorMessage, NativeError nativeError, PpInfo ppInfo, Dictionary<string, string> additionalErrorInfo, PrintData printData, Basket rejectedBasket)

Parameters

Type	Name	Description
ResultCode	resultCode
System.String	errorMessage
NativeError	nativeError
PpInfo	ppInfo
System.Collections.Generic.Dictionary<System.String, System.String>	additionalErrorInfo
PrintData	printData
Basket	rejectedBasket

TimException(ResultCode, String, String, NativeError, PpInfo, Dictionary<String, String>, PrintData, Basket)

Declaration

public TimException(ResultCode resultCode, string errorMessage, string localizedMessage, NativeError nativeError, PpInfo ppInfo, Dictionary<string, string> additionalErrorInfo, PrintData printData, Basket rejectedBasket)

Parameters

Type	Name	Description
ResultCode	resultCode
System.String	errorMessage
System.String	localizedMessage
NativeError	nativeError
PpInfo	ppInfo
System.Collections.Generic.Dictionary<System.String, System.String>	additionalErrorInfo
PrintData	printData
Basket	rejectedBasket

Fields

PrintData

Gets the print data.

Declaration

public PrintData PrintData

Field Value

Type	Description
PrintData	The print data.

Properties

AdditionalErrorInfo

Gets the additional error information.

Declaration

public Dictionary<string, string> AdditionalErrorInfo { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>	The additional error information.

ErrorMessage

Returns the error message as transmitted from the terminal.

The message language depends on the terminal but will generally be in English.

An empty string is returned if the terminal does not send a message.

Declaration

public string ErrorMessage { get; }

Property Value

Type	Description
System.String

LocalizedMessage

Returns the localised error message in human readable form derived from the error code sent by the terminal.

The message will be in the merchant language of the terminal provided systemInformation() has been executed (English otherwise).

Declaration

public string LocalizedMessage { get; }

Property Value

Type	Description
System.String

NativeError

Gets the native error.

Declaration

public NativeError NativeError { get; }

Property Value

Type	Description
NativeError	The native error.

PpInfo

Payment protocol specific information

Declaration

public PpInfo PpInfo { get; }

Property Value

Type	Description
PpInfo

RejectedBasket

Rejected basket as modified by host or null if absent. Used for {@link Guides#PETROL} only.

Declaration

public Basket RejectedBasket { get; }

Property Value

Type	Description
Basket

ResultCode

Gets the result code.

Declaration

public ResultCode ResultCode { get; }

Property Value

Type	Description
ResultCode

Methods

LocalizeMessage(String)

Returns the localised error message in human readable form derived from the error code sent by the terminal.

The message will be in the language supplied in the parameter.

Valid language strings are currently: "en","de","de-AT","de-CH","fr", "fr-BE","fr-CH","it","bg","hr","cs","nl","nl-BE","nl-NL","el","hu", "lt","pl","pt","ro","sk","sl","es","sv","fi","no","da"

"de" defaults to "de-CH" "fr" defaults to "fr-CH" "nl" defaults to "nl-BE"

Declaration

public string LocalizeMessage(string language)

Parameters

Type	Name	Description
System.String	language

Returns

Type	Description
System.String

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Exception.ToString()

Implements

System.Runtime.InteropServices._Exception

System.Runtime.Serialization.ISerializable

See Also

System.Exception