Configuration API for C# SDK

C# complete API reference for building real-time applications on PubNub, including basic usage and sample code.

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}");
}

Configuration

PNConfiguration instance is storage for user-provided information which describe further PubNub client behavior. Configuration instance contain additional set of properties which allow to perform precise PubNub client configuration.

Method(s)

To create configuration instance you can use the following function in the C# SDK:

PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));

Properties	Type	Required	Description
`SubscribeKey`	string	Yes	`SubscribeKey` from Admin Portal.
`PublishKey`	string	Optional	`PublishKey` from Admin Portal (only required if publishing).
`SecretKey`	string	Optional	`SecretKey` required for access control operations.
`UserId`	`UserId`	Yes	`UserId` to use. The `UserId` object takes `string` as an argument. You should set a unique identifier for the user or the device that connects to PubNub. It's a UTF-8 encoded string of up to 92 alphanumeric characters. If you don't set the `UserId`, you won't be able to connect to PubNub.
`LogLevel`	`PubnubLogLevel`	No	Enum defining the level of severity captured in logs. Available values: `PubnubLogLevel.Trace` `PubnubLogLevel.Debug` `PubnubLogLevel.Info` `PubnubLogLevel.Warn` `PubnubLogLevel.Error` Default is `PubnubLogLevel.None`, which means logging is off. For more information, refer to Troubleshooting.
`AuthKey`	string	Optional	If Access Manager is utilized, client will use this `AuthKey` in all restricted requests.
`Secure`	bool	Optional	Use `SSL`.
`SubscribeTimeout`	int	Optional	How long to keep the `subscribe` loop running before disconnect. The value is in seconds.
`NonSubscribeRequestTimeout`	int	Optional	On `non subscribe` operations, how long to wait for server response. The value is in seconds.
`FilterExpression`	string	Optional	Feature to subscribe with a custom filter expression.
`HeartbeatNotificationOption`	`PNHeartbeatNotificationOption`	Optional	`Heartbeat` notifications, by default, the SDK will alert on failed heartbeats (equivalent to: `PNHeartbeatNotificationOption.FAILURES`). Other options such as all heartbeats (`PNHeartbeatNotificationOption.ALL`) or no heartbeats (`PNHeartbeatNotificationOption.NONE`) are supported.
`Origin`	string	Optional	Custom `Origin` if needed.
`ReconnectionPolicy`	`PNReconnectionPolicy`	Optional	Custom reconnection configuration parameters. Default is `PNReconnectionPolicy.EXPONENTIAL` (subscribe only). Available values: `PNReconnectionPolicy.NONE` `PNReconnectionPolicy.LINEAR` `PNReconnectionPolicy.EXPONENTIAL` For more information, refer to SDK connection lifecycle.
`ConnectionMaxRetries`	int	Optional	The maximum number of reconnection attempts. If not provided, the SDK will not reconnect. For more information, refer to Reconnection Policy.
`PresenceTimeout`	int	Optional	Defines how long the server considers the client alive for presence. This property works similarly to the concept of long polling by sending periodic requests to the PubNub server at a given interval (like every 300 seconds). These requests ensure the client remains active on subscribed channels. If no heartbeat is received within the timeout period, the client is marked inactive, triggering a "timeout" event on the presence channel.
`SetPresenceTimeoutWithCustomInterval`	int	Optional	Specifies how often the client will send heartbeat signals to the server. This property offers more granular control over client activity tracking than `PresenceTimeout`. Configure this property to achieve a shorter presence timeout if needed, with the interval typically recommended to be `(PresenceTimeout / 2) - 1`.
`Proxy`	Proxy	Optional	Instructs the SDK to use a `Proxy` configuration when communicating with PubNub servers.
`RequestMessageCountThreshold`	Number	Optional	`PNRequestMessageCountExceededCategory` is thrown when the number of messages into the payload is above of `requestMessageCountThreshold`.
`SuppressLeaveEvents`	bool	Optional	When `true` the SDK doesn't send out the leave requests.
`DedupOnSubscribe`	bool	Optional	When `true` duplicates of subscribe messages will be filtered out when devices cross regions.
`MaximumMessagesCacheSize`	int	Optional	It is used with `DedupOnSubscribe` to cache message size.Default is `100`.
`FileMessagePublishRetryLimit`	int	Optional	The number of tries made in case of Publish File Message failure.Default is `5`.
`CryptoModule`	`AesCbcCryptor(CipherKey)` `LegacyCryptor(CipherKey)`	Optional	The cryptography module used for encryption and decryption of messages and files. Takes the `CipherKey` parameter as argument. For more information, refer to the CryptoModule section.
`EnableEventEngine`	`Boolean`	Optional	True by default. Whether to use the standardized workflows for subscribe and presence. Refer to SDK connection lifecycle for more information.
`RetryConfiguration`	`RetryConfiguration`	Optional	(Applicable when `enableEventEngine = true`) Custom reconnection configuration parameters. Available values: `RetryConfiguration.Linear(int delayInSecond, int maxRetry)` `RetryConfiguration.Exponential(int minDelayInSecond, int maxDelayInSecond, int maxRetry)` For more information, refer to Reconnection Policy. The C-sharp SDK doesn't support excluding endpoints.
~~`LogVerbosity`~~	~~`PNLogVerbosity`~~	No	This parameter is deprecated, use `LogLevel` instead. ~~Set `PNLogVerbosity.BODY` to enable debugging. To disable debugging use the option `PNLogVerbosity.NONE`~~
~~`PubnubLog`~~	~~`IPubnubLog`~~	~~Optional~~	This parameter is deprecated, use the `SetLogger` method to configure a custom logger that implements the `IPubnubLogger` interface. ~~Pass the instance of a class that implements `IPubnubLog` to capture logs for troubleshooting.~~
~~`CipherKey`~~	~~string~~	~~Optional~~	This way of setting this parameter is deprecated, pass it to `CryptoModule` instead. ~~If `cipher` is passed, all communications to/from PubNub will be encrypted.~~
~~`UseRandomInitializationVector`~~	~~bool~~	~~Optional~~	This way of setting this parameter is deprecated, pass it to `CryptoModule` instead. ~~When `true` the IV will be random for all requests and not just file upload. When `false` the IV will be hardcoded for all requests except File Upload. Default `false`.~~
~~`Uuid`~~	~~string~~	~~Yes~~	This parameter is deprecated, use `userId` instead. `UUID` to use. You should set a unique `UUID` to identify the user or the device that connects to PubNub. If you don't set the `UUID`, you won't be able to connect to PubNub.

