PHPPHP V4 Mobile Push API Reference for Realtime Apps

 

These docs are for PubNub 4.x for PHP which is our latest and greatest! For the docs of the older versions of the SDK, please check PubNub 3.x for PHP.

If you have questions about the PubNub for PHP SDK, please contact us at support@pubnub.com.

PubNub's Mobile Push Gateway feature enables developers to bridge native PubNub publishing with 3rd-party push notification services including Google Android GCM (Google Cloud Messaging)/FCM (Firebase Cloud Messaging), Apple iOS APNs (Apple Push Notification service), and Microsoft Windows Phone MPNS (Microsoft Push Notification Service).

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

Learn more about our Mobile Push Gateway here.


Requires Mobile Push Notifications add-on XRequires that you enable the Mobile Push Notifications for your key. Refer to the following page for details on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
Enable push notifications on provided set of channels.
To run Adding Device to Channel you can use the following method(s) in the PHP V4 SDK
  1. ParameterTypeRequiredDefaultsDescription
    pushTypePNPushTypeYesNot setAccepted values: PNPushType.GCM, PNPushType.APNS, PNPushType.MPNS.
    channelsArrayYesAdd push notifications on the specified channels.
    deviceIdStringYesDevice id.
use PubNub\Enums\PNPushType;

$pubnub->addChannelsToPush()
    ->pushType(PNPushType::GCM)
    ->channels(["ch1", "ch2", "ch3"])
    ->deviceId("deviceId")
    ->sync();

Requires Mobile Push Notifications add-on XRequires that you enable the Mobile Push Notifications for your key. Refer to the following page for details on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
Request for all channels on which push notification has been enabled using specified pushToken.
To run Listing Channels For Device you can use the following method(s) in the PHP V4 SDK
  1. ParameterTypeRequiredDefaultsDescription
    pushTypePNPushTypeYesNot setAccepted values: PNPushType.GCM, PNPushType.APNS, PNPushType.MPNS.
    deviceIdStringYesDevice id.
$pubnub->arrayPushProvisions()
    ->pushType(PNPushType::GCM)
    ->deviceId("deviceId")
    ->sync();
MethodTypeDescription
getChannels()ArrayList of channels associated for push notifications.

Requires Mobile Push Notifications add-on XRequires that you enable the Mobile Push Notifications for your key. Refer to the following page for details on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
Disable push notifications on provided set of channels. If nil will be passed as channels then client will remove push notifications from all channels which associated with pushToken.
To run Removing Device From Channel you can use the following method(s) in the PHP V4 SDK
  1. ParameterTypeRequiredDefaultsDescription
    pushTypePNPushTypeYesNot setAccepted values: PNPushType.GCM, PNPushType.APNS, PNPushType.MPNS.
    channelsString|ArrayYesRemove push notifications from the specified channels.
    deviceIdStringYesDevice id.
use PubNub\Enums\PNPushType;

$pubnub->removeChannelsFromPush()
    ->pushType(PNPushType::GCM)
    ->channels(["ch1", "ch2", "ch3"])
    ->deviceId("deviceId")
    ->sync();