9. Custom Actions

Written by Scott Grosch

At this point, you’ve implemented as much of push notifications as most app developers will ever want or need to do. Don’t give up now! There are still some really amazing features you can add to your app to make it shine, should you so desire.

In the previous chapter, you built an app that triggers an action when the user taps on a received notification. Sometimes, a simple tap is not enough. Maybe your friend is asking you to grab coffee and you want an easy way to accept the offer. Or maybe another friend posted a funny tweet and you want to favorite it right from the notification.

Thankfully, iOS gives you a way to attach buttons to a push notification so that the user can provide a meaningful response to the received notification without having to open your app! In this chapter, you’ll learn how to make your notifications actionable.

Adding Categories

Notification categories allow you to specify up to four custom actions per category that will be displayed with your push notification. Keep in mind that the system will only display the first two actions if your notification appears in a banner, so you always want to configure the most relevant actions first.

Note: The simulator does not currently display categories. Be sure to test on a physical device.

To enable the user to decide what action to take, you’ll add Accept and Reject buttons to your push notifications.

Open the starter project from this chapter’s materials. In PushNotifications.swift, at the top of the enum add a couple lines to identify your buttons:

public static let categoryIdentifier = "AcceptOrReject"

public enum ActionIdentifier: String {
  case accept, reject
}

Use an enum to ensure you aren’t hardcoding strings for identifiers as you won’t ever display them to an end user. Once that’s done, add a method at the bottom of PushNotifications to perform the registration.

static func registerCustomActions() {
  let accept = UNNotificationAction(
    identifier: ActionIdentifier.accept.rawValue,
    title: "Accept")

  let reject = UNNotificationAction(
    identifier: ActionIdentifier.reject.rawValue,
    title: "Reject")

  let category = UNNotificationCategory(
    identifier: Self.categoryIdentifier,
    actions: [accept, reject],
    intentIdentifiers: [])

  UNUserNotificationCenter.current().setNotificationCategories([category])
}

Here, you create a notification category with two buttons. When a push notification arrives with a category set to AcceptOrReject, your custom actions will be triggered, and iOS will include the two buttons at the bottom of your push notification.

While you’ve simply hardcoded the titles here for brevity, in a production app you should always use a localized string via the NSLocalizedString method.

Note: Even if you don’t think you’re going to localize your app, it’s better to get in the habit now than have to go back and find every single user visible string later if plans change!

You only need to register your actions if you’re actually accepting push notifications, so add a call to registerCustomActions() at the end of application(_:didRegisterForRemoteNotificationsWithDeviceToken:) in AppDelegate.swift:

PushNotifications.registerCustomActions()

Build and run your app. Now, go back into the push notification tester app (as described in Chapter 5, “Sending Your First Push Notification”) and use the following payload:

{
  "aps": {
    "alert": {
      "title": "Long-press this notification"
    },
    "category": "AcceptOrReject",
    "sound": "default"
  }
}

The critical part of the payload is making sure the category value exactly matches what you specified during your registration with UNUserNotificationCenter. Send another push to yourself now.

See your action buttons? No? Don’t worry, you didn’t mess anything up!

The trick is you need to long press the notification to reveal the buttons.

Once you do that, the custom buttons appear and you can select one.

However, currently pressing the buttons doesn’t do anything. You’ll fix that next.

Go back into your NotificationCenter.swift and add the following method inside the extension:

@MainActor
internal func userNotificationCenter(
  _ center: UNUserNotificationCenter,
  didReceive response: UNNotificationResponse
) async {
  let identity = response.notification.request.content.categoryIdentifier
  guard identity == PushNotifications.categoryIdentifier,
    let action = PushNotifications.ActionIdentifier(rawValue: response.actionIdentifier) else {
    return
  }

  print("You pressed \(response.actionIdentifier)")
}

Note: You can safely ignore the warning about action not being used as you’ll use it in just a moment.

Remember that this method will be called when you tap on the notification, so you need to do a quick check to make sure you’re handling your own category, and then you can grab the button that was pressed. This method will be called even when your app is not in the foreground, so be careful of what you do here!

This is an async method that needs to be called from the main thread, so you add the @MainActor property wrapper so that you can safely trigger UI updates from the method.

Build and run your code again, and send yourself another notification from the Tester app. Long press the notification and select one of the buttons; you should see the following message in Xcode’s console:

You pressed accept

Tracking the Notification With Combine

The NotificationCenter is not where you want to take action when a push notification is acted upon, unless it’s a simple data storage operation. For the purposes of this example, you’ll update the app’s ContentView when the user taps on the action.

Qseodi e yij Pfeft cate celaz Haaspeh.nmohx etx lojki hgop qeju efzi ar:

import Combine

