C#C# V4 Presence API Reference for Realtime Apps

 

These docs are for PubNub 4.0 for C# which is our latest and greatest! For the docs of the 3.x versions of the SDK, please check the links: C#, Windows 8, Windows 8.1, ASP.Net, Windows Phone 8, Windows Phone 8.1, Xamarin.iOS, Xamarin.Android, Xamarin.Mac and C# PCL.

If you have questions about the PubNub for C# SDK, please contact us at support@pubnub.com.

Presence enables you to track the online and offline status of users and devices in realtime, as well as 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.


Requires Presence add-on XRequires that the Presence add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-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.
To call Here Now you can use the following method(s) in the C# V4 SDK:
  1. ParameterTypeRequiredDescription
    ChannelsArrayOptionalThe Channels to get the here now details.
    ChannelGroupsArrayOptionalThe ChannelGroups to get the here now details.
    IncludeStateboolOptionalIf true, the response will include the presence states of the users for Channels/ChannelGroups.
    IncludeUUIDsboolOptionalIf true, the response will include the UUIDs of the connected clients.
    QueryParamDictionary<string, object>OptionalDictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
    AsyncPNCallbackDeprecatedPNCallback of type PNHereNowResult.
    ExecutePNCallbackYesPNCallback of type PNHereNowResult.
    ExecuteAsyncNoneOptionalReturns PNResult<PNHereNowResult>.
PNResult<PNHereNowResult> herenowResponse = await pubnub.HereNow()
                                                        // tailor the next two lines to example
                                                        .Channels(new string[] {
                                                            "coolChannel",
                                                            "coolChannel2"
                                                            })
                                                        .IncludeUUIDs(true)
                                                        .ExecuteAsync();
PNHereNowResult herenowResult = herenowResponse.Result;
PNStatus status = herenowResponse.Status;
if (status.Error)
{
    // handle error
    return;
}
if (herenowResult != null && herenowResult.Channels != null && herenowResult.Channels.Count > 0)
{
    foreach (KeyValuePair<string, PNHereNowChannelData> kvp in herenowResult.Channels)
    {
        PNHereNowChannelData channelData = kvp.Value;
        Console.WriteLine("---");
        Console.WriteLine("channel:" + channelData.ChannelName);
        Console.WriteLine("occupancy:" + channelData.Occupancy);
        Console.WriteLine("Occupants:");
        if (channelData.Occupants != null && channelData.Occupants.Count > 0)
        {
            for (int index = 0; index < channelData.Occupants.Count; index++)
            {
                PNHereNowOccupantData occupant = channelData.Occupants[index];
                Console.WriteLine(string.Format("uuid: {0}", occupant.Uuid));
                Console.WriteLine(string.Format("state:{0}", (occupant.State != null) ?
                pubnub.JsonPluggableLibrary.SerializeToJsonString(occupant.State) : ""));
            }
        }
    }
}
The HereNow() operation returns a PNResult<PNHereNowResult> which contains the following properties:
Property NameTypeDescription
ResultPNHereNowResultReturns a PNHereNowResult object.
StatusPNStatusReturns a PNStatus object.
PNHereNowResult contains the following properties:
Property NameTypeDescription
TotalChannelsintTotal Channels.
TotalOccupancyintTotal Occupancy.
ChannelsDictionary<string, PNHereNowChannelData>A map with values of PNHereNowChannelData for each channel. See PNHereNowChannelData for more details.
Property NameTypeDescription
ChannelNamestringChannel name.
OccupancyintOccupancy of the channel.
OccupantsList<PNHereNowOccupantData>A list of PNHereNowOccupantData, see PNHereNowOccupantData for more details.
Property NameTypeDescription
UuidstringUUIDs of the user.
StateobjectState of the user.
  1. pubnub.HereNow()
        // tailor the next two lines to example
        .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) {
                        PNHereNowChannelData channelData = kvp.Value;
                        Console.WriteLine("---");
                        Console.WriteLine("channel:" + channelData.ChannelName);
                        Console.WriteLine("occupancy:" + channelData.Occupancy);
                        Console.WriteLine("Occupants:");
                        if (channelData.Occupants != null && channelData.Occupants.Count > 0) {
                            for (int index = 0; index < channelData.Occupants.Count; index++) {
                                PNHereNowOccupantData occupant = channelData.Occupants[index];
                                Console.WriteLine(string.Format("uuid: {0}", occupant.Uuid));
                                Console.WriteLine(string.Format("state:{1}", (occupant.State != null) ?
                                pubnub.JsonPluggableLibrary.SerializeToJsonString(occupant.State) : ""));
                            }
                        }
                    }
                }
            }
        ));
  2. Requires Presence add-on XRequires that the Presence add-on is enabled for your key. See this page on enabling add-on features on your keys:

    http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-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
    {
    	"status" : 200,
    	"message" : "OK",
    	"service" : "Presence",
    	"uuids" : [
    		{
    			"uuid" : "myUUID0"
    		},
    		{
    			"state" : {
    				"abcd" : {
    					"age" : 15
    				}
    			},
    			"uuid" : "myUUID1"
    		},
    		{
    			"uuid" : "b9eb408c-bcec-4d34-b4c4-fabec057ad0d"
    		},
    		{
    			"state" : {
    				"abcd" : {
    					"age" : 15
    				}
    			},
    			"uuid" : "myUUID2"
    		},
    		{
    			"state" : {
    				"abcd" : {
    					"age" : 24
    				}
    			},
    			"uuid" : "myUUID9"
    		}
    	],
    	"occupancy" : 5
    }
  3. Requires Presence add-on XRequires that the Presence add-on is enabled for your key. See this page on enabling add-on features on your keys:

    http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-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
    {
        "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" ],
                    "occupancy": 1
                }
            },
            "total_channels": 3,
            "total_occupancy": 3
        },
        "service": "Presence"
    }
  4. Requires Presence add-on XRequires that the Presence add-on is enabled with Global Here Now checked for your key. See this page on enabling add-on features on your keys:

    http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
    You can return the list of UUIDs and occupancy for all channels by omitting the channel:
    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(true) // if false, only shows occupancy count
        .ExecuteAsync();
    
    PNHereNowResult herenowResult = herenowResponse.Result;
    PNStatus status = herenowResponse.Status;
    //handle it
    {
        "total_channels" : 2,
        "total_occupancy" : 3,
        "channels" : {
            "lobby" : {
                "occupancy" : 1,
                "uuids" : [
                    "dara01"
                ]
            },
            "game01" : {
                "occupancy" : 2,
                "uuids" : [
                    "jason01",
                    "jason02"
                ]
            }
        }
    }
  5. Requires Presence add-on XRequires that the Presence add-on is enabled with Global Here Now checked for your key. See this page on enabling add-on features on your keys:

    http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
    You can return only the occupancy information (Global Here Now) by omitting the channel name
    PNResult<PNHereNowResult> herenowResponse = await pubnub.HereNow()
            .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
    
    {
        "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" ],
                    "occupancy": 1
                }
            },
            "total_channels": 3,
            "total_occupancy": 3
        },
        "service": "Presence"
    }
  6. PNResult<PNHereNowResult> herenowResponse = await pubnub.HereNow()
        .ChannelGroups(new string[] {
            // who is present on channel groups?
            "cg1",
            "cg1",
            "cg3"
        })
        .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
    {
    	occupancy : 4,
    	uuids : ['123123234t234f34fq3dq', '143r34f34t34fq34q34q3', '23f34d3f4rq34r34rq23q', 'w34tcw45t45tcw435tww3']
    }

