Mobile Push Notifications API for PubNub Python SDK

Mobile Push Notifications feature enables developers to bridge native PubNub publishing with 3rd-party push notification services including Google Android FCM (Firebase Cloud Messaging) and Apple iOS APNs (Apple Push Notification service).

By using the Mobile Push Notifications feature, developers can eliminate the need for developing, configuring, and maintaining additional server-side components for third-party push notification providers.

To learn more, read about Mobile Push Notifications.

Request execution and return values

You can decide whether to perform the Python SDK operations synchronously or asynchronously.

• .sync() returns an Envelope object, which has two fields: Envelope.result, whose type differs for each API, and Envelope.status of type PnStatus.

  pubnub.publish() \
      .channel("myChannel") \
      .message("Hello from PubNub Python SDK") \
      .sync()

• .pn_async(callback) returns None and passes the values of Envelope.result and Envelope.status to a callback you must define beforehand.

  def my_callback_function(result, status):
      print(f'TT: {result.timetoken}, status: {status.category.name}')
  
  pubnub.publish() \
      .channel("myChannel") \
      .message("Hello from PubNub Python SDK") \
      .pn_async(my_callback_function)

Add Device to Channel

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 Python SDK:

pubnub.add_channels_to_push() \
    .push_type(PNPushType) \
    .channels(List) \
    .device_id(String) \
    .topic(String) \
    .environment(PNPushEnvironment)

Parameter	Type	Required	Default	Description
push_type	PNPushType	Yes	n/a	The available push types. Accepted values: PNPushType.GCM, PNPushType.APNS2
channels	List	Yes	n/a	The channels to add the mobile push notifications to.
device_id	String	Yes	n/a	The device ID (token) to associate with the mobile push notifications.
topic	String	Required for PNPushType.APNS2	n/a	The topic name for the notification. For the Apple platform, this is the application's bundle identifier. Required only if push_type is set to PNPushType.APNS2.
environment	String	Required for PNPushType.APNS2	PNPushEnvironment.DEVELOPMENT	The environment where the device should manage the list of channels with enabled notifications. Required only if push_type is set to PNPushType.APNS2.

Basic Usage

Add Device to Channel

Builder Pattern

from pubnub.enums import PNPushType, PNPushEnvironment

# for FCM/GCM
envelope = pubnub.add_channels_to_push() \
    .push_type(PNPushType.GCM) \
    .channels(["ch1", "ch2", "ch3"]) \
    .device_id("deviceId") \
    .sync()

# for APNS2
envelope = pubnub.add_channels_to_push() \
    .push_type(PNPushType.APNS2) \
    .channels(["ch1", "ch2", "ch3"]) \
    .device_id("deviceId") \
    .topic("myapptopic") \

show all 17 lines

Named Arguments

from pubnub.enums import PNPushType

# for FCM/GCM
envelope = pubnub.add_channels_to_push(push_type=PNPushType.GCM,
                                       channels=["ch1", "ch2", "ch3"],
                                       device_id="deviceId") \
    .sync()

# for APNS2
envelope = pubnub.add_channels_to_push(push_type=PNPushType.APNS2,
                                      channels=["ch1", "ch2", "ch3"],
                                      device_id="deviceId",
                                      topic="myapptopic",
                                      environment=PNPushEnvironment.DEVELOPMENT) \
    .sync()

Returns

The add_channels_to_push() operation does not return actionable data. You can check the status object for the outcome by inspecting status.is_error().

List Channels For Device

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 Python SDK:

pubnub.list_push_channels() \
    .push_type(PNPushType) \
    .device_id(String) \
    .topic(String) \
    .environment(PNPushEnvironment)

Parameter	Type	Required	Default	Description
push_type	PNPushType	Yes	n/a	The available push types. Accepted values: PNPushType.GCM, PNPushType.APNS2
device_id	String	Yes	n/a	The device ID (token) to associate with the mobile push notifications.
topic	String	Required for PNPushType.APNS2	n/a	The topic name for the notification. For the Apple platform, this is the application's bundle identifier. Required only if push_type is set to PNPushType.APNS2.
environment	String	Required for PNPushType.APNS2	PNPushEnvironment.DEVELOPMENT	The environment where the device should manage the list of channels with enabled notifications. Required only if push_type is set to PNPushType.APNS2.

Basic Usage

List Channels For Device

Builder Pattern

from pubnub.enums import PNPushType, PNPushEnvironment

# for FCM/GCM
envelope = pubnub.list_push_channels() \
    .push_type(PNPushType.GCM) \
    .device_id("deviceId") \
    .sync()

# for APNS2
envelope = pubnub.list_push_channels() \
    .push_type(PNPushType.APNS2) \
    .device_id("deviceId") \
    .topic("myapptopic") \
    .environment(PNPushEnvironment.DEVELOPMENT) \
    .sync()

Named Arguments

from pubnub.enums import PNPushType, PNPushEnvironment

