Utility Methods API for C# SDK
The methods on this page are utility methods that don't fit into other categories.
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}");
}
Destroy
Destroy frees up the threads and allows for clean exit.
Method(s)
destroy()
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;
class DestroyExample
{
static void Main(string[] args)
{
// Configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
SubscribeKey = "demo",
PublishKey = "demo",
Secure = true
};
show all 26 linesReturns
None
Encrypt
This function allows to encrypt
the data.
Deprecated
The cipherKey
parameter in this method is deprecated. We recommend that you configure a seprate instance of the crypto module and use it for partial encryption.
If you pass cipherKey
as an argument, it overrides the crypto module configuration and the legacy encryption with 128-bit cipher key entropy is used.
Method(s)
To encrypt
the data you can use the following method(s) in C# SDK.
pubnub.Encrypt(inputString, cipherKey)
Parameter | Description |
---|---|
inputString *Type: String | The data to encrypt . |
cipherKey Type: String | Cipher key to use for encryption. |
Basic Usage
Encrypt part of message
string stringToEncrypt = "hello world";
var crypto = PubnubApi.Security.Crypto.CryptoModule.CreateAesCbcCryptor("test");
crypto.Encrypt(stringToEncrypt);
Encrypt File
This function allow to encrypt
the file content/data.
Deprecated
The cipherKey
parameter in this method is deprecated. We recommend that you configure a seprate instance of the crypto module and use it for partial encryption.
If you pass cipherKey
as an argument, it overrides the crypto module configuration and the legacy encryption with 128-bit cipher key entropy is used.
Method(s)
To encrypt
the file you can use the following method(s) in C# SDK.
pubnub.EncryptFile(sourceFile, destinationFile)
pubnub.EncryptFile(sourceFile, destinationFile, cipherKey)
Parameter | Description |
---|---|
sourceFile *Type: String | File to be encrypted. |
destinationFile *Type: String | Path of the encrypted file to be saved. |
cipherKey Type: String | Cipher Key to use for encryption. If provided, the legacy encryption with 128-bit cipher key entropy is used. If not provided, the CryptoModule from PubNub config will be used. For more information, refer to Crypto module configuration. |
byte[] outputBytes = pubnub.EncryptFile(sourceBytes) byte[] outputBytes = pubnub.EncryptFile(sourceBytes, cipherKey)
Parameter | Description |
---|---|
sourceBytes *Type: byte[] | byte array of the file. |
cipherKey Type: String | Cipher Key to use for encryption. If provided, the legacy encryption with 128-bit cipher key entropy is used. If not provided, the CryptoModule from PubNub config will be used. For more information, refer to Crypto module configuration. |
Basic Usage
string source_file = "cat_picture.jpg"; // checks bin folder if no path is provided
string destination_file = "destination_cat_pic.jpg"; // checks bin folder if no path is provided
var crypto = PubnubApi.Security.Crypto.CryptoModule.CreateAesCbcCryptor("test");
crypto.EncryptFile(source_file, destination_file);
byte[] sourceBytes = System.IO.File.ReadAllBytes("cat_picture.jpg"); // checks bin folder if no path is provided
var crypto = PubnubApi.Security.Crypto.CryptoModule.CreateAesCbcCryptor("test");
byte[] outputBytes = crypto.EncryptFile(sourceBytes);
System.IO.File.WriteAllBytes("destination_cat_pic.jpg", outputBytes); // checks bin folder if no path is provided
Decrypt
This function allows to decrypt
the data.
Deprecated
The cipherKey
parameter in this method is deprecated. We recommend that you configure a seprate instance of the crypto module and use it for partial encryption.
If you pass cipherKey
as an argument, it overrides the crypto module configuration and the legacy encryption with 128-bit cipher key entropy is used.
Method(s)
To decrypt
the data you can use the following method(s) in C# SDK.
pubnub.Decrypt(inputString, cipherKey)
Parameter | Description |
---|---|
inputString *Type: String | The data to decrypt . |
cipherKey Type: String | Cipher key to use for encryption. |
Basic Usage
Decrypt part of message
var crypto = PubnubApi.Security.Crypto.CryptoModule.CreateAesCbcCryptor("test");
crypto.Decrypt(encryptedString);
Decrypt File
This function allow to decrypt
the file content/data.
Method(s)
To decrypt
the file you can use the following method(s) in C# SDK.
pubnub.DecryptFile(sourceFile, destinationFile); pubnub.DecryptFile(sourceFile, destinationFile, cipherKey);
Parameter | Description |
---|---|
sourceFile *Type: String | File to be decrypted. |
destinationFile *Type: String | Path of the decrypted file to be saved. |
cipherKey Type: String | Cipher Key to use for decryption. If provided, the legacy encryption with 128-bit cipher key entropy is used. If not provided, the CryptoModule from PubNub config will be used. For more information, refer to Crypto module configuration. |
byte[] outputBytes = pubnub.DecryptFile(sourceBytes) byte[] outputBytes = pubnub.DecryptFile(sourceBytes, cipherKey)
Parameter | Description |
---|---|
sourceBytes *Type: byte[] | byte array of the file. |
cipherKey Type: String | Cipher Key to use for decryption. If provided, the legacy encryption with 128-bit cipher key entropy is used. If not provided, the CryptoModule from PubNub config will be used. For more information, refer to Crypto module configuration. |
Basic Usage
string source_file = "encrypted_cat_pic.jpg"; // checks bin folder if no path is provided
string destination_file = "cat_pic_original.jpg"; // checks bin folder if no path is provided
var crypto = PubnubApi.Security.Crypto.CryptoModule.CreateAesCbcCryptor("test");
crypto.DecryptFile(source_file, destination_file);
byte[] sourceBytes = System.IO.File.ReadAllBytes("encrypted_cat_pic.jpg"); // checks bin folder if no path is provided
var crypto = PubnubApi.Security.Crypto.CryptoModule.CreateAesCbcCryptor("test");
byte[] outputBytes = crypto.DecryptFile(sourceBytes);
System.IO.File.WriteAllBytes("cat_pic_original.jpg", outputBytes); // checks bin folder if no path is provided
Disconnect
Call the Disconnect
method to force the SDK to stop all requests to PubNub server when there are active subscribe channels.
Method(s)
To disconnect
the data transmission you can use the following method(s) in C# SDK.
Disconnect<T>()
This method doesn't take any arguments.
Basic Usage
pubnub.Disconnect<string>();
Get Subscribed Channel Groups
Returns all the subscribed channel groups in a List of type String
.
Method(s)
To Get Subscribe Channel Groups
you can use the following method(s) in the C# SDK:
List<string> GetSubscribedChannelGroups()
Basic Usage
Get Subscribed Channel Groups
List<string> groups = pubnub.GetSubscribedChannelGroups();
Response
List<String>
["channelGroup1", "channelGroup2"]
Get Subscribed Channels
Returns all the subscribed channels in a List of type String
.
Method(s)
To Get Subscribed Channels
you can use the following method(s) in the C# SDK:
List<string> GetSubscribedChannels()
Basic Usage
Get Subscribed Channels
List<string> channels = pubnub.GetSubscribedChannels();
Response
List<String>
["channel1", "channel2"]
Reconnect
Call the reconnect
method to force the SDK to try and reach out PubNub.
Method(s)
To reconnect
the data you can use the following method(s) in C# SDK.
Reconnect<T>(bool resetSubscribeToken)
Parameter | Description |
---|---|
resetSubscribeToken Type: bool | Passing true will send zero timetoken upon reconnect. |
Basic Usage
pubnub.Reconnect<string>();
Time
This function will return a 17 digit precision Unix epoch.
Algorithm constructing the timetoken
timetoken = (Unix epoch time in seconds) * 10000000
Example of creating a timetoken for a specific time and date:
08/19/2013 @ 9:20pm in UTC = 1376961606
timetoken = 1376961606 * 10000000
timetoken = 13769616060000000
Method(s)
To fetch Time
you can use the following method(s) in C# SDK:
pubnub.QueryParam(Dictionary<string,object>).Time()
Parameter | Description |
---|---|
QueryParam Type: Dictionary <string, object> | Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose. |
Async Type: PNCallback | PNCallback of type PNTimeResult . |
Execute *Type: PNCallback | PNCallback of type PNTimeResult . |
Basic Usage
Get PubNub Timetoken
pubnub.Time()
.Execute(new PNTimeResultExt(
(result, status) => {
// handle time result.
}
));
Returns
The Time
operation returns a PNTimeResult
which contains the following property:
Property Name | Type | Description |
---|---|---|
Timetoken | long | Returns a long representation of current timetoken. |