Publish/Subscribe API for JavaScript SDK

PubNub delivers messages worldwide in less than 30 ms. Send a message to one recipient or broadcast to thousands of subscribers.

For higher-level conceptual details on publishing and subscribing, refer to Connection Management and to Publish Messages.

Supported and recommended asynchronous patterns

PubNub supports Callbacks, Promises, and Async/Await for asynchronous JS operations. The recommended pattern is Async/Await and all sample requests in this document are based on it. This pattern returns a status only on detecting an error. To receive the status errors, you must use the try...catch syntax in your code.

Publish

publish() sends a message to all channel subscribers. PubNub replicates the message across its points of presence and delivers it to all subscribed clients on that channel.

Prerequisites and limitations

• You must initialize PubNub with the publishKey.
• You don't have to be subscribed to a channel to publish to it.
• You cannot publish to multiple channels simultaneously.

Security

Secure messages with Transport Layer Security (TLS) or Secure Sockets Layer (SSL) by setting ssl to true during initialization. You can also encrypt messages.

Message data

The message can contain any JavaScript Object Notation (JSON)-serializable data (objects, arrays, integers, strings). Avoid special classes or functions. Strings can include any UTF‑8 characters.

Don't JSON serialize

You should not JSON serialize the message and meta parameters when sending signals, messages, or files as the serialization is automatic. Pass the full object as the message/meta payload and let PubNub handle everything.

Size

The maximum message size is 32 KiB. This includes the escaped character count and the channel name. Aim for under 1,800 bytes for optimal performance.

If your message exceeds the limit, you'll receive a Message Too Large error. To learn more or calculate payload size, see Message size limits.

Publish rate

You can publish as fast as bandwidth allows. There is a soft throughput limit because messages may drop if subscribers can't keep up.

For example, publishing 200 messages at once may cause the first 100 to drop if a subscriber hasn't received any yet. The in-memory queue stores only 100 messages.

Custom message type

You can optionally provide the customMessageType parameter to add your business-specific label or category to the message, for example text, action, or poll.

Best practices

• Publish to a channel serially (not concurrently).
• Verify a success return code (for example, [1,"Sent","136074940..."]).
• Publish the next message only after a success return code.
• On failure ([0,"blah","<timetoken>"]), retry.
• Keep the in-memory queue under 100 messages to avoid drops.
• Throttle bursts to meet latency needs (for example, no more than 5 messages per second).

Method(s)

To Publish a message, you can use the following method(s) in the JavaScript SDK:

1pubnub.publish({
2 message: any,
3 channel: string,
4 meta: any,
5 storeInHistory: boolean,
6 sendByPost: boolean,
7 ttl: number,
8 customMessageType: string
9}): Promise<PublishResponse>;

* required

Parameter	Description
message * Type: any Default: n/a	The message may be any valid JSON type including objects, arrays, strings, and numbers.
channel * Type: string Default: n/a	Specifies the channel ID to publish messages to.
storeInHistory Type: boolean Default: true	If true the messages are stored in history. If storeInHistory is not specified, then the history configuration on the key is used.
sendByPost Type: boolean Default: false	When true, the SDK uses HTTP POST to publish the messages. The message is sent in the BODY of the request, instead of the query string when HTTP GET is used. Also the messages are compressed thus reducing the size of the messages. Using HTTP POST to publish messages adheres to RESTful API best practices.
meta Type: any Default: n/a	Publish extra meta with the request.
ttl Type: number Default: n/a	Set a per message time to live in Message Persistence. If storeInHistory = true, and ttl = 0, the message is stored with no expiry time. If storeInHistory = true and ttl = X (X is an Integer value), the message is stored with an expiry time of X hours unless you have message retention set to Unlimited on your keyset configuration in the Admin Portal. If storeInHistory = false, the ttl parameter is ignored. If ttl is not specified, then expiration of the message defaults back to the expiry value for the key.
customMessageType Type: string Default: n/a	A case-sensitive, alphanumeric string from 3 to 50 characters describing the business-specific label or category of the message. Dashes - and underscores _ are allowed. The value cannot start with special characters or the string pn_ or pn-. Examples: text, action, poll.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

