Publish/Subscribe API for Unity SDK

The foundation of the PubNub service is the ability to send a message and have it delivered anywhere in less than 30ms. Send a message to just one other person or broadcast to thousands of subscribers at once.

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

Publish​

publish() sends a message to all channel subscribers. A successfully published message is replicated across PubNub's points of presence and sent simultaneously to all subscribed clients on a channel.

  • 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.

Method(s)​

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

pubnub.Publish()
    .Message(object)
    .Channel(string)
    .ShouldStore(bool)
    .Meta(Dictionary<string, object>)
    .UsePOST(bool)
    .Ttl(int)
    .QueryParam(Dictionary<string,object>)
    .CustomMessageType(string)
    .Execute(System.Action<PNPublishResult, PNStatus>)
* required
ParameterDescription
Message *
Type: object
The payload.
Channel *
Type: string
Destination of the Message (channel ID).
ShouldStore
Type: bool
Store in history.
If ShouldStore is not specified, then the history configuration on the key is used.
Meta
Type: Dictionary<string, object>
Meta data object which can be used with the filtering ability.
UsePOST
Type: bool
Use POST to Publish.
Ttl
Type: int
Set a per message time to live in storage.
  1. If ShouldStore = true, and Ttl = 0, the message is stored with no expiry time.
  2. If ShouldStore = 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.
  3. If ShouldStore = false, the Ttl parameter is ignored.
  4. If Ttl is not specified, then expiration of the message defaults back to the expiry value for the key.
QueryParam
Type: Dictionary<string, object>
Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
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.
Sync
Type: Command
Block the thread, exception thrown if something goes wrong.
Async
Type: PNCallback
PNCallback of type PNPublishResult.
Execute
Type: System.Action
System.Action of type PNPublishResult.
ExecuteAsync
Type: None
Returns Task<PNResult<PNPublishResult>>.

Basic Usage​

Publish a message to a channel​

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.

using PubnubApi.Unity;
using UnityEngine;

public class PubnubBasicUsageExample : MonoBehaviour {

    //Reference to a pubnub manager previously setup in Unity Editor
    //For more details see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
    [SerializeField] private PNManagerBehaviour pubnubManager;

    //An editor-serialized string with the test channel ID
    [SerializeField] private string testChannelId = "test_channel_id";

