JavaScriptWebWebNode.jsPhoneGapReactReduxTitaniumVueJavaScript V4 Misc API Reference for Realtime AppsNode.js V4 Misc API Reference for Realtime AppsPhoneGap V4 Misc API Reference for Realtime AppsTitanium V4 Misc API Reference for Realtime AppsVue V4 Misc API Reference for Realtime Apps

Close PubNub

Description

End all open requests and close the PubNub instance.

Basic Usage

pubnub.stop();

Decrypt

var decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method

Encrypt

var sCypher = "testCypher";
var msgContent = "This is the data I wish to encrypt.";
console.log('msgContent: ' + msgContent);

// Encrypt with pubnub
var encryptedMessage = pubnub.encrypt(JSON.stringify(msgContent), sCypher);
console.log('encryptedMessage PN: ' + encryptedMessage);

Reconnect

pubnub.reconnect();

setProxy

pubnub.setProxy({
	hostname: 'YOUR HOSTNAME HERE',
  	port: 8080,
	protocol: 'YOUR PROTOCOL HERE'
});

Time

Description

timetoken = (Unix epoch time in seconds) * 10000000

08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000

Method(s)

1. time(Function callback)

   Parameter	Type	Required	Description
   callback	Function	Yes	Callback is called after a successful return.

Basic Usage

// assuming an initialized PubNub instance already exists
pubnub.time(function(status, response) {
	if (status.error) {
		// handle error if something went wrong based on the status object
	} else {
		console.log(response.timetoken);
	}
})

Response

//Example of status
{
    error: false,
    operation: 'PNTimeOperation',
    statusCode: 200
}

//Example of response
{
    timetoken: 15031768233407550
}

Other Examples

1. Basic usage using Promises

   pubnub.time().then((timetoken) => {
       console.log(timetoken);
   }).catch((error) => {
       console.log(error)
   });

APNS2Configuration

Description

APNS2 configuration type.

Method(s)

1. type APNS2Configuration = {
  collapseId?: string,
  expirationDate?: Date,
  targets: Array<APNS2Target>
}

   Parameter	Type	Required	Description
   collapseId	String	Optional	Notification group / collapse identifier. Value will be used in APNS POST request as apns-collapse-id header value.
   expirationDate	Date	Optional	Date till which APNS will try to deliver notification to target device. Value will be used in APNS POST request as apns-expiration header value.
   targets	Array<APNS2Target>	Yes	List of topics which should receive this notification.

APNSNotificationPayload

Description

APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.

Properties

1. Parameter	Type	Description
   configurations	Array<APNS2NotificationConfiguration *> *	List of APNS over HTTP/2 delivery configurations.
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.
   silent	Boolean	Whether operation system should handle notification layout by default or not. alert, sound and badge will be removed from resulting payload if set to true.

APNS2Target

Description

APNS2 configuration target type.

Method(s)

1. type APNS2Target = {
  topic: string,
  environment?: 'development' | 'production',
  excludedDevices?: Array<string>
}

   Parameter	Type	Required	Defaults	Description
   topic	String	Yes		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   environment	String	Optional	development	Environment within which registered devices to which notifications should be delivered. Available: development production
   excludedDevices	Array	Yes		List of devices (their push tokens) to which this notification shouldn't be delivered.

FCMNotificationPayload

Description

FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.

Properties

1. Parameter	Type	Description
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   data	Hash	Custom key-value object with additional information which will be passed to device along with displayable notification information. All object and scalar type value should be converted to strings before passing to this object. Keys shouldn't match: from, message_type or start with google or gcm. Also as key can't be used any word defined in this table.
   silent	Boolean	Whether operation system should handle notification layout by default or not. notification key with it's content will be moved from root level under data key.
   icon	String	Icon which should be shown on the left from notification title instead of application icon.
   tag	String	Unique notification identifier which can be used to publish update notifications (they will previous notification with same tag).
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

MPNSNotificationPayload

Description

MPNSNotificationPayload instance provides access to options specific only to push notifications sent with MPNS.

Properties

