Classes
| Class | Description | |
|---|---|---|
 | ATTConnectionDetails |
ATTConnectionDetails class includes properties required when
recording and playing back using ATT.
|
| ChangeLocaleEventArgs |
The ChangeLocaleEventArgs class is used to convey information to a caller that a Lanaguage/Locale change
has happened
|
| ClassDetail |
The ClassDetail class is used to encapsulate detail information about an ispec or class.
|
| ConnectionChangeSystemRequestCancelEventArgs |
The ConnectionChangeSystemRequestCancelEventArgs class is used to convey information to a caller that has
registered to receive the ChangeSystemRequest event
An instance of this class is returned to the EventHandler with the relevant information.
|
| ConnectionCloseRequestArgs |
The ConnectionCloseRequestArgs class is used to convey information to a caller that has
registered to receive the CloseRequest event
An instance of this class is returned to the EventHandler with the relevant information.
|
| ConnectionDetails |
The ConnectionDetails class defines properties required to establish a connection with the
Runtime system through the Access Layer API.
An instance of this class must be created and populated with the required information, so it can
be used by the Connect/ConnectAsync methods.
|
| ConnectionDownLoadCompleteEventArgs |
The ConnectionDownLoadCompleteCancelEventArgs class is used to convey information to a caller that has
registered to receive the DownLoadComplete event
An instance of this class is returned to the EventHandler with the relevant information.
|
| ConnectionEventArgs |
The ConnectionEventArgs class is used to convey information to a caller that has
registered to receive one of the following events:
- SetCursorRequest (notification of which field has focus)
- ChangeLocaleRequest (notification of a language change)
- TransmissionObjectChanged (notification of a different Ispec returned from the runtime system)
An instance of this class is returned to the EventHandler with the relevant information.
|
| FileRepositoryConnectionDetails |
Specifies a details that can be used for uploading and downloading files (e.g. images) from a host/server the client.
|
| GeneralDetails |
GeneralDetails
|
| InformationEventArgs |
The InformationEventArgs class is used to convey information to a caller that has
registered to receive the ConnectionProgressStatus event
An instance of this class is returned to the EventHandler with the relevant information.
|
| Logging |
Logging
|
| ReportInfo |
The ReportInfo class encapsulates properties for an AB Suite Report
|
| SessionDetails |
SessionDetails
|
| ShowClassRecallScreenEventArgs |
The ShowClassRecallScreenEventArgs class is used to convey information to a caller that has
registered to receive the ShowTeachRequest event
An instance of this class is returned to the EventHandler with the relevant information.
|
| SkippedFieldItem |
SkippedField
|
| TransactionErrorsArgs |
The TransactionErrorsArgs class is used to convey information to a caller that has
registered to receive the ProcessTransactionErrors event
An instance of this class is returned to the EventHandler with the relevant information.
|
| TransmissionObject |
The TransmissionObject provides information about the current context of a session with the host application.
It contains the most recent DataModel returned from the host, the outcome of the last transaction, the status line
information, and details of any lists sent from the host system.
|
Interfaces
| Interface | Description | |
|---|---|---|
 | IConnection |
The IConnection interface is used to establish a session and manage a connection to the runtime system.
|
| IDataModelFactory |
The IDataModelFactory interface allows a DataModel to be retrieved from the DataModelFactory,
from a supplied ispec/class name.
|
| IFileRepositoryService |
The IFileRepositoryService is an interface that can be implemented to manage file storage on a server machine.
This is typically used for uploading and downloading images required for a client application, but can be extended
to include any file type.
|
| ILogger |
The ILogger interface provides methods to log information to the Access Layer Log file,
using different severity levels.
The message parameter in each Log method can be declared using a format that allows value substitution.
For example: LogInfo("My connected session is: {1}",sessionId};
This will show the following entry in the Log file, assuming the variable sessionId contains the string "123":
My connected session is: 123
|
| IMethodExecuter |
The IMethodExecutor defines an interface for execuing Public Mehtod calls to the AB Suite system
|
| IMockupConnection |
The IMockupConnection interface is used to simulate an Access Layer API connection without a physical connection to
the runtime system. This interface is available for Testing purposes.
|
| IRecordInfo |
An interface for accessing the ATT Recording information
|
| IRtConnection |
The IRtConnection interface
|
| IUnsolicitedMessages |
The IUnsolicitedMessages interface can be used to send colon commands to the
runtime system and obtain responses. It also handles the initiation of reports
and any accept interactions with that user, which may be required by a report.
|
| IViewModelViewFactory |
The IViewModelViewFactory is an interface designed for retrieving ViewModel instances and
ViewModel details from a ViewModel factory.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
 | ClassDetailDetailType |
The DetailType enumeration distinguishes a class from an ispec
1 - for an ispec
|
| ConnectionMode |
enum ConnectionMode is used for ATT recording.
0 - Connected mode
1 - Disconnected mode
|
| InformationEventArgsInformationType |
The InformationType enumeration is used to convey information about the current state of the connection.
|
| TransmissionReturnCode |
The TransmissionReturnCode enumeration contains a integer value which indicates the state of the current transaction:
|