Publish a message to a channel

1 

1 

Subscribe to the channel

Before running the above publish example, either using the Debug Console or in a separate script running in a separate terminal window, subscribe to the same channel that is being published to.

Response

1type PublishResponse = {
2 timetoken: number
3}

Other examples

Publish a JSON-serialized message

1 

Store the published message for 10 hours

1 

Publish successful

1 

Publish unsuccessful by network down

1 

Publish unsuccessful by initialization without a publish key

1 

Fire

The fire endpoint sends a message to Functions event handlers and Illuminate. The message goes directly to handlers registered on the target channel and triggers their execution. The handler can read the request body. Messages sent via fire() aren't replicated to subscribers and aren't stored in history.

Method(s)

To Fire a message, you can use the following method(s) in the JavaScript SDK:

1fire({
2 Object message,
3 String channel,
4 Boolean sendByPost,
5 Object meta
6})

* required

Parameter	Description
message * Type: Object Default: n/a	The message may be any valid JSON type including objects, arrays, strings, and numbers.
channel * Type: String Default: n/a	Specifies channel ID to publish messages to.
sendByPost Type: Boolean Default: false	If true the messages sent via POST.
meta Type: Object Default: n/a	Publish extra meta with the request.

Sample code

Fire a message to a channel

1 

Signal

The signal() function sends a signal to all subscribers of a channel.

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, please contact support.

Method(s)

To Signal a message, you can use the following method(s) in the JavaScript SDK:

1pubnub.signal({
2 message: string,
3 channel: string,
4 customMessageType: string,
5}): Promise<SignalResponse>;

* required

Parameter	Description
message * Type: string	The message may be any valid JSON type including objects, arrays, strings, and numbers.
channel * Type: string	Specifies channel ID to send messages to.
customMessageType Type: string	A case-sensitive, alphanumeric string from 3 to 50 characters describing the business-specific label or category of the message. Dashes - and underscores _ are allowed. The value cannot start with special characters or the string pn_ or pn-. Examples: text, action, poll.

Sample code

Signal a message to a channel

1 

Response

1type SignalResponse = {
2 timetoken: number
3}

Subscribe

The subscribe function creates an open TCP socket to PubNub and begins listening for messages and events on a specified entity or set of entities. To subscribe successfully, configure the appropriate subscribeKey at initialization.

Conceptual overview

For more general information about subscriptions, refer to Subscriptions.

Entities are first-class citizens that provide access to their encapsulated APIs. You can subscribe using the PubNub client object or directly on a specific entity:

• channel
• channelGroup
• userMetadata
• channelMetadata

A newly subscribed client receives messages after the subscribe() call completes. You can configure retryConfiguration to automatically attempt to reconnect and retrieve any available messages if a client gets disconnected.

Subscribe only opens the connection

Calling subscribe() opens a connection but doesn't deliver messages to your code. You must also add event listeners to receive messages and access sender information. The message object received through listeners includes the sender's ID in the publisher field.

Subscription scope

Subscriptions let you attach listeners for specific real-time update types. Your app receives messages and events through those listeners. There are two types:

• subscription: created from an entity and scoped to that entity (for example, a particular channel)
• subscriptionSet: created from the PubNub client and scoped to the client (for example, all subscriptions created on a single pubnub object). A set can include one or more subscriptions.

The event listener is a single point through which your app receives all the messages, signals, and events in the entities you subscribed to. For information on adding event listeners, refer to Event listeners.

Add subscriptions to an existing set

If you subscribe to a subscription set and then add more subscriptions to it, they are automatically subscribed to.

Create a subscription

An entity-level subscription allows you to receive messages and events for only that entity for which it was created. Using multiple entity-level subscriptions is useful for handling various message/event types differently in each channel.

1// entity-based, local-scoped
2const channel = pubnub.channel('channel_1');
3channel.subscription(subscriptionOptions)

* required

Parameter	Description
subscriptionOptions Type: subscriptionOptions	Subscription behavior configuration.