1. Parameter	Type	Description
   backContent	String	Message which should be shown in notification body (text for back tile). 40 characters long to fit into tile.
   backTitle	String	Additional information which may explain reason why this notification has been delivered. Maximum 15 characters long.
   count	Number	Value between 1-99 which will be shown on the tile.
   title	String	Title of the tile.
   type	String	Type of notification which should be presented to the user.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

NotificationsPayload

Description

NotificationsPayload instance provides convenient method and properties which allow to setup notification for multiple platforms without getting into details how they should be formatted.
Builder instance contain additional set of properties which allow to fine tune payloads for particular platforms and even access to RAW payload dictionaries.

Method(s)

1. Parameter	Type	Description
   subtitle	String	Additional information which may explain reason why this notification has been delivered.
   badge	Number	Number which should be shown in space designated by platform (for example atop of application icon).
   sound	String	Path to file with sound or name of system sound which should be played upon notification receive.
   debugging	Boolean	Whether PubNub service should provide debug information about devices which received created notifications payload.
   apns	APNSNotificationPayload	Access to APNS specific notification builder.
   mpns	MPNSNotificationPayload	Access to MPNS specific notification builder.
   fcm	FCMNotificationPayload	Access to FCM specific notification builder.

2. PubNub.notificationPayload(String title, String body)

   Parameter	Type	Required	Description
   title	String	Optional	Short text which should be shown at the top of notification instead of application name.
   body	String	Optional	Message which should be shown in notification body (under title line).

3. buildPayload(Array<String> platforms)

   Parameter	Type	Required	Description
   platforms	Array	Yes	List of platforms for which payload should be added to final dictionary. Available: apns apns2 fcm mpns

Basic Usage

Create notification payload builder with pre-defined notification title and body:

1. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   let messagePayload = builder.buildPayload(['apns2', 'fcm']);
   messagePayload.message = 'Max invited you to \'quiz\' chat room';
   messagePayload.roomID = 'ewuiogw9vewg0';
   
   pubnub.publish(
       {
           message: messagePayload,
           channel: 'chat-bot',
       }, 
       function (status, response) {
           // Handle publish results
       }
   );

2. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');

Response

Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.

Other Examples

1. Generate simple notification payload for FMC and APNS:

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           }
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

2. Generate simple notification payload for FMC and APNS over HTTP/2 (default configuration):

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [{ targets: [{ topic: 'com.meetings.chat.app' }] }];
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           },
           "pn_push": [
               {
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

3. Generate simple notification payload for FMC and APNS over HTTP/2 (custom configuration):

   let configuration = [
       { 
           collapseId: 'invitations',
           expirationDate: new Date(Date.now() + 10000),
           targets: [{ topic: 'com.meetings.chat.app' }] 
       }
   ];
   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [configuration];
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "Chat invitation",
                   "title": "You have been invited to 'quiz' chat"
               }
           },
           "pn_push": [
               {
                   "collapse_id": "invitations",
                   "expiration": "2019-11-28T22:06:09.163Z",
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "title": "Chat invitation"
           }
       }
   }

Example above show how to create notification payload which APNS will try to redeliver few times (if devices not active) and give up after 10 seconds since moment when it has been scheduled.

Additionally this invitation notification will be grouped along with other invitation notifications (using provided collapse_id as group identifier) and shown as one in notification center.

Returns

Configured and ready to use NotificationsPayload instance.

Close PubNub

Description

End all open requests and close the PubNub instance.

Basic Usage

pubnub.stop();

Decrypt

var decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method

Encrypt

var sCypher = "testCypher";
var msgContent = "This is the data I wish to encrypt.";
console.log('msgContent: ' + msgContent);

// Encrypt with pubnub
var encryptedMessage = pubnub.encrypt(JSON.stringify(msgContent), sCypher);
console.log('encryptedMessage PN: ' + encryptedMessage);

Reconnect

pubnub.reconnect();

Time

Description

timetoken = (Unix epoch time in seconds) * 10000000

08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000

Method(s)

1. time(Function callback)

   Parameter	Type	Required	Description
   callback	Function	Yes	Callback is called after a successful return.

Basic Usage

