App Context API for C# SDK

This page describes App Context (formerly Objects v2). To upgrade from Objects v1, refer to the migration guide.

App Context provides easy-to-use, serverless storage for user and channel data you need to build innovative, reliable, scalable applications. Use App Context to easily store metadata about your application users and channels, and their membership associations, without the need to stand up your own databases.

PubNub also triggers events when object data is changed: set, updated, or removed from the database. At the same time, making a request to set the same data that already exist, doesn't trigger any event. Clients can receive these events in real time and update their front-end application accordingly.

Request execution

We recommend using try and catch statements when working with the C# SDK.

If there's an issue with the provided API parameter values, like missing a required parameter, the SDK throws an exception. However, if there is a server-side API execution issue or a network problem, the error details are contained within the status.

try
{
    PNResult<PNPublishResult> publishResponse = await pubnub.Publish()
        .Message("Why do Java developers wear glasses? Because they can't C#.")
        .Channel("my_channel")
        .ExecuteAsync();

    PNStatus status = publishResponse.Status;

    Console.WriteLine("Server status code : " + status.StatusCode.ToString());
}
catch (Exception ex)
{
    Console.WriteLine($"Request can't be executed due to error: {ex.Message}");
}

User

Get Metadata for All Users

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

Method(s)

To Get All UUID Metadata you can use the following method(s) in the C# SDK:

pubnub.GetAllUuidMetadata()
        .IncludeCustom(bool)
        .IncludeCount(bool)
        .Page(PNPageObject)
        .Sort(List<string>)
        .Filter(string)
        .Limit(int)

* required

