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 anEnvelope
object, which has two fields:Envelope.result
, whose type differs for each API, andEnvelope.status
of typePnStatus
.pubnub.publish() \
.channel("myChannel") \
.message("Hello from PubNub Python SDK") \
.sync() -
.pn_async(callback)
returnsNone
and passes the values ofEnvelope.result
andEnvelope.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
# for FCM/GCM
from pubnub.enums import PNPushType
envelope = pubnub.add_channels_to_push()\
.push_type(PNPushType.GCM)\
.channels(["ch1", "ch2", "ch3"])\
.device_id("deviceId")\
.sync()
# for APNS2
from pubnub.enums import PNPushType
envelope = pubnub.add_channels_to_push()\
.push_type(PNPushType.APNS2)\
.channels(["ch1", "ch2", "ch3"])\
show all 19 linesReturns
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 . |