// assuming an initialized PubNub instance already exists
pubnub.time(function(status, response) {
	if (status.error) {
		// handle error if something went wrong based on the status object
	} else {
		console.log(response.timetoken);
	}
})

Response

//Example of status
{
    error: false,
    operation: 'PNTimeOperation',
    statusCode: 200
}

//Example of response
{
    timetoken: 15031768233407550
}

APNS2Configuration

Description

APNS2 configuration type.

Method(s)

1. type APNS2Configuration = {
  collapseId?: string,
  expirationDate?: Date,
  targets: Array<APNS2Target>
}

   Parameter	Type	Required	Description
   collapseId	String	Optional	Notification group / collapse identifier. Value will be used in APNS POST request as apns-collapse-id header value.
   expirationDate	Date	Optional	Date till which APNS will try to deliver notification to target device. Value will be used in APNS POST request as apns-expiration header value.
   targets	Array<APNS2Target>	Yes	List of topics which should receive this notification.

APNSNotificationPayload

Description

APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.

Properties

1. Parameter	Type	Description
   configurations	Array<APNS2NotificationConfiguration *> *	List of APNS over HTTP/2 delivery configurations.
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.
   silent	Boolean	Whether operation system should handle notification layout by default or not. alert, sound and badge will be removed from resulting payload if set to true.

APNS2Target

Description

APNS2 configuration target type.

Method(s)

1. type APNS2Target = {
  topic: string,
  environment?: 'development' | 'production',
  excludedDevices?: Array<string>
}

   Parameter	Type	Required	Defaults	Description
   topic	String	Yes		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   environment	String	Optional	development	Environment within which registered devices to which notifications should be delivered. Available: development production
   excludedDevices	Array	Yes		List of devices (their push tokens) to which this notification shouldn't be delivered.

FCMNotificationPayload

Description

FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.

Properties

1. Parameter	Type	Description
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   data	Hash	Custom key-value object with additional information which will be passed to device along with displayable notification information. All object and scalar type value should be converted to strings before passing to this object. Keys shouldn't match: from, message_type or start with google or gcm. Also as key can't be used any word defined in this table.
   silent	Boolean	Whether operation system should handle notification layout by default or not. notification key with it's content will be moved from root level under data key.
   icon	String	Icon which should be shown on the left from notification title instead of application icon.
   tag	String	Unique notification identifier which can be used to publish update notifications (they will previous notification with same tag).
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

MPNSNotificationPayload

Description

MPNSNotificationPayload instance provides access to options specific only to push notifications sent with MPNS.

Properties

1. Parameter	Type	Description
   backContent	String	Message which should be shown in notification body (text for back tile). 40 characters long to fit into tile.
   backTitle	String	Additional information which may explain reason why this notification has been delivered. Maximum 15 characters long.
   count	Number	Value between 1-99 which will be shown on the tile.
   title	String	Title of the tile.
   type	String	Type of notification which should be presented to the user.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

NotificationsPayload

Description

NotificationsPayload instance provides convenient method and properties which allow to setup notification for multiple platforms without getting into details how they should be formatted.
Builder instance contain additional set of properties which allow to fine tune payloads for particular platforms and even access to RAW payload dictionaries.

Method(s)

1. Parameter	Type	Description
   subtitle	String	Additional information which may explain reason why this notification has been delivered.
   badge	Number	Number which should be shown in space designated by platform (for example atop of application icon).
   sound	String	Path to file with sound or name of system sound which should be played upon notification receive.
   debugging	Boolean	Whether PubNub service should provide debug information about devices which received created notifications payload.
   apns	APNSNotificationPayload	Access to APNS specific notification builder.
   mpns	MPNSNotificationPayload	Access to MPNS specific notification builder.
   fcm	FCMNotificationPayload	Access to FCM specific notification builder.

2. PubNub.notificationPayload(String title, String body)

   Parameter	Type	Required	Description
   title	String	Optional	Short text which should be shown at the top of notification instead of application name.
   body	String	Optional	Message which should be shown in notification body (under title line).

3. buildPayload(Array<String> platforms)

   Parameter	Type	Required	Description
   platforms	Array	Yes	List of platforms for which payload should be added to final dictionary. Available: apns apns2 fcm mpns