`CryptoModule`

CryptoModule provides encrypt/decrypt functionality for messages and files. From the 6.18.0 release on, you can configure how the actual encryption/decryption algorithms work.

Each PubNub SDK is bundled with two ways of encryption: the legacy encryption with 128-bit cipher key entropy and the recommended 256-bit AES-CBC encryption. For more general information on how encryption works, refer to the Message Encryption and File Encryption sections.

If you do not explicitly set the CryptoModule in your app and have the CipherKey and UseRandomInitializationVector params set in PubNub config, the client defaults to using the legacy encryption.

Legacy encryption with 128-bit cipher key entropy

You don't have to change your encryption configuration if you want to keep using the legacy encryption. If you want to use the recommended 256-bit AES-CBC encryption, you must explicitly set that in PubNub config.

`CryptoModule` configuration

To configure the CryptoModule to encrypt all messages/files, you can use the following methods in the C# SDK:

// encrypts using 256-bit AES-CBC cipher (recommended)
// decrypts data encrypted with the legacy and the 256-bit AES-CBC ciphers
pnConfiguration.CryptoModule = new CryptoModule(new AesCbcCryptor("enigma"), new List<ICryptor> { new LegacyCryptor("enigma") })

// encrypts with 128-bit cipher key entropy (legacy)
// decrypts data encrypted with the legacy and the 256-bit AES-CBC ciphers
pnConfiguration.CryptoModule = new CryptoModule(new LegacyCryptor("enigma"), new List<ICryptor> { new AesCbCCryptor("enigma") })

