VueVue V4 Storage & Playback API Reference for Realtime Apps

Go to Channel Groups

History

Description

• 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.

Method(s)

1. history({String channel, Boolean reverse, Number count, Boolean stringifiedTimeToken, String start, String end},Function callback)

   Parameter	Type	Required	Defaults	Description
   Operation Arguments	Hash	Yes		A hash of arguments.
   channel	String	Yes		Specifies channel to return history messages from.
   reverse	Boolean	Optional	false	Setting to true will traverse the time line in reverse starting with the oldest message first. If both start and end arguments are provided, reverse is ignored and messages are returned starting with the newest message.
   count	Number	Optional	100	Specifies the number of historical messages to return. Default/Maximum is 100.
   stringifiedTimeToken	Boolean	Optional	false	If stringifiedTimeToken is specified as true, the SDK will return timetoken values as a strings instead of integers. Usage of setting is encouraged in javascript environments which perform round-up/down on large integers.
   start	String	Optional		Time token delimiting the start of time slice (exclusive) to pull messages from.
   end	String	Optional		Time token delimiting the end of time slice (inclusive) to pull messages from.
   callback	Function	Optional		Executes on a successful/unsuccessful history.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

pubnub.history(
    {
        channel: 'history_channel',
        count: 100, // how many items to fetch
        stringifiedTimeToken: true, // false is the default
    },
    function(status, response) {
        // handle status, response
    }
);

Response

// Example of Status
{
    error: false,
    operation: "PNHistoryOperation",
    statusCode: 200
}

// Example of Response
{
    endTimeToken: "14867650866860159",
    messages: [
        {
            timetoken: "14867650866860159",
            entry: "[User 636] hello World"
        },
        {...},
        {...},
        {...}
    ],
    startTimeToken: "14867650866860159"
}

Other Examples

1. Use history() to retrieve the three oldest messages by retrieving from the time line in reverse:

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.history(
       {
           channel: 'my_channel',
           reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
           count: 3, // how many items to fetch
           stringifiedTimeToken: true// false is the default
       },
       function(status, response) {
           // handle status, response
       }
   );

2. Use history() to retrieve messages newer than a given time token by paging from oldest message to newest message starting at a single point in time (exclusive):

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.history(
       {
           channel: 'my_channel',
           reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
           stringifiedTimeToken: true, // false is the default
           start: '13406746780720711'// start time token to fetch
       },
       function(status, response) {
           // handle status, response
       }
   );

3. Use history() to retrieve messages until a given time token by paging from newest message to oldest message until a specific end point in time (inclusive):

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.history(
       {
           channel: 'my_channel',
           stringifiedTimeToken: true, // false is the default
           end: '13406746780720711'// start time token to fetch
       },
       function(status, response) {
           // handle status, response
       }
   );

4. History Paging Example

   Usage! You can call the method by passing 0 or a valid time token as the argument.

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   getAllMessages = function(timetoken) {
       pubnub.history(
           {
               channel: 'history_test',
               stringifiedTimeToken: true, // false is the default
               start: timetoken // start time token to fetch
           },
           function(status, response) {
               var msgs = response.messages;
               var start = response.startTimeToken;
               var end = response.endTimeToken;
               // if msgs were retrieved, do something useful with them
               if (msgs != "undefined" && msgs.length > 0) {
                   console.log(msgs.length);
                   console.log("start : "+ start);
                   console.log("end : "+ end);
               }
               // if 100 msgs were retrieved, there might be more; call history again
               if (msgs.length == 100)
                   getAllMessages(start);
           }
       );
   }
   
   //Usage examples:
   //getAllMessages();
   //getAllMessages(null);

    
5. Basic usage using Promises

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.history({
       channel: 'history_channel',
       reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
       count: 100, // how many items to fetch
       stringifiedTimeToken: true, // false is the default
       start: '123123123123', // start time token to fetch
       end: '123123123133'// end timetoken to fetch
   }).then((response) => {
       console.log(response);
   }).catch((error) => {
       console.log(error);
   });

6. Use history() to retrieve the three oldest messages by retrieving from the time line in reverse using Promises:

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.history({
       channel: 'my_channel',
       reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
       count: 3, // how many items to fetch
       stringifiedTimeToken: true// false is the default
   }).then((response) => {
       console.log(response);
   }).catch((error) => {
       console.log(error);
   });

7. Use history() to retrieve messages newer than a given time token by paging from oldest message to newest message starting at a single point in time (exclusive) using Promises:

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.history({
       channel: 'my_channel',
       reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
       stringifiedTimeToken: true, // false is the default
       start: '13406746780720711' // start time token to fetch
   }).then((response) => {
       console.log(response);
   }).catch((error) => {
       console.log(error);
   });

