Configuration API for C# SDK

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

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

8    PNStatus status = publishResponse.Status;
9

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

Configuration​

PNConfiguration stores user-provided settings that control how the C# Software Development Kit (SDK) behaves. Use these properties to fine-tune client behavior and get a prototype running fast.

Method(s)​

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

1

CryptoModule​

CryptoModule encrypts and decrypts messages and files. From 6.18.0 onward, you can configure the algorithms it uses.

Each SDK includes two options: legacy 128-bit encryption and recommended 256-bit AES-CBC. For background, see Message Encryption and File Encryption.

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.

For detailed encryption configuration, utility methods for encrypting/decrypting messages and files, and practical examples, see the dedicated Encryption page.

Sample code​

1

Initialization​

Include the code​

1

Description​

Initialize the PubNub client and set credentials such as PublishKey and SubscribeKey.

Method(s)​

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

1

Sample code​

Initialize the PubNub client API​

1

Returns​

Returns a PubNub instance for APIs like Publish(), Subscribe(), History(), and HereNow().

Other examples​

Initialize a non-secure client​

1

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:

1

Initializing with SSL enabled​

This example shows how to enable Transport Layer Encryption (SSL). Initialize the client with Secure set to true, then subscribe and publish as usual.

1

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

1

After initialization with SecretKey, the client can access Access Manager functions. The client signs Access Manager messages with the SecretKey.

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 work with these sources, the SDK provides local representations of server entities, so you can subscribe and add handlers per entity. For details, see Publish & Subscribe.

UserId​

Set or get the user ID at runtime.

Property(s)​

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

1

1pubnub.GetCurrentUserId();

This method doesn't take any arguments.

Sample code​

Set user ID​

1

Get user ID​

1

Authentication key​

Set and get the user authentication key.

Property(s)​

1pnConfiguration.AuthKey

This method doesn't take any arguments.

Sample code​

Set auth key​

1

Get auth key​

1

Returns​

Get Auth key returns the current authentication key.

Filter expression​

Stream filtering lets a subscriber receive only messages that match a filter. The client sets the filter, and the server applies it to block unmatched messages.

Use the following property to set or get message filters. For details, see Publish Messages.

Property(s)​

1FilterExpression

1pnConfiguration.FilterExpression;

This method doesn't take any arguments.

Sample code​

Set filter expression​

1

Get filter expression​

1