C#C# V4 Storage & Playback API Reference for Realtime Apps

 

These docs are for PubNub 4.0 for C# which is our latest and greatest! For the docs of the 3.x versions of the SDK, please check the links: C#, Windows 8, Windows 8.1, ASP.Net, Windows Phone 8, Windows Phone 8.1, Xamarin.iOS, Xamarin.Android, Xamarin.Mac and C# PCL.

If you have questions about the PubNub for C# SDK, please contact us at support@pubnub.com.

The PubNub Storage and Playback Service provides real-time access to history for all messages published to PubNub. Each published message is timestamped to the nearest 10 nanoseconds, and is stored across multiple availability zones in several geographical data center locations. Stored messages can be encrypted with AES-256 message encryption, ensuring that they are not readable while stored on PubNub's network.

Messages can be stored for a configurable duration or forever, as controlled by the retention policy that is configured on your account. The following options are available: 1 day, 7 days, 1 month, and Forever.


Requires Storage & Playback add-on XRequires that the Storage & Playback add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function fetches historical messages of a channel.
It is possible to control how messages are returned and in what order, for example you can:
  • Search for messages starting on the newest end of the timeline (default behavior - Reverse = false)
  • Search for messages from the oldest end of the timeline by setting Reverse to true.
  • Page through results by providing a Start OR End time token.
  • Retrieve a slice of the time line by providing both a Start AND End time token.
  • Limit the number of messages to a specific quantity using the Count parameter.
 
Start & End parameter usage clarity:
If only the Start parameter is specified (without End), you will receive messages that are older than and up to that Start timetoken value.
If only the End parameter is specified (without Start) you will receive messages that match that End timetoken value and newer.
Specifying values for both Start and End parameters will return messages between those timetoken values (inclusive on the End value).
Keep in mind that you will still receive a maximum of 100 messages even if there are more messages that meet the timetoken values. Iterative calls to history adjusting the Start timetoken is necessary to page through the full set of results if more than 100 messages meet the timetoken values.
To run History you can use the following method(s) in the C# V4 SDK
  1. ParameterTypeRequiredDescription
    ChannelstringYesSpecifies Channelto return history messages from.
    IncludeMetaboolOptionalWhether meta (passed when Publishing the message) should be included in response or not.
    ReverseboolOptionalSetting to true will traverse the time line in reverse starting with the oldest message first.
    IncludeTimetokenboolOptionalWhether event dates time tokens should be included in response or not.
    StartlongOptionalTime token delimiting the Start of time slice (exclusive) to pull messages from.
    EndlongOptionalTime token delimiting the End of time slice (inclusive) to pull messages from.
    CountintOptionalSpecifies the number of historical messages to return.
    QueryParamDictionary<string, object>OptionalDictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
    AsyncPNCallbackDeprecatedPNCallback of type PNHistoryResult.
    ExecutePNCallbackYesPNCallback of type PNHistoryResult.
    ExecuteAsyncNoneOptionalReturns PNResult<PNHistoryResult>.
Retrieve the last 100 messages on a channel:
PNResult<PNHistoryResult> historyResponse = await pubnub.History()
    .Channel("history_channel") // where to fetch history from
    .Count(100) // how many items to fetch
    .ExecuteAsync();