Create a subscription set

A client-level subscriptionSet allows you to receive messages and events for all entities in the set. A single subscriptionSet is useful for similarly handling various message/event types in each channel.

1// client-based, general-scoped
2pubnub.subscriptionSet({
3 channels: string[],
4 channelGroups: string[],
5 subscriptionOptions: subscriptionOptions
6}))

* required

Parameter	Description
→ channels Type: string[]	Channels to subscribe to. Either channels or channelGroups is mandatory.
→ channelGroups Type: string[]	Channel groups to subscribe to. Either channels or channelGroups is mandatory.
→ subscriptionOptions Type: subscriptionOptions	Subscription behavior configuration.

subscriptionOptions

subscriptionOptions is a class. Available properties include:

Option	Type	Description
receivePresenceEvents	boolean	Whether presence updates for userIds should be delivered through the listener streams. For information on how to receive presence events and what those events are, refer to Presence Events.
cursor	object	Cursor from which to return any available cached messages. Message retrieval with cursor is not guaranteed and should only be considered a best-effort service. A cursor consists of a timetoken and region: cursor?: { timetoken?: string; region?: number } If you pass any primitive type, the SDK converts them into SubscriptionCursor but if their value is not a 17-digit number or a string with numeric characters, the provided value will be ignored.

Modify a subscription set

You can add and remove subscriptions to and from an existing set to create new sets. If you subscribe to a subscription set and then add more subscriptions to it, they are automatically subscribed to.

Refer to the Other examples section for more information on adding and removing subscriptions.

Method(s)

subscription and subscriptionSet use the same subscribe() method.

Subscribe

To subscribe, you can use the following method in the JavaScript SDK:

1subscription.subscribe()
2subscriptionSet.subscribe()

Sample code

1 

Wildcard subscribe and message objects

Wildcard subscribe (e.g., sports.*) works the same as regular subscribe - you still need to add event listeners to receive messages. The message objects received include the sender's ID in the publisher field, the actual channel name in the channel field, and the wildcard match in the subscription field.

Other examples

Create a subscription set from 2 individual subscriptions

1 

Create a subscription set from 2 sets

1 

Add subscriptions to an existing set

1 

Returns

The subscribe() method doesn't have a return value.

Entities

Entities are subscribable objects for which you can receive real-time updates (messages, events, etc).

• channel
• channelGroup
• userMetadata
• channelMetadata

Create channels

This method returns a local channel entity.

1pubnub.channel(string)

* required

Parameter	Description
channel * Type: string	The ID of the channel to create a subscription of.

Sample code

1 

Create channel groups

This method returns a local channelGroup entity.

1pubnub.channelGroup(string)

* required

Parameter	Description
channel_group * Type: string	The name of the channel group to create a subscription of.

Sample code

1 

Create channel metadata

This method returns a local channelMetadata entity.

1pubnub.channelMetadata(string)

* required

Parameter	Description
channelMetadata * Type: string	The String identifier of the channel metadata object to create a subscription of.

Sample code

1 

Create user metadata

This method returns a local userMetadata entity.

1pubnub.userMetadata(string)

* required

Parameter	Description
userMetadata * Type: string	The String identifier of the user metadata object to create a subscription of.

Sample code

1 

Event listeners

Messages and events are received in your app using a listener. This listener allows a single point to receive all messages, signals, and events.

You can attach listeners to the instances of subscription, subscriptionSet, and, in the case of the connection status, the PubNub client.

Add listeners

You can implement multiple listeners with the addListener() method or register an event-specific listener that receives only a selected type, like message or file.

Method(s)

1 

Sample code

1 

Message object contains sender information

When you receive messages through listeners, the message object includes the sender's ID in the publisher field, along with the message content, channel name, timetoken, and other metadata.

Add connection status listener

The PubNub client has a listener dedicated to handling connection status updates.

Client scope

This listener is only available on the PubNub object.

Method(s)

1 

Sample code

1 

Returns

The subscription status. For information about available statuses, refer to SDK statuses.