8. Use history() to retrieve messages until a given time token by paging from newest message to oldest message until a specific end point in time (inclusive) using Promises:

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.history({
       channel: 'my_channel',
       stringifiedTimeToken: true, // false is the default
       end: '13406746780720711'// start time token to fetch
   }).then((response) => {
       console.log(response);
   }).catch((error) => {
       console.log(error);
   });

9. Paging History Responses using Promises:

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   function getAllMessages(timetoken) {
   	pubnub.history(
   		{
   			channel: 'history_test',
   			stringifiedTimeToken: true, // false is the default
   			start: timetoken // start time token to fetch
   		}).then((response) => {
   			var msgs = response.messages;
   			var start = response.startTimeToken;
   			var end = response.endTimeToken;
   
   			// if msgs were retrieved, do something useful with them
   			if (msgs !== undefined && msgs.length > 0) {
   				console.log(msgs.length);
   				console.log("start : " + start);
   				console.log("end : " + end);
   			}
   
   			// if 100 msgs were retrieved, there might be more; call history again
   			if (msgs.length == 100) {
   				getAllMessages(start);
   			}
   		}).catch((error) => {
   			console.log(error);
   		});
   }
   
   //Usage examples:
   //getAllMessages();
   //getAllMessages(null);

Batch History

Description

• 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.

Method(s)

1. fetchMessages({Array channels, Number count, Boolean stringifiedTimeToken, String start, String end},Function callback)

   Parameter	Type	Required	Defaults	Description
   Operation Arguments	Hash	Yes		A hash of arguments.
   channels	Array	Yes		Specifies channels to return history messages from.
   count	Number	Optional	25	Specifies the number of historical messages to return per channel. Default/Maximum is 25 per channel.
   stringifiedTimeToken	Boolean	Optional	false	If stringifiedTimeToken is specified as true, the SDK will return timetoken values as a strings instead of integers. Usage of setting is encouraged in javascript environments which perform round-up/down on large integers.
   start	String	Optional		Time token delimiting the start of time slice (exclusive) to pull messages from.
   end	String	Optional		Time token delimiting the end of time slice (inclusive) to pull messages from.
   callback	Function	Optional		Executes on a successful/unsuccessful history.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

// assuming pubnub is an initialized instance
// start, end, count are optional
pubnub.fetchMessages(
    { 
        channels: ['ch1', 'ch2', 'ch3'], 
        start: "15343325214676133",
        end: "15343325004275466",
        count: 30 
    }, 
    function(status, response) {
        // handle response
    }
);

Response

//Example of status
{
    error: false,
    operation: 'PNFetchMessagesOperation',
    statusCode: 200
}

//Example of response
{ 
    channels:
    {
        "my-channel":[{
            "message":"message_1",
            "timetoken":"15483367794816642"
          },
          {
            "message":"message_2",
            "timetoken":"15483367810978163"
          },
          {
            "message":"message_3",
            "timetoken":"15483367819545303"
          },
          {
            "message":"message_4",
            "timetoken":"15483367827886667"
          }]
        "my-channel-2":[{
            "message":"message_1",
            "timetoken":"15483367827886667"
          },
          {
            "message":"message_2",
            "timetoken":"15483367819545303"
          },
          {
            "message":"message_3",
            "timetoken":"15483367810978163"
          },
          {
            "message":"message_4",
            "timetoken":"15483367794816642"
          }]
        "my-channel-3":[{
            "message":"message_1",
            "timetoken":"15483373338046565"
          },
          {
            "message":"message_2",
            "timetoken":"15483373303521793"
          },
          {
            "message":"message_3",
            "timetoken":"15483373407379141"
          },
          {
            "message":"message_4",
            "timetoken":"15483373366944653"
          }]
     }
}

Delete Messages from History

Description

Method(s)

1. deleteMessages({String channel, String start, String end},Function callback)

   Parameter	Type	Required	Description
   channel	String	Yes	Specifies channel messages to be deleted from history.
   start	String	Optional	Time token delimiting the start of time slice (inclusive) to delete messages from.
   end	String	Optional	Time token delimiting the end of time slice (exclusive) to delete messages from.
   callback	Function	Optional	Is called on successful or unsuccessful execution of deleteMessages.

Basic Usage

import PubNubVue from 'pubnub-vue';

const pubnub = PubNubVue.getInstance();

pubnub.deleteMessages(
    {
        channel: 'ch1',
        start: '15088506076921021',
        end: '15088532035597390'
    },
    function(result) {
        console.log(result);
    }
);

Response

{
    error: false,
    operation: 'PNDeleteMessagesOperation',
    statusCode: 200
}

Other Examples

1. Delete specific message from history
   
   
   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.

   import PubNubVue from 'pubnub-vue';
   
   const pubnub = PubNubVue.getInstance();
   
   pubnub.deleteMessages(
       {
           channel: 'ch1',
           start: '15526611838554309',
           end: '15526611838554310'
       },
       function(result) {
           console.log(result);
       }
   );

Go to Mobile Push