The History() operation returns a PNResult<PNHistoryResult> which contains the following properties:
Property NameTypeDescription
ResultPNHistoryResultReturns a PNHistoryResult object.
StatusPNStatusReturns a PNStatus object.
PNHistoryResult which contains the following properties:
Property NameTypeDescription
MessagesList<PNHistoryItemResult>List of messages of type PNHistoryItemResult. See PNHistoryItemResult for more details.
StartTimetokenlongStart timetoken.
EndTimetokenlongEnd timetoken.
Property NameTypeDescription
TimetokenlongTimetoken of the message.
EntryobjectMessage.
  1. pubnub.History()
        .Channel("history_channel") // where to fetch history from
        .Count(100) // how many items to fetch
        .Execute(new PNHistoryResultExt(
            (result, status) => {
            }
        ));
  2. PNResult<PNHistoryResult> historyResponse = await pubnub.History()
        .Channel("my_channel") // where to fetch history from
        .Count(3) // how many items to fetch
        .Reverse(true) // should go in reverse?
        .ExecuteAsync();
    
    {
        "Messages":[
    	    {
                "Timetoken": 0,
                "Entry": "Pub1"
            },
    	    {
                "Timetoken": 0,
                "Entry": "Pub2"
            },	
    	    {
                "Timetoken": 0,
                "Entry": "Pub3"
            }
    	],
        "StartTimeToken": 13406746729185766,
        "EndTimeToken": 13406746780720711
    }
    
  3. PNResult<PNHistoryResult> historyResponse = await pubnub.History()
        .Channel("my_channel") // where to fetch history from
        .Start(13847168620721752L) // first timestamp
        .Reverse(true) // should go in reverse?
        .ExecuteAsync();
    
    {
        "Messages":[
            {
                "Timetoken": 0,
                "Entry": "Pub3"
            },
            {
                "Timetoken": 0,
                "Entry": "Pub4"
            },
            {
                "Timetoken": 0,
                "Entry": "Pub5"
            }
        ],
        "StartTimeToken": 13406746780720711,
        "EndTimeToken": 13406746845892666
    }
    
  4. PNResult<PNHistoryResult> historyResponse = await pubnub.History()
        .Channel("my_channel") // where to fetch history from
        .Count(100) // how many items to fetch
        .Start(-1) // first timestamp
        .End(13847168819178600L) // last timestamp
        .Reverse(true) // should go in reverse?
        .ExecuteAsync();
    
    {
        "Messages":[
            {
                "Timetoken": 0,
                "Entry": "Pub3"
            },
            {
                "Timetoken": 0,
                "Entry": "Pub4"
            },
            {
                "Timetoken": 0,
                "Entry": "Pub5"
            }
        ],
        "StartTimeToken": 13406746780720711,
        "EndTimeToken": 13406746845892666
    }
    
  5.  
    Usage!
    You can call the method by passing 0 or a valid time token as the argument.
    public class PubnubRecursiveHistoryFetcher {
        private static Pubnub pubnub;
    
        public abstract class CallbackSkeleton {
            public abstract void HandleResponse(PNHistoryResult result);
        }
    
        public PubnubRecursiveHistoryFetcher() {
            // NOTICE: for demo/demo pub/sub keys Storage & Playback is disabled,
            // so use your pub/sub keys instead
            PNConfiguration pnConfiguration = new PNConfiguration();
            pnConfiguration.SubscribeKey = "demo";
            pubnub = new Pubnub(pnConfiguration);
        }
    
        static public void Main() {
            PubnubRecursiveHistoryFetcher fetcher = new PubnubRecursiveHistoryFetcher();
            GetAllMessages(new DemoCallbackSkeleton());
        }
    
        public static void GetAllMessages(CallbackSkeleton callback) {
            GetAllMessages(-1L, callback);
        }
    
        public static void GetAllMessages(long startTimestamp, CallbackSkeleton callback) {
            CountdownEvent latch = new CountdownEvent(1);
    
            pubnub.History()
                .Channel("history_channel") // where to fetch history from
                .Count(100) // how many items to fetch
                .Start(startTimestamp) // first timestamp
                .Execute(new DemoHistoryResult(callback));
        }
    
        public class DemoHistoryResult : PNCallback<PNHistoryResult> {
            CallbackSkeleton internalCallback;
            public DemoHistoryResult(CallbackSkeleton callback) {
                this.internalCallback = callback;
            }
            public override void OnResponse(PNHistoryResult result, PNStatus status) {
                if (!status.Error && result != null && result.Messages != null && result.Messages.Count > 0) {
                    Console.WriteLine(result.Messages.Count);
                    Console.WriteLine("start:" + result.StartTimeToken.ToString());
                    Console.WriteLine("end:" + result.EndTimeToken.ToString());
    
                    internalCallback.HandleResponse(result);
                    GetAllMessages(result.EndTimeToken, this.internalCallback);
                }
            }
        };
    
        public class DemoCallbackSkeleton : CallbackSkeleton {
            public override void HandleResponse(PNHistoryResult result) {
                //Handle the result
            }
        }
    }
  6. PNResult<PNHistoryResult> historyResponse = await pubnub.History()
        .Channel("history_channel") // where to fetch history from
        .Count(100) // how many items to fetch
        .IncludeTimetoken(true) // include timetoken with each entry
        .ExecuteAsync();

Requires Storage & Playback add-on XRequires that the Storage & Playback add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.

This function fetches historical messages from multiple channels. The includeMessageActions flag also allows you to fetch message actions along with the messages.