Basic Usage

Create notification payload builder with pre-defined notification title and body:

1. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   let messagePayload = builder.buildPayload(['apns2', 'fcm']);
   messagePayload.message = 'Max invited you to \'quiz\' chat room';
   messagePayload.roomID = 'ewuiogw9vewg0';
   
   pubnub.publish(
       {
           message: messagePayload,
           channel: 'chat-bot',
       }, 
       function (status, response) {
           // Handle publish results
       }
   );

2. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');

Response

Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.

Other Examples

1. Generate simple notification payload for FMC and APNS:

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           }
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

2. Generate simple notification payload for FMC and APNS over HTTP/2 (default configuration):

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [{ targets: [{ topic: 'com.meetings.chat.app' }] }];
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           },
           "pn_push": [
               {
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

3. Generate simple notification payload for FMC and APNS over HTTP/2 (custom configuration):

   let configuration = [
       { 
           collapseId: 'invitations',
           expirationDate: new Date(Date.now() + 10000),
           targets: [{ topic: 'com.meetings.chat.app' }] 
       }
   ];
   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [configuration];
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "Chat invitation",
                   "title": "You have been invited to 'quiz' chat"
               }
           },
           "pn_push": [
               {
                   "collapse_id": "invitations",
                   "expiration": "2019-11-28T22:06:09.163Z",
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "title": "Chat invitation"
           }
       }
   }

Example above show how to create notification payload which APNS will try to redeliver few times (if devices not active) and give up after 10 seconds since moment when it has been scheduled.

Additionally this invitation notification will be grouped along with other invitation notifications (using provided collapse_id as group identifier) and shown as one in notification center.

Returns

Configured and ready to use NotificationsPayload instance.

Close PubNub

Description

End all open requests and close the PubNub instance.

Basic Usage

pubnub.stop();

Decrypt

var decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method

Encrypt

var sCypher = "testCypher";
var msgContent = "This is the data I wish to encrypt.";
console.log('msgContent: ' + msgContent);

// Encrypt with pubnub
var encryptedMessage = pubnub.encrypt(JSON.stringify(msgContent), sCypher);
console.log('encryptedMessage PN: ' + encryptedMessage);

Reconnect

pubnub.reconnect();

Time

Description

timetoken = (Unix epoch time in seconds) * 10000000

08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000

Method(s)

1. time(Function callback)

   Parameter	Type	Required	Description
   callback	Function	Yes	Callback is called after a successful return.

Basic Usage

pubnub.time(function(status, response) {
    if (status.error) {
        console.log(status.error);
    } else {
        console.log(response.timetoken);
    }
});

Response

//Example of status
{
    error: false,
    operation: 'PNTimeOperation',
    statusCode: 200
}

//Example of response
{
    timetoken: 15031768233407550
}

Other Examples

1. Basic usage using Promises

   pubnub.time().then((timetoken) => {
       console.log(timetoken);
   }).catch((error) => {
       console.log(error)
   });

APNS2Configuration

Description

APNS2 configuration type.

Method(s)

1. type APNS2Configuration = {
  collapseId?: string,
  expirationDate?: Date,
  targets: Array<APNS2Target>
}

   Parameter	Type	Required	Description
   collapseId	String	Optional	Notification group / collapse identifier. Value will be used in APNS POST request as apns-collapse-id header value.
   expirationDate	Date	Optional	Date till which APNS will try to deliver notification to target device. Value will be used in APNS POST request as apns-expiration header value.
   targets	Array<APNS2Target>	Yes	List of topics which should receive this notification.

APNSNotificationPayload

Description

APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.

Properties

1. Parameter	Type	Description
   configurations	Array<APNS2NotificationConfiguration *> *	List of APNS over HTTP/2 delivery configurations.
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.
   silent	Boolean	Whether operation system should handle notification layout by default or not. alert, sound and badge will be removed from resulting payload if set to true.

APNS2Target

Description

APNS2 configuration target type.

Method(s)