# for FCM/GCM
envelope = pubnub.list_push_channels(push_type=PNPushType.GCM, device_id="deviceId").sync()

# for APNS2
envelope = pubnub.list_push_channels(push_type=PNPushType.APNS2,
                                     device_id="deviceId",
                                     topic="myapptopic",
                                     environment=PNPushEnvironment.DEVELOPMENT) \
    .sync()

Returns

The list_push_channels() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNPushListProvisionsResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNPushListProvisionsResult

Method	Type	Description
Channels	List	List of channels associated for mobile push notifications.

Remove Device From Channel

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. If nil will be passed as channels then client will remove mobile push notifications from all channels which associated with pushToken.

Method(s)

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

pubnub.remove_channels_from_push() \
    .push_type(PNPushType) \
    .channels(List) \
    .device_id(String) \
    .topic(String) \
    .environment(PNPushEnvironment)

Parameter	Type	Required	Default	Description
push_type	PNPushType	Yes	n/a	The available push types. Accepted values: PNPushType.GCM, PNPushType.APNS2
channels	List	Yes	n/a	The channels to add the mobile push notifications to.
device_id	String	Yes	n/a	The device ID (token) to associate with the mobile push notifications.
topic	String	Required for PNPushType.APNS2	n/a	The topic name for the notification. For the Apple platform, this is the application's bundle identifier. Required only if push_type is set to PNPushType.APNS2.
environment	String	Required for PNPushType.APNS2	PNPushEnvironment.DEVELOPMENT	The environment where the device should manage the list of channels with enabled notifications. Required only if push_type is set to PNPushType.APNS2.

Basic Usage

Remove Device From Channel

Builder Pattern

from pubnub.enums import PNPushType, PNPushEnvironment

# for FCM/GCM
envelope = pubnub.remove_channels_from_push() \
    .push_type(PNPushType.GCM) \
    .channels("ch1", "ch2", "ch3") \
    .device_id("deviceId") \
    .sync()

# for APNS2

envelope = pubnub.remove_channels_from_push() \
    .push_type(PNPushType.APNS2) \
    .channels("ch1", "ch2", "ch3") \
    .device_id("deviceId") \

show all 18 lines

Named Arguments

from pubnub.enums import PNPushType, PNPushEnvironment

# for FCM/GCM
envelope = pubnub.remove_channels_from_push(channels=["ch1", "ch2", "ch3"],
                                            push_type=PNPushType.GCM,
                                            device_id="deviceId") \
    .sync()

# for APNS2
envelope = pubnub.remove_channels_from_push(channels=["ch1", "ch2", "ch3"],
                                            push_type=PNPushType.APNS2,
                                            device_id="deviceId",
                                            topic="myapptopic",
                                            environment=PNPushEnvironment.DEVELOPMENT) \
    .sync()

Returns

The remove_channels_from_push() operation does not return actionable data. You can check the status object for the outcome by inspecting status.is_error().

Remove all mobile push notifications

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 Python SDK:

pubnub.remove_device_from_push() \
    .push_type(PNPushType) \
    .device_id(String) \
    .topic(String) \
    .environment(PNPushEnvironment)

Parameter	Type	Required	Default	Description
push_type	PNPushType	Yes	n/a	The available push types. Accepted values: PNPushType.GCM, PNPushType.MPNS, PNPushType.APNS2
device_id	String	Yes	n/a	The device ID (token) to associate with the mobile push notifications.
topic	String	Required for PNPushType.APNS2	n/a	The topic name for the notification. For the Apple platform, this is the application's bundle identifier. Required only if push_type is set to PNPushType.APNS2.
environment	String	Required for PNPushType.APNS2	PNPushEnvironment.DEVELOPMENT	The environment where the device should manage the list of channels with enabled notifications. Required only if push_type is set to PNPushType.APNS2.

Basic Usage

Remove all mobile push notifications

Builder Pattern

from pubnub.enums import PNPushType, PNPushEnvironment

# for FCM/GCM
envelope = pubnub.remove_device_from_push() \
    .push_type(PNPushType.GCM) \
    .device_id("deviceId") \
    .sync()

# for APNS2
envelope = pubnub.remove_device_from_push() \
    .push_type(PNPushType.APNS2) \
    .device_id("deviceId") \
    .topic("myapptopic") \
    .environment(PNPushEnvironment.DEVELOPMENT) \
    .sync()

Named Arguments

from pubnub.enums import PNPushType, PNPushEnvironment

# for FCM/GCM
envelope = pubnub.remove_device_from_push(device_id="deviceId", push_type=PNPushType.GCM).sync()
# for APNS2
envelope = pubnub.remove_device_from_push(device_id="deviceId",
                                          push_type=PNPushType.APNS2,
                                          topic="myapptopic",
                                          environment=PNPushEnvironment.DEVELOPMENT) \
    .sync()

Returns

The remove_device_from_push() operation does not return actionable data. You can check the status object for the outcome by inspecting status.is_error().