Features

Low-level and high-level APIs

A basic push solution communicates with the PPG using PAP messages. The push solution also contains user subscription and user management, push message validation, the management of result notifications (acknowledgements), and so on.

The Push Service SDK provides low-level and high-level APIs to handle the functionality in a push solution. Depending on your development environment and the design of the push solution, you might choose to use the low-level APIs to create PAP messages and develop the rest of the solution on your own. Alternatively, you might want to use the high-level APIs to handle some of the more complex operations of your solution.

API

Description

Components

Low-level APIs

The low-level APIs focus on creating and parsing PAP messages, as well as communicating with the PPG. These APIs provide a simple API layer over the PAP XML, removing the need for you to write and parse PAP control entities and multipart MIME messages.

For more information, see the low-level API reference.

  • Commons component (contains the commons package)
  • PAP component (contains the pap and query packages)

High-level APIs

The high-level APIs are built on top of the functionality that the low-level APIs provide, and provide a number of extra features.

You can use the high-level APIs when you want to use the SDK to process and store push responses, subscriptions, and acknowledgments.

When you use the high-level APIs, you can store SDK data in system memory or a database. If you send many push messages, using a database is preferable to system memory.

For more information, see the high-level API reference.

  • Core component (contains the push, pushappmgmt, and subscription packages)
  • Acknowledgment component (contains the acknowledgment package)
  • Monitoring component (contains the monitoring package)

Support for typical feature sets

You can use the Push Service SDK to develop your own server-side push initiator. The server-side push initiator automatically tracks push messages using the SDK's built-in acknowledgement handling capability. You must set the store push requests flag to true in your app to use this feature.

Sample server-side push initiators

The Push Service SDK includes the following sample server-side push initiators. You can run the samples to understand how the Push Service SDK works and to access some of the features of the SDK with little or no development effort. You can also use what you learn from the samples to develop your own server-side push initiator.

Low-level sample server-side push initiator

You can use this sample to perform the following tasks:

  • Send a push request message
  • Cancel the delivery of a previously submitted push request
  • Query the PPG database to get the status of previously submitted push request messages by using various criteria
  • Query the PPG database to view the subscription status of the subscribers

You can also use the sample to test and debug your push-enabled apps.

High-level sample server-side push initiator

You can use this sample to perform the following tasks:

  • Send a push request message
  • Cancel the delivery of a previously submitted push request
  • Query the PPG database to get the status of previously submitted push request messages by using various criteria
  • Add, update, or delete a push-enabled app record from the SDK storage
  • Update the credentials of a push-enabled app
  • Update the status of a push-enabled app
  • List all of the push-enabled apps in the SDK storage
  • Suspend or resume a subscription
  • Unsubscribe a subscriber
  • View the list of subscribers of a push-enabled app
  • View the details of a specific subscriber
  • Query the subscription status of the subscribers in the SDK storage or in the PPG database
  • Synchronize the status of subscribers between the SDK storage and the PPG database

You can also use the sample to test and debug your push-enabled apps.

You can find the source code for the sample server-side push initiators in the following locations after you install the SDK:

  • In the SDK distribution for the high-level APIs, the path is pushsdk-high-level\high-level-sample\high-level-sample-1.2.x.xx-sources.jar.
  • In the SDK distribution for the low-level APIs, the path is pushsdk-low-level\low-level-sample\low-level-sample-1.2.x.xx-sources.jar.

Last modified: 2015-06-11



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus