Retrieving Messages from History
PubNub allows you to store and retrieve messages as they get sent over the network by using the Storage & Playback feature. PubNub uses a time-series based database in which each message is stored on the channel it was published, timestamped to the nearest 10 nanoseconds. The message retention policy can be configured from your account with the following options: 1 day, 7 days, 1 month, and Forever.
Retrieving unread counts of messages
The messageCounts method returns a count of unread messages in one or more channels. The count returned is the number of messages in history with a timetoken value greater than the passed value in the timetoken parameter.
To use this feature, you need to cache the timetoken of either the last retrieved message on a channel, or the last time the user was online.
pubnub.messageCounts({
channels: ['ch-1', 'ch-2'],
channelTimetokens: ['15518041524300251'],
}, (status, results) => {
// handle status, response
console.log(status);
console.log(results);
});
pubnub.messageCounts(
channels: [
"ch-1": "15526611838554310",
"ch-2": "15526611838554309"
],
channelTimetokens: ["15518041524300251"]
) { result in
switch result {
case let .success(response):
print("Successful Message Count Response: \(response)")
case let .failure(error):
print("Failed Message Count Response: \(error.localizedDescription)")
}
}
Long lastHourTimetoken = (Calendar.getInstance().getTimeInMillis() - TimeUnit.HOURS.toMillis(1)) * 10000L;
pubnub.messageCounts()
.channels(Arrays.asList("ch-1", "ch-2"))
.channelsTimetoken(Arrays.asList(lastHourTimetoken))
.async(new PNCallback<PNMessageCountResult>() {
public void onResponse(PNMessageCountResult result, PNStatus status) {
if (!status.isError()) {
for (Map.Entry<String, Long> messageCountEntry : result.getChannels().entrySet()) {
messageCountEntry.getKey(); // the channel name
messageCountEntry.getValue(); // number of messages for that channel
}
} else {
// Handle error accordingly.
status.getErrorData().getThrowable().printStackTrace();
}
}
});
List<string> channelList = new List<string>();
channelList.Add("ch-1");
channelList.Add("ch-2");
pubnub.MessageCounts().Channels(channelList).ChannelsTimetoken(new List<long>{15518041524300251}).Async((result, status) => {
if (!status.Error) {
if((result.Channels != null)){
Debug.Log(string.Format("MessageCounts, {0}", result.Channels.Count));
foreach(KeyValuePair<string, int> kvp in result.Channels){
Debug.Log(string.Format("==kvp.Key {0}, kvp.Value {1} ", kvp.Key, kvp.Value));
}
}
} else {
Debug.Log(status.Error);
Debug.Log(status.ErrorData.Info);
}
});
Fetching missed messages
Use this method to catch up on missed messages when a device comes back online. The request returns a list of messages that were published before the start timetoken and after the end timetoken.
The method returns a maximum of 25 messages per channel. To retrieve more messages, use timestamps to page through the next batch of messages.
Start and End parameters
Messages are always returned in chronological order — from oldest to newest — within the timetoken range you request.
If you specify only the start parameter (without end), you will receive messages older than the start timetoken value.
If you specify only the end parameter (without start), you will receive messages from the last (most recent) message going back to that timetoken value.
Specify values for both start and end to retrieve messages between those timetokens (inclusive of the end value).
// start, end, count are optional
pubnub.fetchMessages(
{
channels: ['ch-1'],
end: '15343325004275466',
count: 100
},
(status, response) => {
// handle response
}
);
pubnub.fetchMessageHistory(
for: ["ch-1"],
end: 15343325004275466,
max: 100
) { result in
switch result {
case let .success(response):
print("Successful History Fetch Response: \(response)")
case let .failure(error):
print("Failed History Fetch Response: \(error.localizedDescription)")
}
}
pubnub.fetchMessages()
.channels(Arrays.asList("ch-1"))
.end(15343325004275466)
.maximumPerChannel(100)
.async(new PNCallback<PNFetchMessagesResult>() {
public void onResponse(PNFetchMessagesResult result, PNStatus status) {
if (!status.isError()) {
Map<String, List<PNFetchMessageItem>> channels = result.getChannels();
for (PNFetchMessageItem messageItem : channels.get("my_channel")) {
System.out.println(messageItem.getMessage());
System.out.println(messageItem.getMeta());
System.out.println(messageItem.getTimetoken());
HashMap<String, HashMap<String, List<PNFetchMessageItem.Action>>> actions =
messageItem.getActions();
for (String type : actions.keySet()) {
System.out.println("Action type: " + type);
for (String value : actions.get(type).keySet()) {
System.out.println("Action value: " + value);
for (PNFetchMessageItem.Action action : actions.get(type).get(value)) {
System.out.println("Action timetoken: " + action.getActionTimetoken());
System.out.println("Action publisher: " + action.getUuid());
}
}
}
}
} else {
status.getErrorData().getThrowable().printStackTrace();
}
}
});
pubnub.FetchMessages()
.Channels(new List<string>{"ch-1"})
.End(15343325004275466)
.Count(100)
.Async ((result, status) => {
if(status.Error){
Debug.Log (string.Format(" FetchMessages Error: {0} {1} {2}", status.StatusCode, status.ErrorData, status.Category));
} else {
Debug.Log (string.Format("In FetchMessages, result: "));
foreach(KeyValuePair<string, List<PNMessageResult>> kvp in result.Channels){
Debug.Log("kvp channelname" + kvp.Key);
foreach(PNMessageResult pnMessageResut in kvp.Value){
Debug.Log("Channel: " + pnMessageResut.Channel);
Debug.Log("payload: " + pnMessageResut.Payload.ToString());
Debug.Log("timetoken: " + pnMessageResut.Timetoken.ToString());
}
}
}
});
Retrieving most recent messages
Use the fetchMessages() method to fetch the most recent messages that were published in the specified channel(s) before the current time.
The method returns a maximum of 25 messages per channel. To retrieve more messages, use the timestamps to page through the next batch of messages.
pubnub.fetchMessages(
{
channels: ['ch-1'],
count: 100
},
(status, response) => {
// handle response
}
);
pubnub.fetchMessageHistory(
for: ["ch-1"],
max: 100
) { result in
switch result {
case let .success(response):
print("Successful History Fetch Response: \(response)")
case let .failure(error):
print("Failed History Fetch Response: \(error.localizedDescription)")
}
}
pubnub.fetchMessages()
.channels(Arrays.asList("ch-1"))
.maximumPerChannel(100)
.async(new PNCallback<PNFetchMessagesResult>() {
public void onResponse(PNFetchMessagesResult result, PNStatus status) {
if (!status.isError()) {
Map<String, List<PNFetchMessageItem>> channels = result.getChannels();
for (PNFetchMessageItem messageItem : channels.get("my_channel")) {
System.out.println(messageItem.getMessage());
System.out.println(messageItem.getMeta());
System.out.println(messageItem.getTimetoken());
HashMap<String, HashMap<String, List<PNFetchMessageItem.Action>>> actions =
messageItem.getActions();
for (String type : actions.keySet()) {
System.out.println("Action type: " + type);
for (String value : actions.get(type).keySet()) {
System.out.println("Action value: " + value);
for (PNFetchMessageItem.Action action : actions.get(type).get(value)) {
System.out.println("Action timetoken: " + action.getActionTimetoken());
System.out.println("Action publisher: " + action.getUuid());
}
}
}
}
} else {
status.getErrorData().getThrowable().printStackTrace();
}
}
});
pubnub.FetchMessages()
.Channels(new List<string>{"ch-1"})
.Count(100)
.IncludeMeta(true)
.Async ((result, status) => {
if(status.Error){
Debug.Log (string.Format(" FetchMessages Error: {0} {1} {2}", status.StatusCode, status.ErrorData, status.Category));
} else {
Debug.Log (string.Format("In FetchMessages, result: "));
foreach(KeyValuePair<string, List<PNMessageResult>> kvp in result.Channels){
Debug.Log("kvp channelname" + kvp.Key);
foreach(PNMessageResult pnMessageResut in kvp.Value){
Debug.Log("Channel: " + pnMessageResut.Channel);
Debug.Log("payload: " + pnMessageResut.Payload.ToString());
Debug.Log("timetoken: " + pnMessageResut.Timetoken.ToString());
}
}
}
});