Developer

Agentry OpenUI API for iOS

Use the OpenUI API for iOS to add custom controls to Agentry applications.

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

iOSOpenUIExternal

The iOS OpenUI exposed interfaces.
Table 40: OpenUI External

Object

Description

SMPOpenUIImage class

An immutable object that represents an Agentry image.

SMPOpenUILocation class

An immutable object that represents an Agentry location.

SMPOpenUIButtonDisplayAdapter protocol

Adapter protocol for an extension field that represents a button.

SMPOpenUIButtonDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a button.

SMPOpenUICollectionDisplayAdapter protocol

Protocol for a field extension that represents a collection.

SMPOpenUICollectionDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a collection.

SMPOpenUICredentialProviderAdapter protocol

Protocol for a client credential provider adapter.

SMPOpenUICredentialProviderModel protocol

Protocol for a client credential provider adapter.

SMPOpenUIDateAndTimeDisplayAdapter protocol

Protocol for a field extension that represents a display-only date and time field.

SMPOpenUIDateAndTimeDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only date and time.

SMPOpenUIDateAndTimeEditAdapter protocol

Protocol for a field extension that represents an editable date and time field.

SMPOpenUIDateAndTimeEditModel protocol

Model protocol of object provided to an adapter that is used for an extension field that represents an editable date and time.

SMPOpenUIDateDisplayAdapter protocol

Protocol for a field extension that represents a display-only date field.

SMPOpenUIDateDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only date.

SMPOpenUIDateEditAdapter protocol

Protocol for a field extension that represents an editable date field.

SMPOpenUIDateEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable date.

SMPOpenUIDecimalDisplayAdapter protocol

Protocol for a field extension that represents a display-only decimal field.

SMPOpenUIDecimalDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only decimal.

SMPOpenUIDecimalEditAdapter protocol

Protocol for a field extension that represents an editable decimal field.

SMPOpenUIDecimalEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable decimal.

SMPOpenUIDurationDisplayAdapter protocol

Protocol for a field extension that represents a display-only duration field.

SMPOpenUIDurationDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only duration.

SMPOpenUIDurationEditAdapter protocol

Protocol for a field extension that represents an editable duration field.

SMPOpenUIDurationEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable duration.

SMPOpenUIEmbeddedImageDisplayAdapter protocol

Protocol for a field extension that represents an embedded image field.

SMPOpenUIEmbeddedImageDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an Embedded Image.

SMPOpenUIExternalDataDisplayAdapter protocol

Protocol for a field extension that represents a display-only external data field.

SMPOpenUIExternalDataDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field representing a display-only external data.

SMPOpenUIExternalDataEditAdapter protocol

Protocol for a field extension that represents an editable date field.

SMPOpenUIExternalDataEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable external data.

SMPOpenUIFieldAdapter protocol

The base class for the protocols that must be implemented by all Open UI field extension classes.

SMPOpenUIFieldModel protocol

Protocol implemented by all model objects that are given to an adapter extension so it can interface with Agentry.

SMPOpenUIIntegerDisplayAdapter protocol

Protocol for a field extension that represents a display-only integer field.

SMPOpenUIIntegerDisplayModel protocol .

Model protocol of object provided to an adapter used for an extension field that represents a display-only integer

SMPOpenUIIntegerEditAdapter protocol

Protocol for a field extension that represents and editable integer.

SMPOpenUIIntegerEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable integer.

SMPOpenUILabelDisplayAdapter protocol

Protocol for a field extension that represents a label field.

SMPOpenUILabelDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a label.

SMPOpenUILocationDisplayAdapter protocol

Protocol for a field extension that represents a display-only location field.

SMPOpenUILocationDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only location.

SMPOpenUILocationEditAdapter protocol

Protocol for a field extension that represents an editable location field.

SMPOpenUILocationEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable location.

SMPOpenUIStringDisplayAdapter protocol

Protocol for a field extension that represents a display-only string field.

SMPOpenUIStringDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only string.

SMPOpenUIStringEditAdapter protocol

Protocol for a field extension that represents an editable string field.

SMPOpenUIStringEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable string.

SMPOpenUITimeDisplayAdapter protocol

Protocol for a field extension that represents a display-only time field.

SMPOpenUITimeDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only time

SMPOpenUITimeEditAdapter protocol

Protocol for a field extension that represents an editable time field.

SMPOpenUITimeEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable time.

SMPOpenUIUnsignedIntegerDisplayAdapter protocol

Protocol for a field extension that represents a display-only unsigned integer field.

SMPOpenUIUnsignedIntegerDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field that represents a display-only unsigned integer.

SMPOpenUIUnsignedIntegerEditAdapter protocol

Protocol for a field extension that represents an editable unsigned integer field.

SMPOpenUIUnsignedIntegerEditModel protocol

Model protocol of object provided to an adapter used for an extension field that represents an editable unsigned integer.

SMPOpenScanChannel_iOS

Use the APIs in this group to implement SMPOpenScanChannel on the iOS client.
Table 41: OpenScan Channel

Object

Description

SMPOpenScanChannel protocol

Defines the messages that an implementation of SMPOpenScanChannel must respond to from the Agentry iOS client.

SMPOpenScanChannelDelegate protocol

The SMPOpenScanChannel delegate is responsible for handling data that is received from an SMPOpenScanChannel.