Mobile Push Notifications API for Cocoa Objective-C SDK

The Mobile Push Notifications feature connects native PubNub publishing to third-party push services. Supported services include Google Android FCM (Firebase Cloud Messaging) and Apple iOS APNs (Apple Push Notification service).

To learn more, read about Mobile Push Notifications.

Add a device to a push notifications channel

note

Requires Mobile Push Notifications add-on

Enable Mobile Push Notifications for your key in the Admin Portal. See how to enable add-on features.

Enable mobile push notifications on a set of channels.

Method(s)

To run Adding Device to Channel you can use the following method(s) in the Cocoa SDK:

1- (void)addPushNotificationsOnChannels:(NSArray<NSString *> *)channels
2                   withDevicePushToken:(NSData *)pushToken
3                         andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`channels` * Type: NSArray	Channels to enable for push notifications.
`pushToken` * Type: NSData	Device push token.
`block` Type: PNPushNotificationsStateModificationCompletionBlock	Completion block with request status.

1- (void)addPushNotificationsOnChannels:(NSArray<NSString *> *)channels
                 withDevicePushToken:(id)pushToken
                            pushType:(PNPushType)pushType
                       andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`channels` * Type: NSArray`<NSString >`	Channels to enable for push notifications.
`pushToken` * Type: id	Device token (`NSData` for APNS/APNS2, `NSString` otherwise).
`pushType` * Type: PNPushType	One of: `PNAPNSPush`, `PNAPNS2Push`, `PNFCMPush`, `PNMPNSPush`.
`block` Type: PNPushNotificationsStateModificationCompletionBlock	Completion block.

1- (void)addPushNotificationsOnChannels:(NSArray<NSString *> *)channels
                 withDevicePushToken:(id)pushToken
                            pushType:(PNPushType)pushType
                         environment:(PNAPNSEnvironment)environment
                               topic:(NSString *)topic
                       andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`channels` * Type: NSArray`<NSString *>`	Channels to enable for push notifications.
`pushToken` * Type: id	Device token (`NSData` for APNS/APNS2, `NSString` otherwise).
`pushType` * Type: PNPushType	One of: `PNAPNSPush`, `PNAPNS2Push`, `PNFCMPush`, `PNMPNSPush`.
`environment` * Type: PNAPNSEnvironment	APNs environment.
`topic` * Type: NSString	APNs topic (bundle identifier).
`block` Type: PNPushNotificationsStateModificationCompletionBlock	Completion block.

Sample code

Add device to channel

1[self.client addPushNotificationsOnChannels:@[@"wwdc",@"google.io"]
2                        withDevicePushToken:self.devicePushToken
3                              andCompletion:^(PNAcknowledgmentStatus *status) {
4

5    if (!status.isError) {
6

7    // Handle successful push notification enabling on passed channels.
8    }
9    else {
10

11        /**
12         Handle modification error. Check 'category' property
13         to find out possible reason because of which request did fail.
14         Review 'errorData' property (which has PNErrorData data type) of status
15         object to get additional information about issue.
16

17         Request can be resent using: [status retry];
18         */
19    }
20}];
show all 20 lines

Response

Response objects which is returned by client when APNS Add Device API is used:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNAcknowledgmentStatus : PNErrorStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

Other examples

Example for method no. 2

1[self.client addPushNotificationsOnChannels:@[@"wwdc",@"google.io"]
                      withDevicePushToken:self.devicePushToken
                                  pushType:PNAPNSPush
                              andCompletion:^(PNAcknowledgmentStatus *status) {
5

  if (!status.isError) {
      // Push notifications successful enabled on passed channels.
  } else {
      /**
          * Handle modification error. Check 'category' property to find out possible issue because
          * of which request did fail.
          *
          * Request can be resent using: [status retry];
          */
  }
16}];
show all 16 lines

Example for method no. 3

1[self.client addPushNotificationsOnChannels:@[@"wwdc",@"google.io"]
                      withDevicePushToken:self.devicePushToken
                                  pushType:PNAPNS2Push
                              environment:PNAPNSProduction
                                      topic:@"com.my-application.bundle"
                              andCompletion:^(PNAcknowledgmentStatus *status) {
7

  if (!status.isError) {
      // Push notifications successful enabled on passed channels.
  } else {
      /**
          * Handle modification error. Check 'category' property to find out possible issue because
          * of which request did fail.
          *
          * Request can be resent using: [status retry];
          */
  }
18}];
show all 18 lines

Add device to channel (builder pattern)

note

Requires Mobile Push Notifications add-on

This method requires that the Mobile Push Notifications add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Enable mobile push notifications on provided set of channels.

Method(s)

To run Adding Device to Channel you can use the following method(s) in the Cocoa SDK

APNS2 token

1push()
  .enable()
  .channels(NSArray<NSString *> *)
  .token(id)
  .pushType(PNPushType)
  .environment(PNAPNSEnvironment)
  .topic(NSString *)
  .performWithCompletion(nullable PNPushNotificationsStateModificationCompletionBlock);

* required

Parameter	Description
`channels` * Type: NSArray`<NSString *>`	Channels to enable for push notifications.
`token` * Type: id	Device token / identifier that you must set to `NSData`.
`pushType` * Type: PNPushType	One of: `PNAPNSPush`, `PNAPNS2Push`, `PNFCMPush`, `PNMPNSPush`.
`environment` Type: PNAPNSEnvironment	APNs environment.
`topic` Type: NSString	APNs topic (bundle identifier).
`block` Type: PNPushNotificationsStateModificationCompletionBlock	Completion block.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

FCM token

1push()
  .enable()
  .fcmToken(NSString *)
  .channels(NSArray<NSString *> *)
  .performWithCompletion(nullable PNPushNotificationsStateModificationCompletionBlock);

* required

Parameter	Description
`channels` * Type: NSArray`<NSString >`	Channels to enable for push notifications.
`fcmToken` * Type: NSString *	FCM-provided device push token which should be used to enable mobile push notifications on a specified set of `channels`.
`completion` Type: PNPushNotificationsStateModificationCompletionBlock	Push notifications addition on `channels` processing `completion block` which pass only one argument - request processing status to report about how data pushing was successful or not.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

Sample code

APNS2 token

1self.client.push().enable()
  .token(self.devicePushToken)
  .channels(@[@"wwdc",@"google.io"])
  .pushType(PNAPNS2Push)
  .environment(PNAPNSProduction)
  .topic(@"com.my-application.bundle")
  .performWithCompletion(^(PNAcknowledgmentStatus *status) {
      if (!status.isError) {
          // Push notifications successful enabled on passed channels.
      } else {
          /**
           * Handle modification error. Check 'category' property to find out possible issue because
           * of which request did fail.
           *
           * Request can be resent using: [status retry];
           */
      }
  });
show all 18 lines

FCM token

1self.client.push().enable()
  .token(self.devicePushToken)
  .channels(@[@"wwdc",@"google.io"])
  .pushType(PNFCMPush)
  .performWithCompletion(^(PNAcknowledgmentStatus *status) {
      if (!status.isError) {
          // Push notifications successful enabled on passed channels.
      } else {
          /**
           * Handle modification error. Check 'category' property to find out possible issue because
           * of which request did fail.
           *
           * Request can be resent using: [status retry];
           */
      }
  });
show all 16 lines

Response

Response objects which is returned by client when APNS Add Device API is used:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNAcknowledgmentStatus : PNErrorStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

List channels for device

note

Requires Mobile Push Notifications add-on

This method requires that the Mobile Push Notifications add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Request for all channels on which push notification has been enabled using specified pushToken.

Method(s)

To run Listing Channels For Device you can use the following method(s) in the Cocoa SDK:

1- (void)pushNotificationEnabledChannelsForDeviceWithPushToken:(NSData *)pushToken
2                                                andCompletion:(PNPushNotificationsStateAuditCompletionBlock)block;

* required

Parameter	Description
`pushToken` * Type: NSData	Device push token against which search on PubNub service should be performed.
`block` * Type: PNPushNotificationsStateAuditCompletionBlock	Push `notifications` status processing completion `block` which pass two arguments: result - in case of successful request processing data field will contain results of push `notifications` audit operation; status - in case if error occurred during request processing.

1- (void)pushNotificationEnabledChannelsForDeviceWithPushToken:(id)pushToken
2                                                     pushType:(PNPushType)pushType
3                                                andCompletion:(PNPushNotificationsStateAuditCompletionBlock)block;

* required

Parameter	Description
`pushToken` * Type: id	Device token / identifier that you must set to `NSString`.
`pushType` * Type: PNPushType	One of: `PNFCMPush`.
`block` * Type: PNPushNotificationsStateAuditCompletionBlock	`Audit notifications enabled channels` request completion block.

1- (void)pushNotificationEnabledChannelsForDeviceWithPushToken:(id)pushToken
                                                   pushType:(PNPushType)pushType
                                                environment:(PNAPNSEnvironment)environment
                                                      topic:(NSString *)topic
                                              andCompletion:(PNPushNotificationsStateAuditCompletionBlock)block;

* required

Parameter	Description
`pushToken` * Type: id	Device token / identifier that you must set to `NSData`.
`pushType` * Type: PNPushType	One of: `PNAPNS2Push`.
`environment` * Type: PNAPNSEnvironment	APNs environment.
`topic` * Type: NSString	APNs topic (bundle identifier).
`block` * Type: PNPushNotificationsStateAuditCompletionBlock	`Audit notifications enabled channels` request completion block.

Sample code

List channels for device

1[self.client pushNotificationEnabledChannelsForDeviceWithPushToken:self.devicePushToken
                                                    andCompletion:^(PNAPNSEnabledChannelsResult *result,
                                                                    PNErrorStatus *status) {
    if (!status) {
5

      // Handle downloaded list of channels using: result.data.channels
  }
  else {
9

      /**
       Handle audition error. Check 'category' property
       to find out possible reason because of which request did fail.
       Review 'errorData' property (which has PNErrorData data type) of status
       object to get additional information about issue.
15

       Request can be resent using: [status retry];
       */
  }
}];
show all 19 lines

Response

Response objects which is returned by clientAPNS List Devices API is used:

1@interface PNAPNSEnabledChannelsData : PNServiceData
2

3// Channels with active mobile push notifications.
4@property (nonatomic, readonly, strong) NSArray<NSString *> *channels;
5

6@end
7

8@interface PNAPNSEnabledChannelsResult : PNResult
9

10// APNS enabled channels audit request processed information.
11@property (nonatomic, readonly, strong) PNAPNSEnabledChannelsData *data;
12

13@end

Error response which is used in case of APNS List Devices API call failure:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNErrorStatus : PNStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

Other examples

Example for method no. 2

1[self.client pushNotificationEnabledChannelsForDeviceWithPushToken:self.devicePushToken
                          pushType:PNFCMPush
                  andCompletion:^(PNFCMEnabledChannelsResult *result, PNErrorStatus *status) {
4

  if (!status.isError) {
      // Handle downloaded list of channels using: result.data.channels
  } else {
      /**
          * Handle audition error. Check 'category' property to find out possible issue because of
          * which request did fail.
          *
          * Request can be resent using: [status retry];
          */
  }
15}];

Example for method no. 3

1[self.client pushNotificationEnabledChannelsForDeviceWithPushToken:self.devicePushToken
                          pushType:PNAPNS2Push
                      environment:PNAPNSDevelopment
                          topic:@"com.my-application.bundle"
                  andCompletion:^(PNAPNSEnabledChannelsResult *result, PNErrorStatus *status) {
6

  if (!status.isError) {
      // Handle downloaded list of channels using: result.data.channels
  } else {
      /**
          * Handle audition error. Check 'category' property to find out possible issue because of
          * which request did fail.
          *
          * Request can be resent using: [status retry];
          */
  }
17}];
show all 17 lines

List channels for device (builder pattern)

note

Requires Mobile Push Notifications add-on

This method requires that the Mobile Push Notifications add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Request for all channels on which push notification has been enabled using specified pushToken.

Method(s)

To run Listing Channels For Device you can use the following method(s) in the Cocoa SDK

APNS2 token

1push()
  .audit()
  .token(id)
  .pushType(PNPushType)
  .environment(PNAPNSEnvironment)
  .topic(NSString *)
  .performWithCompletion(PNPushNotificationsStateAuditCompletionBlock);

* required

Parameter	Description
`token` * Type: id	Device token / identifier that you must set to `NSData`.
`pushType` * Type: PNPushType	One of: `PNFCMPush`.
`environment` Type: PNAPNSEnvironment	APNs environment.
`topic` Type: NSString	APNs topic (bundle identifier).
`block` * Type: PNPushNotificationsStateAuditCompletionBlock	`Audit notifications enabled channels` request completion block.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

FCM token

1push()
  .audit()
  .fcmToken(NSString *)
  .performWithCompletion(PNPushNotificationsStateModificationCompletionBlock);

* required

Parameter	Description
`fcmToken` * Type: NSString *	FCM-provided device `push token` against which search on PubNub service should be performed.
`completion` * Type: PNPushNotificationsStateAuditCompletionBlock	Push `notifications` status processing completion `block` which pass two arguments: `result` - in case of successful request processing `data` field will contain results of push `notifications` audit operation; `status` - in case if error occurred during request processing.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

Sample code

APNS2 token

1self.client.push()
  .audit()
  .token(self.devicePushToken)
  .pushType(PNAPNS2Push)
  .environment(PNAPNSProduction)
  .topic(@"com.my-application.bundle")
  .performWithCompletion(^(PNAPNSEnabledChannelsResult *result, PNErrorStatus *status) {
      if (!status.isError) {
          // Handle downloaded list of channels using: result.data.channels
      } else {
          /**
              * Handle audition error. Check 'category' property to find out possible issue because of
              * which request did fail.
              *
              * Request can be resent using: [status retry];
              */
      }
  });
show all 18 lines

FCM token

1self.client.push().audit()
  .fcmToken(self.pushToken)
  .performWithCompletion(^(PNAPNSEnabledChannelsResult *result, PNErrorStatus *status) {
      if (!status) {
          // Handle downloaded list of channels using: result.data.channels
      } else {
          /**
              Handle audition error. Check 'category' property
              to find out possible reason because of which request did fail.
              Review 'errorData' property (which has PNErrorData data type) of status
              object to get additional information about issue.
12

              Request can be resent using: [status retry];
          */
      }
  }];
show all 16 lines

Response

Response objects which is returned by client when APNS List Devices API is used:

1@interface PNAPNSEnabledChannelsData : PNServiceData
2

3// Channels with active mobile push notifications.
4@property (nonatomic, readonly, strong) NSArray<NSString *> *channels;
5

6@end
7

8@interface PNAPNSEnabledChannelsResult : PNResult
9

10// APNS enabled channels audit request processed information.
11@property (nonatomic, readonly, strong) PNAPNSEnabledChannelsData *data;
12

13@end

Error response which is used in case of APNS List Devices API call failure:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNErrorStatus : PNStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

Remove device from channel

note

Requires Mobile Push Notifications add-on

This method requires that the Mobile Push Notifications add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Disable mobile push notifications on provided set of channels.

Method(s)

To run Removing Device From Channel you can use the following method(s) in the Cocoa SDK:

