iPhone Client Object API

The Sybase Unwired Platform iPhone Client Object API consists of generated business object classes that represent the mobile business object model built and designed in the Unwired WorkSpace development environment.

The iPhone Client Object API is used by device applications to synchronize and retrieve data and invoke mobile business object operations. The iPhone Client Object API supports only message-based synchronization.

• Connection APIs
  The iPhone Client Object API contains classes and methods for managing local database information, and managing connections to the Unwired Server through a synchronization connection profile.
• Synchronization APIs
  Typically, the generated package database class already has a valid synchronization connection profile. You can login to the Unwired Server with your username and credentials.
• Query APIs
  The Query APIs allow you to retrieve data from mobile business objects, to retrieve relationship data and paging data, and to retrieve and filter a query result set.
• Operations APIs
  The create, update, and delete and related operations allow you to perform operations on data on the local client database, and to propagate that data to the Unwired Server.
• Local Business Object
  A business object can be either local or mobile. A local business object is a client-only object. Unlike a mobile business object, a local business object cannot be synchronized with the Unwired Server. Local business objects do not call submitPending, or perform a replay or import from the Unwired Server.
• Personalization APIs
  Personalization keys allow the mobile user to define (personalize) certain input field values within the mobile application. The PersonalizationParameters class is generated automatically for managing personalization keys. Personalization parameters provide default values for synchronization parameters when the synchronization key of the object is mapped to the personalization key while developing a mobile business object.
• Object State APIs
  The object state APIs include status indicator APIs for returning information about entities in the database, and a method to refresh the MBO entity in the local database.
• Security APIs
  Unwired Server supports encryption of client data and the database.
• Utility APIs
  The iPhone Client Object API provides utility APIs to support a variety of tasks.
• Complex Attribute Types
  The MBO examples previously described have attributes that are primitive types (such as int, long, string), and make use of the basic database operations (create, update, and delete). To support interactions with certain back-end datasources, such as SAP® and Web services, an MBO may have more complex attributes: an integer or string list, a class or MBO object, or a list of objects. Some back-end datasources require complex types to be passed in as input parameters. The input parameters can be any of the allowed attribute types, including primitive lists, objects, and object lists.
• Exceptions
  Reviewing exceptions allows you to identify where an error has occurred during application execution.
• MetaData and Object Manager API
  The MetaData and Object Manager API allows you to access metadata for database, classes, entities, attributes, operations, and parameters.
• Message-Based Synchronization APIs
  The message-based synchronization APIs enable a user application to subscribe to a server package, to remove an existing subscription from the Unwired Server, to suspend or resume requests to the Unwired Server, and to recover data related to the package from the server.
• Messaging Client API
  The Sybase Unwired Platform messaging client (SUPMessageClient) API is part of the libclientrt library. The messaging client is responsible for setting up a connection between the user application and the server, as well as sending client messages up to the Unwired Server and receiving the import messages sent down to the client.