Requires Presence add-on XRequires that the Presence add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-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.
 
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.
To call WhereNow() you can use the following method(s) in the C# V4 SDK:
  1. ParameterTypeRequiredDescription
    UuidstringOptionalUuid.
    QueryParamDictionary<string, object>OptionalDictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
    AsyncCommandDeprecatedPNCallback of type PNWhereNowResult.
    ExecuteCommandYesPNCallback of type PNWhereNowResult.
    ExecuteAsyncNoneOptionalReturns PNResult<PNWhereNowResult>.
You simply need to define the uuid and the callback function to be used to send the data to as in the example below.
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.
The WhereNow() operation returns a PNResult<PNWhereNowResult> which contain the following properties:
Property NameTypeDescription
ResultPNWhereNowResultReturns a PNWhereNowResult object.
StatusPNStatusReturns a PNStatus object.
PNWhereNowResult contains the following properties:
Property NameTypeDescription
ChannelsList<string>The list of channels where the UUID is present.
  1. pubnub.WhereNow()
        .Execute(new PNWhereNowResultExt(
            (result, status) => {
                // returns a pojo with channels
                // channel groups which I am part of.
            }
        ));
  2. 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

Requires Presence add-on XRequires that the Presence add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-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.
  1. ParameterTypeRequiredDescription
    ChannelsArrayOptionalChannels to set state.
    ChannelGroupsArrayOptionalChannelGroups to set state.
    StateDictionary<string, object>OptionalState to set.
    UuidstringOptionalUuid
    QueryParamDictionary<string, object>OptionalDictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
    AsyncPNCallbackDeprecatedPNCallback of type PNSetStateResult.
    ExecutePNCallbackYesPNCallback of type PNSetStateResult.
    ExecuteAsyncNoneOptionalReturns PNResult<PNSetStateResult>.
  1. ParameterTypeRequiredDescription
    ChannelsArrayOptionalChannel name to fetch the state.
    ChannelGroupsArrayOptionalChannelGroups name to fetch the state.
    UuidstringOptionalUuid
    QueryParamDictionary<string, object>OptionalDictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
    AsyncPNCallbackDeprecatedPNCallback of type PNGetStateResult.
    ExecutePNCallbackYesPNCallback of type PNGetStateResult.
    ExecuteAsyncNoneOptionalReturns PNResult<PNGetStateResult>.
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
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();

PNGetStateResult getstateResult = getstateResponse.Result;
PNStatus status = getstateResponse.Status;
// handle response
The SetPresenceState() operation returns a PNResult<PNSetStateResult> which contains the following properties:
Property NameTypeDescription
ResultPNGetStateResultReturns a PNSetStateResult object.
StatusPNStatusReturns a PNStatus object.
PNSetStateResult contains the following property:
Property NameTypeDescription
StateDictionary<string, object>Dictionary of UUIDs and the user states.
The GetPresenceState() operation returns a PNResult<PNGetStateResult> which contains the following properties:
Property NameTypeDescription
ResultPNGetStateResultReturns a PNGetStateResult object.
StatusPNStatusReturns a PNStatus object.
PNGetStateResult contains the following property:
Property NameTypeDescription
StateByUUIDDictionary<string, object>Dictionary of UUIDs and the user states.
  1. 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
            }
        ));
  2. 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(
            (result, status) => {
                // handle response
            }
        ));
  3. 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"
        })
        .State(myState) // the new state
        .ExecuteAsync();
    
    PNSetStateResult setstateResult = setstateResponse.Result;
    PNStatus status = setstateResponse.Status;
    // on new state for those channels
    The above code would return the following response to the client:
    {
    	first  : "Robert",
    	last   : "Plant",
    	age    : 59,
    	region : "UK"
    }