Unsubscribe

Stop receiving real-time updates from a subscription or a subscriptionSet.

Method(s)

1subscription.unsubscribe()
2 
3subscriptionSet.unsubscribe()

Sample code

1 

Returns

None

Unsubscribe all

Stop receiving real-time updates from all data streams and remove the entities associated with them.

Client scope

This method is only available on the PubNub object.

Method(s)

1pubnub.unsubscribeAll()

Sample code

1 

Returns

None

Subscribe (old)

Not recommended

The use of this method is discouraged. Use Subscribe instead.

Receive messages

Your app receives messages and events via event listeners. The event listener is a single point through which your app receives all the messages, signals, and events that are sent in any channel you are subscribed to.

For more information about adding a listener, refer to the Event Listeners section.

Description

This function causes the client to create an open TCP socket to the PubNub Real-Time Network and begin listening for messages on a specified channel. To subscribe to a channel ID the client must send the appropriate subscribeKey at initialization.

By default a newly subscribed client will only receive messages published to the channel after the subscribe() call completes.

Connectivity notification

You can be notified of connectivity via the listener, on establishing connection the statusEvent.category returns PNConnectedCategory.

By waiting for the connect event to return before attempting to publish, you can avoid a potential race condition on clients that subscribe and immediately publish messages before the subscribe has completed.

Unsubscribing from all channels

Unsubscribing from all channels, and then subscribing to a new channel Y is not the same as subscribing to channel Y and then unsubscribing from the previously-subscribed channel(s). Unsubscribing from all channels resets the last-received timetoken and thus, there could be some gaps in the subscription that may lead to message loss.

Method(s)

To Subscribe to a channel, you can use the following method(s) in the JavaScript SDK:

1pubnub.subscribe({
2 channels: Array<string>,
3 channelGroups: Array<string>,
4 withPresence: boolean,
5 timetoken: number
6}): Promise<SubscribeResponse>;

* required

Parameter	Description
channels * Type: Array<string> Default: n/a	Specifies the channels to subscribe to. It is possible to specify multiple channels as a list or as an array.
channelGroups Type: Array<string> Default: n/a	Specifies the channelGroups to subscribe to.
withPresence Type: boolean Default: false	If true it also subscribes to presence instances.
timetoken Type: number Default: n/a	Specifies timetoken from which to start returning any available cached messages. Message retrieval with timetoken is not guaranteed and should only be considered a best-effort service.

Sample code

Subscribe to a channel:

1 

Event listeners

The response of the call is handled by adding a Listener. Please see the Event Listeners section for more details. Listeners should be added before calling the method.

Returns

The following objects will be returned in the status response

Object	Description
category	PNConnectedCategory
operation	PNSubscribeOperation
affectedChannels	The channels affected in the operation, of type array.
subscribedChannels	All the current subscribed channels, of type array.
affectedChannelGroups	The channel groups affected in the operation, of type array.
lastTimetoken	The last timetoken used in the subscribe request, of type long.
currentTimetoken	The current timetoken fetched in the subscribe response, which is going to be used in the next request, of type long.

1{
2 category: 'PNConnectedCategory',
3 operation: 'PNSubscribeOperation',
4 affectedChannels: ['my_channel_1'],
5 subscribedChannels: ['my_channel_1'],
6 affectedChannelGroups: [],
7 lastTimetoken: '14974492380756600',
8 currentTimetoken: '14974492384874375'
9}

The following objects will be returned in the subscribe message response

Object	Description
channel	The channel ID for which the message belongs.
subscription	The channel group or wildcard subscription match (if exists).
timetoken	Publish timetoken.
message	The payload.
actualChannel	Deprecated. Use property channel.
subscribedChannel	Deprecated. Use property subscription.

1{
2 actualChannel: null,
3 channel: "my_channel_1",
4 message: "Hello World!",
5 publisher: "pn-58e1a647-3e8a-4c7f-bfa4-e007ea4b2073",
6 subscribedChannel: "my_channel_1",
7 subscription: null,
8 timetoken: "14966804541029440"
9}

The following objects will be returned in the Presence response

Object	Description
action	Can be join, leave, state-change or timeout.
channel	The channel ID for which the message belongs.
occupancy	No. of users connected with the channel ID.
state	User State.
subscription	The channel group or wildcard subscription match (if exists)
timestamp	Current timetoken.
timetoken	Publish timetoken.
uuid	UUIDs of users who are connected with the channel ID.

1{
2 category: 'PNConnectedCategory',
3 operation: 'PNSubscribeOperation',
4 affectedChannels: ['my_channel_1'],
5 subscribedChannels: ['my_channel_1'],
6 affectedChannelGroups: [],
7 lastTimetoken: '14974492380756600',
8 currentTimetoken: '14974492384874375'
9}

Other examples

Subscribing to multiple channels

It's possible to subscribe to more than one channel using the Multiplexing feature. The example shows how to do that using an array to specify the channel names.

Alternative subscription methods

You can also use Wildcard Subscribe and Channel Groups to subscribe to multiple channels at a time. To use these features, the Stream Controller add-on must be enabled on your keyset in the Admin Portal.

1 

Subscribing to a Presence channel

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.

For any given channel there is an associated Presence channel. You can subscribe directly to the channel by appending -pnpres to the channel name. For example the channel named my_channel would have the presence channel named my_channel-pnpres.

1 

Wildcard subscribe to channels

Requires Stream Controller add-on

This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal (with Enable Wildcard Subscribe checked). Read the support page on enabling add-on features on your keys.

Wildcard subscribes allow the client to subscribe to multiple channels using wildcard. For example, if you subscribe to a.* you will get all messages for a.b, a.c, a.x. The wildcarded * portion refers to any portion of the channel string name after the dot (.).

1 

Wildcard grants and revokes

Only one level (a.*) of wildcarding is supported. If you grant on * or a.b.*, the grant will treat * or a.b.* as a single channel named either * or a.b.*. You can also revoke permissions from multiple channels using wildcards but only if you previously granted permissions using the same wildcards. Wildcard revokes, similarly to grants, only work one level deep, like a.*.

Subscribing with state

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.

Required UUID

Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.

1 

Subscribe to a channel group

Requires Stream Controller add-on

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

1 

Subscribe to the presence channel of a channel group

Requires Stream Controller and Presence add-ons

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

1 

Subscribing to multiple channel groups

Requires Stream Controller add-on

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

1 

Subscribing to a channel and channel group simultaneously

Requires Stream Controller add-on

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

1 

Sample Responses

Join event

1{
2 "channel": "my_channel",
3 "subscription": null,
4 "actualChannel": null,
5 "subscribedChannel": "my_channel-pnpres",
6 "action": "join",
7 "timetoken": "15119466699655811",
8 "occupancy": 2,
9 "uuid": "User1",
10 "timestamp": 1511946669
11}

Leave event

1{
2 "channel": "my_channel",
3 "subscription": null,
4 "actualChannel": null,
5 "subscribedChannel": "my_channel-pnpres",
6 "action": "leave",
7 "timetoken": "15119446002445794",
8 "occupancy": 1,
9 "uuid": "User1",
10 "timestamp": 1511944600
11}

Timeout event

1{
2 "channel": "my_channel",
3 "subscription": null,
4 "actualChannel": null,
5 "subscribedChannel": "my_channel-pnpres",
6 "action": "timeout",
7 "timetoken": "15119519897494311",
8 "occupancy": 3,
9 "uuid": "User2",
10 "timestamp": 1511951989
11}

State change event

1{
2 "channel": "my_channel",
3 "subscription": null,
4 "actualChannel": null,
5 "subscribedChannel": "my_channel-pnpres",
6 "action": "state-change",
7 "state": {
8 "isTyping": true
9 },
10 "timetoken": "15119477895378127",
11 "occupancy": 5,
12 "uuid": "User4",
13 "timestamp": 1511947789
14}

Interval event

1{
2 "action": "interval",
3 "occupancy": 2,
4 "timestamp": 1511947739
5}

When a channel is in interval mode with presence_deltas pnconfig flag enabled, the interval message may also include the following fields which contain an array of changed UUIDs since the last interval message.

• joined
• left
• timedout

For example, this interval message indicates there were 2 new UUIDs that joined and 1 timed out UUID since the last interval:

1{
2 "action":"interval",
3 "timestamp":1548340678,
4 "occupancy":2,
5 "join":["pn-94bea6d1-2a9e-48d8-9758-f1b7162631ed","pn-cecbfbe3-312f-4928-93a2-5a79c91b10e0"]},
6 "timedout":["pn-cecbfbe3-312f-4928-93a2-5a79c91b10e0"],
7 "b":"my-channel-pnpres"
8}

If the full interval message is greater than 30KB (since the max publish payload is ∼32KB), none of the extra fields will be present. Instead there will be a here_now_refresh boolean field set to true. This indicates to the user that they should do a hereNow request to get the complete list of users present in the channel.

1{
2 "channel": "my_channel",
3 "subscription": null,
4 "actualChannel": null,
5 "subscribedChannel": "my_channel-pnpres",
6 "action": "interval",
7 "timetoken": "15119477396210903",
8 "occupancy": 4,
9 "timestamp": 1511947739,
10 "here_now_refresh" : true
11}

You can be notified of connectivity status, message, and presence notifications via the listeners.

Listeners should be added before calling the method.

Add listeners

1pubnub.addListener({
2 // Messages
3 message: function (m) {
4 const channelName = m.channel; // Channel on which the message was published
5 const channelGroup = m.subscription; // Channel group or wildcard subscription match (if exists)
6 const pubTT = m.timetoken; // Publish timetoken
7 const msg = m.message; // Message payload
8 const publisher = m.publisher; // Message publisher
9 },
10 // Presence
11 // requires a subscription with presence
12 presence: function (p) {
13 const action = p.action; // Can be join, leave, timeout, state-change, or interval
14 const channelName = p.channel; // Channel to which the message belongs
15 const occupancy = p.occupancy; // Number of users subscribed to the channel
16 const state = p.state; // User state
17 const channelGroup = p.subscription; // Channel group or wildcard subscription match, if any
18 const publishTime = p.timestamp; // Publish timetoken
19 const timetoken = p.timetoken; // Current timetoken
20 const uuid = p.uuid; // UUIDs of users who are subscribed to the channel
21 },
22 // Signals
23 signal: function (s) {
24 const channelName = s.channel; // Channel to which the signal belongs
25 const channelGroup = s.subscription; // Channel group or wildcard subscription match, if any
26 const pubTT = s.timetoken; // Publish timetoken
27 const msg = s.message; // Payload
28 const publisher = s.publisher; // Message publisher
29 },
30 // App Context
31 objects: (objectEvent) => {
32 const channel = objectEvent.channel; // Channel to which the event belongs
33 const channelGroup = objectEvent.subscription; // Channel group
34 const timetoken = objectEvent.timetoken; // Event timetoken
35 const publisher = objectEvent.publisher; // UUID that made the call
36 const event = objectEvent.event; // Name of the event that occurred
37 const type = objectEvent.type; // Type of the event that occurred
38 const data = objectEvent.data; // Data from the event that occurred
39 },
40 // Message Actions
41 messageAction: function (ma) {
42 const channelName = ma.channel; // Channel to which the message belongs
43 const publisher = ma.publisher; // Message publisher
44 const event = ma.event; // Message action added or removed
45 const type = ma.data.type; // Message action type
46 const value = ma.data.value; // Message action value
47 const messageTimetoken = ma.data.messageTimetoken; // Timetoken of the original message
48 const actionTimetoken = ma.data.actionTimetoken; // Timetoken of the message action
49 },
50 // File Sharing
51 file: function (event) {
52 const channelName = event.channel; // Channel to which the file belongs
53 const channelGroup = event.subscription; // Channel group or wildcard subscription match (if exists)
54 const publisher = event.publisher; // File publisher
55 const timetoken = event.timetoken; // Event timetoken
56 
57 const message = event.message; // Optional message attached to the file
58 const fileId = event.file.id; // File unique id
59 const fileName = event.file.name;// File name
60 const fileUrl = event.file.url; // File direct URL
61 },
62 status: function (s) {
63 const affectedChannelGroups = s.affectedChannelGroups; // Array of channel groups affected in the operation
64 const affectedChannels = s.affectedChannels; // Array of channels affected in the operation
65 const category = s.category; // Returns PNConnectedCategory
66 const operation = s.operation; // Returns PNSubscribeOperation
67 const lastTimetoken = s.lastTimetoken; // Last timetoken used in the subscribe request (type long)
68 const currentTimetoken = s.currentTimetoken; /* Current timetoken fetched in subscribe response,
69 * to be used in the next request (type long) */
70 const subscribedChannels = s.subscribedChannels; // Array of all currently subscribed channels
71 },
72});

