On this page

PubNub Module

The pubnub module provides PubNub client API methods.

Execution boundaries

You can chain up to 3 hops from one Function to another using publish or fire.
Within one Function execution, you can perform up to 3 combined operations: KV store, XHRs, publish, or fire.

The pubnub module is made available via the following require() statement:

1const pubnub = require('pubnub');

Publish

Use the publish() method to send a message to subscribers and Functions.

Usage

1publish({ message, channel })

* required

Parameter	Description
`message` * Type: Object	The message to send.
`channel` * Type: String	The channel to publish to.

1pubnub.publish({
2    "channel": "hello_universe",
3    "message": request.message
4}).then((publishResponse) => {
5    console.log(`Publish Status: ${publishResponse[0]}:${publishResponse[1]} with TT ${publishResponse[2]}`);
6});

JSON requirement

Published payloads must be valid JSON. Strings won't trigger Functions.

Fire

Use the fire() method to trigger Functions without delivering to subscribers.

Usage

1fire({ message, channel })

* required

Parameter	Description
`message` * Type: Object	JavaScript object to be sent to PubNub.
`channel` * Type: String	The channel to publish to.

1pubnub.fire({
2    "channel": "hello_universe",
3    "message": request.message
4}).then((publishResponse) => {
5    console.log(`Publish Status: ${publishResponse[0]}:${publishResponse[1]} with TT ${publishResponse[2]}`);
6});

Signal

To send a signal to PubNub Subscribers and Functions, use the signal() method.

By default, signals are limited to a message payload size of 64 bytes. This limit applies only to the payload and not to the URI or headers. If you require a larger payload size, contact support.

Usage

1signal({ message, channel })

* required

Parameter	Description
`message` * Type: Object	JavaScript object to be sent to PubNub.
`channel` * Type: String	The channel to publish to.

1pubnub.signal({
2    "channel": "hello_universe",
3    "message": request.message // must be smaller than 64 bytes
4}).then((signalResponse) => {
5    console.log(`Signal Status: ${signalResponse[0]}:${signalResponse[1]} with TT ${signalResponse[2]}`);
6});

JSON requirement

Payload that is published via signal requires a valid JSON. Strings won't trigger Functions.

At present, the main use case for Functions is to construct the URL and integrate with external services, for example, for image moderation or logging. To upload and download files, you need to use a PubNub client SDK.

List files in channel

Retrieve the list of files uploaded to a channel.

Usage

listFiles accepts a single argument — a Javascript object with the following properties:

1listFiles({ channel, limit, next })

* required

Parameter	Description
`channel` * Type: String Default: n/a	Retrieve list of files for this `channel`.
`limit` Type: Number Default: `100`	Number of files to return.
`next` Type: String Default: n/a	String token to get the `next` batch of files.

1const pubnub = require('pubnub');
2

3return pubnub.listFiles({
4    channel: 'my_channel',
5    limit: 2,
6    next: '10rX15WW7pyYsbwPY2h3ZlPfP1vSFl_3M6rCappuuCSULLIQb3MWOOba7xouJDxxs8yS9Ql6mxdz-1FmMdeiUE53GPMjNLmrUtefZdhoaswVwat7Z0Q6YzXi4FQYclt7pW_nQlOaC-vzaGSaeSB4QeQS2vlmjyiDVFYPQvSz6g39X7__1H73-XgogHZqqI-jnWMonp2fpgcQ',
7}).then((res) => {
8    console.log(res);
9}).catch((err) => {
10    // handle error
11});

Returns

Returns a promise that resolves to an object with the following format:

1{
status: number,
data: Array<{
  name: string,
  id: string,
  size: number,
  created: string
}>,
next: string,
count: number,
11}

For example:

1{
status: 200,
data: [
    {
      name: 'cat_picture.jpg',
      id: '0936618c-94f9-4e96-bd9c-aa4fd8719c28',
      size: 31,
      created: '2020-08-13T19:05:30Z'
    },
    {
      name: 'my_other_file.jpg',
      id: '2afb0f85-8eb3-43bf-84f9-5b4c7e031f8f',
      size: 23,
      created: '2020-08-13T19:07:22Z'
    },
],
next: "1NrsIonxYtGgsxNA3_Klt6jxt235cJUKY3hRNXkRP1TlHrzCSPj0yhysBgb04dRtwtkeR7lxcKyq-Y-CU7wxB1Tplf-NaW3mFYrzV5DDhGK7WEuT3FIBpg8RfA2rIScBhLJ-3Jaqthf9SKKU2fJzkPdPgwdz7yJvrfWrmsyXzZblbprUXl_HWaUKv4aE7_wP-91Nz_xpwM84",
count: 2,
19}
show all 19 lines

Get file URL

Get a file's direct download URL. This method doesn't make any API calls, and won't decrypt an encrypted file.

Usage

getFileUrl accepts a single argument — a Javascript object with the following properties:

1getFileUrl({ channel, id, name })

* required

Parameter	Description
`channel` * Type: String	`Channel` that the file was sent to.
`id` * Type: String	The file's unique identifier.
`name` * Type: String	`Name` of the file.

1const pubnub = require('pubnub');
2

3const url = pubnub.getFileUrl({
4    channel: 'my_channel',
5    id: '12345678-1234-5678-123456789012',
6    name: 'cat_picture.jpg',
7});
8

9console.log(url);

Returns

Returns a string with the following format:

1'https://ps.pndsn.com/v1/files/my-subkey/channels/my_channel/files/12345678-1234-5678-123456789012/cat_picture.jpg'

Delete file

Deletes a file from the specified channel.

Usage

deleteFile accepts a single argument — a Javascript object with the following properties:

1deleteFile({ channel, id, name })

* required

Parameter	Description
`channel` * Type: String	`Channel` that the file was sent to.
`id` * Type: String	The file's unique identifier.
`name` * Type: String	`Name` of the file.

1const pubnub = require('pubnub');
2