    private async void Start() {
        //Getting a reference to the Pubnub instance
        var pubnub = pubnubManager.pubnub;
show all 33 lines
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.

Returns​

The Publish() operation returns a PNResult<PNPublishResult> which contains the following properties:

Property NameTypeDescription
Result
PNPublishResult
Returns a PNPublishResult object.
Status
PNStatus
Returns a PNStatus object.

PNPublishResult contains the following properties:

Property NameTypeDescription
Timetoken
long
Returns a long representation of the timetoken when the message was published.

Other Examples​

Publish a message to a channel synchronously​

//Publishing Dictionary
Dictionary<string, float> position = new Dictionary<string, float>();
position.Add("lat", 32F);
position.Add("lng", 32F);

Debug.Log("before pub: " + pubnub.JsonPluggableLibrary.SerializeToJsonString(position));

pubnub.Publish()
    .Message(position)
    .Channel("my_channel")
    .CustomMessageType("text-message")
    .Execute(new PNPublishResultExt(
        (result, status) => {
            Debug.Log("pub timetoken: " + result.Timetoken.ToString());
            Debug.Log("pub status code : " + status.StatusCode.ToString());
show all 17 lines

Publish with metadata​

string[] arrayMessage = new string[] {
    "hello",
    "there"
};

pubnub.Publish()
    .Message(arrayMessage.ToList())
    .Channel("suchChannel")
    .ShouldStore(true)
    .Meta("<json data as dictionary object>")
    .UsePOST(true)
    .CustomMessageType("text-message")
    .Execute((result, status) => {
            // handle publish result, status always present, result if successful
            // status.Error to see if error happened
show all 17 lines

Store the published message for 10 hours​

PNPublishResult res = pubnub.Publish()
    .Channel("coolChannel")
    .Message("test")
    .ShouldStore(true)
    .Ttl(10)
    .CustomMessageType("text-message")
    .Sync();

Publishing messages for receipt on FCM and APNS associated devices, sample payload​

public class MobilePayload
{
    public Dictionary<string, object> pn_apns;
    public Dictionary<string, object> pn_gcm;
    public Dictionary<string, object> full_game;
}

Dictionary<string, object> apnsData = new Dictionary<string, object>();
apnsData.Add("aps", new Dictionary<string, object>() {
    { "alert", "Game update 49ers touchdown" },
    { "badge", 2 }
});
apnsData.Add("teams", new string[] { "49ers", "raiders" });
apnsData.Add("score", new int[] { 7, 0 });

show all 54 lines

For more details, refer to Mobile Push.

Fire​

The fire endpoint allows the client to send a message to Functions Event Handlers and Illuminate. These messages will go directly to any Event Handlers registered on the channel that you fire to and will trigger their execution. The content of the fired request will be available for processing within the Event Handler. The message sent via fire() isn't replicated, and so won't be received by any subscribers to the channel. The message is also not stored in history.

Method(s)​

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

pubnub.Fire()
    .Message(object)
    .Channel(string)
    .Meta(Dictionary<string, object>)
    .UsePOST(bool)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNPublishResult, PNStatus>)
* required
ParameterDescription
Message *
Type: object
The payload.
Channel *
Type: string
Destination of the message (channel ID).
Meta
Type: Dictionary<string, object>
Meta data object which can be used with the filtering ability.
UsePOST
Type: bool
Use POST to Publish.
QueryParam
Type: Dictionary<string, object>
Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
Sync
Type: Command
Block the thread, exception thrown if something goes wrong.
Async
Type: PNCallback
PNCallback of type PNPublishResult
Execute
Type: System.Action
System.Action of type PNPublishResult
ExecuteAsync
Type: None
Returns Task<PNResult<PNPublishResult>>.

Basic Usage​

Fire a message to a channel​

string[] arrMessage = new string[] {
    "hello",
    "there"
};

pubnub.Fire()
    .Message(arrMessage.ToList())
    .Channel(channel)
    .UsePOST(true)
    .Execute((result, status) => {
            if (status.Error) {
                // something bad happened.
                Debug.Log("error happened while publishing: " + pubnub.JsonPluggableLibrary.SerializeToJsonString(status));
            } else {
                Debug.Log("publish worked! timetoken: " + result.Timetoken.ToString());
show all 18 lines

Signal​

The signal() function is used to send 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 Unity SDK:

pubnub.Signal()
    .Message(object)
    .Channel(string)
    .CustomMessageType(string)
    .Execute(System.Action<PNPublishResult, PNStatus>)
* required
ParameterDescription
Message *
Type: object
The payload.
Channel *
Type: string
Destination of the Message (channel ID).
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.
Execute
Type: System.Action
System.Action of type PNPublishResult.
ExecuteAsync
Type: None
Returns Task<PNResult<PNPublishResult>>.

Basic Usage​

Signal a message to a channel​

Dictionary<string, string> myMessage = new Dictionary<string, string>();
myMessage.Add("msg", "Hello Signals");

pubnub.Signal()
    .Message(myMessage)
    .Channel("foo")
    .CustomMessageType("text-message")
    .Execute((result, status) => {
        if (status.Error) {
            Debug.Log(status.ErrorData.Information);
        } else {
            Debug.Log(result.Timetoken);
        }
    });

Response​

Property NameTypeDescription
Timetoken
long
Returns a long representation of the timetoken when the message was signaled.

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, you must 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:

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

Subscription scope​

Subscription objects provide an interface to attach listeners for various real-time update types. Your app receives messages and events via those event listeners. Two types of subscriptions are available:

  • Subscription, created from an entity with a scope of only that entity (for example, a particular channel)
  • SubscriptionSet, created from the PubNub client with a global scope (for example, all subscriptions created on a single pubnub object ). A subscription set can have 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.

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.

Keep a strong reference

You should keep a strong reference to every created subscription/subscription set because they must stay in memory to listen for updates. If you were to create a Subscription/SubscriptionSet and not keep a strong reference to it, Automatic Reference Counting (ARC) could deallocate the Subscription as soon as your code finishes executing.

// entity-based, local-scoped
Channel firstChannel = pubnub.Channel("first");

Subscription subscription = firstChannel.Subscription(SubscriptionOptions options);
* required
ParameterDescription
options
Type: SubscriptionOptions
Subscription behavior configuration.

Create a subscription set​

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

Keep a strong reference

You should keep a strong reference to every created subscription/subscription set because they must stay in memory to listen for updates. If you were to create a Subscription/SubscriptionSet and not keep a strong reference to it, Automatic Reference Counting (ARC) could deallocate the Subscription as soon as your code finishes executing.

// client-based, general-scoped
SubscriptionSet subscriptionSet = pubnub.SubscriptionSet(
   channels: string[],
   channelGroups: string[],
   options: SubscriptionOptions
)
* required
ParameterDescription
channels *
Type: string[]
One or more channels to create a subscription of. Either channels or channelGroups is required.
channelGroups *
Type: string[]
One or more channels to create a subscription of. Either channels or channelGroups is required.
options
Type: SubscriptionOptions
Subscription behavior configuration.
Add/remove sets

You can add and remove subscriptions to create new sets. Refer to the Other examples section for more information.

SubscriptionOptions​

SubscriptionOptions is an enum. Available properties include:

OptionDescription
ReceivePresenceEvents
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.

Method(s)​

Subscription and SubscriptionSet use the same subscribe<object>() method.

Subscribe​

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

subscription.Subscribe<object>(SubscriptionCursor cursor)
* required
ParameterDescription
cursor
Type: SubscriptionCursor
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: long?; Region: int? }

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.
Basic usage​
Subscription subscription1 = pubnub.Channel("channelName").Subscription()
subscription1.Subscribe<object>()

SubscriptionSet subscriptionSet = pubnub.Subscription(
    new string[] {"channel1", "channel2"},
    new string[] {"channel_group_1", "channel_group_2"},
    SubscriptionOptions.ReceivePresenceEvents
)

subscriptionSet.Subscribe<object>()
Other examples​
Create a subscription set from 2 individual subscriptions​
// Create a subscription from a channel entity
Subscription subscription1 = pubnub.Channel("channelName").Subscription()

// Create a subscription from a channel group entity
Subscription subscription2 = pubnub.ChannelGroup("channelGroupName").Subscription()

// create a subscription set from individual entities
SubscriptionSet subscriptionSet = subscription1.Add(subscription2)

subscriptionSet.Subscribe<object>()
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).

Create channels​

This method returns a local Channel entity.

pubnub.Channel(String)
* required
ParameterDescription
Channel *
Type: String
The ID of the channel to create a subscription of.

Basic usage​

pubnub.Channel("channelName")

Create channel groups​

This method returns a local ChannelGroup entity.

pubnub.ChannelGroup(String)
* required
ParameterDescription
ChannelGroup *
Type: String
The name of the channel group to create a subscription of.

Basic usage​

pubnub.ChannelGroup("channelGroupName")

Create channel metadata​

This method returns a local ChannelMetadata entity.

pubnub.ChannelMetadata(String)
* required
ParameterDescription
ChannelMetadata *
Type: String
The String identifier of the channel metadata object to create a subscription of.

Basic usage​

pubnub.ChannelMetadata("channelMetadata")

Create user metadata​

This method returns a local UserMetadata entity.

pubnub.UserMetadata(String)
* required
ParameterDescription
UserMetadata *
Type: String
The String identifier of the user metadata object to create a subscription of.

Basic usage​

pubnub.UserMetadata("userMetadata")

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 onEvent closure or register an event-specific listener that receives only a selected type, like message or file.

Method(s)​

// Add event-specific listeners
// Add a listener to receive Message changes
Subscription subscription1 = pubnub.Channel("channelName").Subscription()

subscription1.OnMessage = (Pubnub pn, PNMessageResult<object> messageEvent) => {
 Console.WriteLine($"Message received {messageEvent.Message}");
};

subscription1.Subscribe<object>()


// Add multiple listeners
SubscribeCallbackExt eventListener = new SubscribeCallbackExt(
 delegate (Pubnub pn, PNMessageResult<object> messageEvent) {
  Console.WriteLine($"received message {messageEvent.Message}");
show all 37 lines

Basic usage​

Subscription subscription1 = pubnub.Channel("channelName").Subscription()


SubscriptionSet subscriptionSet = pubnub.Subscription(
    new string[] {"channel1", "channel2"},
    new string[] {"channel_group_1", "channel_group_2"},
    SubscriptionOptions.ReceivePresenceEvents
)

SubscribeCallbackExt eventListener = new SubscribeCallbackExt(
 delegate (Pubnub pn, PNMessageResult<object> messageEvent) {
  Console.WriteLine($"received message {messageEvent.Message}");
 }
)

show all 22 lines

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)​

pubnub.AddListener(listener)

Basic usage​

SubscribeCallbackExt eventListener = new SubscribeCallbackExt(
 delegate (Pubnub pn, PNStatus e) {
  Console.WriteLine("Status event");
 }
);

pubnub.AddListener(eventListener)

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)​

subscription.Unsubscribe<object>()

subscriptionSet.Unsubscribe<object>()

Basic Usage​

Subscription subscription1 = pubnub.Channel("channelName").Subscription()

SubscriptionSet subscriptionSet = pubnub.Subscription(
    new string[] {"channel1", "channel2"},
    new string[] {"channel_group_1", "channel_group_2"},
    SubscriptionOptions.ReceivePresenceEvents
)

subscription1.Subscribe<object>()
subscriptionSet.Subscribe<object>()

subscription1.Unsubscribe<object>()
subscriptionSet.Unsubscribe<object>()

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)​

pubnub.UnsubscribeAll<object>()

Basic Usage​

Subscription subscription1 = pubnub.Channel("channelName").Subscription()

SubscriptionSet subscriptionSet = pubnub.Subscription(
    new string[] {"channel1", "channel2"},
    new string[] {"channel_group_1", "channel_group_2"},
    SubscriptionOptions.ReceivePresenceEvents
)

subscription1.Subscribe<object>()
subscriptionSet.Subscribe<object>()

pubnub.UnsubscribeAll<object>()

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 ID. 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. If a client gets disconnected from a channel, it can automatically attempt to reconnect to that channel ID and retrieve any available messages that were missed during that period. This can be achieved by setting ReconnectionPolicy to PNReconnectionPolicy.LINEAR, when initializing the client.

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 Unity SDK:

pubnub.Subscribe<string>()
    .Channels(Array|List<string>)
    .ChannelGroups(Array|List<string>)
    .WithTimetoken(long)
    .WithPresence()
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNPublishResult, PNStatus>)
* required
ParameterDescription
Channels
Type: Array or List<string>
Subscribe to Channels, Either Channels or ChannelGroups is required.
ChannelGroups
Type: Array or List<string>
Subscribe to ChannelGroups, Either Channels or ChannelGroups is required.
WithTimetoken
Type: long
Pass a Timetoken.
WithPresence
Type: Command
Also subscribe to related presence information.
QueryParam
Type: Dictionary<string, object>
Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
Execute
Type: System.Action
System.Action of type PNPublishResult.

Basic Usage​

Subscribe to a channel:

pubnub.Subscribe<string>()
    .Channels(new string[] {
        // subscribe to channels
        "my_channel"
     })
    .Execute();
Event listeners

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

Returns​

PNMessageResult

PNMessageResult<T> is returned in the Listeners

The Subscribe() operation returns a PNStatus which contains the following operations:

Property NameTypeDescription
Category
PNStatusCategory
Details of PNStatusCategory are here
Error
bool
This is true if an error occurred in the execution of the operation.
ErrorData
PNErrorData
Error data of the exception (if Error is true)
StatusCode
int
Status code of the execution.
Operation
PNOperationType
Operation type of the request.
AffectedChannels
List<string>
A list of affected channels in the operation.
AffectedChannelGroups
List<string>
A list of affected channel groups in the operation.

The Subscribe() operation returns a PNMessageResult<T> for messages which contains the following operations:

Property NameTypeDescription
Message
object
The message sent on the channel ID.
Subscription
string
The channel group or wildcard subscription match (if exists).
Channel
string
The channel ID for which the message belongs.
Timetoken
long
Timetoken for the message.
UserMetadata
object
User metadata.

The Subscribe() operation returns a PNPresenceEventResult from presence which contains the following operations:

Property NameTypeDescription
Event
string
Events like join, leave, timeout, state-change, interval.
Uuid
string
UUID for the event.
Timestamp
long
Timestamp for the event.
Occupancy
int
Current occupancy.
State
Dictionary
State of the UUID.
Subscription
string
The channel group or wildcard subscription match (if exists).
Channel
string
The channel ID for which the message belongs.
Timetoken
long
Timetoken of the message.
UserMetadata
object
User metadata.
Join
string[]
List of channels when the event is interval.
Timeout
string[]
List of channels when the event is interval.
Leave
string[]
List of channels when the event is interval.
HereNowRefresh
bool
Flag to indicate whether HereNow fetch is needed.

Other Examples​

Basic subscribe with logging

PNConfiguration pnConfiguration = new PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
// subscribeKey from admin panel
pnConfiguration.SubscribeKey = "my_subkey"; // required
// publishKey from admin panel (only required if publishing)
pnConfiguration.PublishKey = "my_pubkey";
// secretKey (only required for access operations)
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
Pubnub pubnub = new Pubnub(pnConfiguration);

pubnub.Subscribe<string>()
    .Channels(new string[] {
        // subscribe to channels
        "my_channel"
    })
    .Execute();

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.

pubnub.Subscribe<string>()
    .Channels(new string[] {
        // subscribe to channels information
        "my_channel1",
        "my_channel2"
    })
    .Execute();
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.

pubnub.Subscribe<string>()
    .Channels(new string[] {
        // subscribe to channels
        "my_channel"
    })
    .WithPresence() // also subscribe to related presence information
    .Execute();
Sample Responses​
Join Event​
{
    "Event": "join",
    "Uuid": "175c2c67-b2a9-470d-8f4b-1db94f90e39e",
    "Timestamp": 1345546797,
    "Occupancy": 2,
    "State": null,
    "Channel":" my_channel",
    "Subscription": "",
    "Timetoken": 15034141109823424,
    "UserMetadata": null,
    "Join": null,
    "Timeout": null,
    "Leave": null,
    "HereNowRefresh": false
}
Leave Event​
{
    "Event": "leave",
    "Uuid": "175c2c67-b2a9-470d-8f4b-1db94f90e39e",
    "Timestamp": 1345546797,
    "Occupancy": 1,
    "State": null,
    "Channel": "my_channel",
    "Subscription": "",
    "Timetoken": 15034141109823424,
    "UserMetadata": null,
    "Join": null,
    "Timeout": null,
    "Leave": null,
    "HereNowRefresh": false
}
Timeout Event​
{
    "Event": "timeout",
    "Uuid": "175c2c67-b2a9-470d-8f4b-1db94f90e39e",
    "Timestamp": 1345546797,
    "Occupancy": 0,
    "State": null,
    "Channel": "my_channel",
    "Subscription": "",
    "Timetoken": 15034141109823424,
    "UserMetadata": null,
    "Join": null,
    "Timeout": null,
    "Leave": null,
    "HereNowRefresh": false
}
State Change Event​
{
    "Event": "state-change",
    "Uuid": "175c2c67-b2a9-470d-8f4b-1db94f90e39e",
    "Timestamp": 1345546797,
    "Occupancy": 1,
    "State": {
        "isTyping": true
    },
    "Channel": "my_channel",
    "Subscription": "",
    "Timetoken": 15034141109823424,
    "UserMetadata": null,
    "Join": null,
    "Timeout": null,
    "Leave": null,
show all 17 lines
Interval Event​
{
    "Event": "interval",
    "Uuid": "175c2c67-b2a9-470d-8f4b-1db94f90e39e",
    "Timestamp": 1345546797,
    "Occupancy": 2,
    "State": null,
    "Channel": "my_channel",
    "Subscription": "",
    "Timetoken": 15034141109823424,
    "UserMetadata": null,
    "Join": null,
    "Timeout": null,
    "Leave": null,
    "HereNowRefresh": false
}

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
  • timed out

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

{
    "Event": "interval",
    "Uuid": "175c2c67-b2a9-470d-8f4b-1db94f90e39e",
    "Timestamp": <unix timestamp>,
    "Occupancy": <# users in channel>,
    "State": null,
    "Channel": "my_channel",
    "Subscription": "",
    "Timetoken": 15034141109823424,
    "UserMetadata": null,
    "Join": ["uuid2", "uuid3"],
    "Timeout": ["uuid1"],
    "Leave": null,
    "HereNowRefresh": false
}

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.

{
    "Event": "interval",
    "Uuid": "175c2c67-b2a9-470d-8f4b-1db94f90e39e",
    "Timestamp": <unix timestamp>,
    "Occupancy": <# users in channel>,
    "State": null,
    "Channel": "my_channel",
    "Subscription": "",
    "Timetoken": 15034141109823424,
    "UserMetadata": null,
    "Join": null,
    "Timeout": null,
    "Leave": null,
    "HereNowRefresh": true
}
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 * portion refers to any part of the channel string name after the dot (.).

pubnub.Subscribe<string>()
    .Channels(new string[] {
        // subscribe to channels information
        "foo.*"
    })
    .Execute();
Wildcard grants and revokes

Only one level (a.*) of using wildcards 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 UserId

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.

PNConfiguration pnConfiguration = new PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
pnConfiguration.SubscribeKey = "demo";
pnConfiguration.PublishKey = "demo";
Pubnub pubnub = new Pubnub(pnConfiguration);
SubscribeCallbackListener listener = new()
listener.onStatus += (pubnub, status) => {
    if (status.Category == PNStatusCategory.PNConnectedCategory) {
        Dictionary<string, object> data = new Dictionary<string, object>();
        data.Add("FieldA", "Awesome");
        data.Add("FieldB", 10);

        pubnub.SetPresenceState()
            .Channels(new string[] { "awesomeChannel" })
            .ChannelGroups(new string[] { "awesomeChannelGroup" })
            .State(data)
show all 28 lines
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.

pubnub.Subscribe<string>()
    .Channels(new string[] {
        // subscribe to channels
        "ch1",
        "ch2"
    })
    .ChannelGroups(new string[] {
        // subscribe to channel groups
        "cg1",
        "cg2"
    })
    .WithTimetoken(1337L) // optional, pass a timetoken
    .WithPresence() // also subscribe to related presence information
    .Execute();
Subscribe to the presence channel of a channel group​
Requires Stream Controller and Presence add-ons

This method requires 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.

pubnub.Subscribe<string>()
    .ChannelGroups(new string[] {
        // subscribe to channel groups
        "cg1",
        "cg2"
    })
    .WithTimetoken(1337L) // optional, pass a timetoken
    .WithPresence() // also subscribe to related presence information
    .Execute();
Subscribe with a Custom Type​

Unity supports subscribing with custom types. However only one type of message can be subscribed for a given channel. If you want to subscribe different types of messages for the same channel, then subscribing using the generic type as string is the recommended option.

public class Phone
    {
        public string Number { get; set; }
        public string Extenion { get; set; }

        [JsonConverter(typeof(StringEnumConverter))]
        public PhoneType PhoneType { get; set; }
    }

    public enum PhoneType
    {
        Home,
        Mobile,
        Work
    }
show all 64 lines

Event Listeners​

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

Listeners should be added before calling the method.

Add Listeners​
using PubnubApi;
using PubnubApi.Unity;

pubnub = new Pubnub(pnConfiguration);
var listener = new SubscribeCallbackListener();
pubnub.AddListener(listener);

listener.onStatus += OnPnStatus;
listener.onMessage += OnPnMessage;
listener.onPresence += OnPnPresence;
listener.onFile += OnPnFile;
listener.onObject += OnPnObject;
listener.onSignal += OnPnSignal;
listener.onMessageAction += OnPnMessageAction;

show all 42 lines
Removing Listeners​
protected override void OnDestroy() {
    // Use OnDestroy to clean up, e.g. unsubscribe from listeners.
    listener.onStatus -= OnPnStatus;
    listener.onMessage -= OnPnMessage;
    listener.onPresence -= OnPnPresence;
    listener.onFile -= OnPnFile;
    listener.onObject -= OnPnObject;
    listener.onSignal -= OnPnSignal;
    listener.onMessageAction -= OnPnMessageAction;
    
    base.OnDestroy();
}
Listener status events​
CategoryDescription
PNNetworkIssuesCategory
A subscribe event experienced connection issues when running.
PNReconnectedCategory
SDK was able to reconnect to pubnub.
PNConnectedCategory
SDK subscribed with a new mix of channels (fired every time the channel / channel group mix changed).
PNAcknowledgmentCategory
An API call was successful. This status has additional details based on the type of the successful operation.
PNAccessDeniedCategory
Request failed because of access error (active Access Manager). status.AffectedChannels or status.AffectedChannelGroups contain list of channels and/or groups to which user with specified auth key doesn't have access.
PNTimeoutCategory
Used API didn't receive a response from server in time.
PNDisconnectedCategory
Client unsubscribed from specified real-time data channels.
PNUnexpectedDisconnectCategory
Subscribe loop failed and at this moment client is disconnected from real-time data channels. This could due to the machine or device is not connected to Internet or this has been lost, your ISP (Internet Service Provider) is having to troubles or perhaps or the SDK is behind of a proxy.
PNBadRequestCategory
Request cannot be completed as not all required values have been passed (like subscribe key, publish key) or passed values are of unexpected data type.
PNMalformedFilterExpressionCategory
Subscription request cannot be processed as the passed filter expression is malformed and cannot be evaluated.
PNMalformedResponseCategory
Request received in response non-JSON data. It can be because of an error message from the proxy server (if applicable).
PNDecryptionErrorCategory
Message Persistence API may return this status category in case if some messages can't be decrypted.
PNTLSConnectionFailedCategory
TLS handshake issues. In most cases is because of poor network quality and packets loss and delays.
PNRequestMessageCountExceededCategory
This status event will be fired each time the client receives more messages than the value of RequestMessageCountThreshold, set in PNConfiguration.
PNReconnectionAttemptsExhausted
In case of network disconnect the PubNub client SDK will attempt to reconnect a finite number of times after which this status is sent and the re-connection attempts will stop.
PNUnknownCategory
PubNub SDK returns this error for SDK exceptions or when server responds with an error.

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 Unity SDK:

pubnub.Unsubscribe<string>()
    .Channels(Array)
    .ChannelGroups(Array)
    .QueryParam(Dictionary<string,object>)
    .Execute()
* required
ParameterDescription
Channels
Type: Array
Unsubscribe to channels, Either Channels or ChannelGroups is required
ChannelGroups
Type: Array
Unsubscribe to channel groups, Either channels or channelGroup is required
QueryParam
Type: Dictionary<string, object>
Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
Execute *
Type: Command
Command that will execute Unsubscribe.

Basic Usage​

Unsubscribe from a channel:

pubnub.Unsubscribe<string>()
     .Channels(new string[] {
        "my_channel"
     })
     .Execute();
Event listeners

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

Returns​

None

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.

pubnub.Unsubscribe<string>()
    .Channels(new string[] {
        "ch1",
        "ch2",
        "ch3"
    })
    .ChannelGroups(new string[] {
        "cg1",
        "cg2",
        "cg3"
    })
    .Execute();
Example Response​
{
    "Category": "PNDisconnectedCategory",
    "ErrorData": null,
    "Error": false,
    "StatusCode": 200,
    "Operation": "PNUnsubscribeOperation",
    "TlsEnabled": false,
    "Uuid": null,
    "AuthKey": null,
    "Origin": "ps.pndsn.com",
    "ClientRequest": null,
    "AffectedChannels": ["ch1","ch2","ch3"],
    "AffectedChannelGroups": ["cg1","cg2","cg3"]
}
Unsubscribe from a channel group​
pubnub.Unsubscribe<string>()
    .ChannelGroups(new string[] {
        "cg1",
        "cg2",
        "cg3"
    })
    .Execute();
Example Response​
{
    "Category": "PNDisconnectedCategory",
    "ErrorData": null,
    "Error": false,
    "StatusCode": 200,
    "Operation": "PNUnsubscribeOperation",
    "TlsEnabled": false,
    "Uuid": null,
    "AuthKey": null,
    "Origin": "ps.pndsn.com",
    "ClientRequest": null,
    "AffectedChannels": [],
    "AffectedChannelGroups": ["cg1","cg2","cg3"]
}

Unsubscribe All (old)​

Not recommended

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

Method(s)​

pubnub.UnsubscribeAll<string>()
    .QueryParam(Dictionary<string,object>)
* required
ParameterDescription
QueryParam
Type: Dictionary<string, object>
Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.

Basic Usage​

pubnub.UnsubscribeAll();

Returns​

None

Last updated on
On this page