Parameter	Description
`IncludeCustom` Type: bool	Whether to fetch `Custom` fields or not.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`
`Filter` Type: string	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`Limit` Type: int	Number of objects to return in response. Default is `100`, which is also the maximum value.

Basic Usage

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 System;
using PubnubApi;
using System.Threading.Tasks;

class GetAllUuidMetadataExample
{
    static async Task Main(string[] args)
    {
        // Configuration
        PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
        {
            SubscribeKey = "demo",
            PublishKey = "demo",
            Secure = true
        };
show all 44 lines

Response

{
    "Uuids": [
        {
            "Uuid": "uuid-1",
            "Name": "John Doe",
            "Email": "jack@twitter.com",
            "ExternalId": null,
            "ProfileUrl": null,
            "Custom": null,
            "Updated": "2020-06-17T16:28:14.060718Z"
        },
        {
            "Uuid": "uuid-2",
            "Name": "Bob Cat",
            "Email": "bobc@example.com",
show all 29 lines

Get User Metadata

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

Method(s)

To Get UUID Metadata you can use the following method(s) in the C# SDK:

pubnub.GetUuidMetadata()
        .Uuid(string)
        .IncludeCustom(bool)

* required

Parameter	Description
`Uuid` * Type: string	Unique user identifier. If not supplied then current user's `Uuid` is used.
`IncludeCustom` Type: bool	Whether to fetch `Custom` fields or not.

Basic Usage

// Get Metadata for UUID set in the pubnub instance
PNResult<PNGetUuidMetadataResult> getUuidMetadataResponse = await pubnub.GetUuidMetadata()
    .ExecuteAsync();
PNGetUuidMetadataResult getUuidMetadataResult = getUuidMetadataResponse.Result;
PNStatus status = getUuidMetadataResponse.Status;

// Get Metadata for a specific UUID
PNResult<PNGetUuidMetadataResult> getUuidMetadataResponse = await pubnub.GetUuidMetadata()
    .Uuid("my-uuid")
    .ExecuteAsync();
PNGetUuidMetadataResult getUuidMetadataResult = getUuidMetadataResponse.Result;
PNStatus status = getUuidMetadataResponse.Status;

Response

{
    "Uuid": "uuid-1",
    "Name": "John Doe",
    "Email": "jack@twitter.com",
    "ExternalId": null,
    "ProfileUrl": null,
    "Custom": null,
    "Updated": "2020-06-17T16:28:14.060718Z"
}

Set User Metadata

Unsupported partial updates of custom metadata

The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:

Get the existing metadata and store it locally.
Append the new custom metadata to the existing one.
Set the entire updated custom object.

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

Method(s)

To Set UUID Metadata you can use the following method(s) in the C# SDK:

pubnub.SetUuidMetadata()
        .Uuid(string)
        .Name(string)
        .Email(string)
        .ExternalId(string)
        .ProfileUrl(string)
        .Custom(Dictionary<string, object>)
        .IncludeCustom(bool)
        .IfMatchesEtag(string)

* required

Parameter	Description
`Uuid` * Type: string	Unique user identifier. If not supplied then current user's `Uuid` is used.
`Name` * Type: string	Display name for the user.
`Email` Type: string	The user's email address.
`ExternalId` Type: string	User's identifier in an external system.
`ProfileUrl` Type: string	The URL of the user's profile picture.
`Custom` Type: Dictionary`<string, object>`	JSON object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties.
`IncludeCustom` Type: bool	Whether to fetch `Custom` fields or not.
`IfMatchesEtag` Type: String	The entity tag to be used to ensure updates only happen if the object hasn't been modified since it was read. Use the eTag you received from an applicable get metadata method to check against the server entity tag. If the eTags don't match, an HTTP 412 error is thrown.

API limits

To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.

Basic Usage

// Set Metadata for UUID set in the pubnub instance
PNResult<PNSetUuidMetadataResult> setUuidMetadataResponse = await pubnub.SetUuidMetadata()
    .Uuid(config.Uuid)
    .Name("John Doe")
    .Email("john.doe@user.com")
    .ExecuteAsync();
PNSetUuidMetadataResult setUuidMetadataResult = setUuidMetadataResponse.Result;
PNStatus status = setUuidMetadataResponse.Status;

Response

{
    "Uuid": "uuid-1",
    "Name": "John Doe",
    "Email": "jack@twitter.com",
    "ExternalId": null,
    "ProfileUrl": null,
    "Custom": null,
    "Updated": "2020-06-17T16:28:14.060718Z"
}

Remove User Metadata

Removes the metadata from a specified UUID.

Method(s)

To Remove UUID Metadata you can use the following method(s) in the C# SDK:

pubnub.RemoveUuidMetadata()
        .Uuid(string)

* required

Parameter	Description
`Uuid` * Type: string	Unique user identifier. If not supplied then current user's `Uuid` is used.

Basic Usage

// Remove Metadata for UUID set in the pubnub instance
PNResult<PNRemoveUuidMetadataResult> removeUuidMetadataResponse = await pubnub.RemoveUuidMetadata()
    .ExecuteAsync();
PNRemoveUuidMetadataResult removeUuidMetadataResult = removeUuidMetadataResponse.Result;
PNStatus status = removeUuidMetadataResponse.Status;

Response

{}

Channel

Get Metadata for All Channels

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

Method(s)

To Get All Channel Metadata you can use the following method(s) in the C# SDK:

pubnub.GetAllChannelMetadata()
        .IncludeCustom(bool)
        .IncludeCount(bool)
        .Page(PNPageObject)
        .Sort(List<string>)
        .Filter(string)

* required

Parameter	Description
`IncludeCustom` Type: bool	Whether to fetch `Custom` fields or not.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`
`Filter` Type: string	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.

Basic Usage

PNResult<PNGetAllChannelMetadataResult> getAllChannelMetadataResponse = await pubnub.GetAllChannelMetadata()
    .IncludeCount(true)
    .IncludeCustom(true)
    .ExecuteAsync();

PNGetAllChannelMetadataResult getAllChannelMetadataResult = getAllChannelMetadataResponse.Result;
PNStatus status2 = getAllChannelMetadataResponse.Status;

Response

