Client Object API Usage

The SAP Mobile Platform Client Object API consists of generated business object classes that represent mobile business objects (MBOs) that are designed and built in the SAP Mobile WorkSpace development environment. Device applications use the Client Object API to retrieve data and invoke mobile business object operations.

• Client Object API Reference
  Use the SAP Mobile Platform Client Object API C# docs as a Client Object API reference.
• Application APIs
  The Application class, in the Sybase.Mobile namespace, manages mobile application registrations, connections and context.
• Connection APIs
  The Connection APIs contain methods for managing local database information, establishing a connection with the SAP Mobile Server, and authenticating.
• Synchronization Profile
  The Synchronization Profile contains information for establishing a connection with the SAP Mobile Server's data synchronization channel where the server package has been deployed. The Sybase.Persistence.ConnectionProfile class manages that information. By default, this information includes the server host, port, domain name, certificate and public key that are pushed by the message channel during the registration process.
• Authentication APIs
  You can log in to the SAP Mobile Server with your user name and credentials and use the X.509 certificate you installed in the task flow for single sign-on.
• Personalization APIs
  Personalization keys allow the application to define certain input parameter values that are personalized for each mobile user. 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. The Personalization APIs allow you to manage personalization keys, and get and set personalization key values.
• Synchronization APIs
  You can synchronize mobile business objects (MBOs) based on synchronization parameters, for individual MBOs, or as a group, based on the group's synchronization policy.
• Log Record APIs
  The Log Record APIs allow you to customize aspects of logging.
• Change Log API
  The change log allows a client to retrieve entity changes from the back end. If a client application already has a list view constructed, it simply needs to add, modify, or delete entries in the list according to the change logs.
• Security APIs
  The security APIs allow you to customize some aspects of connection and database security.
• Callback and Listener APIs
  The callback and listener APIs allow you to optionally register a callback handler and listen for device events, application connection events, and package synchronize and replay events.
• Query APIs
  The Query API allows you to retrieve data from mobile business objects, to page data, and to retrieve a query result by filtering. You can also use the Query API to filter children MBOs of a parent MBO in a one to many relationship.
• Persistence APIs
  The persistence APIs include operations and object state APIs.
• MetaData API
  You can access metadata for database, classes, entities, attributes, operations, and parameters using the MetaData API.
• Exceptions
  Reviewing exceptions allows you to identify where an error has occurred during application execution. These sections do not contain error codes contained in the exception classes. See the Developer Guide: Device Client Error Reference for detailed information about SAP Mobile Platform error codes.