Presence API for PubNub Unity SDK

Presence enables you to track the online and offline status of users and devices in real time and store custom state information. Presence provides authoritative information on:

When a user has joined or left a channel
Who, and how many, users are subscribed to a particular channel
Which channel(s) an individual user is subscribed to
Associated state information for these users

Learn more about our Presence feature here.

Presence event modes

Presence mode indicates when presence events are triggered for that channel. It can be either:

Announce Mode
Interval Mode

The mode is dependant on the occupancy count.
This setting is controlled through Admin Portal. To learn more about this, visit Presence documentation.

Here Now

Requires Presence add-on

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

You can obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count of the channel by calling the HereNow() function in your application.

Cache

This method has a 3 second response cache time.

Method(s)

To call Here Now you can use the following method(s) in the Unity SDK:

pubnub.HereNow()
    .Channels(Array)
    .ChannelGroups(Array)
    .IncludeState(bool)
    .IncludeUUIDs(bool)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNHereNowResult, PNStatus>)

Parameter	Type	Required	Description
`Channels`	Array	Optional	The `Channels` to get the `here now` details.
`ChannelGroups`	Array	Optional	The `ChannelGroups` to get the `here now` details.
`IncludeState`	bool	Optional	If `true`, the response will include the presence states of the users for `Channels`/`ChannelGroups`.
`IncludeUUIDs`	bool	Optional	If `true`, the response will include the `UUIDs` of the connected clients.
`QueryParam`	Dictionary`<string, object>`	Optional	Dictionary `object` to pass name/value pairs as query `string` params with PubNub URL request for debug purpose.
~~`Async`~~	~~PNCallback~~	~~Deprecated~~	~~`PNCallback` of type `PNHereNowResult`.~~
`Execute`	`System.Action`	Yes	`System.Action` of type `PNHereNowResult`.
`ExecuteAsync`	None	Optional	Returns `Task<PNResult<PNHereNowResult>>`.

Basic Usage

Get a list of UUIDs subscribed to channel

PNResult<PNHereNowResult> herenowResponse = await pubnub.HereNow()
    .Channels(new string[]
    {
        "coolChannel",
        "coolChannel2"
    })
    .IncludeUUIDs(true)
    .ExecuteAsync();

PNHereNowResult herenowResult = herenowResponse.Result;
PNStatus status = herenowResponse.Status;