3return pubnub.deleteFile({
4    channel: 'my_channel',
5    id: '12345678-1234-5678-123456789012',
6    name: 'cat_picture.jpg' ,
7}).then((res) => {
8    console.log(res);
9}).catch((err) => {
10    // handle error
11});

Returns

Returns a promise that resolves to an object with the following format:

1{
2  status: 200,
3}

Publish file message

Manually publish information about a previously uploaded file.

Usage

publishFile accepts a single argument — a Javascript object with the following properties:

1publishFile({ message, channel, fileId, fileName, storeInHistory, ttl, meta })

* required

Parameter	Description
`channel` * Type: String Default: n/a	`Channel` on which to send the file message.
`fileId` * Type: String Default: n/a	The file's unique identifier.
`fileName` * Type: String Default: n/a	`Name` of the file.
`message` Type: Object Default: n/a	Message to attach to the file. The message can be any value that can be JSON-stringified.
`storeInHistory` Type: Boolean Default: `true`	Whether published file messages should be stored in the channel's history. If `storeInHistory` isn't specified, then the history configuration on the key is used.
`ttl` Type: Number Default: n/a	How long the message should be stored in the channel's history, in hours. If not specified, defaults to the keyset's retention value.
`meta` Type: Object Default: n/a	Additional metadata published with the message.

1const pubnub = require('pubnub');
2

3return pubnub.publishFile({
4    channel: 'my_channel',
5    fileId: '12345678-1234-5678-123456789012',
6    fileName: 'cat_picture.jpg',
7    message: {
8        someField: 'someValue',
9    },
10}).then((res) => {
11    console.log(res);
12}).catch((err) => {
13    // handle error
14});

Returns

Returns a promise that resolves to an object with the following format:

1[ 1, "Sent", "15973568884237770" ]

Presence

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

For information on how to receive presence events and what those events are, refer to Presence Events.

Here now

To fetch Here Now, use the hereNow() method.

Usage

1hereNow({ channels, channelGroups, includeUUIDs, includeState })

* required

Parameter	Description
`channels` Type: Array	`channels` is an array which specifies the `channels` to return occupancy results.
`channelGroups` Type: Array	`channelGroups` is an array which specifies the `channelGroup` to return occupancy results.
`includeUUIDs` Type: Boolean	Setting `includeUUIDs` to `false` disables the return of UUIDs.
`includeState` Type: Boolean	Setting `includeState` to `true` enables the return of subscriber state information.

1pubnub.hereNow({
2    channels: ["ch1"],
3    channelGroups : ["cg1"],
4    includeUUIDs: true,
5    includeState: true
6}).then((response) => {
7    console.log(response)
8}).catch((error) => {
9    // handle error
10});

Where now

To fetch Where Now, use the whereNow() method.

Usage

1whereNow({ uuid })

* required

Parameter	Description
`uuid` Type: String	`uuid` specifies the UUID to return channel list for.

1pubnub.whereNow({
2    uuid: "uuid"
3}).then((response) => {
4    console.log(response)
5}).catch((error) => {
6    // handle error
7});

Global here now

To fetch Global Here Now, use the hereNow() method.

Usage

1hereNow({ includeUUIDs, includeState })

* required

Parameter	Description
`includeUUIDs` Type: Boolean	Setting `includeUUIDs` to `false` disables the return of UUIDs.
`includeState` Type: Boolean	Setting `includeState` to `true` enables the return of subscriber state information.

1pubnub.hereNow({
2    includeUUIDs: true,
3    includeState: true
4}).then((response) => {
5    console.log(response)
6}).catch((error) => {
7    // handle error
8});

Set state

To fetch Set State, use the setState() method.

Usage

1setState({ channels, channelGroups, state, uuid })

* required

Parameter	Description
`channels` Type: Array	Specifies the `channels` to get the state. Either `channels` or `channelGroups` should be provided.
`channelGroups` Type: Array	Specifies the `channelGroups` to get the state. Either `channels` or `channelGroups` should be provided.
`state` Type: Object	`state` is a JSON object of key/value pairs with supported `data-types` of int, float, and string. Nesting of key/values is not permitted and key names beginning with the `pn` prefix are reserved.
`uuid` Type: String	`uuid` to set the current state.

1pubnub.setState({
2    channels: ['ch1'],
3    channelGroups: ['cg1'],
4    state: newState,
5    uuid: "uuid"
6}).then((response) => {
7    console.log(response)
8}).catch((error) => {
9    // handle error
10});

Get state

To fetch Set State, use the getState() method.

Usage

1getState({ uuid, channels, channelGroups })

* required

Parameter	Description
`uuid` Type: String	`uuid` is the subscriber UUID to get the current state.
`channels` Type: Array	Specifies the `channels` to get the state. Either `channels` or `channelGroups` should be provided.
`channelGroups` Type: Array	Specifies the `channelGroups` to get the state. Either `channels` or `channelGroups` should be provided.

1pubnub.getState({
2    uuid: "uuid",
3    channels: ['ch1'],
4    channelGroups: ['cg1']
5}).then((response) => {
6    console.log(response)
7}).catch((error) => {
8    // handle error
9});

Access Manager

Requires Access Manager

This method requires that Access Manager is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Grant

To grant permissions in Access Manager v2, use the grant() method.

Required secret key

Only server-side instances with a valid secret key can grant permissions to PubNub resources.

Usage

1grant({ channels, channelGroups, uuids, authKeys, ttl, read, write, manage, delete, get, update, join})

* required

Parameter	Description
`channels` Type: Array	Array which specifies the channel(s) to grant permissions to.
`channelGroups` Type: Array	Array which specifies the channel group(s) to grant permissions to.
`uuids` Type: Array	Array which specifies the UUID(s) to grant permissions to. You can't grant permissions to channels or channel groups in the same request if you decide to use `uuids`. This parameter does not support wildcards.
`authKeys` Type: Array	Array which specifies the authorization credentials that should be granted access to selected resources. `authKeys` are required for user-level grants. If you don't specify this parameter, the permissions will apply to all clients on the channel-level or application-level.
`ttl` * Type: Number	Time in minutes for which granted permissions are valid. The default value is `1440 (24hrs)` and the allowed values range from `1` to `525600`. If you set `ttl` to `0`, it will apply the grant indefinitely.
`read` Type: Boolean	Set to `true` to grant `read` permissions. Set to `false` to remove permissions.
`write` Type: Boolean	Set to `true` to grant `write` permissions. Set to `false` to remove permissions.
`manage` Type: Boolean	Set to `true` to grant `manage` permissions. Set to `false` to remove permissions.
`delete` Type: Boolean	Set to `true` to grant `delete` permissions. Set to `false` to remove permissions.
`get` Type: Boolean	Set to `true` to grant `get` permissions. Set to `false` to remove permissions.
`update` Type: Boolean	Set to `true` to grant `update` permissions. Set to `false` to remove permissions.
`join` Type: Boolean	Set to `true` to grant `join` permissions. Set to `false` to remove permissions.

Max number of resources

There is a limit of up to 200 resources of the same type that you can request access to in a single grant API call.

1pubnub.grant({
2    channels: [ch1, ch2],
3    channelGroups: [cg1, cg2],
4    authKeys: [key1, key2],
5    ttl: 12313,
6    read: true,
7    write: true,
8    manage: true
9}).then((response) => {
10    console.log(response)
11}).catch((error) => {
12    // handle error
13});

Grant token

To grant channel, channel group, and UUID permissions in Access Manager v3, use the grantToken() method.

Required secret key

Only server-side instances with a valid secret key can grant permissions to PubNub resources.

Usage

1grantToken({ ttl, authorizedUuid, resources, patterns, meta })

* required

Parameter	Description
`ttl` * Type: Number	Total number of minutes for which the token is valid. The minimum allowed value is `1`. The maximum is `43,200` minutes (30 days).
`authorizedUuid` Type: String	Single `uuid` which is authorized to use the token to make API requests to PubNub.
`resources` Type: Object	Object containing resource permissions.
`resources.uuids` Type: Object	Object containing `uuid` metadata permissions. For example, `{"uuid-1": {get: true, update: true, delete: true},"uuid-2": {...}}`.
`resources.channels` Type: Object	Object containing channel permissions. For example, `{"channel-id-1": {read: true, write: true, manage: true, delete: true, get: true, update: true, join: true},"channel-id-2": {...}}`.
`resources.groups` Type: Object	Object containing channel group permissions. For example, `{"group-id-1": {read: true, manage: true},"group-id-2": {...}}`.
`patterns` Type: Object	Object containing permissions to multiple resources specified by a RegEx pattern.
`patterns.uuids` Type: Object	Object containing `uuid` metadata permissions to apply to all `uuid`s matching the RegEx pattern. For example, `{"uuid-pattern-1": {get: true, update: true, delete: true},"uuid-pattern-2": {...}}`.
`patterns.channels` Type: Object	Object containing channel permissions to apply to all `channel`s matching the RegEx pattern. For example, `{"channel-pattern-1": {read: true, write: true, manage: true, delete: true, get: true, update: true, join: true}, "channel-pattern-2": {...}}`.
`patterns.groups` Type: Object	Object containing channel group permissions to apply to all channel groups matching the pattern. For example, `{"group-pattern-1": {read: true, manage: true}, "group-pattern-2": {...}}`.
`meta` Type: Object	Extra metadata to be published with the request. Values must be scalar only; arrays or objects aren't supported.

Required key/value mappings

For a successful grant request, you must specify permissions for at least one uuid, channel, or group, either as a resource sequence (resources) or as a regular expression (patterns).

1pubnub.grantToken(
  {
      ttl: 15,
      authorizedUuid: "my-authorized-uuid",
      resources: {
          channels: {
              "channel-a": {
                  read: true
              },
              "channel-b": {
                  read: true,
                  write: true
              },
              "channel-c": {
                  read: true,
                  write: true
              },
              "channel-d": {
                  read: true,
                  write: true
              }
          },
          groups: {
              "channel-group-b": {
                  read: true
              }
          },
          uuids: {
              "uuid-c": {
                  get: true
              },
              "uuid-d": {
                  get: true,
                  update: true
              }
          }
      },
      patterns: {
          channels: {
          "^channel-[A-Za-z0-9]$": {
              read: true
          }
          }
      }
  },
  function (status, token) {
      console.log(token)
  });
show all 48 lines

Revoke token

The revokeToken() method is used by the server to revoke access to PubNub resources previously granted using the grantToken() method.

This method only applies to Access Manager v3.

Required secret key

Only server-side instances with a valid secret key can revoke permissions to PubNub resources.

Usage

1revokeToken(token)

* required

Parameter	Description
`token` * Type: String	Current token with embedded permissions.

1pubnub.revokeToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Parse token

The parseToken() method decodes an existing token and returns the object containing permissions embedded in that token. The client can use this method for debugging to check the permissions to the resources or find out the token's ttl details.

This method only applies to Access Manager v3.

Usage

1parseToken(token)

* required

Parameter	Description
`token` * Type: String	Current token with embedded permissions.

1pubnub.parseToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Set token

The setToken() method is used by the client devices to update the authentication token granted by the server.

This method only applies to Access Manager v3.

Usage

1setToken(token)

* required

Parameter	Description
`token` * Type: String	Current token with embedded permissions.

1pubnub.setToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Channel groups

Requires Stream Controller

This method requires that Stream Controller is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Add channels

To add channels to a channel group, use channelGroups.addChannels().

Maximum number of channels

200 channels can be added to the channel group per one API call.

Usage

1channelGroups.addChannels({ channels, channelGroup })

* required

Parameter	Description
`channels` * Type: Array	`channels` is an array that specifies channels to be added to a channel group.
`channelGroup` * Type: String	`channelGroup` is a string that specifies the channel group to which you can add channels.

1pubnub.channelGroups.addChannels({
2    channels: ['ch1', 'ch2'],
3    channelGroup: 'myChannelGroup'
4}).then((response) => {
5    console.log(response)
6}).catch((error) => {
7    // handle error
8});

List channels

To list all the channels of the channel group, use channelGroups.listChannels().

Usage

1channelGroups.listChannels({ channels })

* required

Parameter	Description
`channelGroup` * Type: String	`channelGroup` is a string that specifies the channel group from which you want to list the channel(s).

1pubnub.channelGroups.listChannels({
2    channelGroup: 'myChannelGroup'
3}).then((response) => {
4    console.log(response)
5}).catch((error) => {
6    // handle error
7});

Remove channels

To remove the channels from the channel group, use channelGroups.removeChannels().

Usage

1channelGroups.removeChannels({ channels, channelGroup })

* required

Parameter	Description
`channels` * Type: Array	`channels` is an array that specifies channels to remove from the channel group.
`channelGroup` * Type: String	`channelGroup` is a string that specifies the channel group from which you want to remove channels.

1pubnub.channelGroups.removeChannels({
2    channels: ['ch1'],
3    channelGroup: 'myChannelGroup'
4}).then((response) => {
5    console.log(response)
6}).catch((error) => {
7    // handle error
8});

Delete channel group

To remove the channel group, use channelGroups.deleteGroup().

Usage

1channelGroups.deleteGroup({ channelGroup })

* required

Parameter	Description
`channelGroup` * Type: String	`channelGroup` is a string that specifies the channel group to remove.

1pubnub.channelGroups.deleteGroup({
2    channelGroup: 'myChannelGroup'
3}).then((response) => {
4    console.log(response)
5}).catch((error) => {
6    // handle error
7});

Message persistence

Requires Message Persistence

This method requires that Message Persistence is enabled for your key in the Admin Portal.

History

To fetch History, use the history() method.

Usage

1history({ channel, reverse, count, stringifiedTimeToken, start, end })

* required

Parameter	Description
`channel` * Type: String	Specifies `channel` to return history messages from.
`reverse` Type: Boolean	Setting to `true` will traverse the timeline in `reverse` starting with the oldest message first. If both `start` and `end` arguments are provided, `reverse` is ignored and messages are returned starting from the newest `message`.
`count` Type: Number	Specifies the number of historical `messages` to return.
`stringifiedTimeToken` Type: Boolean	If `stringifiedTimeToken` is specified as `true`, the SDK will return `timetoken` values as strings instead of integers. This setting is encouraged in JavaScript environments which perform round-up/down on large integers.
`start` Type: String	Timetoken delimiting the `start` of `time` slice (exclusive) to pull messages from.
`end` Type: String	Timetoken delimiting the `end` of `time` slice (inclusive) to pull messages from.

1export default (request) => {
  var pubnub = require('pubnub');
3

  return pubnub.history({
      'channel' : 'my_channel',
      'count' : 3,
      'stringifiedTimeToken' : true,
      'reverse' : true,
  }).then((response) => {
      console.log("startTT", response.startTimeToken);
      console.log("endTT", response.endTimeToken);
      response['messages'].forEach((value, index) => {
          console.log("message:", value.entry, "timetoken:", value.timetoken);
      });
      return request.ok();
  });
17};
show all 17 lines

Batch history

To fetch History from multiple channels, use the fetchMessages() method.

Usage

1fetchMessages({ channels, count, start, end, stringifiedTimeToken })

* required

Parameter	Description
`channels` * Type: Array	Specifies `channels` to return history messages from.
`count` Type: Number	Specifies the number of historical `messages` to return per channel.
`start` Type: String	Timetoken delimiting the `start` of `time` slice (exclusive) to pull messages from.
`end` Type: String	Timetoken delimiting the `end` of `time` slice (inclusive) to pull messages from.
`stringifiedTimeToken` Type: Boolean	If `stringifiedTimeToken` is specified as true, the SDK will return `timetoken` values as a strings instead of integers.

1pubnub.fetchMessages({
  'channels' : ['my_channel', 'my_other_channel'],
  'count' : 8,
  'start' : '15343325214676133',
  'end' : '15343325004275466',
  'stringifiedTimeToken' : true,
7}).then((status, response) => {
  console.log(status);
  console.log(response);
10});

Delete messages from history

To delete messages from the history, use the deleteMessages() method.

Required setting

There is a setting to accept delete from history requests for a key, which you must enable by checking the Enable Delete-From-History checkbox in the key settings for your key in the Admin Portal.

Requires Initialization with a secret key.

Usage

1deleteMessages({ channel, start, end })

* required

Parameter	Description
`channel` * Type: String	Specifies `channel` messages to be deleted from history.
`start` Type: String	Timetoken delimiting the `start` of `time` slice (inclusive) to delete messages from.
`end` Type: String	Timetoken delimiting the `end` of `time` slice (exclusive) to delete messages from.

1pubnub.deleteMessages({
2    'channel' : 'my_channel',
3    'start': '15088506076921021',
4    'end': '15088532035597390',
5}).then((result) => {
6    console.log(result);
7});

Message counts

Specifies the number of historical messages to return per channel. The returned count is the number of messages in history with a timetoken value greater than the passed value in the channelTimetokens parameter.

Usage

1messageCounts({ channels, channelTimetokens })

* required

Parameter	Description
`channels` * Type: Array	The `channels` to fetch the message count.
`channelTimetokens` * Type: Array	List of timetokens in the order of the channels list. Specify a single timetoken to apply it to all channels. Otherwise, the list of timetokens must be the same length as the list of channels, or the Function returns a `PNStatus` with an error flag.

1pubnub.messageCounts({
2    'channels' : ['my_channel', 'my_other_channel'],
3    'channelTimetokens' : ['my_timetoken', 'my_other_timetoken'],
4}).then((status, results) => {
5    console.log(status);
6    console.log(results);
7});

Mobile push

Requires Mobile Push Notifications

This method requires that Mobile Push Notifications is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Add device to channel

To enable mobile push notifications on a provided set of channels, use push.addChannels().

Usage

1push.addChannels({ channels, device, pushGateway })

* required