show all 72 lines

Remove listeners

1var existingListener = {
2 message: function () {
3 },
4};
5 
6pubnub.removeListener(existingListener);

Listener status events

Category	Description
PNNetworkUpCategory	The SDK detected that the network is online.
PNNetworkDownCategory	The SDK announces this when a connection isn't available, or when the SDK isn't able to reach PubNub servers.
PNNetworkIssuesCategory	A subscribe event experienced an exception when running. The SDK isn't able to reach PubNub servers. This may be due to many reasons, such as the machine or device isn't connected to the internet; the internet connection has been lost; your internet service provider is having trouble; or, perhaps the SDK is behind a proxy.
PNReconnectedCategory	The SDK was able to reconnect to PubNub.
PNConnectedCategory	SDK subscribed with a new mix of channels. This is fired every time the channel or channel group mix changes.
PNAccessDeniedCategory	Access Manager permission failure.
PNMalformedResponseCategory	JSON parsing crashed.
PNBadRequestCategory	The server responded with a bad response error because the request is malformed.
PNDecryptionErrorCategory	If using decryption strategies and the decryption fails.
PNTimeoutCategory	Failure to establish a connection to PubNub due to a timeout.
PNRequestMessageCountExceedCategory	The SDK announces this error if requestMessageCountThreshold is set, and the number of messages received from PubNub (in-memory cache messages) exceeds the threshold.
PNUnknownCategory	Returned when the subscriber gets a non-200 HTTP response code from the server.

Unsubscribe (old)

Not recommended

The use of this method is discouraged. Use Unsubscribe instead.

When subscribed to a single channel, this function causes the client to issue a leave from the channel and close any open socket to the PubNub Network. For multiplexed channels, the specified channel(s) will be removed and the socket remains open until there are no more channels remaining in the list.

Unsubscribing from all channels

Unsubscribing from all channels, and then subscribing to a new channel Y is not the same as subscribing to channel Y and then unsubscribing from the previously-subscribed channel(s). Unsubscribing from all channels resets the last-received timetoken and thus, there could be some gaps in the subscription that may lead to message loss.

Method(s)

To Unsubscribe from a channel, you can use the following method(s) in the JavaScript SDK:

1pubnub.unsubscribe({
2 channels: Array<string>,
3 channelGroups: Array<string>
4}): Promise<UnsubscribeResponse>;

* required

Parameter	Description
channels * Type: Array<string>	Specifies the channel ID to unsubscribe from.
channelGroups Type: Array<string>	Specifies the channelGroups to unsubscribe from.

Sample code

Unsubscribe from a channel:

1 

Response

The output below demonstrates the response to a successful call:

1{
2 "action" : "leave"
3}

Other examples

Unsubscribing from multiple channels

Requires Stream Controller add-on

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

1 

Example response

1{
2 "action" : "leave"
3}

Unsubscribing from multiple channel groups

Requires Stream Controller add-on

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

1 

Unsubscribe all (old)

Not recommended

The use of this method is discouraged. Use Unsubscribe all instead.

Unsubscribe from all channels and all channel groups

Method(s)

1unsubscribeAll()

Sample code

1 

Returns

None