if (status.Error)
{
    // handle error
show all 42 lines

Returns

The HereNow() operation returns a PNResult<PNHereNowResult> which contains the following properties:

Property Name	Type	Description
`Result`	PNHereNowResult	Returns a `PNHereNowResult` object.
`Status`	PNStatus	Returns a `PNStatus` object.

PNHereNowResult contains the following properties:

Property Name	Type	Description
`TotalChannels`	int	Total `Channels`.
`TotalOccupancy`	int	Total `Occupancy`.
`Channels`	`Dictionary<string, PNHereNowChannelData>`	A map with values of `PNHereNowChannelData` for each `channel`. See PNHereNowChannelData for more details.

PNHereNowChannelData

Property Name	Type	Description
`ChannelName`	string	`Channel` name.
`Occupancy`	int	`Occupancy` of the `channel`.
`Occupants`	List`<PNHereNowOccupantData>`	A list of `PNHereNowOccupantData`, see PNHereNowOccupantData for more details.

PNHereNowOccupantData

Property Name	Type	Description
`Uuid`	string	`UUIDs` of the user.
`State`	object	`State` of the user.

Other Examples

Get a list of UUIDs subscribed to channel synchronously

pubnub.HereNow()
    .Channels(new string[] {
        "coolChannel",
        "coolChannel2"
        })
    .IncludeUUIDs(true)
    .Execute(new PNHereNowResultEx(
        (result, status) => {
            if (status.Error) {
                // handle error
                return;
            }

            if (result.Channels != null && result.Channels.Count > 0) {
                foreach (KeyValuePair<string, PNHereNowChannelData> kvp in result.Channels) {
show all 32 lines

Returning State

Requires Presence add-on

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

PNResult<PNHereNowResult> herenowResponse = await pubnub.HereNow()
    .Channels(new string[] {
        // who is present on those channels?
        "my_channel"
    })
    .IncludeState(true) // include state with request (false by default)
    .IncludeUUIDs(true) // if false, only shows occupancy count
    .ExecuteAsync();

PNHereNowResult herenowResult = herenowResponse.Result;
PNStatus status = herenowResponse.Status;
//handle it

Example Response

{
    "status" : 200,
    "message" : "OK",
    "service" : "Presence",
    "uuids" : [
        {
            "uuid" : "myUUID0"
        },
        {
            "state" : {
                "abcd" : {
                    "age" : 15
                }
            },
            "uuid" : "myUUID1"
show all 38 lines

Return Occupancy Only

Requires Presence add-on

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

You can return only the occupancy information for a single channel by specifying the channel and setting UUIDs to false:

PNResult<PNHereNowResult> herenowResponse = await pubnub.HereNow()
    .Channels(new string[] {
            // who is present on those channels?
        "my_channel"
    })
    .IncludeState(false) // include state with request (false by default)
    .IncludeUUIDs(false) // if false, only shows occupancy count
    .ExecuteAsync();

PNHereNowResult herenowResult = herenowResponse.Result;
PNStatus status = herenowResponse.Status;
//handle it

Example Response

{
    "status": 200,
    "message": "OK",
    "payload": {
        "channels": {
            "81d8d989-b95f-443c-a726-04fac323b331": {
                "uuids": [ "70fc1140-22b5-4abc-85b2-ff8c17b24d59" ],
                "occupancy": 1
            },
            "81b7a746-d153-49e2-ab70-3037a75cec7e": {
                "uuids": [ "91363e7f-584b-49cc-822c-52c2c01e5928" ],
                "occupancy": 1
            },
            "c068d15e-772a-4bcd-aa27-f920b7a4eaa8": {
                "uuids": [ "ccfac1dd-b3a5-4afd-9fd9-db11aeb65395" ],
show all 23 lines

Where Now

Requires Presence add-on

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

You can obtain information about the current list of channels to which a UUID is subscribed to by calling the WhereNow() function in your application.

Timeout events

If the app is killed/crashes and restarted (or the page containing the PubNub instance is refreshed on the browser) within the heartbeat window no timeout event is generated.

Method(s)

To call WhereNow() you can use the following method(s) in the Unity SDK:

pubnub.WhereNow()
    .Uuid(string)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNWhereNowResult, PNStatus>)

Parameter	Type	Required	Description
`Uuid`	string	Yes	`Uuid`.
`QueryParam`	Dictionary`<string, object>`	Optional	Dictionary `object` to pass name/value pairs as query `string` params with PubNub URL request for debug purpose.
~~`Async`~~	~~Command~~	~~Deprecated~~	~~`PNCallback` of type `PNWhereNowResult`.~~
`Execute`	`System.Action`	Yes	`System.Action` of type `PNWhereNowResult`.
`ExecuteAsync`	None	Optional	Returns `Task<PNResult<PNWhereNowResult>>`.

Basic Usage

You simply need to define the uuid and the callback function to be used to send the data to as in the example below.

Get a list of channels a UUID is subscribed to

PNResult<PNWhereNowResult> wherenowResponse = await pubnub.WhereNow()
    .ExecuteAsync();

PNWhereNowResult wherenowResult = wherenowResponse.Result;
PNStatus status = wherenowResponse.Status;
// returns a pojo with channels
// channel groups which I am part of.

Returns

The WhereNow() operation returns a PNResult<PNWhereNowResult> which contain the following properties:

Property Name	Type	Description
`Result`	PNWhereNowResult	Returns a `PNWhereNowResult` object.
`Status`	PNStatus	Returns a `PNStatus` object.

PNWhereNowResult contains the following properties:

Property Name	Type	Description
`Channels`	List`<string>`	The list of `channels` where the `UUID` is present.

Other Examples

Get a list of channels synchronously

pubnub.WhereNow()
    .Execute(new PNWhereNowResultExt(
        (result, status) => {
            // returns a pojo with channels
            // channel groups which I am part of.
        }
    ));

Obtain information about the current list of channels of some other UUID

PNResult<PNWhereNowResult> wherenowResponse = await pubnub.WhereNow()
    .Uuid("some-other-uuid") // uuid of the user we want to spy on.
    .ExecuteAsync();

PNWhereNowResult wherenowResult = wherenowResponse.Result;
PNStatus status = wherenowResponse.Status;
// returns a pojo with channels
// channel groups which "some-other-uuid" part of.ere_now_example_1

User State

Requires Presence add-on

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

The state API is used to set/get key/value pairs specific to a subscriber Uuid.

State information is supplied as a Generic Dictionary object(Dictionary<string, object>) of key/value pairs.

Method(s)

Set State

pubnub.SetPresenceState()
    .Channels(Array)
    .ChannelGroups(Array)
    .State(Dictionary<string, object>)
    .Uuid(string)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNSetStateResult, PNStatus>)

Parameter	Type	Required	Description
`Channels`	Array	Optional	`Channels` to set `state`.
`ChannelGroups`	Array	Optional	`ChannelGroups` to set `state`.
`State`	Dictionary`<string, object>`	Optional	`State` to set.
`Uuid`	string	Yes	`Uuid`
`QueryParam`	Dictionary`<string, object>`	Optional	Dictionary `object` to pass name/value pairs as query `string` params with PubNub URL request for debug purpose.
~~`Async`~~	~~PNCallback~~	~~Deprecated~~	~~`PNCallback` of type `PNSetStateResult`.~~
`Execute`	`System.Action`	Yes	`System.Action` of type `PNSetStateResult`.
`ExecuteAsync`	None	Optional	Returns `Task<PNResult<PNSetStateResult>>`.

Get State

pubnub.GetPresenceState()
    .Channels(Array)
    .ChannelGroups(Array)
    .Uuid(string)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNGetStateResult, PNStatus>)

Parameter	Type	Required	Description
`Channels`	Array	Optional	`Channel` name to fetch the `state`.
`ChannelGroups`	Array	Optional	`ChannelGroups` name to fetch the `state`.
`Uuid`	string	Yes	`Uuid`
`QueryParam`	Dictionary`<string, object>`	Optional	Dictionary `object` to pass name/value pairs as query `string` params with PubNub URL request for debug purpose.
~~`Async`~~	~~PNCallback~~	~~Deprecated~~	~~`PNCallback` of type `PNGetStateResult`.~~
`Execute`	`System.Action`	Yes	`System.Action` of type `PNGetStateResult`.
`ExecuteAsync`	None	Optional	Returns `Task<PNResult<PNGetStateResult>>`.

Basic Usage

Set State

Dictionary<string, object> myState = new Dictionary<string, object>();
myState.Add("age", 20);

PNResult<PNSetStateResult> setstateResponse = await pubnub.SetPresenceState()
    .Channels(new string[] {
        "ch1",
        "ch2",
        "ch3"
    })
    .State(myState)
    .ExecuteAsync();

PNSetStateResult setstateResult = setstateResponse.Result;
PNStatus status = setstateResponse.Status;
// handle set state response

Get State

PNResult<NGetStateResult> getstateResponse = await pubnub.GetPresenceState()
    .Channels(new string[] {
        // channels to fetch state for
        "ch1",
        "ch2",
        "ch3"
    })
    .ChannelGroups(new string[] {
        // channel groups to fetch state for
        "cg1",
        "cg2",
        "cg3"
    })
    .Uuid("suchUUID") // uuid of user to fetch, or for own uuid
    .ExecuteAsync();
show all 19 lines

Returns

The SetPresenceState() operation returns a PNResult<PNSetStateResult> which contains the following properties:

Property Name	Type	Description
`Result`	PNGetStateResult	Returns a `PNSetStateResult` object.
`Status`	PNStatus	Returns a `PNStatus` object.

PNSetStateResult contains the following property:

Property Name	Type	Description
`State`	Dictionary`<string, object>`	Dictionary of `UUIDs` and the user states.

The GetPresenceState() operation returns a PNResult<PNGetStateResult> which contains the following properties:

Property Name	Type	Description
`Result`	PNGetStateResult	Returns a `PNGetStateResult` object.
`Status`	PNStatus	Returns a `PNStatus` object.

PNGetStateResult contains the following property:

Property Name	Type	Description
`StateByUUID`	Dictionary`<string, object>`	Dictionary of `UUIDs` and the user states.

Other Examples

Set state synchronously

Dictionary<string, object> myState = new Dictionary<string, object>();
myState.Add("age", 20);

pubnub.SetPresenceState()
    .Channels(new string[] {
        "ch1",
        "ch2",
        "ch3"
    })
    .State(myState)
    .Execute(new PNSetStateResultExt(
        (result, status) => {
            // handle set state response
        }
    ));

Get state synchronously

pubnub.GetPresenceState()
    .Channels(new string[] {
        // channels to fetch state for
        "ch1",
        "ch2",
        "ch3"
    })
    .ChannelGroups(new string[] {
        // channel groups to fetch state for
        "cg1",
        "cg2",
        "cg3"
    })
    .Uuid("suchUUID") // uuid of user to fetch, or for own uuid
    .Execute(new PNGetStateResultExt(
show all 19 lines

Set state for channels in channel group

Dictionary<string, object> myState = new Dictionary<string, object>();
myState.Add("age", 20);

PNResult<PNSetStateResult> setstateResponse = await pubnub.SetPresenceState()
    .ChannelGroups(new string[] {
        // apply on those channel groups
        "cg1",
        "cg2",
        "cg3"
    })
    .Channels(new string[] {
        // apply on those channels
        "ch1",
        "ch2",
        "ch3"
show all 22 lines

The above code would return the following response to the client:

{
    first  : "Robert",
    last   : "Plant",
    age    : 59,
    region : "UK"
}

Presence event modes

Here Now​

Requires Presence add-on

Cache

Method(s)​

Basic Usage​

Get a list of UUIDs subscribed to channel​

Returns​

PNHereNowChannelData​

PNHereNowOccupantData​

Other Examples​

Get a list of UUIDs subscribed to channel synchronously​

Returning State​

Requires Presence add-on

Example Response​

Return Occupancy Only​

Requires Presence add-on

Example Response​

Where Now​

Requires Presence add-on

Timeout events

Method(s)​

Basic Usage​

Get a list of channels a UUID is subscribed to​

Returns​

Other Examples​

Get a list of channels synchronously​

Obtain information about the current list of channels of some other UUID​

User State​

Requires Presence add-on

Method(s)​

Set State​

Get State​

Basic Usage​

Set State​

Get State​

Returns​

Other Examples​

Set state synchronously​

Get state synchronously​

Set state for channels in channel group​

Here Now

Method(s)

Basic Usage

Get a list of UUIDs subscribed to channel

Returns

PNHereNowChannelData

PNHereNowOccupantData

Other Examples

Get a list of UUIDs subscribed to channel synchronously

Returning State

Example Response

Return Occupancy Only

Example Response

Where Now

Method(s)

Basic Usage

Get a list of channels a UUID is subscribed to

Returns

Other Examples

Get a list of channels synchronously

Obtain information about the current list of channels of some other UUID

User State

Method(s)

Set State

Get State

Basic Usage

Set State

Get State

Returns

Other Examples

Set state synchronously

Get state synchronously

Set state for channels in channel group