Parameter	Description
`channels` * Type: Array	Specifies channels to associate with mobile push notifications.
`device` * Type: String	The device ID to associate with mobile push notifications.
`pushGateway` * Type: String	`apns`, `mpns` or `gcm`

1pubnub.push.addChannels({
2    channels: ['my_channel', 'my_other_channel'],
3    device: 'nice_device',
4    pushGateway: 'apns'
5}).then((response) => {
6    console.log(response)
7}).catch((error) => {
8    // handle error
9});

List channels for device

To request all channels on which push notifications were enabled, use push.listChannels().

Usage

1push.listChannels({ device, pushGateway })

* required

Parameter	Description
`device` * Type: String	The device ID to associate with mobile push notifications.
`pushGateway` * Type: String	`apns`, `mpns` or `gcm`

1pubnub.push.listChannels({
2    device: 'nice_device',
3    pushGateway: 'apns'
4}).then((response) => {
5    console.log(response)
6}).catch((error) => {
7    // handle error
8});

Remove device from channel

To disable mobile push notifications on a provided set of channels, use push.removeChannels().

Usage

1push.removeChannels({ channels, device, pushGateway })

* required

Parameter	Description
`channels` * Type: Array	Specifies channels to associate with mobile push notifications.
`device` * Type: String	The device ID to associate with mobile push notifications.
`pushGateway` * Type: String	`apns`, `mpns` or `gcm`

1pubnub.push.removeChannels({
2    channels: ['my_channel', 'my_other_channel'],
3    device: 'nice_device',
4    pushGateway: 'apns'
5}).then((response) => {
6    console.log(response)
7}).catch((error) => {
8    // handle error
9});

Remove all mobile push notifications

To disable mobile push notifications from all channels which are registered with a specified pushToken, use push.deleteDevice().

Usage

1push.deleteDevice({ device, pushGateway })

* required

Parameter	Description
`device` * Type: String	The device ID to associate with mobile push notifications.
`pushGateway` * Type: String	`apns`, `mpns` or `gcm`

1pubnub.push.deleteDevice({
2    device: 'nice_device',
3    pushGateway: 'apns'
4}).then((response) => {
5    console.log(response)
6}).catch((error) => {
7    // handle error
8});

App Context

Get metadata for all users

Returns a paginated list of UUID metadata objects, optionally including the custom data object for each.

Usage

1getAllUUIDMetadata({include, filter, sort, limit, page})

* required

Parameter	Description
`include` Type: Object Default: n/a	Include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getAllUUIDMetadata({
      limit: 1,
      include: {
          customFields: true,
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Fetched uuid metadata successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to fetch uuid metadata');
  });
18};
show all 18 lines

Response

1{
 "status" : 200,
 "data" : [
    {
       "name" : "my-name",
       "updated" : "2020-07-16T21:10:38.770048Z",
       "id" : "my-uuid",
       "email" : "me@email.com",
       "custom" : {
          "foo" : "bar"
       },
       "externalId" : null,
       "eTag" : "AePWsMnEl9m23wE",
       "profileUrl" : null
    }
 ],
 "next" : "Mg",
18}
show all 18 lines

Other examples

Get the next page of the results.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getAllUUIDMetadata({
      limit: 1,
      include: {
          customFields: true,
      },
      page: {
          next: "Mg", // from previous response
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Fetched uuid metadata successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to fetch uuid metadata');
  });
21};
show all 21 lines

Response

1{
"status": 200,
"data": [
  {
    "created": "2020-03-10T18:45:49.460388Z",
    "eTag": "Ad+6yqHMr6TYxgE",
    "email": null,
    "externalId": null,
    "id": "my-other-uuid",
    "name": "my-other-name",
    "profileUrl": null,
    "updated": "2020-03-10T18:45:49.460388Z"
  }
],
"next": "MQ",
"prev": "Mg",
17}
show all 17 lines

Get user metadata

Returns metadata for the specified UUID, optionally including the custom data object for each.

Usage

1getUUIDMetadata({uuid, include})

* required

Parameter	Description
`uuid` * Type: String Default: n/a	Unique UUID identifier.
`include` Type: Object Default: n/a	Specifies whether to include the UUID's custom data field.
`customFields` Type: Boolean Default: `true`	Whether to fetch custom fields.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getUUIDMetadata({
    uuid: 'my-uuid',
    include: {
      customFields: false,
    },
  })
  .then((resp) => {
    console.log(resp);
    return event.ok('Fetched UUID metadata successfully.');
  })
  .catch((err) => {
    console.log(err);
    return event.abort('Failed to fetch UUID metadata');
  });
18};
show all 18 lines

Response

1{
 "status" : 200,
 "data" : {
    "email" : "me@email.com",
    "profileUrl" : null,
    "externalId" : null,
    "updated" : "2020-07-16T21:10:38.770048Z",
    "name" : "my-name",
    "eTag" : "AePWsMnEl9m23wE",
    "id" : "my-uuid"
 }
12}

Set user metadata

Set metadata for a UUID in the database, optionally including the custom data object for each.

Usage

1setUUIDMetadata({ uuid, data, include })

* required

Parameter	Description
`uuid` * Type: String Default: n/a	Unique UUID identifier.
`data` * Type: Object Default: n/a	Object with UUID metadata to set.
`name` Type: String Default: n/a	Display name for the UUID, maximum `200` characters.
`externalId` Type: String Default: n/a	UUID's identifier in an external system.
`profileUrl` Type: String Default: n/a	The URL of the UUID's profile picture.
`email` Type: String Default: n/a	The UUID's email address, maximum `80` characters.
`custom` Type: Object Default: n/a	JSON object of key-value pairs with supported data types. Values must be scalar only; arrays or objects are not supported.
`include` Type: Object Default: n/a	Include additional fields in the response.
`customFields` Type: Boolean Default: `true`	Whether to fetch custom fields.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.setUUIDMetadata({
      uuid: 'my-uuid',
      data: {
          name: 'my-name',
          email: 'me@email.com',
          custom: {
              foo: 'bar',
          },
      },
      include: {
          customFields: false,
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Set UUID metadata successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to set UUID metadata.');
  });
25};
show all 25 lines