1. type APNS2Target = {
  topic: string,
  environment?: 'development' | 'production',
  excludedDevices?: Array<string>
}

   Parameter	Type	Required	Defaults	Description
   topic	String	Yes		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   environment	String	Optional	development	Environment within which registered devices to which notifications should be delivered. Available: development production
   excludedDevices	Array	Yes		List of devices (their push tokens) to which this notification shouldn't be delivered.

FCMNotificationPayload

Description

FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.

Properties

1. Parameter	Type	Description
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   data	Hash	Custom key-value object with additional information which will be passed to device along with displayable notification information. All object and scalar type value should be converted to strings before passing to this object. Keys shouldn't match: from, message_type or start with google or gcm. Also as key can't be used any word defined in this table.
   silent	Boolean	Whether operation system should handle notification layout by default or not. notification key with it's content will be moved from root level under data key.
   icon	String	Icon which should be shown on the left from notification title instead of application icon.
   tag	String	Unique notification identifier which can be used to publish update notifications (they will previous notification with same tag).
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

MPNSNotificationPayload

Description

MPNSNotificationPayload instance provides access to options specific only to push notifications sent with MPNS.

Properties

1. Parameter	Type	Description
   backContent	String	Message which should be shown in notification body (text for back tile). 40 characters long to fit into tile.
   backTitle	String	Additional information which may explain reason why this notification has been delivered. Maximum 15 characters long.
   count	Number	Value between 1-99 which will be shown on the tile.
   title	String	Title of the tile.
   type	String	Type of notification which should be presented to the user.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

NotificationsPayload

Description

NotificationsPayload instance provides convenient method and properties which allow to setup notification for multiple platforms without getting into details how they should be formatted.
Builder instance contain additional set of properties which allow to fine tune payloads for particular platforms and even access to RAW payload dictionaries.

Method(s)

1. Parameter	Type	Description
   subtitle	String	Additional information which may explain reason why this notification has been delivered.
   badge	Number	Number which should be shown in space designated by platform (for example atop of application icon).
   sound	String	Path to file with sound or name of system sound which should be played upon notification receive.
   debugging	Boolean	Whether PubNub service should provide debug information about devices which received created notifications payload.
   apns	APNSNotificationPayload	Access to APNS specific notification builder.
   mpns	MPNSNotificationPayload	Access to MPNS specific notification builder.
   fcm	FCMNotificationPayload	Access to FCM specific notification builder.

2. PubNub.notificationPayload(String title, String body)

   Parameter	Type	Required	Description
   title	String	Optional	Short text which should be shown at the top of notification instead of application name.
   body	String	Optional	Message which should be shown in notification body (under title line).

3. buildPayload(Array<String> platforms)

   Parameter	Type	Required	Description
   platforms	Array	Yes	List of platforms for which payload should be added to final dictionary. Available: apns apns2 fcm mpns

Basic Usage

Create notification payload builder with pre-defined notification title and body:

1. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   let messagePayload = builder.buildPayload(['apns2', 'fcm']);
   messagePayload.message = 'Max invited you to \'quiz\' chat room';
   messagePayload.roomID = 'ewuiogw9vewg0';
   
   pubnub.publish(
       {
           message: messagePayload,
           channel: 'chat-bot',
       }, 
       function (status, response) {
           // Handle publish results
       }
   );

2. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');

Response

Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.

Other Examples

1. Generate simple notification payload for FMC and APNS:

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           }
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

2. Generate simple notification payload for FMC and APNS over HTTP/2 (default configuration):

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [{ targets: [{ topic: 'com.meetings.chat.app' }] }];
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           },
           "pn_push": [
               {
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

3. Generate simple notification payload for FMC and APNS over HTTP/2 (custom configuration):

   let configuration = [
       { 
           collapseId: 'invitations',
           expirationDate: new Date(Date.now() + 10000),
           targets: [{ topic: 'com.meetings.chat.app' }] 
       }
   ];
   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [configuration];
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "Chat invitation",
                   "title": "You have been invited to 'quiz' chat"
               }
           },
           "pn_push": [
               {
                   "collapse_id": "invitations",
                   "expiration": "2019-11-28T22:06:09.163Z",
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "title": "Chat invitation"
           }
       }
   }

