Home > Articles > Programming > General Programming/Other Languages

  • Print
  • + Share This
This chapter is from the book

Building Notification Payloads

Delivering push notification through APNS requires three things: your SSL certificate, a device ID, and a custom payload with the notification you want to send. The payload uses JSON formatting. You've already read about generating the certificate and producing the device identifiers, which you need to pass up to your server. Building the JSON payloads basically involves transforming a small well-defined dictionary into JSON format.

JSON (JavaScript Object Notation) is a simple data interchange format based on key-value pairs. The JSON Web site (www.json.org) offers a full syntax breakdown of the format, which allows you to represent values that are strings, numbers, and arrays. The APNS payload consists of up to 256 bytes, which must contain your complete notification information.

Notification payloads must include an aps dictionary. This dictionary defines the properties that produce the sound, badge, and/or alert sent to the user. In addition, you may add custom dictionaries with any data you need to send to your application so long as you stay within the 256 byte limit. Figure 16-11 shows the hierarchy for basic (nonlocalized) alerts.

Figure 16-11. The aps dictionary may contain one or more notification types including a badge request, a sound file, and/or an alert.

aps
     badge : number
     sound : sound file name string
     alert : string
     alert
           body : string
           action-loc-key : string

The aps dictionary contains one or more notification types. These include the standard types you've already read about: badges, sounds, and alerts. Badge and sound notifications each take one argument. The badge is set by a number, the sound by a string that refers to a file already inside the application bundle. If that file is not found (or the developer passes default as the argument), a default sound plays for any notification with a sound request. When a badge request is not included, the iPhone removes any existing badge from the application icon.

There are two ways to produce an alert. You can pass a string, which defines the message to show. This automatically produces a notification with two buttons under that message: Close and View. To customize buttons, pass a dictionary instead. Send the message text as the body and the string to use for the Action key (normally View) as action-loc-key. This replaces View with whatever text you specify.

To produce an alert with a single OK button, pass null as the argument to action-loc-key. This creates a special alert style with one button. Just as when a user taps Close, the OK style alert will not pass any data directly to your application. The app must poll for any updates when next opened by the user.

Localized Alerts

When working with localized applications, construct your aps > alert dictionary with two additional keys. Use loc-key to pass a key that is defined in your application's Localizable.strings file. The iPhone looks up the key and replaces it with the string found for the current localization.

At times, localization strings use arguments like %@ and %n$@. Should that hold true for the localization you are using, you can pass those arguments as an array of strings via loc-args. As a rule, Apple recommends against using complicated localizations as they can consume a major portion of your 256-byte bandwidth.

Transforming from Dictionary to JSON

Once you've designed your dictionary, you must transform it to JSON. The JSON format is simple but precise. If you can, use an automated library to convert your dictionary to the JSON string. There are numerous solutions for this for any number of programming languages, including JavaScript, Perl, and so on. Here's a quick rundown of JSON basics. Table 16-1 offers examples of these rules in action.

Table 16-1. JSON Payload Samples

Sample Type

JSON

Hello message, displays with two buttons.

{"aps":{"alert":"hello"}}

Hello message, displays with two buttons, but built using JSON with an alert dictionary.

{"aps":{"alert":{"body":"hello"}}}

Hello message with one OK button.

{"aps":{"alert":{"action-loc-key":null,"body":"hello"}}}

Hello message with two buttons, Close and Open, the latter being a custom replacement for View.

{"aps":{"alert":{"action-loc-key":"Open","body":"hello"}}}

Hello message that adds an application badge of 3.

{"aps":{"badge":3,"alert":{"body":"hello"}}}

Play a sound without an alert.

{"aps":{"sound":"ping2.caf","alert":{}}}

Play sound, display badge, display alert, use a custom button.

{"aps":{"sound":"ping2.caf","badge":2,"alert":{"action-loc-key":"Open","body":"Hello"}}}

Add a custom payload including an array.

{"aps":{"alert":{"body":"Hello"}},"key1":"value1","key2":["a","b","c"]}

  • The entire payload is a dictionary. Dictionaries consist of key-value pairs stored between brackets, that is, {key:value, key:value, key:value, ...}.
  • Key-value pairs are separated with commas.
  • Strings use double quotes; numbers do not. Reserved words include true, false, and null. Reserved words are not quoted.
  • Arrays consist of a list of items between square brackets, that is, [item, item, item,...].
  • The following symbols must be escaped in strings by using a backslash literal indicator: '" \ /.
  • You may want to remove carriage returns (\r) and new lines (\n) from your payloads when sending messages.
  • Spaces are optional. Save space by omitting them between items.
  • The aps dictionary appears within the top-level folder, so the most basic payload looks something like {aps:{}}.

Custom Data

So long as your payload has room left, keeping in mind your tight byte budget, you can send additional information in the form of key-value pairs. As Table 16-1 showed, these custom items can include arrays and dictionaries as well as strings, numbers, and constants. You define how to use and interpret this additional information. The entire payload dictionary is sent to your application so whatever information you pass along will be available to the application: didReceiveRemoteNotification: method via the user dictionary.

A dictionary containing custom key-value pairs does not need to provide an alert, although doing so allows your user to choose to open your application if it isn't running. If your application is already launched, the key-value pairs arrive as a part of the payload dictionary.

Receiving Data on Launch

When your client receives a notification, tapping the action key (by default, View) launches your application. Then after launching, the iPhone sends your application delegate an optional callback. The delegate recovers its notification dictionary by implementing a method named application:didFinishLaunchingWithOptions:. Unfortunately, this method might not work properly. So here are both the standard ways of retrieving notification information plus a work-around.

Normally, the iPhone passes the notification dictionary to the delegate method via the launch options parameter. For remote notifications, this is the official callback to retrieve data from an alert-box launch. The didReceiveRemoteNotification: method is not called when the iPhone receives a notification and the application is not running.

This "finished launching" method is actually designed to handle two completely different circumstances. First, it handles these notification alert launches, allowing you to recover the payload dictionary and use the data that was sent. Second, it works with application launches from openURL:. If your app has published a URL scheme, and that scheme is used by another application, the application delegate handles that launch with this method.

In either case, the method must return a Boolean value. As a rule, return YES if you were able to process the request or NO if you were not. This value is actually ignored in the case of remote notification launches, but you must still return a value.

At the time of writing, implementing this method does not work properly. The application will hang without displaying a GUI. Fortunately, there's an easy work-around that does not rely on the callback method. You can, instead, listen for a launch notification and catch the userInfo dictionary that is sent with it. This solution has the advantage of being reliable and tested. Keep an eye on Apple's developer forums (http://devforums.apple.com) to keep track of when this issue gets fixed.

Start by adding your application delegate as a listener via the default NSNotificationCenter in your normal applicationDidFinishLaunching method.

[[NSNotificationCenter defaultCenter] addObserver:self
    selector:@selector(launchNotification)
    name:@"UIApplicationDidFinishLaunchingNotification" object:nil];

Then implement the method for the selector you provided. Here, the application waits for the GUI to finish loading and then displays the user info dictionary, where the remote notification data has been stored.

- (void) launchNotification: (NSNotification *) notification
{
    [self performSelector:@selector(showString) withObject:
    [[notification userInfo] description] afterDelay:1.0f];
}

Between the notification listener and the method callback, you can reliably grab the user data from remote notifications. This work-around should remain viable regardless of when and how Apple addresses the didFinishLaunchingWithOptions method.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020