Developer

Agentry OpenUI API for Android

Use the OpenUI API for Android to add custom controls to the Agentry Client.

The API documentation is available in source code as part of the Agentry Toolkit. See Setting Up the Development Environment for Agentry Toolkit.

Client Package

The following tables list the OpenUI packages available for Android in these categories: Adapters, Alt Input, Models, and Security.

Table 34: Adapters Package

Object

Description

ButtonDisplayAdapter class

The class that any extension class for button display needs to extend.

CollectionDisplayAdapter class

The class that any extension class for collection display needs to extend.

DateAndTimeDisplayAdapter class

The class that any extension class for time and date display needs to extend.

DateAndTimeEditAdapter class

The class that any extension class for time and date edit needs to extend.

DateDisplayAdapter class

The class that any extension class for date display needs to extend.

DateEditAdapter class

The class that any extension class for date edit needs to extend.

DecimalDisplayAdapter class

The class that any extension class for decimal display needs to extend.

DecimalEditAdapter class

The class that any extension class for decimal edit needs to extend.

DurationDisplayAdapter class

The class that any extension class for duration display needs to extend.

DurationEditAdapter class

The class that any extension class for duration edit needs to extend.

EmbeddedImageDisplayAdapter class

The class that any extension class for embedded image display needs to extend.

ExternalDataDisplayAdapter class

The class that any extension class for external data display needs to extend.

ExternalDataEditAdapter class

The class that any extension class for external data edit needs to extend.

FieldAdapter class

The abstract class from which all open UI adapter abstract classes derive.

IntegerDisplayAdapter class

The class that any extension class for integer display needs to extend.

IntegerEditAdapter class

The class that any extension class for integer editing needs to extend.

LabelDisplayAdapter class

The class that any extension class for label display needs to extend.

LocationDisplayAdapter class

The class that any extension class for location display needs to extend.

LocationEditAdapter class

The class that any extension class for location edit needs to extend.

StringDisplayAdapter class

The class that any extension class for string display needs to extend.

StringEditAdapter class

The class that any extension class for string edit needs to extend.

TimeDisplayAdapter class

The class that any extension class for time display needs to extend.

TimeEditAdapter class

The class that any extension class for time edit needs to extend.

Table 35: Alt Input Package

Object

Description

AlternateInputChannelAdapter interface

Interface that provides alternate input functionality.

AlternateInputChannelModel interface

Interface that provides alternate input channel model.

Table 36: Models Package

Core

Description

ButtonDisplayModel interface

Interface given to a button display extension object so it can call methods provided by the host.

CollectionDisplayModel interface

Interface given to a collection display extension object so it can call methods provided by the host.

DateAndTimeDisplayModel interface

Interface given to a time and date display extension object so it can call methods provided by the host.

DateAndTimeEditModel interface

Interface given to a time and date edit extension object so it can call methods provided by the host.

DateDisplayModel interface

Interface given to a date display extension object so it can call methods provided by the host.

DateEditModel interface

Interface given to a date edit extension object so it can call methods provided by the host.

DecimalDisplayModel interface

Interface given to an decimal display extension object so it can call methods provided by the host.

DecimalEditModel interface

Interface given to an decimal edit extension object so it can call methods provided by the host.

DurationDisplayModel interface

Interface given to a duration display extension object so it can call methods provided by the host.

DurationEditModel interface

Interface given to a duration edit extension object so it can call methods provided by the host.

EmbeddedImageDisplayModel interface

Interface given to a embedded image display extension object so it can call methods provided by the host.

ExternalDataDisplayModel interface

Interface given to a external data display extension object so it can call methods provided by the host.

ExternalDataEditModel interface

Interface given to a external data edit extension object so it can call methods provided by the host.

FieldModel interface

Interface given to an extension object so it can call methods provided by the host.

IntegerDisplayModel interface

Interface given to an integer display extension object so it can call methods provided by the host.

IntegerEditModel interface

Interface given to an integer edit extension object so it can call methods provided by the host.

LabelDisplayModel interface

Interface given to a label display extension object so it can call methods provided by the host.

LocationDisplayModel interface

Interface given to a location display extension object so it can call methods provided by the host.

LocationEditModel interface

Interface given to a location edit extension object so it can call methods provided by the host.

StringDisplayModel interface

Interface given to a string display extension object so it can call methods provided by the host.

StringEditModel interface

Interface given to a string edit extension object so it can call methods provided by the host.

TimeDisplayModel interface

Interface given to a time display extension object so it can call methods provided by the host.

TimeEditModel interface

Interface given to a time edit extension object so it can call methods provided by the host.

Table 37: Security Package

Object

Description

CredentialManagerActivity class

Base class that AgentryCredentialActivity needs to extend to implement custom credential validation.

CredentialManagerAdapter class

Base adapter class for OpenUI credential validation.

CredentialManagerModel interface

Model that the AgentryCredentialManager and AgentryCredentialActivity classes use to call into Agentry.

Core Package

Table 38: Dataapi Package

Object

Description

AgentryData interface

Java interface that provides the Agentry Data API.

AgentryProperty interface

Java interface that provides Agentry API properties

Table 39: OpenUI Package

Object

Description

AgentryImage class

Java implementation to support Agentry images.

AgentryLocation class

Provides location details.

HTTPHeader class

Defines the data structure for authentication based on HTTP headers in OpenUI.

MaskColor class

Encapsulates a masking color that is used by OpenUIImage.

ProcessInputReturn class

Contains the result of calling to process input.

ActionEnableType enum

Enable states that an action can have.

ActionResult enum

Result states that running an action can return.

AuthType enum

Authentication types used by the client.

AutosizeBehavior enum

Values for autosize behavior for Agentry fields.

ButtonType enum

Button types to which the Agentry Button Widget can be set (such as check box, radio button, or push).

DurationDisplayFormat enum

Duration display formats (such as HourMinSec, HourMin, MinSec, or DecHour).

ImagePosition enum

Valid positions for images in available space (such as Unknown, Center, Upper Left, and so forth).

ImagePresentation enum

Image attributes (such as Unknown, Lock Aspect Ration, Stretch to Fit, Full Size, and so forth).

LastClientAuthenticationResult enum

Validation result types for the most recent client authentication attempt (such as No Prior Attempt, Successful, Failed SSL, or Failed HTTP Auth).

OpenUIImage interface

Interface for OpenUI images.

ResultCallback interface

Interface for processing activity results, for example, the results from an activity that performs scanning.

ResultCallbackHolder interface

Interface for holding a ResultCallback object as a listener.