Example above show how to create notification payload which APNS will try to redeliver few times (if devices not active) and give up after 10 seconds since moment when it has been scheduled.

Additionally this invitation notification will be grouped along with other invitation notifications (using provided collapse_id as group identifier) and shown as one in notification center.

Returns

Configured and ready to use NotificationsPayload instance.

Close PubNub

Description

End all open requests and close the PubNub instance.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

pubnub.stop();

Decrypt

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

const decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method

Encrypt

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

const sCypher = "testCypher";
const msgContent = "This is the data I wish to encrypt.";
console.log('msgContent: '+ msgContent);
 
// Encrypt with pubnub
const encryptedMessage = pubnub.encrypt(JSON.stringify(msgContent), sCypher);
console.log('encryptedMessage PN: '+ encryptedMessage);

Reconnect

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

pubnub.reconnect();

Time

Description

timetoken = (Unix epoch time in seconds) * 10000000

08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000

Method(s)

1. time(Function callback)

   Parameter	Type	Required	Description
   callback	Function	Yes	Callback is called after a successful return.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

pubnub.time(function(status, response) {
    if (status.error) {
        // handle error if something went wrong based on the status object
    } else {
        console.log(response.timetoken);
    }
});

Response

//Example of status
{
    error: false,
    operation: 'PNTimeOperation',
    statusCode: 200
}

//Example of response
{
    timetoken: 15031768233407550
}

Other Examples

1. Basic usage using Promises

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.time().then((timetoken) => {
       console.log(timetoken);
   }).catch((error) => {
       console.log(error);
   });

APNS2Configuration

Description

APNS2 configuration type.

Method(s)

1. type APNS2Configuration = {
  collapseId?: string,
  expirationDate?: Date,
  targets: Array<APNS2Target>
}

   Parameter	Type	Required	Description
   collapseId	String	Optional	Notification group / collapse identifier. Value will be used in APNS POST request as apns-collapse-id header value.
   expirationDate	Date	Optional	Date till which APNS will try to deliver notification to target device. Value will be used in APNS POST request as apns-expiration header value.
   targets	Array<APNS2Target>	Yes	List of topics which should receive this notification.

APNSNotificationPayload

Description

APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.

Properties

1. Parameter	Type	Description
   configurations	Array<APNS2NotificationConfiguration *> *	List of APNS over HTTP/2 delivery configurations.
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.
   silent	Boolean	Whether operation system should handle notification layout by default or not. alert, sound and badge will be removed from resulting payload if set to true.

APNS2Target

Description

APNS2 configuration target type.

Method(s)

1. type APNS2Target = {
  topic: string,
  environment?: 'development' | 'production',
  excludedDevices?: Array<string>
}

   Parameter	Type	Required	Defaults	Description
   topic	String	Yes		Notifications topic name (usually it is bundle identifier of applicationfor Apple platform). Required only if pushGateway set to apns2.
   environment	String	Optional	development	Environment within which registered devices to which notifications should be delivered. Available: development production
   excludedDevices	Array	Yes		List of devices (their push tokens) to which this notification shouldn't be delivered.

FCMNotificationPayload

Description

FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.

Properties

1. Parameter	Type	Description
   notification	Hash	Hash with parameters which specify user-visible key-value pairs.
   data	Hash	Custom key-value object with additional information which will be passed to device along with displayable notification information. All object and scalar type value should be converted to strings before passing to this object. Keys shouldn't match: from, message_type or start with google or gcm. Also as key can't be used any word defined in this table.
   silent	Boolean	Whether operation system should handle notification layout by default or not. notification key with it's content will be moved from root level under data key.
   icon	String	Icon which should be shown on the left from notification title instead of application icon.
   tag	String	Unique notification identifier which can be used to publish update notifications (they will previous notification with same tag).
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

MPNSNotificationPayload

Description

MPNSNotificationPayload instance provides access to options specific only to push notifications sent with MPNS.

Properties

