Configuration API for PubNub C# SDK

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

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` (only required for access operations, keep away from Android).
`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 64 alphanumeric characters. If you don't set the `UserId`, you won't be able to connect to PubNub.
`LogVerbosity`	PNLogVerbosity	Yes	Set `PNLogVerbosity.BODY` to enable debugging. To disable debugging use the option `PNLogVerbosity.NONE`
`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	Set to `PNReconnectionPolicy.LINEAR` for automatic reconnects. Use option `PNReconnectionPolicy.NONE` to disable automatic reconnects. Use option `PNReconnectionPolicy.EXPONENTIAL` to set exponential retry interval.
`PresenceTimeout`	int	Optional	The setting with set the custom presence server timeout.The value is in seconds.
`PresenceInterval`	int	Optional	The setting with set the custom presence server timeout along with the custom interval to send the ping back to the server.The value is in seconds.
`Proxy`	Proxy	Optional	Instruct the SDK to use a `Proxy` configuration when communicating with PubNub servers.
`PubnubLog`	IPubnubLog	Optional	Pass the instance of a class that implements `IPubnubLog` to capture logs for troubleshooting.
`UseClassicHttpWebRequest`	bool	Optional	Use `HttpWebRequest` to support ASP.NET/MVC and other IIS hosting applications.
`EnableTelemetry`	bool	Optional	Enables the SDK to capture analytics in terms of response time and sends them to PubNub server. It is enabled by default.
`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	None
`enableEventEngine`	`Boolean`	Optional	Whether to use the standardized workflows for subscribe and presence. Read Listener status events 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.
~~`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

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.

// UserId passed during initialization
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
// subscribeKey from Admin Portal
pnConfiguration.SubscribeKey = "SubscribeKey"; // required
// publishKey from Admin Portal (only required if publishing)
pnConfiguration.PublishKey = "PublishKey";
// secretKey (only required for access operations)
pnConfiguration.SecretKey = "SecretKey";
// the cryptography module used for encryption and decryption
pnConfiguration.CryptoModule = new CryptoModule(new AesCbcCryptor("enigma"), new List<ICryptor> { new LegacyCryptor("enigma") })
// Enable Debugging
pnConfiguration.LogVebosity = PNLogVerbosity.BODY;
// if Access Manager is utilized, client will use this AuthKey in all restricted
// requests
pnConfiguration.AuthKey = "authKey";
show all 30 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);

Parameter	Type	Required	Description
`pnConfiguration`	PNConfiguration	Yes	Goto Configuration for more details.

Basic Usage

Initialize the PubNub client API

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

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

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

Listeners should be added before calling the method.

Method 1 to add listener

// Adding listener.
pubnub.AddListener(new SubscribeCallbackExt(
    delegate (Pubnub pnObj, PNMessageResult<object> pubMsg)
    {
        Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(pubMsg));
        var channelName = pubMsg.Channel;
        var channelGroupName = pubMsg.Subscription;
        var pubTT = pubMsg.Timetoken;
        var msg = pubMsg.Message;
        var publisher = pubMsg.Publisher;
    },
    delegate (Pubnub pnObj, PNPresenceEventResult presenceEvnt)
    {
        Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(presenceEvnt));
        var action = presenceEvnt.Event; // Can be join, leave, state-change or timeout
show all 80 lines

//Add listener to receive Signal messages
SubscribeCallbackExt signalSubscribeCallback = new SubscribeCallbackExt(
    delegate (Pubnub pubnubObj, PNSignalResult<object> message) {
        // Handle new signal message stored in message.Message
    },
    delegate (Pubnub pubnubObj, PNStatus status)
    {
        // the status object returned is always related to subscribe but could contain
        // information about subscribe, heartbeat, or errors
    }
);
pubnub.AddListener(signalSubscribeCallback);

SubscribeCallbackExt eventListener = new SubscribeCallbackExt(
    delegate (Pubnub pnObj, PNObjectEventResult objectEvent)
    {
        string channelMetadataId = objectEvent.Channel; // The channel
        string uuidMetadataId = objectEvent.Uuid; // The UUID
        string objEvent = objectEvent.Event; // The event name that occurred
        string eventType = objectEvent.Type; // The event type that occurred
        PNUuidMetadataResult uuidMetadata = objectEvent.UuidMetadata; // UuidMetadata
        PNChannelMetadataResult channelMetadata = objectEvent.ChannelMetadata; // ChannelMetadata
    },
    delegate (Pubnub pnObj, PNStatus status)
    {

    }
);
show all 16 lines

Method 2 to add listener

public class DevSubscribeCallback : SubscribeCallback
    {
        public override void Message<T>(Pubnub pubnub, PNMessageResult<T> message)
        {
            // Handle new message stored in message.Message
        }

        public override void Presence(Pubnub pubnub, PNPresenceEventResult presence)
        {
            // handle incoming presence data
        }

        public override void Signal<T>(Pubnub pubnub, PNSignalResult<T> signal)
        {
            // Handle new signal message stored in signal.Message
show all 87 lines

Remove Listeners

SubscribeCallbackExt listenerSubscribeCallack = new SubscribeCallbackExt(
    (pubnubObj, message) => { },
    (pubnubObj, presence) => { },
    (pubnubObj, status) => { });

pubnub.AddListener(listenerSubscribeCallack);

// some time later
pubnub.RemoveListener(listenerSubscribeCallack);

Listener status events

When you initialized your PubNub client with enableEventEngine set to true (default option), the SDK will emit various statuses depending on your client network connection.

If you use the deprecated methods for subscribing and had enableEventEngine set to false, the status list the SDK emits is different.

To help you adjust your app code, see the Status Events for the exact mapping between the current and deprecated C# SDK statuses.

For more generic information, head to SDK Connection Lifecycle.

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

Property	Type	Required	Description
`UserId`	string	Yes	`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

Property	Type	Required	Description
`AuthKey`	string	Yes	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

Property	Type	Required	Description
`FilterExpression`	string	Yes	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;

Configuration​

Method(s)​

CryptoModule​

Legacy encryption with 128-bit cipher key entropy

CryptoModule configuration​

Older SDK versions

Basic Usage​

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​

Method 1 to add listener​

Method 2 to add listener​

Remove Listeners​

Listener status events​

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

Method 1 to add listener

Method 2 to add listener

Remove Listeners

Listener status events

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