Response

1{
"status" : 200,
"data" : {
  "email" : "me@email.com",
  "profileUrl" : null,
  "externalId" : null,
  "updated" : "2020-07-16T21:10:38.770048Z",
  "name" : "my-name",
  "eTag" : "AePWsMnEl9m23wE",
  "id" : "my-uuid"
}
12}

Remove user metadata

Removes the metadata from a specified UUID.

Usage

1removeUUIDMetadata({ uuid })

* required

Parameter	Description
`uuid` * Type: String	Unique UUID identifier.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.removeUUIDMetadata({
      uuid: 'my-uuid',
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Removed UUID successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to remove UUID metadata');
  });
15};

Response

1{
2  "status": 200,
3  "data": null
4}

Get metadata for all channels

Returns a paginated list of channel metadata objects, optionally including the custom data object for each.

Usage

1getAllChannelMetadata({include, filter, sort, limit, page})

* required

Parameter	Description
`include` Type: Object Default: n/a	Include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getAllChannelMetadata({
      limit: 1,
      include: {
          totalCount: true,
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Fetched channel metadata successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to fetch channel metadata');
  });
18};
show all 18 lines

Response

1{
 "status" : 200,
 "data" : [
    {
       "name" : "channel-name",
       "description" : "What a great channel",
       "updated" : "2020-07-16T21:18:12.156794Z",
       "eTag" : "AeWFs+b3rMH4Dw",
       "id" : "my-channel"
    }
 ],
 "totalCount" : 2,
 "next" : "MQ"
14}

Other examples

Get the next page of the results.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getAllChannelMetadata({
      limit: 1,
      page: {
          next: "MQ", // from previous response
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Fetched channel metadata successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to fetch channel metadata');
  });
18};
show all 18 lines

Response

1{
"status" : 200,
"data" : [
  {
    "updated" : "2020-07-16T21:19:28.735177Z",
    "eTag" : "AeDH5/ixi/7lZw",
    "id" : "my-other-channel",
    "description" : "What another great channel",
    "name" : "other-channel-name"
  }
],
"prev" : "MQ",
"next" : "Mg"
14}

Get channel metadata

Returns metadata for the specified channel, optionally including the custom data object for each.

Usage

1getChannelMetadata({channel, include})

* required

Parameter	Description
`channel` * Type: String Default: n/a	Unique channel identifier.
`include` Type: Object Default: n/a	Specifies whether to include the channel's custom data field.
`customFields` Type: Boolean Default: `true`	Whether to fetch custom fields.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getChannelMetadata({
      channel: 'my-channel',
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Fetched channel metadata successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to fetch channel metadata');
  });
15};

Response

1{
"status" : 200,
"data" : {
  "description" : "What a great channel",
  "eTag" : "AeWFs+b3rMH4Dw",
  "id" : "my-channel",
  "updated" : "2020-07-16T21:18:12.156794Z",
  "custom" : {
     "foo" : "bar"
  },
  "name" : "channel-name"
}
13}

Set channel metadata

Set metadata for a channel in the database, optionally including the custom data object for each.

Usage

1setChannelMetadata({ channel, data, include })

* required

Parameter	Description
`channel` * Type: String Default: n/a	Unique channel identifier.
`data` * Type: Object Default: n/a	Object with channel metadata to set.
`name` Type: String Default: n/a	Name of the channel.
`description` Type: String Default: n/a	Description of the channel.
`custom` Type: Object Default: n/a	JSON object of key-value pairs with supported data types. Values must be scalar only; arrays or objects are not supported.
`include` Type: Object Default: n/a	Include additional fields in the response.
`customFields` Type: Boolean Default: `true`	Whether to fetch custom fields.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.setChannelMetadata({
      channel: 'my-channel',
      data: {
          name: 'channel-name',
          description: 'What a great channel',
          custom: {
              foo: 'bar',
          },
      },
      include: {
          customFields: false,
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Set channel metadata successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to set channel metadata.');
  });
25};
show all 25 lines

Response

1{
"status" : 200,
"data" : {
  "eTag" : "AeWFs+b3rMH4Dw",
  "id" : "my-channel",
  "name" : "channel-name",
  "description" : "What a great channel",
  "updated" : "2020-07-16T21:18:12.156794Z"
}
10}

Remove channel metadata

Removes the metadata from a specified channel.

Usage

1removeChannelMetadata({ channel })

* required

Parameter	Description
`channel` * Type: String Default: n/a	Unique channel identifier.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.removeChannelMetadata({
      channel: 'my-channel',
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Removed channel successfully');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to remove channel metadata');
  });
15};

Response

1{
2  "data": null,
3  "status": 200
4}

Get channel memberships

The method returns a list of channel memberships for a user. This method doesn't return user's subscriptions.

Usage

1getMemberships({uuid, include, limit, page, filter, sort})

* required

Parameter	Description
`uuid` * Type: String Default: n/a	UUID whose memberships you wish to retrieve.
`include` Type: Object Default: n/a	Specifies whether to include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`channelFields` Type: Boolean Default: `false`	Whether to include fields for channel metadata.
`customChannelFields` Type: Boolean Default: `false`	Whether to include custom fields for channel metadata.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getMemberships({
      uuid: "my-uuid",
      limit: 2,
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Fetched uuid memberships successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to fetch memberships');
  });
16}
show all 16 lines

Response

1{
"status" : 200,
"data" : [
  {
    "updated" : "2020-07-16T21:28:58.702287Z",
    "channel" : {
      "id" : "my-channel"
    },
    "eTag" : "AY39mJKK//C0VA"
  },
  {
    "eTag" : "AY39mJKK//C0VA",
    "updated" : "2020-07-16T21:28:21.992673Z",
    "channel" : {
      "id" : "my-other-channel"
    }
  }
],
"next" : "Mg"
20}
show all 20 lines

Set channel memberships

Set channel memberships for a UUID.

Usage