1- (void)removePushNotificationsFromChannels:(NSArray<NSString *> *)channels
2                        withDevicePushToken:(NSData *)pushToken
3                              andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`channels` * Type: NSArray	List of channel names for which mobile push notifications should be disabled. `If passed list is empty all notifications will be disabled.`
`pushToken` * Type: NSData	Device push token which should be used to disable push `notifications` on specified set of `channels`.
`block` Type: PNPushNotificationsStateModificationCompletionBlock	Push `notifications` removal from `channels` processing completion `block` which pass only one argument - request processing `status` to report about how data pushing was successful or not.

1- (void)removePushNotificationsFromChannels:(NSArray<NSString *> *)channels
                      withDevicePushToken:(id)pushToken
                                 pushType:(PNPushType)pushType
                            andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`channels` * Type: NSArray`<NSString >`	List of channel names for which mobile push notifications should be disabled.
`pushToken` * Type: id	Device token / identifier that you must set to `NSString`.
`pushType` * Type: PNPushType	One of: `PNAPNS2Push`.
`block` Type: PNPushNotificationsStateModificationCompletionBlock	`Remove notifications from channels` request completion block.

1- (void)removePushNotificationsFromChannels:(NSArray<NSString *> *)channels
                      withDevicePushToken:(id)pushToken
                                 pushType:(PNPushType)pushType
                              environment:(PNAPNSEnvironment)environment
                                    topic:(NSString *)topic
                            andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`channels` * Type: NSArray`<NSString >`	List of channel names for which mobile push notifications should be disabled.
`pushToken` * Type: id	Device token / identifier that you must set to `NSData`.
`pushType` * Type: PNPushType	One of: `PNAPNS2Push`, `PNFCMPush`.
`environment` * Type: PNAPNSEnvironment	APNs environment.
`topic` * Type: NSString	APNs topic (bundle identifier).
`block` Type: PNPushNotificationsStateModificationCompletionBlock	`Remove notifications from channels` request completion block.

Sample code

Remove device from channel

1[self.client removePushNotificationsFromChannels:@[@"wwdc",@"google.io"]
2                                withDevicePushToken:self.devicePushToken
3                                    andCompletion:^(PNAcknowledgmentStatus *status) {
4

5    if (!status.isError) {
6

7        // Handle successful push notification disabling on passed channels.
8    }
9    else {
10

11        /**
12            Handle modification error. Check 'category' property
13            to find out possible reason because of which request did fail.
14            Review 'errorData' property (which has PNErrorData data type) of status
15            object to get additional information about issue.
16

17            Request can be resent using: [status retry];
18            */
19    }
20}];
show all 20 lines

Response

Response objects which is returned by client when APNS Remove Device API is used:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNAcknowledgmentStatus : PNErrorStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

Other examples

Example for method no. 2

1[self.client removePushNotificationsFromChannels:@[@"wwdc",@"google.io"]
                              withDevicePushToken:self.devicePushToken
                                      pushType:PNFCMPush
                                  andCompletion:^(PNAcknowledgmentStatus *status) {
5

  if (!status.isError) {
      // Push notification successfully disabled on passed channels.
  } else {
      /**
          * Handle modification error. Check 'category' property to find out possible issue because
          * of which request did fail.
          *
          * Request can be resent using: [status retry];
          */
  }
16}];
show all 16 lines

Example for method no. 3

1[self.client removePushNotificationsFromChannels:@[@"wwdc",@"google.io"]
                              withDevicePushToken:self.devicePushToken
                                      pushType:PNAPNS2Push
                                      environment:PNAPNSProduction
                                          topic:@"com.my-application.bundle"
                                  andCompletion:^(PNAcknowledgmentStatus *status) {
7

  if (!status.isError) {
      // Push notification successfully disabled on passed channels.
  } else {
      /**
          * Handle modification error. Check 'category' property to find out possible issue because
          * of which request did fail.
          *
          * Request can be resent using: [status retry];
          */
  }
18}];
show all 18 lines

Remove device from channel (builder pattern)

note

Requires Mobile Push Notifications add-on

This method requires that the Mobile Push Notifications add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Disable mobile push notifications on provided set of channels.

Method(s)

To run Removing Device From Channel, you can use the following method(s) in the Cocoa SDK.

APNS2 token

1push()
  .disable()
  .token(id)
  .pushType(PNPushType)
  .channels(NSArray<NSString *> *)
  .environment(PNAPNSEnvironment)
  .topic(NSString *)
  .performWithCompletion(nullable PNPushNotificationsStateModificationCompletionBlock);

* required

Parameter	Description
`channels` * Type: NSArray`<NSString >`	List of channel names for which mobile push notifications should be disabled.
`token` * Type: id	Device token / identifier that you must set to `NSData`.
`pushType` * Type: PNPushType	One of: `PNFCMPush`.
`environment` Type: PNAPNSEnvironment	APNs environment.
`topic` Type: NSString	APNs topic (bundle identifier).
`block` Type: PNPushNotificationsStateModificationCompletionBlock	`Remove notifications from channels` request completion block.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

FCM token

1push()
  .disable()
  .fcmToken(NSString *)
  .channels(NSArray<NSString *> *)
  .performWithCompletion(nullable PNPushNotificationsStateModificationCompletionBlock);

* required

Parameter	Description
`channels` * Type: NSArray`<NSString >`	List of channel names for which mobile push notifications should be disabled. `If passed list is empty all notifications will be disabled`.
`fcmToken` * Type: NSString *	FCM-provided device push token which should be used to disable push `notifications` on specified set of `channels`.
`completion` Type: PNPushNotificationsStateAuditCompletionBlock	Push `notifications` removal from `channels` processing completion `block` which pass only one argument - request processing `status` to report about how data pushing was successful or not.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

Sample code

APNS token

1self.client.push().disable()
  .token(self.devicePushToken)
  .channels(@[@"wwdc",@"google.io"])
  .pushType(PNAPNS2Push)
  .environment(PNAPNSProduction)
  .topic(@"com.my-application.bundle")
  .performWithCompletion(^(PNAcknowledgmentStatus *status) {
      if (!status.isError) {
          // Push notification successfully disabled on passed channels.
      } else {
          /**
              * Handle modification error. Check 'category' property to find out possible issue because
              * of which request did fail.
              *
              * Request can be resent using: [status retry];
              */
      }
  });
show all 18 lines

FCM token

1self.client.push().disable()
  .channels(@[@"channel1", @"channel2"])
  .fcmToken(self.pushToken)
  .performWithCompletion(^(PNAcknowledgmentStatus *status) {
      if (!status.isError) {
          // Handle successful push notification enabling on passed channels.
      } else {
          /**
          Handle modification error. Check 'category' property
          to find out possible reason because of which request did fail.
          Review 'errorData' property (which has PNErrorData data type) of status
          object to get additional information about issue.
13

          Request can be resent using: [status retry];
          */
      }
  });
show all 17 lines

Response

Response objects which is returned by client when APNS Remove Device API is used:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNAcknowledgmentStatus : PNErrorStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

Remove all mobile push notifications

note

Requires Mobile Push Notifications add-on

This method requires that the Mobile Push Notifications add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Disable mobile push notifications from all channels registered with the specified pushToken.

Method(s)

To run Remove all mobile push notifications, you can use the following method(s) in the Cocoa SDK:

1- (void)removeAllPushNotificationsFromDeviceWithPushToken:(NSData *)pushToken
2                                            andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`pushToken` * Type: NSData	Device push token which should be used to disable push `notifications` on specified set of `channels`.
`block` Type: PNPushNotificationsStateModificationCompletionBlock	Push `notifications` removal from device processing completion `block` which pass only one argument - request processing `status` to report about how data pushing was successful or not.

1- (void)removeAllPushNotificationsFromDeviceWithPushToken:(id)pushToken
2                                                 pushType:(PNPushType)pushType
3                                            andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`pushToken` * Type: id	Device token / identifier that you must set to `NSString`.
`pushType` * Type: PNPushType	One of: `PNFCMPush`.
`block` Type: PNPushNotificationsStateModificationCompletionBlock	`Remove all notifications` request completion block.

1- (void)removeAllPushNotificationsFromDeviceWithPushToken:(id)pushToken
                                               pushType:(PNPushType)pushType
                                            environment:(PNAPNSEnvironment)environment
                                                  topic:(NSString *)topic
                                          andCompletion:(nullable PNPushNotificationsStateModificationCompletionBlock)block;

* required

Parameter	Description
`channels` * Type: NSArray`<NSString >`	List of channel names for which mobile push notifications should be disabled.
`pushToken` * Type: id	Device token / identifier that you must set to `NSData`.
`pushType` * Type: PNPushType	One of: `PNAPNS2Push`.
`environment` * Type: PNAPNSEnvironment	APNs environment.
`topic` * Type: NSString	APNs topic (bundle identifier).
`block` Type: PNPushNotificationsStateModificationCompletionBlock	`Remove all notifications` request completion block.

Sample code

Remove all mobile push notifications

1[self.client removeAllPushNotificationsFromDeviceWithPushToken:self.devicePushToken
2                                                 andCompletion:^(PNAcknowledgmentStatus *status) {
3

4    if (!status.isError) {
5

6        /**
7         Handle successful push notification disabling for all channels associated with
8         specified device push token.
9         */
10    }
11    else {
12

13        /**
14         Handle modification error. Check 'category' property
15         to find out possible reason because of which request did fail.
16         Review 'errorData' property (which has PNErrorData data type) of status
17         object to get additional information about issue.
18

19         Request can be resent using: [status retry];
20         */
21    }
22}];
show all 22 lines

Response

Response objects which is returned by client when APNS Remove All Devices API is used:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNAcknowledgmentStatus : PNErrorStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

Other examples

Example For Method no. 2

1[self.client removeAllPushNotificationsFromDeviceWithPushToken:self.devicePushToken
                                                    pushType:PNFCMPush
                                               andCompletion:^(PNAcknowledgmentStatus *status) {
4

  if (!status.isError) {
      /**
       * Push notification successfully disabled for all channels associated with specified
       * device push token.
       */
  } else {
      /**
       * Handle modification error. Check 'category' property to find out possible issue because
       * of which request did fail.
       *
       * Request can be resent using: [status retry];
       */
  }
18}];
show all 18 lines

Example For Method no. 3

1[self.client removeAllPushNotificationsFromDeviceWithPushToken:self.devicePushToken
                                                    pushType:PNAPNS2Push
                                                 environment:PNAPNSProduction
                                                       topic:@"com.my-application.bundle"
                                               andCompletion:^(PNAcknowledgmentStatus *status) {
6

  if (!status.isError) {
      /**
       * Push notification successfully disabled for all channels associated with specified
       * device push token.
       */
  } else {
      /**
       * Handle modification error. Check 'category' property to find out possible issue because
       * of which request did fail.
       *
       * Request can be resent using: [status retry];
       */
  }
20}];
show all 20 lines

Remove all mobile push notifications (builder pattern)

note

Requires Mobile Push Notifications add-on

This method requires that the Mobile Push Notifications add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Method(s)

1push()
  .disableAll()
  .token(id)
  .pushType(PNPushType)
  .environment(PNAPNSEnvironment)
  .topic(NSString *)
  .performWithCompletion(nullable PNPushNotificationsStateModificationCompletionBlock);

* required