1. Parameter	Type	Description
   backContent	String	Message which should be shown in notification body (text for back tile). 40 characters long to fit into tile.
   backTitle	String	Additional information which may explain reason why this notification has been delivered. Maximum 15 characters long.
   count	Number	Value between 1-99 which will be shown on the tile.
   title	String	Title of the tile.
   type	String	Type of notification which should be presented to the user.
   payload	Hash	Platform specific notification payload. In addition to data required to make notification visual presentation it can be used to pass additional information which should be sent to remote device.

NotificationsPayload

Description

NotificationsPayload instance provides convenient method and properties which allow to setup notification for multiple platforms without getting into details how they should be formatted.
Builder instance contain additional set of properties which allow to fine tune payloads for particular platforms and even access to RAW payload dictionaries.

Method(s)

1. Parameter	Type	Description
   subtitle	String	Additional information which may explain reason why this notification has been delivered.
   badge	Number	Number which should be shown in space designated by platform (for example atop of application icon).
   sound	String	Path to file with sound or name of system sound which should be played upon notification receive.
   debugging	Boolean	Whether PubNub service should provide debug information about devices which received created notifications payload.
   apns	APNSNotificationPayload	Access to APNS specific notification builder.
   mpns	MPNSNotificationPayload	Access to MPNS specific notification builder.
   fcm	FCMNotificationPayload	Access to FCM specific notification builder.

2. PubNub.notificationPayload(String title, String body)

   Parameter	Type	Required	Description
   title	String	Optional	Short text which should be shown at the top of notification instead of application name.
   body	String	Optional	Message which should be shown in notification body (under title line).

3. buildPayload(Array<String> platforms)

   Parameter	Type	Required	Description
   platforms	Array	Yes	List of platforms for which payload should be added to final dictionary. Available: apns apns2 fcm mpns

Basic Usage

Create notification payload builder with pre-defined notification title and body:

1. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   let messagePayload = builder.buildPayload(['apns2', 'fcm']);
   messagePayload.message = 'Max invited you to \'quiz\' chat room';
   messagePayload.roomID = 'ewuiogw9vewg0';
   
   pubnub.publish(
       {
           message: messagePayload,
           channel: 'chat-bot',
       }, 
       function (status, response) {
           // Handle publish results
       }
   );

2. let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');

Response

Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.

Other Examples

1. Generate simple notification payload for FMC and APNS:

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           }
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

2. Generate simple notification payload for FMC and APNS over HTTP/2 (default configuration):

   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [{ targets: [{ topic: 'com.meetings.chat.app' }] }];
   builder.sound = 'default';
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "You have been invited to 'quiz' chat",
                   "title": "Chat invitation"
               },
               "sound": "default"
           },
           "pn_push": [
               {
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "sound": "default",
               "title": "Chat invitation"
           }
       }
   }

3. Generate simple notification payload for FMC and APNS over HTTP/2 (custom configuration):

   let configuration = [
       { 
           collapseId: 'invitations',
           expirationDate: new Date(Date.now() + 10000),
           targets: [{ topic: 'com.meetings.chat.app' }] 
       }
   ];
   let builder = PubNub.notificationPayload('Chat invitation', 
                                            'You have been invited to \'quiz\' chat');
   builder.apns.configurations = [configuration];
   
   console.log(JSON.stringify(builder.buildPayload(['apns2', 'fcm']), null, 2));

   output

   {
       "pn_apns": {
           "aps": {
               "alert": {
                   "body": "Chat invitation",
                   "title": "You have been invited to 'quiz' chat"
               }
           },
           "pn_push": [
               {
                   "collapse_id": "invitations",
                   "expiration": "2019-11-28T22:06:09.163Z",
                   "targets": [
                       {
                           "environment": "development",
                           "topic": "com.meetings.chat.app"
                       }
                   ],
                   "version": "v2"
               }
           ]
       },
       "pn_gcm": {
           "notification": {
               "body": "You have been invited to 'quiz' chat",
               "title": "Chat invitation"
           }
       }
   }

Example above show how to create notification payload which APNS will try to redeliver few times (if devices not active) and give up after 10 seconds since moment when it has been scheduled.

Additionally this invitation notification will be grouped along with other invitation notifications (using provided collapse_id as group identifier) and shown as one in notification center.

Returns

Configured and ready to use NotificationsPayload instance.