1setMemberships({uuid, channels, include, limit, page, filter, sort})

* required

Parameter	Description
`uuid` * Type: String Default: n/a	UUID whose memberships you wish to set.
`channels` * Type: Array Default: n/a	Array of channels to set membership. Array can contain strings (channel-name only) or objects (which can include custom data).
`include` Type: Object Default: n/a	Specifies whether to include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`channelFields` Type: Boolean Default: `false`	Whether to include fields for channel metadata.
`customChannelFields` Type: Boolean Default: `false`	Whether to include custom fields for channel metadata.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by, and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.setMemberships({
      uuid: "my-uuid",
      channels: [
          "my-channel",
          { id: "my-other-channel", custom: { hello: "world" } },
      ],
      include: {
          channelFields: true,
          customChannelFields: true,
          customFields: true,
          totalCount: true,
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Set uuid memberships successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to set memberships');
  });
25}
show all 25 lines

Response

1{
"status" : 200,
"data" : [
  {
    "channel" : {
      "id" : "my-channel"
    },
    "eTag" : "AY39mJKK//C0VA",
    "custom" : null,
    "updated" : "2020-07-16T21:28:58.702287Z"
  },
  {
    "updated" : "2020-07-16T21:28:58.693461Z",
    "custom" : {
      "hello" : "world"
    },
    "channel" : {
      "updated" : "2020-07-16T21:19:28.735177Z",
      "name" : "other-channel-name",
      "custom" : {
        "foo" : "bar"
      },
      "eTag" : "AeDH5/ixi/7lZw",
      "id" : "my-other-channel",
      "description" : "What another great channel"
    },
    "eTag" : "AbGV6rSh8LS/eg"
  }
],
"next" : "NA",
"totalCount" : 2
32}
show all 32 lines

Remove channel memberships

Remove channel memberships for a UUID.

Usage

1removeMemberships({uuid, channels, include, limit, page, filter, sort})

* required

Parameter	Description
`uuid` * Type: String Default: n/a	UUID from which to remove memberships.
`channels` * Type: Array Default: n/a	Array of channels to remove from uuid memberships.
`include` Type: Object Default: n/a	Specifies whether to include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`channelFields` Type: Boolean Default: `false`	Whether to include fields for channel metadata.
`customChannelFields` Type: Boolean Default: `false`	Whether to include custom fields for channel metadata.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by, and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.removeMemberships({
      uuid: "my-uuid",
      channels: [ "my-channel", "my-other-channel" ],
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Removed uuid memberships successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to remove memberships');
  });
16}
show all 16 lines

Response

1{
2  "status": 200,
3  "data": []
4}

Get channel members

The method returns a list of members in a channel. The list will include user metadata for members that have additional metadata stored in the database.

Usage

1getChannelMembers({channel, include, limit, page, filter, sort})

* required

Parameter	Description
`channel` * Type: String Default: n/a	Channel for which to retrieve members.
`include` Type: Object Default: n/a	Specifies whether to include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`UUIDFields` Type: Boolean Default: `false`	Whether to include fields for uuid metadata.
`customUUIDFields` Type: Boolean Default: `false`	Whether to include custom fields for uuid metadata.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by, and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.getChannelMembers({
      channel: "my-channel",
      include: {
          UUIDFields: true,
      },
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Fetched channel members successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to fetch members');
  });
18}
show all 18 lines

Response

1{
"status" : 200,
"next" : "Mg",
"data" : [
  {
    "eTag" : "AbGV6rSh8LS/eg",
    "uuid" : {
      "id" : "my-other-uuid"
    },
    "updated" : "2020-07-16T21:40:48.367305Z"
  },
  {
    "eTag" : "AY39mJKK//C0VA",
    "uuid" : {
      "profileUrl" : null,
      "eTag" : "AePWsMnEl9m23wE",
      "externalId" : null,
      "name" : "my-name",
      "id" : "my-uuid",
      "email" : "me@email.com",
      "updated" : "2020-07-16T21:44:27.504433Z"
    },
    "updated" : "2020-07-16T21:40:48.357234Z"
  }
]
26}
show all 26 lines

Set channel members

This method sets members in a channel.

Usage

1setChannelMembers({channel, uuids, include, limit, page, filter, sort})

* required

Parameter	Description
`channel` * Type: String Default: n/a	Channel for which to set members.
`uuids` * Type: Array Default: n/a	Array of UUIDs to set as members. Array can contain strings (uuid-name only) or objects (which can include custom data).
`include` Type: Object Default: n/a	Specifies whether to include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`UUIDFields` Type: Boolean Default: `false`	Whether to include fields for uuid metadata.
`customUUIDFields` Type: Boolean Default: `false`	Whether to include custom fields for uuid metadata.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by, and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.setChannelMembers({
      channel: "my-channel",
      uuids: [
          "my-uuid",
          { id: "my-other-uuid", custom: { hello: "world" } },
      ],
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Set channel members successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to set members');
  });
19}
show all 19 lines

Response

1{
"status" : 200,
"data" : [
  {
    "updated" : "2020-07-16T21:40:48.367305Z",
    "eTag" : "AbGV6rSh8LS/eg",
    "uuid" : {
      "id" : "my-other-uuid"
    }
  },
  {
    "uuid" : {
      "id" : "my-uuid"
    },
    "eTag" : "AY39mJKK//C0VA",
    "updated" : "2020-07-16T21:40:48.357234Z"
  }
],
"next" : "Mg"
20}
show all 20 lines

Remove channel members

Remove members from a channel.

Usage

1removeChannelMembers({channel, uuids, include, limit, page, filter, sort})

* required

