Add APNSItemPushType (the apns-push-typewith header field has six valid values)

Author: ricardopereira

Knuff/APNSItem.h

@@ -8,6 +8,8 @@
 
 #import "MTLModel.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
 typedef NS_ENUM(NSUInteger, APNSItemMode) {
   APNSItemModeCustom,
   APNSItemModeKnuff
@@ -18,12 +20,83 @@ typedef NS_ENUM(NSUInteger, APNSItemPriority) {
   APNSItemPriorityImmediately = 10
 };
 
+typedef NS_ENUM(NSUInteger, APNSItemPushType) {
+
+  /**
+   Use the alert push type for notifications that trigger a user interaction—for example, an alert, badge, or sound. If you set this push type, the apns-topic header field must use your app’s bundle ID as the topic. For more information, see Generating a Remote Notification.
+   The alert push type is required on watchOS 6 and later. It is recommended on macOS, iOS, tvOS, and iPadOS.
+   */
+  APNSItemPushTypeAlert,
+
+  /**
+   Use the background push type for notifications that deliver content in the background, and don’t trigger any user interactions. If you set this push type, the apns-topic header field must use your app’s bundle ID as the topic. For more information, see Pushing Background Updates to Your App.
+   The background push type is required on watchOS 6 and later. It is recommended on macOS, iOS, tvOS, and iPadOS.
+   */
+  APNSItemPushTypeBackground,
+
+  /**
+   Use the voip push type for notifications that provide information about an incoming Voice-over-IP (VoIP) call. For more information, see Responding to VoIP Notifications from PushKit.
+   If you set this push type, the apns-topic header field must use your app’s bundle ID with .voip appended to the end. If you’re using certificate-based authentication, you must also register the certificate for VoIP services. The topic is then part of the 1.2.840.113635.100.6.3.4 or 1.2.840.113635.100.6.3.6 extension.
+   The voip push type is not available on watchOS. It is recommended on macOS, iOS, tvOS, and iPadOS.
+   */
+  APNSItemPushTypeVoip,
+
+  /**
+   Use the complication push type for notifications that contain update information for a watchOS app’s complications. For more information, see Updating Your Timeline.
+   If you set this push type, the apns-topic header field must use your app’s bundle ID with .complication appended to the end. If you’re using certificate-based authentication, you must also register the certificate for WatchKit services. The topic is then part of the 1.2.840.113635.100.6.3.6 extension.
+   The complication push type is recommended for watchOS and iOS. It is not available on macOS, tvOS, and iPadOS.
+   */
+  APNSItemPushTypeComplication,
+
+  /**
+   Use the fileprovider push type to signal changes to a File Provider extension. If you set this push type, the apns-topic header field must use your app’s bundle ID with .pushkit.fileprovider appended to the end. For more information, see Using Push Notifications to Signal Changes.
+   The fileprovider push type is not available on watchOS. It is recommended on macOS, iOS, tvOS, and iPadOS.
+   */
+  APNSItemPushTypeFileProvider,
+
+  /**
+   Use the mdm push type for notifications that tell managed devices to contact the MDM server. If you set this push type, you must use the topic from the UID attribute in the subject of your MDM push certificate. For more information, see Device Management.
+   The mdm push type is not available on watchOS. It is recommended on macOS, iOS, tvOS, and iPadOS.
+   */
+  APNSItemPushTypeMDM
+};
+
+/**
+ Default APNSItemPushType.
+ */
+APNSItemPushType APNSItemPushTypeDefault(void);
+
+/**
+ Retrieve the valid string value for the HTTP header.
+ */
+NSString *APNSItemPushTypeToStr(APNSItemPushType pushType);
+
+/**
+ Retrieve APNSItemPushType from string value.
+ */
+APNSItemPushType APNSItemPushTypeFromStr(NSString *pushTypeStr);
+
+/**
+ Retrieve all APNSItemPushType values.
+ */
+NSArray<NSString *> *APNSItemPushTypesAll(void);
+
 @interface APNSItem : MTLModel
+
 @property (nonatomic, copy) NSString *token;
 @property (nonatomic, copy) NSString *payload;
 @property (nonatomic) APNSItemMode mode;
 @property (nonatomic, copy) NSString *certificateDescription;
 @property (nonatomic) APNSItemPriority priority;
+
+/**
+ Required for watchOS 6 and later; recommended for macOS, iOS, tvOS, and iPadOS) The value of this header must accurately reflect the contents of your notification’s payload. If there is a mismatch, or if the header is missing on required systems, APNs may return an error, delay the delivery of the notification, or drop it altogether.
+ */
+@property (nonatomic) APNSItemPushType pushType NS_AVAILABLE(10_15, 13_0);
+
 @property (nonatomic) NSString *collapseID;
 @property (nonatomic) BOOL sandbox; // Only used when an identity includes both development and production
+
 @end
+
+NS_ASSUME_NONNULL_END

Knuff/APNSItem.m

@@ -10,3 +10,59 @@
 
 @implementation APNSItem
 @end
+
+APNSItemPushType APNSItemPushTypeDefault(void) {
+  return APNSItemPushTypeAlert;
+}
+
+NSString *APNSItemPushTypeToStr(APNSItemPushType pushType) {
+  switch (pushType) {
+    case APNSItemPushTypeAlert:
+      return @"alert"; //0
+    case APNSItemPushTypeBackground:
+      return @"background"; //1
+    case APNSItemPushTypeVoip:
+      return @"voip"; //2
+    case APNSItemPushTypeComplication:
+      return @"complication"; //3
+    case APNSItemPushTypeFileProvider:
+      return @"fileprovider"; //4
+    case APNSItemPushTypeMDM:
+      return @"mdm"; //5
+  }
+}
+
+APNSItemPushType APNSItemPushTypeFromStr(NSString *pushTypeStr) {
+  if ([pushTypeStr isEqualToString:APNSItemPushTypeToStr(APNSItemPushTypeAlert)]) {
+    return APNSItemPushTypeAlert;
+  }
+  else if ([pushTypeStr isEqualToString:APNSItemPushTypeToStr(APNSItemPushTypeBackground)]) {
+    return APNSItemPushTypeBackground;
+  }
+  else if ([pushTypeStr isEqualToString:APNSItemPushTypeToStr(APNSItemPushTypeVoip)]) {
+    return APNSItemPushTypeVoip;
+  }
+  else if ([pushTypeStr isEqualToString:APNSItemPushTypeToStr(APNSItemPushTypeComplication)]) {
+    return APNSItemPushTypeComplication;
+  }
+  else if ([pushTypeStr isEqualToString:APNSItemPushTypeToStr(APNSItemPushTypeFileProvider)]) {
+    return APNSItemPushTypeFileProvider;
+  }
+  else if ([pushTypeStr isEqualToString:APNSItemPushTypeToStr(APNSItemPushTypeMDM)]) {
+    return APNSItemPushTypeMDM;
+  }
+  else {
+    return APNSItemPushTypeDefault();
+  }
+}
+
+NSArray<NSString *> *APNSItemPushTypesAll(void) {
+  return @[
+    APNSItemPushTypeToStr(APNSItemPushTypeAlert),
+    APNSItemPushTypeToStr(APNSItemPushTypeBackground),
+    APNSItemPushTypeToStr(APNSItemPushTypeVoip),
+    APNSItemPushTypeToStr(APNSItemPushTypeComplication),
+    APNSItemPushTypeToStr(APNSItemPushTypeFileProvider),
+    APNSItemPushTypeToStr(APNSItemPushTypeMDM),
+  ];
+}