The methods on this page are utility methods that don't fit into other categories.
End all open requests and close the PubNub instance.
pubnub.stop();
This function allows to decrypt the data.
To decrypt the data you can use the following method(s) in JavaScript V4 SDK.
var decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method
It returns the decrypted data as an object.
This function allow to decrypt the file content/data.
To decrypt the file you can use the following method(s) in JavaScript V4 SDK.
// Node.js example
import fs from 'fs';
const fileBuffer = fs.readFileSync('./cat_picture_encrypted.jpg');
const file = pubnub.File.create({ data: fileBuffer, name: 'cat_picture.jpg', mimeType: 'image/jpeg' });
const decryptedFile = await pubnub.decryptFile('myCipherKey', file);
Returns a promise of PubNubFile.
This function allows to encrypt the data.
To encrypt the data you can use the following method(s) in JavaScript V4 SDK.
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);
It returns the encrypted data as string.
This function allow to encrypt the file content/data.
To encrypt the file you can use the following method(s) in JavaScript V4 SDK.
// Node.js example
import fs from 'fs';
const fileBuffer = fs.readFileSync('./cat_picture.jpg');
const file = pubnub.File.create({ data: fileBuffer, name: 'cat_picture.jpg', mimeType: 'image/jpeg' });
const encryptedFile = await pubnub.encryptFile('myCipherKey', file);
Returns a promise of PubNubFile.
Internal representation of the file used by the SDK. Depending on the environment, different methods can be used to extract the file.
Methods supported in Node.js:
file.toBuffer() returns Promise<Buffer>
file.toStream() returns Promise<Readable>
file.toString(encoding: string) returns a string encoded using encoding (if not available, defaults to utf8)
Methods supported in a browser:
file.toFile() returns Promise<File>
file.toBlob() returns Promise<Blob>
file.toArrayBuffer() returns Promise<ArrayBuffer>
file.toString(encoding: string) returns returns a string encoded using encoding (if not available, defaults to utf8)
React and React Native:
pubnub.File.create(input: FileInput): PubNubFile;
FileInput represents a variety of possible inputs that represent a file in different environments.
- Using streams:
{
stream: Readable,
name: string,
mimeType?: string
}
- Using buffers:
{
data: Buffer,
name: string,
mimeType?: string
}
- Using strings:
{
data: string,
encoding: string,
name: string,
mimeType?: string
}
- Using File API:
File
- Using strings:
{
data: string,
name: string,
mimeType?: string
}
- Using ArrayBuffer:
{
data: ArrayBuffer,
name: string,
mimeType?: string
}
Call the reconnect method to force the SDK to try and reach out PubNub.
To reconnect the data you can use the following method(s) in JavaScript V4 SDK.
pubnub.reconnect();
This function will return a 17 digit precision Unix epoch.
| | Timetoken The timetoken is constructed using the following algorithm:
timetoken = (Unix epoch time in seconds) * 10000000
Example of creating a timetoken for a specific time and date
08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000
|
To fetch
Time you can use the following method(s) in JavaScript V4 SDK
// 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);
}
})
//Example of status
{
error: false,
operation: 'PNTimeOperation',
statusCode: 200
}
//Example of response
{
timetoken: 15031768233407550
}
APNS2 configuration type.
APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.
| 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. |
APNS2 configuration target type.
FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.
| 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. |
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.
Create notification payload builder with pre-defined notification title and body:
Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.
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.
Configured and ready to use NotificationsPayload instance.
End all open requests and close the PubNub instance.
pubnub.stop();
This function allows to decrypt the data.
To decrypt the data you can use the following method(s) in Node.js V4 SDK.
var decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method
It returns the decrypted data as an object.
This function allow to decrypt the file content/data.
To decrypt the file you can use the following method(s) in Node.js V4 SDK.
// Node.js example
import fs from 'fs';
const fileBuffer = fs.readFileSync('./cat_picture_encrypted.jpg');
const file = pubnub.File.create({ data: fileBuffer, name: 'cat_picture.jpg', mimeType: 'image/jpeg' });
const decryptedFile = await pubnub.decryptFile('myCipherKey', file);
Returns a promise of PubNubFile.
This function allows to encrypt the data.
To encrypt the data you can use the following method(s) in Node.js V4 SDK.
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);
It returns the encrypted data as string.
This function allow to encrypt the file content/data.
To encrypt the file you can use the following method(s) in Node.js V4 SDK.
// Node.js example
import fs from 'fs';
const fileBuffer = fs.readFileSync('./cat_picture.jpg');
const file = pubnub.File.create({ data: fileBuffer, name: 'cat_picture.jpg', mimeType: 'image/jpeg' });
const encryptedFile = await pubnub.encryptFile('myCipherKey', file);
Returns a promise of PubNubFile.
Internal representation of the file used by the SDK. Depending on the environment, different methods can be used to extract the file.
Methods supported in Node.js:
file.toBuffer() returns Promise<Buffer>
file.toStream() returns Promise<Readable>
file.toString(encoding: string) returns a string encoded using encoding (if not available, defaults to utf8)
Methods supported in a browser:
file.toFile() returns Promise<File>
file.toBlob() returns Promise<Blob>
file.toArrayBuffer() returns Promise<ArrayBuffer>
file.toString(encoding: string) returns returns a string encoded using encoding (if not available, defaults to utf8)
React and React Native:
pubnub.File.create(input: FileInput): PubNubFile;
FileInput represents a variety of possible inputs that represent a file in different environments.
- Using streams:
{
stream: Readable,
name: string,
mimeType?: string
}
- Using buffers:
{
data: Buffer,
name: string,
mimeType?: string
}
- Using strings:
{
data: string,
encoding: string,
name: string,
mimeType?: string
}
- Using File API:
File
- Using strings:
{
data: string,
name: string,
mimeType?: string
}
- Using ArrayBuffer:
{
data: ArrayBuffer,
name: string,
mimeType?: string
}
Call the reconnect method to force the SDK to try and reach out PubNub.
To reconnect the data you can use the following method(s) in Node.js V4 SDK.
pubnub.reconnect();
Call setProxy() to instruct the SDK to assign or reassign a proxy configuration in run time.
To setProxy the data you can use the following method(s) in Node.js V4 SDK.
pubnub.setProxy({
hostname: 'YOUR HOSTNAME HERE',
port: 8080,
protocol: 'YOUR PROTOCOL HERE'
});
This function will return a 17 digit precision Unix epoch.
| | Timetoken The timetoken is constructed using the following algorithm:
timetoken = (Unix epoch time in seconds) * 10000000
Example of creating a timetoken for a specific time and date
08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000
|
To fetch
Time you can use the following method(s) in Node.js V4 SDK
// 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);
}
})
//Example of status
{
error: false,
operation: 'PNTimeOperation',
statusCode: 200
}
//Example of response
{
timetoken: 15031768233407550
}
APNS2 configuration type.
APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.
| 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. |
APNS2 configuration target type.
FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.
| 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 instance provides access to options specific only to push notifications sent with MPNS.
| 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 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.
Create notification payload builder with pre-defined notification title and body:
Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.
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.
Configured and ready to use NotificationsPayload instance.
End all open requests and close the PubNub instance.
pubnub.stop();
This function allows to decrypt the data.
To decrypt the data you can use the following method(s) in PhoneGap V4 SDK.
var decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method
It returns the decrypted data as an object.
This function allows to encrypt the data.
To encrypt the data you can use the following method(s) in PhoneGap V4 SDK.
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);
It returns the encrypted data as string.
Call the reconnect method to force the SDK to try and reach out PubNub.
To reconnect the data you can use the following method(s) in PhoneGap V4 SDK.
pubnub.reconnect();
This function will return a 17 digit precision Unix epoch.
| | Timetoken The timetoken is constructed using the following algorithm:
timetoken = (Unix epoch time in seconds) * 10000000
Example of creating a timetoken for a specific time and date
08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000
|
To fetch
Time you can use the following method(s) in PhoneGap V4 SDK
// 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);
}
})
//Example of status
{
error: false,
operation: 'PNTimeOperation',
statusCode: 200
}
//Example of response
{
timetoken: 15031768233407550
}
APNS2 configuration type.
APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.
| 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. |
APNS2 configuration target type.
FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.
| 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 instance provides access to options specific only to push notifications sent with MPNS.
| 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 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.
Create notification payload builder with pre-defined notification title and body:
Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.
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.
Configured and ready to use NotificationsPayload instance.
End all open requests and close the PubNub instance.
pubnub.stop();
This function allows to decrypt the data.
To decrypt the data you can use the following method(s) in Titanium V4 SDK.
var decrypted = pubnub.decrypt(encrypted, 'myCipherKey'); // Pass the encrypted data as the first parameter in decrypt Method
It returns the decrypted data as an object.
This function allows to encrypt the data.
To encrypt the data you can use the following method(s) in Titanium V4 SDK.
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);
It returns the encrypted data as string.
Call the reconnect method to force the SDK to try and reach out PubNub.
To reconnect the data you can use the following method(s) in Titanium V4 SDK.
pubnub.reconnect();
This function will return a 17 digit precision Unix epoch.
| | Timetoken The timetoken is constructed using the following algorithm:
timetoken = (Unix epoch time in seconds) * 10000000
Example of creating a timetoken for a specific time and date
08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000
|
To fetch
Time you can use the following method(s) in Titanium V4 SDK
pubnub.time(function(status, response) {
if (status.error) {
console.log(status.error);
} else {
console.log(response.timetoken);
}
});
//Example of status
{
error: false,
operation: 'PNTimeOperation',
statusCode: 200
}
//Example of response
{
timetoken: 15031768233407550
}
APNS2 configuration type.
APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.
| 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. |
APNS2 configuration target type.
FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.
| 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 instance provides access to options specific only to push notifications sent with MPNS.
| 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 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.
Create notification payload builder with pre-defined notification title and body:
Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.
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.
Configured and ready to use NotificationsPayload instance.
End all open requests and close the PubNub instance.
import PubNubVue from 'pubnub-vue';
const pubnub = PubNubVue.getInstance();
pubnub.stop();
This function allows to decrypt the data.
To decrypt the data you can use the following method(s) in Vue V4 SDK.
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
It returns the decrypted data as an object.
This function allows to encrypt the data.
To encrypt the data you can use the following method(s) in Vue V4 SDK.
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);
It returns the encrypted data as string.
Call the reconnect method to force the SDK to try and reach out PubNub.
To reconnect the data you can use the following method(s) in Vue V4 SDK.
import PubNubVue from 'pubnub-vue';
const pubnub = PubNubVue.getInstance();
pubnub.reconnect();
This function will return a 17 digit precision Unix epoch.
| | Timetoken The timetoken is constructed using the following algorithm:
timetoken = (Unix epoch time in seconds) * 10000000
Example of creating a timetoken for a specific time and date
08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000
|
To fetch
Time you can use the following method(s) in Vue V4 SDK
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);
}
});
//Example of status
{
error: false,
operation: 'PNTimeOperation',
statusCode: 200
}
//Example of response
{
timetoken: 15031768233407550
}
APNS2 configuration type.
APNSNotificationPayload instance provides access to options specific only to push notifications sent with APNS.
| 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. |
APNS2 configuration target type.
FCMNotificationPayload instance provides access to options specific only to push notifications sent with FCM.
| 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 instance provides access to options specific only to push notifications sent with MPNS.
| 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 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.
Create notification payload builder with pre-defined notification title and body:
Hash with data, which can be sent with publish method call and trigger remote notifications for specified platforms.
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.
Configured and ready to use NotificationsPayload instance.