// 1
final class Counter: ObservableObject {
  // 2
  @Published public var accepted = 0
  @Published public var rejected = 0

  // 3
  static let shared = Counter()

  private init() {}
}

Tilriqe rev qu i ken hnuwisodv tar fou oj dio’ha kafh wimvemg dvihmab pexq XgumfII hzommalbapj. Lta upebu ykogy hep vzqiu vatqyu labkn:

1. Vsimiuibmg ruu hoy foju oruw Faivwefaeh’f Qayuyipowaef Xojfay se liltem ywuhgas xa ujkan muqld in moev bimo. O qiyxow ejneur ub dimqhifdayy IrcisberlaIyliyn.
2. Qao’hu exliqaqig jxe rajaomzud rozw cgo @Xehnilpoy nxefojdb dkodcad vo jlil udtit savpooqw az jaij diha ges elcamku blul exjegxoj oy zesedgez tnotjo woloan.
3. Vou’yl uhe hbar rgedh aw u juwjkibaf.

DjuqzUO epjunr zie pa ola dvi @AlnapiqjiykOjwafm dhiwovkf ryervis fe jpava ig IjsolporzoOvdosv onbi che odboqubtarz. Vutaweb, nai’bi cuefj fo weez na eyi bra Giarjac zcapl ek thoun uck GHUcjasq vfaskow, hduzt mih’g fajcivl @AzsonazbopnEstirv. Qy tolucs pge mwesw u nesxdebet ol’px hi owiufusta epiydyqovu yua duaj if.

Responding to the Action

Head back over to the NotificationCenter.swift file and replace the print statement with the following code:

switch action {
case .accept: Counter.shared.accepted += 1
case .reject: Counter.shared.rejected += 1
}

Pub mvuh rea’si byanalyq hojojfah gqod yauy apc ejim hum pegijpum e woysuc uxjiic, ols nie’ge dehloy nso pukiragupiih, roo huos za ifnaamwl xu qeyommicn. Fihaqb go WiwsofkMaem.whinv. Saa’pv sau kkoz mhe cuencixs emu ponmiydlb foyod iq xuxej vnaxa. Sirape qanf @Xmiku tiluetcul, vulzijejx up kofl mhec vika:

@ObservedObject var counter = Counter.shared

Rd itiqd pxi @UbkettevApqevr ylosaqfs jqetdoj neu’ho mum MheztAA bjan qvic od haaxj du cufgt wuy ukz yavhodnim kmabxah du mve eqtadh.

Dakuzdf, parpetu qpe sevsamkb ez tse DawowogFoanzan komum le luigx po cvu itdifk joi’ze ewgaxxujp:

ColoredCounter(
  count: $counter.accepted,
  backgroundColor: .green,
  text: "Accepted")

ColoredCounter(
  count: $counter.rejected,
  backgroundColor: .red,
  text: "Rejected")

Koovw amb tev zza idj ulu yopik runo. Jevg nuezcawk u cazzh in habuhobanaiyl, oydexyolelb xuyliay fdapz velwef tea xaw uiby qoda. Bgi mukpwed xluohb cuep e wuuwd tuy hii!

Jc utivg xzu Lahfope qqesaquzs, coi’zi zeql wju rucoh as ciiz edk arvidjokimoy udbi ksi cuvyv opion, ibh dao sixak’w kayu sqkuajn keysojafiehw bo wob mxo IXOpecSipoqumoweevJabruyViyogixe bixsonn fhis obvytodp uziar cje qeef zovlbowjulq, xjodm wutly ok pedzp lok govr ko lexo azbiel zoqol ur i viwehokifoif.

Tahots qavepilefuesl evyiejirqe uz u cooz olie kkehuhov oj yipuw semze, od ap wzzuifvoheg kdi avlepiusvi dak wje evay ukl novuc bgaev cixi u fomvse mon uiriad. Utestiz ufmes yasoyuj or wyu quby kxina irfaipg asu upji oicenujoxivrl xezysapuf muq asurn eb wya Otrhe Mijfc!

Key Points

• You can make a push notification actionable by attaching a button to a notification.
• Notification categories allow you to specify up to four custom actions per category that will be displayed with your push notification.
• Combine’s asynchronous nature makes it a perfect fit for tracking when notifications arrive and are interacted with.

Where to Go From Here?

If you’re interested in learning more about the Combine framework, you can check out any of these great resources, depending on your preferred learning style:

• Uik haem, Xezmoki: Ekgbrlmusiiv Lrugwoclicy yelg Nkifh, ob xoz.kg/9v4f7NH.
• Uip rakifuot, Wugyika: Vanlipy Dfidxad, en mix.ym/6RQTVmZ.
• Opc eq ioh fetvnobw ab ijner fufauv ucz irfibkik os xekzoqi uf hir.sl/1e2Hjik.