It's possible to control how messages are returned and in what order. For example, you can:

  • Search for messages starting on the newest end of the timeline.
  • Search for messages from the oldest end of the timeline.
  • Page through results by providing a Start OR End time token.
  • Retrieve a slice of the time line by providing both a Start AND End time token.
  • Limit the number of messages to a specific quantity using the Count parameter.

Batch history returns up to 25 messages per channel, on a maximum of 500 channels. Use the start and end timestamps to page through the next batch of messages.

Start and End parameter usage clarity

If you specify only the Start parameter (without End), you will receive messages that are older than and up to that Start timetoken.

If you specify only the End parameter (without Start), you will receive messages from that End timetoken and newer.

Specify values for both Start and End parameters to retrieve messages between those timetokens (inclusive of the End value).

Keep in mind that you will still receive a maximum of 25 messages even if there are more messages that meet the timetoken values. Iterative calls to history adjusting the Start timetoken is necessary to page through the full set of results if more than 25 messages meet the timetoken values.

To run Fetch History, you can use the following method(s) in the C# V4 SDK:
  1. ParameterTypeRequiredDescription
    Channelsstring[]YesSpecifies channel to return history messages from.
    IncludeMetaboolOptionalWhether meta (passed when Publishing the message) should be included in response or not.
    IncludeMessageActionsboolOptionalThe flag denoting to retrieve history messages with message actions.
    If true, the method is limited to one channel only.
    ReverseboolOptionalSetting to true will traverse the time line in reverse starting with the oldest message first.
    StartlongOptionalTime token delimiting the start of time slice (exclusive) to pull messages from.
    EndlongOptionalTime token delimiting the end of time slice (inclusive) to pull messages from.
    MaximumPerChannelintOptionalSpecifies the number of historical messages to return.
    Default/Maximum is 25 per channel.
    QueryParamDictionary<string, object>OptionalQueryParam accepts a Dictionary object, the keys and values are passed as the query string parameters of the URL called by the API.
    ExecutePNCallbackYesPNCallback of type PNFetchHistoryResult.
    ExecuteAsyncNoneOptionalReturns PNResult<PNFetchHistoryResult>.
Retrieve the last 25 messages on a channel:
PNResult<PNFetchHistoryResult> fetchHistoryResponse = await pubnub.FetchHistory()
    .Channels(new string[] { "my_channel" })
    .IncludeMeta(true)
    .MaximumPerChannel(25)
    .ExecuteAsync();
{
"Messages":
    {"my_channel":
        [{
        "Timetoken":15717278253295153,
        "Entry":"sample message",
        "Meta":"",
        "Actions":null
        }]
    },
"More":null
}
  1. pubnub.FetchHistory()
        .Channels(new string[] { "my_channel" })
        .IncludeMeta(true)
        .MaximumPerChannel(25)
        .Execute(new PNFetchHistoryResultExt((result, status) =>
        { 
    
        }));

Requires Storage & Playback add-on XRequires that the Storage & Playback add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
Removes the messages from the history of a specific channel.
 
There is a setting to accept delete from history requests for a key, which you must enable by checking the Enable Delete-From-History checkbox in the key settings for your key in the Administration Portal.

Requires Initialization with secret key.

To Delete Messages from History you can use the following method(s) in the C# V4 SDK.
  1. ParameterTypeRequiredDescription
    ChannelstringYesSpecifies channel messages to be deleted from history.
    StartlongOptionalTime token delimiting the Start of time slice (inclusive) to delete messages from.
    EndlongOptionalTime token delimiting the End of time slice (exclusive) to delete messages from.
    QueryParamDictionary<string, object>OptionalDictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
    AsyncPNCallbackDeprecatedPNCallback of type PNDeleteMessageResult.
    ExecutePNCallbackYesPNCallback of type PNDeleteMessageResult.
    ExecuteAsyncNoneOptionalReturns PNResult<PNDeleteMessageResult>.
PNResult<PNDeleteMessageResult> delMsgResponse = await pubnub.DeleteMessages()
    .Channel("history_channel")
    .Start(15088506076921021)
    .End(15088532035597390)
    .ExecuteAsync();

PNDeleteMessageResult delMsgResult = delMsgResponse.Result;
PNStatus status = delMsgResponse.Status;