Your client can decrypt content encrypted using either of the modules. This way, you can interact with historical messages or messages sent from older clients while encoding new messages using the more secure 256-bit AES-CBC cipher.

Older SDK versions

Apps built using the SDK versions lower than 6.18.0 will not be able to decrypt data encrypted using the 256-bit AES-CBC cipher. Make sure to update your clients or encrypt data using the legacy algorithm.

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.

Required UserId

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

using System;
using System.Collections.Generic;
using PubnubApi;

class ConfigurationExample
{
    static void Main(string[] args)
    {
        // Create a configuration instance for PubNub
        PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
        {
            SubscribeKey = "demo", // Required
            PublishKey = "demo",   // Only required if publishing
            SecretKey = "SecretKey", // Only required for access operations
            Secure = true, // Enable SSL
show all 35 lines

Initialization

Include the code

using PubnubApi;

Description

This function is used for initializing the PubNub Client API context. This function must be called before attempting to utilize any API functionality in order to establish account level credentials such as PublishKey and SubscribeKey.

Method(s)

To Initialize PubNub you can use the following method(s) in the C# SDK:

new Pubnub(pnConfiguration);

* required

Parameter	Description
`pnConfiguration` * Type: PNConfiguration	Goto Configuration for more details.

Basic Usage

Initialize the PubNub client API

Required UserId

using PubnubApi;

class InitializationExample
{
    static void Main(string[] args)
    {
        // Initialize PubNub using the configuration
        PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
        {
            SubscribeKey = "demo",
            PublishKey = "demo",
            Secure = true
        };

        // Create the PubNub instance with the configuration
show all 19 lines

Returns

It returns the PubNub instance for invoking PubNub APIs like Publish(), Subscribe(), History(), HereNow(), etc.

Other Examples

Initialize a non-secure client

Required UserId

PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
pnConfiguration.PublishKey = "my_pubkey";
pnConfiguration.SubscribeKey = "my_subkey";
pnConfiguration.Secure = false;
Pubnub pubnub = new Pubnub(pnConfiguration);

Initialization for a Read-Only client

In the case where a client will only read messages and never publish to a channel, you can simply omit the PublishKey when initializing the client:

Required UserId

PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
pnConfiguration.SubscribeKey = "my_subkey";
Pubnub pubnub = new Pubnub(pnConfiguration);

Initializing with SSL Enabled

This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with Secure set to true. The hard work is done, now the PubNub API takes care of the rest. Just subscribe and publish as usual and you are good to go.

Required UserId

PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
pnConfiguration.PublishKey = "my_pubkey";
pnConfiguration.SubscribeKey = "my_subkey";
pnConfiguration.Secure = true;
Pubnub pubnub = new Pubnub(pnConfiguration);

Requires Access Manager add-on

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

Secure your 'secretKey'

Anyone with the SecretKey can grant and revoke permissions to your app. Never let your SecretKey be discovered, and to only exchange it / deliver it securely. Only use the SecretKey on secure server-side platforms.

When you init with SecretKey, you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels.

For applications that will administer Access Manager permissions, the API is initialized with the SecretKey as in the following example:

Required UserId

PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
pnConfiguration.PublishKey = "my_pubkey";
pnConfiguration.SubscribeKey = "my_subkey";
pnConfiguration.SecretKey = "my_secretkey";
pnConfiguration.Secure = true;

Pubnub pubnub = new Pubnub(pnConfiguration);

Now that the pubnub object is instantiated the client will be able to access the Access Manager functions. The pubnub object will use the SecretKey to sign all Access Manager messages to the PubNub Network.

Event Listeners

PubNub SDKs provide several sources for real-time updates:

The PubNub client can receive updates from all subscriptions: all channels, channel groups, channel metadata, and users.
The Subscription object can receive updates only for the particular object for which it was created: channel, channel group, channel metadata, or user.
The SubscriptionsSet object can receive updates for all objects for which a list of subscription objects was created.

To facilitate working with those real-time update sources, PubNub SDKs use local representations of server entities that allow you to subscribe and add handlers on a per-entity basis. For more information, refer to Publish & Subscribe.

UserId

These functions are used to set/get a user ID on the fly.

Property(s)

To set/get UserId you can use the following property(s) in C# SDK:

config.UserId = new UserId("myUserId");

* required

Property	Description
`UserId` * Type: string	`UserId` to be used as a device identifier. If you don't set the `UserId`, you won't be able to connect to PubNub.

pubnub.GetCurrentUserId();

This method doesn't take any arguments.

Basic Usage

Set User ID

Required UserId

PNConfiguration pnConfiguration = new PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
config.UserId = new UserId("myUserId");

Get User ID

var currentUserId = pubnub.GetCurrentUserId();

Authentication Key

Setter and getter for users auth key.

Property(s)

AuthKey

* required

Property	Description
`AuthKey` * Type: string	If Access Manager is utilized, client will use this `AuthKey` in all restricted requests.

pnConfiguration.AuthKey;

This method doesn't take any arguments.

Basic Usage

Set Auth Key

PNConfiguration pnConfiguration = new PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
pnConfiguration.AuthKey = "authKey";

Get Auth Key

var sampleAuthKey = pnConfiguration.AuthKey;

Returns

Get Auth key returns the current authentication key.

Filter Expression

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.

Stream filtering allows a subscriber to apply a filter to only receive messages that satisfy the conditions of the filter. The message filter is set by the subscribing client(s) but it is applied on the server side thus preventing unwanted messages (those that do not meet the conditions of the filter) from reaching the subscriber.

To set or get message filters, you can use the following property. To learn more about filtering,refer to the Publish Messages documentation.

Property(s)

FilterExpression

* required

Property	Description
`FilterExpression` * Type: string	PSV2 feature to `Subscribe` with a custom filter expression.

pnConfiguration.FilterExpression;

This method doesn't take any arguments.

Basic Usage

Set Filter Expression

Required UserId

PNConfiguration pnConfiguration = new PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
pnConfiguration.FilterExpression = "such=wow";

Get Filter Expression

var sampleFilterExp = pnConfiguration.FilterExpression;

Request execution

Configuration​

Method(s)​

CryptoModule​

Legacy encryption with 128-bit cipher key entropy

CryptoModule configuration​

Older SDK versions

Basic Usage​

Reference code

Required UserId

Initialization​

Include the code​

Description​

Method(s)​

Basic Usage​

Initialize the PubNub client API​

Required UserId

Returns​

Other Examples​

Initialize a non-secure client​

Required UserId

Initialization for a Read-Only client​

Required UserId

Initializing with SSL Enabled​

Required UserId

Requires Access Manager add-on

Secure your 'secretKey'

Required UserId

Event Listeners​

UserId​

Property(s)​

Basic Usage​

Set User ID​

Required UserId

Get User ID​

Authentication Key​

Property(s)​

Basic Usage​

Set Auth Key​

Get Auth Key​

Returns​

Filter Expression​

Requires Stream Controller add-on

Property(s)​

Basic Usage​

Set Filter Expression​

Required UserId

Get Filter Expression​

Configuration

Method(s)

`CryptoModule`

`CryptoModule` configuration

Basic Usage

Initialization

Include the code

Description

Method(s)

Basic Usage

Initialize the PubNub client API

Returns

Other Examples

Initialize a non-secure client

Initialization for a Read-Only client

Initializing with SSL Enabled

Event Listeners

UserId

Property(s)

Basic Usage

Set User ID

Get User ID

Authentication Key

Property(s)

Basic Usage

Set Auth Key

Get Auth Key

Returns

Filter Expression

Property(s)

Basic Usage

Set Filter Expression

Get Filter Expression