{
    "Channels": [
        {
            "Channel": "my-channel",
            "Name": "My channel",
            "Description": "A channel that is mine",
            "Custom": null,
            "Updated": "2020-06-17T16:52:19.562469Z"
        },
        {
            "Channel": "main",
            "Name": "Main channel",
            "Description": "The main channel",
            "Custom": {
                "public": true,
show all 26 lines

Get Channel Metadata

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

Method(s)

To Get Channel Metadata you can use the following method(s) in the C# SDK:

pubnub.GetChannelMetadata()
        .Channel(string)
        .IncludeCustom(bool)

* required

Parameter	Description
`Channel` * Type: string	Channel name.
`IncludeCustom` Type: bool	Whether to fetch `Custom` fields or not.

Basic Usage

// Get Metadata for a specific channel
PNResult<PNGetChannelMetadataResult> getChannelMetadataResponse = await pubnub.GetChannelMetadata()
    .Channel("my-channel")
    .IncludeCustom(true)
    .ExecuteAsync();

PNGetChannelMetadataResult getChannelMetadataResult = getChannelMetadataResponse.Result;
PNStatus status = getChannelMetadataResponse.Status;

Response

{
    "Channel": "my-channel",
    "Name": "My channel",
    "Description": "A channel that is mine",
    "Custom": null,
    "Updated": "2020-06-17T16:52:19.562469Z"
}

Set Channel Metadata

Unsupported partial updates of custom metadata

The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:

Get the existing metadata and store it locally.
Append the new custom metadata to the existing one.
Set the entire updated custom object.

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

Method(s)

To Set Channel Metadata you can use the following method(s) in the C# SDK:

pubnub.SetChannelMetadata()
        .Channel(string)
        .Name(string)
        .Description(string)
        .Custom(Dictionary<string, object>)
        .IncludeCustom(bool)
        .IfMatchesEtag(string)

* required

Parameter	Description
`Channel` * Type: string	Channel name.
`Name` Type: string	Name of a channel.
`Description` Type: string	Description of a channel.
`Custom` Type: Dictionary`<string, object>`	Include respective additional fields in the response. App Context filtering language doesn’t support filtering by custom properties.
`IncludeCustom` Type: bool	Whether to fetch `custom` fields or not.
`IfMatchesEtag` Type: String	The entity tag to be used to ensure updates only happen if the object hasn't been modified since it was read. Use the eTag you received from an applicable get metadata method to check against the server entity tag. If the eTags don't match, an HTTP 412 error is thrown.

API limits

To learn about the maximum length of parameters used to set channel metadata, refer to REST API docs.

Basic Usage

// Set Metadata for a specific channel
PNResult<PNSetChannelMetadataResult> setChannelMetadataResponse = await pubnub.SetChannelMetadata()
    .Channel("my-channel")
    .Name("John Doe")
    .Description("sample description")
    .Custom(new Dictionary<string, object>() { { "color", "blue" } })
    .IncludeCustom(true)
    .ExecuteAsync();

PNSetChannelMetadataResult setChannelMetadataResult = setChannelMetadataResponse.Result;
PNStatus status = setChannelMetadataResponse.Status;

Response

{
    "Channel": "my-channel",
    "Name": "John Doe",
    "Description": "sample description",
    "Custom": {
        "color": "blue"
    },
    "Updated": "2020-06-17T16:52:19.562469Z"
}

Other Examples

Iteratively update existing metadata

using PubnubApi;

namespace PubNubExample
{
    class Program
    {
        static async Task Main(string[] args)
        {
            PNConfiguration config = new PNConfiguration(new UserId("example"))
            {
                PublishKey = "demo",
                SubscribeKey = "demo",
            };
            Pubnub pubnub = new Pubnub(config);
            string channel = "team.red";
show all 61 lines

Remove Channel Metadata

Removes the metadata from a specified channel.

Method(s)

To Remove Channel Metadata you can use the following method(s) in the C# SDK:

pubnub.RemoveChannelMetadata()
        .Channel(string)

* required

Parameter	Description
`Channel` * Type: string	Channel name.

Basic Usage

// Delete Metadata for a specific channel
PNResult<PNRemoveChannelMetadataResult> removeChannelMetadataResponse = await pubnub.RemoveChannelMetadata()
    .Channel("mychannel")
    .ExecuteAsync();

PNRemoveChannelMetadataResult removeChannelMetadataResult = removeChannelMetadataResponse.Result;
PNStatus status = removeChannelMetadataResponse.Status;

Response

{}

Channel Memberships

Get Channel Memberships

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

Method(s)

To Get Memberships you can use the following method(s) in the C# SDK:

pubnub.GetMemberships()
        .Uuid(string)
        .Include(PNMembershipField[])
        .IncludeCount(bool)
        .Page(PNPageObject)

* required

Parameter	Description
`Uuid` * Type: string	Unique user identifier. If not supplied then current user's `Uuid` is used.
`Include` Type: PNMembershipField[]	Include respective additional fields in the response.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.

Basic Usage

PNResult<PNGetMembershipsResult> getMembershipsResponse = await pubnub.GetMemberships()
    .Uuid("my-uuid")
    .Include(new PNMembershipField[] { PNMembershipField.CUSTOM, PNMembershipField.CHANNEL, PNMembershipField.CHANNEL_CUSTOM })
    .IncludeCount(true)
    .Page(new PNPageObject() { Next = "", Prev = "" })
    .ExecuteAsync();

PNGetMembershipsResult getMembeshipsResult = getMembershipsResponse.Result;
PNStatus status = getMembershipsResponse.Status;

Response

{
    "Memberships": [
        {
            "ChannelMetadata": {
                "Channel": "my-channel",
                "Name": "My channel",
                "Description": "A channel that is mine",
                "Custom": null,
                "Updated": "2020-06-17T16:55:44.632042Z"
            },
            "Custom": {
                "starred": false
            },
            "Updated": "2020-06-17T17:05:25.987964Z"
        },
show all 38 lines

Set Channel Memberships

Set channel memberships for a UUID.

Method(s)

To Set Memberships you can use the following method(s) in the C# SDK:

pubnub.SetMemberships()
        .Uuid(string)
        .Channels(List<PNMembership>)
        .Include(PNMembershipField[])
        .IncludeCount(bool)
        .Page(PNPageObject)
        .Sort(List<string>)
        .Filter(string)
        .Limit(int)

* required

Parameter	Description
`Uuid` * Type: string	Unique user identifier. If not supplied then current user's `Uuid` is used.
`Channels` * Type: List`<PNMembership>`	List of `Channels` to add to membership. List can contain strings (channel-name only) or objects (which can include custom data).
`Include` Type: PNMembershipField[]	Include respective additional fields in the response.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`
`Filter` Type: string	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`Limit` Type: int	Number of objects to return in response. Default is `100`, which is also the maximum value.

API limits

To learn about the maximum length of parameters used to set channel membership metadata, refer to REST API docs.

PNMembership

* required

Property	Description
`Channel` * Type: `string`	The name of the channel associated with this membership.
`Custom` Type: `Dictionary<string, object>`	A dictionary that stores custom metadata related to the membership, allowing for additional context or information.
`Status` Type: `string`	The status of the membership, for example: "active" or "inactive"
`Type` Type: `string`	The type of membership for categorization purposes.

Basic Usage

List<PNMembership> setMembershipChannelMetadataIdList = new List<PNMembership>();
if (!string.IsNullOrEmpty(seMembershipChannelMetaId))
{
    setMembershipChannelMetadataIdList.Add(new PNMembership() { Channel = "my-channel", Custom = new Dictionary<string, object>() { { "item", "book" } } });
}

PNResult<PNMembershipsResult> setMembershipsResponse = await pubnub.SetMemberships()
    .Uuid("my-uuid")
    .Channels(setMembershipChannelMetadataIdList)
    .Include(new PNMembershipField[] { PNMembershipField.CUSTOM, PNMembershipField.CHANNEL, PNMembershipField.CHANNEL_CUSTOM })
    .IncludeCount(true)
    .ExecuteAsync();

PNMembershipsResult setMembershipsResult = setMembershipsResponse.Result;
PNStatus status = setMembershipsResponse.Status;

Response

{
    "Memberships": [
        {
            "ChannelMetadata": {
                "Channel": "my-channel",
                "Name": "My channel",
                "Description": "A channel that is mine",
                "Custom": null,
                "Updated": "2020-06-17T16:55:44.632042Z"
            },
            "Custom": {
                "starred": false
            },
            "Updated": "2020-06-17T17:05:25.987964Z"
        },
show all 38 lines

Remove Channel Memberships

Remove channel memberships for a UUID.

Method(s)

To Remove Memberships you can use the following method(s) in the C# SDK:

pubnub.RemoveMemberships()
        .Uuid(string)
        .Channels(List<string>)
        .Include(PNMembershipField[])
        .IncludeCount(bool)
        .Page(PNPageObject)
        .Sort(List<string>)
        .Filter(string)
        .Limit(int)

* required

Parameter	Description
`Uuid` Type: String	Unique user identifier. If not supplied then current user's `Uuid` is used.
`Channels` * Type: List`<string>`	Channels to remove from membership.
`Include` Type: PNMembershipField[]	Include respective additional fields in the response.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`
`Filter` Type: string	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`Limit` Type: int	Number of objects to return in response. Default is `100`, which is also the maximum value.

Basic Usage

List<string> removeMembershipList = new List<string>();
if (!string.IsNullOrEmpty(removeMembershipChannelMetaId))
{
    removeMembershipList.Add("my-channel");
    removeMembershipList.Add("your-channel");
}

PNResult<PNMembershipsResult> removeMembershipsResponse = await pubnub.RemoveMemberships()
    .Uuid("uuid")
    .Channels(removeMembershipList)
    .Include(new PNMembershipField[] { PNMembershipField.CUSTOM, PNMembershipField.CHANNEL, PNMembershipField.CHANNEL_CUSTOM })
    .IncludeCount(true)
    .ExecuteAsync();

PNMembershipsResult removeMembershipsResult = removeMembershipsResponse.Result;
show all 16 lines

Response

{
    "Memberships": [
        {
            "ChannelMetadata": {
                "Channel": "my-channel",
                "Name": "My channel",
                "Description": "A channel that is mine",
                "Custom": null,
                "Updated": "2020-06-17T16:55:44.632042Z"
            },
            "Custom": {
                "starred": false
            },
            "Updated": "2020-06-17T17:05:25.987964Z"
        },
show all 38 lines

Manage Channel Memberships

The method Set and Remove channel memberships for a user.

Method(s)

To Manage Memberships you can use the following method(s) in the C# SDK:

pubnub.ManageMemberships()
        .Uuid(string)
        .Set(List<PNMembership>)
        .Remove(List<string>)
        .Include(PNMembershipField[])
        .IncludeCount(bool)
        .Page(PNPageObject)
        .Sort(List<string>)

* required

Parameter	Description
`Uuid` * Type: string	Unique user identifier. If not supplied then current user's `Uuid` is used.
`Set` Type: List`<PNMembership>`	Set channel memberships for the user.
`Remove` Type: List`<string>`	Remove channel memberships for the user.
`Include` Type: PNMembershipField[]	Include respective additional fields in the response.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`

Basic Usage

List<PNMembership> setMembrshipList = new List<PNMembership>();
setMembrshipList.Add(new PNMembership() { Channel = "ch1", Custom = new Dictionary<string, object>() { { "say","hello" } } });
setMembrshipList.Add(new PNMembership() { Channel = "ch2", Custom = new Dictionary<string, object>() { { "say", "world" } } });
setMembrshipList.Add(new PNMembership() { Channel = "ch3", Custom = new Dictionary<string, object>() { { "say", "bye" } } });

List<string> removeMembrshipList = new List<string>();
removeMembrshipList.Add("ch4");

PNResult<PNManageMembershipsResult> manageMmbrshipsResponse = await pubnub.ManageMemberships()
    .Uuid("my-uuid")
    .Set(setMembrshipList)
    .Remove(removeMembrshipList)
    .Include(new PNMembershipField[] { PNMembershipField.CUSTOM, PNMembershipField.CHANNEL, PNMembershipField.CHANNEL_CUSTOM })
    .IncludeCount(true)
    .Page(new PNPageObject() { Next = "", Prev = "" })
show all 20 lines

Response

{
    "Memberships": [
        {
            "ChannelMetadata": {
                "Channel": "my-channel",
                "Name": "My channel",
                "Description": "A channel that is mine",
                "Custom": null,
                "Updated": "2020-06-17T16:55:44.632042Z"
            },
            "Custom": {
                "starred": false
            },
            "Updated": "2020-06-17T17:05:25.987964Z"
        },
show all 38 lines

Channel Members

Get Channel Members

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

Method(s)

To Get Channel Members you can use the following method(s) in the C# SDK:

pubnub.GetChannelMembers()
        .Channel(string)
        .Include(PNChannelMemberField[])
        .IncludeCount(bool)
        .Page(PNPageObject)
        .Sort(List<string>)
        .Filter(string)
        .Limit(int)

* required

Parameter	Description
`Channel` * Type: string	Channel name.
`Include` Type: PNChannelMemberField[]	Include respective additional fields in the response.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`
`Filter` Type: string	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`Limit` Type: int	Number of objects to return in response. Default is `100`, which is also the maximum value.

Basic Usage

// Get Members (uuids) for a specific channel
PNResult<PNChannelMembersResult> getChannelMembersResponse = await pubnub.GetChannelMembers()
    .Channel("my-channel")
    .Include(new PNChannelMemberField[] { PNChannelMemberField.CUSTOM, PNChannelMemberField.UUID, PNChannelMemberField.UUID_CUSTOM })
    .IncludeCount(true)
    .ExecuteAsync();

PNChannelMembersResult getChannelMembersResult = getChannelMembersResponse.Result;
PNStatus status2 = getChannelMembersResponse.Status;

Response

{
    "ChannelMembers": [
        {
            "UuidMetadata": {
                "Uuid": "uuid-1",
                "Name": "John Doe",
                "Email": "jack@twitter.com",
                "ExternalId": "",
                "ProfileUrl": "",
                "Custom": null,
                "Updated": "2019-02-20T23:11:20.89375"
            },
            "Custom": {
                "role": "admin"
            },
show all 39 lines

Set Channel Members

This method sets members in a channel.

Method(s)

To Set Channel Members you can use the following method(s) in the C# SDK:

pubnub.SetChannelMembers().Channel(string).Uuids(List<PNChannelMember>).Include(PNChannelMemberField[]).Page(PNPageObject).Sort(List<string>).Filter(string).Limit(int)

* required

Parameter	Description
`Channel` * Type: String	Channel name.
`Uuids` * Type: List`<PNChannelMember>`	List of members to add to the `channel`. List can contain strings (Uuids only) or objects (which can include custom data).
`Include` Type: PNChannelMemberField[]	Include respective additional fields in the response.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`
`Filter` Type: string	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`Limit` Type: int	Number of objects to return in response. Default is `100`, which is also the maximum value.

API limits

To learn about the maximum length of parameters used to set channel members metadata, refer to REST API docs.

Basic Usage

// Add Members (UUID) for a specific channel
List<PNChannelMember> setMemberChannelList = new List<PNChannelMember>();
if (!string.IsNullOrEmpty(setMemberChUuid))
{
    setMemberChannelList.Add(new PNChannelMember() { Uuid = "my-uuid", Custom = new Dictionary<string, object>() { { "planet", "earth" } } });
}
PNResult<PNChannelMembersResult> setChannelMembersResponse = await pubnub.SetChannelMembers()
    .Channel(setmemberChMetadataId)
    .Uuids(setMemberChannelList)
    .Include(new PNChannelMemberField[] { PNChannelMemberField.CUSTOM, PNChannelMemberField.UUID, PNChannelMemberField.UUID_CUSTOM })
    .IncludeCount(true)
    .ExecuteAsync();

PNChannelMembersResult setChannelMembersResult = setChannelMembersResponse.Result;
PNStatus status2 = setChannelMembersResponse.Status;

Response

{
    "ChannelMembers": [
        {
            "UuidMetadata": {
                "Uuid": "uuid-1",
                "Name": "John Doe",
                "Email": "jack@twitter.com",
                "ExternalId": "",
                "ProfileUrl": "",
                "Custom": null,
                "Updated": "2019-02-20T23:11:20.89375"
            },
            "Custom": {
                "role": "admin"
            },
show all 39 lines

Remove Channel Members

Remove members from a Channel.

Method(s)

To Remove Channel Members you can use the following method(s) in the C# SDK:

pubnub.RemoveChannelMembers()
        .Channel(string)
        .Remove( List)
        .Include(PNChannelMembersInclude[])
        .Limit(int)
        .Count(bool)
        .Start(string)
        .End(string)
        .Sort(List)
        .Async()

* required

Parameter	Description
`Channel` * Type: string	Channel name.
`Uuids` * Type: List`<string>`	Members to remove from channel.
`Include` Type: PNChannelMemberField[]	Include respective additional fields in the response.
`IncludeCount` Type: bool	Request `IncludeCount` to be included in paginated response. By default, `IncludeCount` is omitted.
`Page` Type: PNPageObject	Use for pagination.
`Sort` Type: List`<string>`	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction. For example: `{name: 'asc'}`
`Filter` Type: string	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
`Limit` Type: int	Number of objects to return in response. Default is `100`, which is also the maximum value.

Basic Usage

// Remove Members (UUID) for a specific channel
List<string> removeChannelMemberList = new List<string>();
removeChannelMemberList.Add("my-uuid");
removeChannelMemberList.Add("your-uuid");

PNResult<PNChannelMembersResult> removeChannelMembersResponse = await pubnub.RemoveChannelMembers()
    .Channel("my-channel")
    .Uuids(removeChannelMemberList)
    .Include(new PNChannelMemberField[] { PNChannelMemberField.CUSTOM, PNChannelMemberField.UUID, PNChannelMemberField.UUID_CUSTOM })
    .IncludeCount(true)
    .ExecuteAsync();

PNChannelMembersResult removeChannelMembersResult = removeChannelMembersResponse.Result;
PNStatus status = removeChannelMembersResponse.Status;

Response

{
    "ChannelMembers": [
        {
            "UuidMetadata": {
                "Uuid": "uuid-1",
                "Name": "John Doe",
                "Email": "jack@twitter.com",
                "ExternalId": "",
                "ProfileUrl": "",
                "Custom": null,
                "Updated": "2019-02-20T23:11:20.89375"
            },
            "Custom": {
                "role": "admin"
            },
show all 39 lines

Request execution

User​

Get Metadata for All Users​

Method(s)​

Basic Usage​

Reference code

Response​

Get User Metadata​

Method(s)​

Basic Usage​

Response​

Set User Metadata​

Unsupported partial updates of custom metadata

Method(s)​

API limits

Basic Usage​

Response​

Remove User Metadata​

Method(s)​

Basic Usage​

Response​

Channel​

Get Metadata for All Channels​

Method(s)​

Basic Usage​

Response​

Get Channel Metadata​

Method(s)​

Basic Usage​

Response​

Set Channel Metadata​

Unsupported partial updates of custom metadata

Method(s)​

API limits

Basic Usage​

Response​

Other Examples​

Iteratively update existing metadata​

Remove Channel Metadata​

Method(s)​

Basic Usage​

Response​

Channel Memberships​

Get Channel Memberships​

Method(s)​

Basic Usage​

Response​

Set Channel Memberships​

Method(s)​

API limits

PNMembership​

Basic Usage​

Response​

Remove Channel Memberships​

Method(s)​

Basic Usage​

Response​

Manage Channel Memberships​

Method(s)​

Basic Usage​

Response​

Channel Members​

Get Channel Members​

Method(s)​

Basic Usage​

Response​

Set Channel Members​

Method(s)​

API limits

Basic Usage​

Response​

Remove Channel Members​

Method(s)​

Basic Usage​

Response​

User

Get Metadata for All Users

Method(s)

Basic Usage

Response

Get User Metadata

Method(s)

Basic Usage

Response

Set User Metadata

Method(s)

Basic Usage

Response

Remove User Metadata

Method(s)

Basic Usage

Response

Channel

Get Metadata for All Channels

Method(s)

Basic Usage

Response

Get Channel Metadata

Method(s)

Basic Usage

Response

Set Channel Metadata

Method(s)

Basic Usage

Response

Other Examples

Iteratively update existing metadata

Remove Channel Metadata

Method(s)

Basic Usage

Response

Channel Memberships

Get Channel Memberships

Method(s)

Basic Usage

Response

Set Channel Memberships

Method(s)

PNMembership

Basic Usage

Response

Remove Channel Memberships

Method(s)

Basic Usage

Response

Manage Channel Memberships

Method(s)

Basic Usage

Response

Channel Members

Get Channel Members

Method(s)

Basic Usage

Response

Set Channel Members

Method(s)

Basic Usage

Response

Remove Channel Members

Method(s)

Basic Usage

Response