if (status != null && status.Error)
{
    //Check for any error
    Console.WriteLine(status.ErrorData.Information);
}
else if (delMsgResult != null)
{
    //Expect empty object
    Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(delMsgResult));
}
The DeleteMessages() operation returns a PNResult<PNDeleteMessageResult> which returns empty PNDeleteMessageResult object.
  1. pubnub.DeleteMessages()
        .Channel("history_channel")
        .Start(15088506076921021)
        .End(15088532035597390)
        .Execute(new PNDeleteMessageResultExt(
            (result, status) => {
                if (status != null && status.Error) {
                    //Check for any error
                    Console.WriteLine(status.ErrorData.Information);
                }
                else if (result != null) {
                    //Expect empty object
                    Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(result));
                }
            }
        ));

  2. To delete a specific message, pass the publish timetoken (received from a successful publish) in the End parameter and timetoken +/- 1 in the Start parameter. e.g. if 15526611838554310 is the publish timetoken, pass 15526611838554309 in Start and 15526611838554310 in End parameters respectively as shown in the following code snippet.
    PNResult<PNDeleteMessageResult> delMsgResponse = await pubnub.DeleteMessages()
        .Channel("history_channel")
        .Start(15526611838554309)
        .End(15526611838554310)
        .ExecuteAsync();
    
    PNDeleteMessageResult delMsgResult = delMsgResponse.Result;
    PNStatus status = delMsgResponse.Status;
    
    if (status != null && status.Error)
    {
        //Check for any error
        Console.WriteLine(status.ErrorData.Information);
    }
    else if (delMsgResult != null)
    {
        //Expect empty object
        Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(delMsgResult));
    }

Requires Storage & Playback add-on XRequires that the Storage & Playback add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
Returns the number of messages published on one or more channels since a given time. The count returned is the number of messages in history with a timetoken value greater than the passed value in the ChannelsTimetokenparameter.
 For keys with unlimited message retention enabled, this method considers only messages published in the last 7 days.
You can use the following method(s) in the C# V4 SDK:
  1. ParameterTypeRequiredDescription
    Channelsstring[]YesThe channels to fetch the message count
    ChannelsTimetokenlong[]YesArray of timetokens, in order of the channels list. Specify a single timetoken to apply it to all channels. Otherwise, the list of timetokens must be the same length as the list of channels, or the function returns a PNStatuswith an error flag.
    AsyncPNCallbackDeprecatedPNCallback of type PNMessageCountResult .
    ExecutePNCallbackYesPNCallback of type PNMessageCountResult .
    ExecuteAsyncNoneOptionalReturns PNResult<PNMessageCountResult>.
PNResult<PNMessageCountResult> msgCountResponse = await pubnub.MessageCounts()
    .Channels(new string[] { "message_count_channel" })
    .ChannelsTimetoken(new long[] { 15088506076921021 })
    .ExecuteAsync();

PNMessageCountResult msgCountResult = msgCountResponse.Result;
PNStatus status = msgCountResponse.Status;

if (status != null && status.Error)
{
    //Check for any error
    Console.WriteLine(status.ErrorData.Information);
}
else
{
    Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(msgCountResult));
}
The operation returns a PNResult<PNMessageCountResult> which contains the following operations
Property NameTypeDescription
ResultPNMessageCountResultReturns a PNMessageCountResult object.
StatusPNStatusReturns a PNStatus object
PNMessageCountResult contains the following properties:
Property NameTypeDescription
ChannelsDictionary<string, long>Collection of channels along with the messages count. channels without messages have a count of 0. channels with 10,000 messages or more have a count of 10000.
  1. pubnub.MessageCounts()
    	.Channels(new string[] { "message_count_channel" })
    	.ChannelsTimetoken(new long[] { 15088506076921021 })
    	.Execute(new PNMessageCountResultExt(
    	(result, status) => {
    		if (status != null && status.Error)
    		{
    			//Check for any error
    			Console.WriteLine(status.ErrorData.Information);
    		}
    		else
    		{
    			Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(result));
    		}
    	}));
  2. PNResult<PNMessageCountResult> msgCountResponse = await pubnub.MessageCounts()
        .Channels(new string[] { "message_count_channel", "message_count_channel2" })
        .ChannelsTimetoken(new long[] { 15088506076921021, 15088506076921131 })
        .ExecuteAsync();
    
    PNMessageCountResult msgCountResult = msgCountResponse.Result;
    PNStatus status = msgCountResponse.Status;
    
    if (status != null && status.Error)
    {
        //Check for any error
        Console.WriteLine(status.ErrorData.Information);
    }
    else
    {
        Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(msgCountResult));
    }