Parameter	Description
`token` * Type: id	Device token / identifier which depending from passed `pushType` should be `NSData` (for `PNAPNS2Push`) or `NSString` for other.
`pushType` * Type: PNPushType	One of: `PNAPNS2Push`, `PNFCMPush`.
`environment` Type: PNAPNSEnvironment	APNs environment.
`topic` Type: NSString	APNs topic (bundle identifier).
`block` Type: PNPushNotificationsStateModificationCompletionBlock	`Remove all notifications` request completion block.

Optional arguments

This method uses the builder pattern, you can remove the arguments which are optional.

Sample code

Remove all mobile push notifications, using builder pattern

1self.client.push().disableAll()
  .token(self.devicePushToken)
  .pushType(PNAPNS2Push)
  .environment(PNAPNSProduction)
  .topic(@"com.my-application.bundle")
  .performWithCompletion(^(PNAcknowledgmentStatus *status) {
      if (!status.isError) {
          /**
           * Push notification successfully disabled for all channels associated with specified
           * device push token.
           */
      } else {
          /**
           * Handle modification error. Check 'category' property to find out possible issue because
           * of which request did fail.
           *
           * Request can be resent using: [status retry];
           */
      }
  });
show all 20 lines

Response

Response object returned by the client when APNS Remove All Devices API is used:

1@interface PNErrorData : PNServiceData
2

3// Stringified error information.
4@property (nonatomic, readonly, strong) NSString *information;
5

6@end
7

8@interface PNAcknowledgmentStatus : PNErrorStatus
9

10// Whether status object represent error or not.
11@property (nonatomic, readonly, assign, getter = isError) BOOL error;
12

13// Additional information related to error status object.
14@property (nonatomic, readonly, strong) PNErrorData *errorData;
15

16@end
show all 16 lines

Add a device to a push notifications channel​

note

Method(s)​

Sample code​

Add device to channel​

Response​

Other examples​

Example for method no. 2​

Example for method no. 3​

Add device to channel (builder pattern)​

note

Method(s)​

APNS2 token​

Optional arguments

FCM token​

Optional arguments

Sample code​

APNS2 token​

FCM token​

Response​

List channels for device​

note

Method(s)​

Sample code​

List channels for device​

Response​

Other examples​

Example for method no. 2​

Example for method no. 3​

List channels for device (builder pattern)​

note

Method(s)​

APNS2 token​

Optional arguments

FCM token​

Optional arguments

Sample code​

APNS2 token​

FCM token​

Response​

Remove device from channel​

note

Method(s)​

Sample code​

Remove device from channel​

Response​

Other examples​

Example for method no. 2​

Example for method no. 3​

Remove device from channel (builder pattern)​

note

Method(s)​

APNS2 token​

Optional arguments

FCM token​

Optional arguments

Sample code​

APNS token​

FCM token​

Response​

Remove all mobile push notifications​

note

Method(s)​

Sample code​

Remove all mobile push notifications​

Response​

Other examples​

Remove all mobile push notifications (builder pattern)​

note

Method(s)​

Optional arguments

Sample code​

Remove all mobile push notifications, using builder pattern​

Response​

Add a device to a push notifications channel

Method(s)

Sample code

Add device to channel

Response

Other examples

Example for method no. 2

Example for method no. 3

Add device to channel (builder pattern)

Method(s)

APNS2 token

FCM token

Sample code

APNS2 token

FCM token

Response

List channels for device

Method(s)

Sample code

List channels for device

Response

Other examples

Example for method no. 2

Example for method no. 3

List channels for device (builder pattern)

Method(s)

APNS2 token

FCM token

Sample code

APNS2 token

FCM token

Response

Remove device from channel

Method(s)

Sample code

Remove device from channel

Response

Other examples

Example for method no. 2

Example for method no. 3

Remove device from channel (builder pattern)

Method(s)

APNS2 token

FCM token

Sample code

APNS token

FCM token

Response

Remove all mobile push notifications

Method(s)

Sample code

Remove all mobile push notifications

Response

Other examples

Remove all mobile push notifications (builder pattern)

Method(s)

Sample code

Remove all mobile push notifications, using builder pattern

Response