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.

beginOnlineLogin
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.
Setting Synchronization Parameters
Synchronization parameters let an application change the parameters used to retrieve data from an MBO during a synchronization session. A package may or may not have synchronization parameters, depending on whether you need to partition data. Change the synchronization parameter to affect the data that is retrieved.
Subscribe Data
The subscribe method allows the application to subscribe to a server package.
Unsubscribe Data
The unsubscribe method allows the application to remove the existing subscription from server. The device application must already have a subscription with the server.
Suspend Subscription
The suspendSubscription operation allows a device application to send a suspend request to the Unwired Server. This notifies the server to stop delivering data changes.
Synchronize Data
The beginSynchronize methods send a message to the Unwired Server to synchronize data between the client and the server.
Resume Subscription
The resumeSubscription operation allows a device application to send a resume request to the Unwired Server. This request notifies the Unwired Server to resume sending data changes since the last suspension.
Recover Subscription
The recover operation allows the device application to send a recover request. This notifies the Unwired Server to send down all the data related to the package.
Start or Stop Background Synchronization
Message-based synchronization is performed at the package level. The generated package database class provides methods for starting and stopping the background processing of the incoming messages.
Replay Results
The client application can call the hasPendingOperations method after a submitpending call to the server to wait for replay results. This method returns true if there are replay pending requests, otherwise, it returns false.

Parent topic: iOS Client Object API

Related concepts

Query APIs

Installing and Testing X.509 Certificates on iOS Clients

Related reference

Connection APIs

Operations APIs

Local Business Object

Personalization APIs

Object State APIs

Security APIs

Single Sign-On With X.509 Certificate Related Object API

Utility APIs

Complex Attribute Types

Exceptions

MetaData and Object Manager API

Messaging Client API

Created July 25, 2012. To comment on this topic, go to: DocCommentXchange.