Parameter	Description
`channel` * Type: String Default: n/a	Channe` from which to remove members.
`uuids` * Type: Array Default: n/a	Array of UUIDs to remove from channel members.
`include` Type: Object Default: n/a	Specifies whether to include additional fields in the response.
`customFields` Type: Boolean Default: `false`	Whether to fetch custom fields.
`UUIDFields` Type: Boolean Default: `false`	Whether to include fields for uuid metadata.
`customUUIDFields` Type: Boolean Default: `false`	Whether to include custom fields for uuid metadata.
`totalCount` Type: Boolean Default: `false`	Whether to include `totalCount` in response.
`limit` Type: Number Default: `100`	Maximum number of results to return per page.
`page` Type: Object Default: n/a	Use for pagination.
`next` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination. It fetches the next page, allowing you to continue from where you left off.
`prev` Type: String Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination. It fetches the previous page, enabling access to earlier data. Ignored if the `next` parameter is supplied.
`filter` Type: String Default: n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`sort` Type: Object Default: n/a	Key-value pair of a property to sort by, and a sort direction. Available options are `id`, `name`, and `updated`. Sort directions are `asc` (ascending), `desc` (descending). For example, `{ name: 'asc' }`.

1export default (event) => {
  const pubnub = require('pubnub');
3

  return pubnub.objects.removeChannelMembers({
      channel: "my-channel",
      uuids: [ "my-uuid", "my-other-uuid" ],
  })
  .then((resp) => {
      console.log(resp);
      return event.ok('Removed channel members successfully.');
  })
  .catch((error) => {
      console.log(err);
      return event.abort('Failed to remove members');
  });
16}
show all 16 lines

Response

1{
2  "status": 200,
3  "data": []
4}

Message Reactions

Add Message Reaction

Add an action on a published message.

Usage

1addMessageAction({channel, messageTimetoken, action:{type, value}, uuid})

* required

Parameter	Description
`channel` * Type: String	Name of a channel which stores the message for which an action should be added.
`messageTimetoken` * Type: String	Timetoken of message for which action should be added.
`action` * Type: Hash	Message reaction information.
`action.type` * Type: String	What feature this message reaction represents.
`action.value` * Type: String	Value which should be stored along with a message reaction.
`uuid` * Type: String	The UUID associated with the reaction.

1pubnub.addMessageAction({
2    channel: 'channel1'
3    messageTimetoken: '15610547826970040',
4    action: {
5        type: 'reaction',
6        value: 'smiley_face',
7    },
8    uuid: 'uuid'
9}).then((response) => {
10    console.log(response)
11}).catch((error) => {
12    // handle error
13});

Remove Message Reaction

Remove a peviously added action on a published message.

Usage

1removeMessageAction({channel, messageTimetoken, actionTimetoken, uuid})

* required

Parameter	Description
`channel` * Type: String	Name of a channel which stores the message for which an action should be removed.
`messageTimetoken` * Type: String	Timetoken of a message for which an action should be removed.
`actionTimetoken` * Type: String	Action addition timetoken.
`uuid` * Type: String	UUID associated with the action.

1pubnub.removeMessageAction({
2    channel: 'channel1'
3    messageTimetoken: '15610547826970040',
4    actionTimetoken: '15610547826970040',
5    uuid: 'uuid'
6}).then((response) => {
7    console.log(response)
8}).catch((error) => {
9    // handle error
10});

Get Message Reactions

Get a list of message reactions in a channel.

Usage

1getMessageActions({channel, start, end, limit})

* required

Parameter	Description
`channel` * Type: String	Name of a channel from which a list of messages actions should be retrieved.
`start` Type: String	Message reaction timetoken denoting the start of the range requested. Return values will be less than start.
`end` Type: String	Message reaction timetoken denoting the end of the range requested. Return values will be greater than or equal to end.
`limit` Type: Number	Number of message reactions to return in response.

1pubnub.getMessageActions({
2    channel: 'channel1',
3    start: '15610547826970041',
4    end: '15610547826970040',
5    limit: 100,
6}).then((response) => {
7    console.log(response)
8}).catch((error) => {
9    // handle error
10});

Functions support

Functions provides a rich set of tools, and this documentation does not cover all of the potential situations you may encounter. If you need help with a situation not covered by the documentation, please contact PubNub Support

Execution boundaries

Publish​

Publish​

Usage​

JSON requirement

Fire​

Usage​

Signal​

Usage​

JSON requirement

File sharing​

List files in channel​

Usage​

Returns​

Get file URL​

Usage​

Returns​

Delete file​

Usage​

Returns​

Publish file message​

Usage​

Returns​

Presence​

Requires Presence

Here now​

Usage​

Where now​

Usage​

Global here now​

Usage​

Set state​

Usage​

Get state​

Usage​

Access Manager​

Requires Access Manager

Grant​

Required secret key

Usage​

Max number of resources

Grant token​

Required secret key

Usage​

Required key/value mappings

Revoke token​

Required secret key

Usage​

Parse token​

Usage​

Set token​

Usage​

Channel groups​

Requires Stream Controller

Add channels​

Maximum number of channels

Usage​

List channels​

Usage​

Remove channels​

Usage​

Delete channel group​

Usage​

Message persistence​

Requires Message Persistence

History​

Usage​

Batch history​

Usage​

Delete messages from history​

Required setting

Usage​

Message counts​

Usage​

Mobile push​

Requires Mobile Push Notifications

Add device to channel​

Usage​

List channels for device​

Usage​

Publish

Publish

Usage

Fire

Usage

Signal

Usage

File sharing

List files in channel

Usage

Returns

Get file URL

Usage

Returns

Delete file

Usage

Returns

Publish file message

Usage

Returns

Presence

Here now

Usage

Where now

Usage

Global here now

Usage

Set state

Usage

Get state

Usage

Access Manager

Grant

Usage

Grant token

Usage

Revoke token

Usage

Parse token

Usage

Set token

Usage

Channel groups

Add channels

Usage

List channels

Usage

Remove channels

Usage

Delete channel group

Usage

Message persistence

History

Usage

Batch history

Usage

Delete messages from history

Usage

Message counts

Usage

Mobile push

Add device to channel

Usage

List channels for device

Usage

Remove device from channel

Usage

Remove all mobile push notifications

Usage

App Context

Get metadata for all users

Usage

Response

Other examples

Response

Get user metadata

Usage

Response

Set user metadata

Usage