NativeNativeTwistedTornadoAsyncioPythonPython V4 Storage & Playback API Reference for Realtime Apps

Go to Channel Groups


 

These docs are for PubNub 4.0 for Python V4 which is our latest and greatest! For the docs of the older versions of the SDK, please check PubNub 3.0 for Python, PubNub 3.0 for Python-Tornado and PubNub 3.0 for Python-Twisted.

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

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.
PubNub Storage/Playback Service provides real-time access to an unlimited history for all messages published to PubNub. Stored messages are replicated 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.
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 Python V4 SDK
  1. ParameterTypeRequiredDefaultsDescription
    channelStringYesSpecifies channel to return history messages from.
    reverseBooleanOptionalFalseSetting to True will traverse the time line in reverse starting with the oldest message first.
    include_timetokenBooleanOptionalFalseWhether event dates time tokens should be included in response or not.
    startIntOptionalTime token delimiting the start of time slice (exclusive) to pull messages from.
    endIntOptionalTime token delimiting the end of time slice (inclusive) to pull messages from.
    countIntOptionalSpecifies the number of historical messages to return.
Retrieve the last 100 messages on a channel:
envelope = pubnub.history().channel("history_channel").count(100).sync()
The history() operation returns a PNHistoryResult which contains the following fields:
MethodTypeDescription
messages
List
List of messages of type PNHistoryItemResult. See PNHistoryItemResult for more details.
start_timetoken
Int
Start timetoken.
end_timetoken
Int
End timetoken.
MethodTypeDescription
timetoken
Int
Timetoken of the message.
entry
Object
Message.
  1. envelope = pubnub.history().channel("my_channel").count(3).reverse(True).sync()
    
    {
        end_timetoken: 13406746729185766,
        start_timetoken: 13406746780720711,
        messages: [{
            crypto: None,
            entry: 'Pub1',
            timetoken: None
        },{
            crypto: None,
            entry: 'Pub2',
            timetoken: None
        },{
            crypto: None,
            entry: 'Pub2',
            timetoken: None
        }]
    }
  2. pubnub.history()\
        .channel("my_channel")\
        .start(13847168620721752)\
        .reverse(true)\
        .sync()
    {
        end_timetoken: 13406746729185766,
        start_timetoken: 13406746780720711,
        messages: [{
            crypto: None,
            entry: 'Pub4',
            timetoken: None
        },{
            crypto: None,
            entry: 'Pub5',
            timetoken: None
        },{
            crypto: None,
            entry: 'Pub6',
            timetoken: None
        }]
    }
  3. pubnub.history()\
        .channel("my_channel")\
        .count(100)\
        .start(-1)\
        .end(13847168819178600)\
        .reverse(True)\
        .sync()
    {
        end_timetoken: 13406746729185766,
        start_timetoken: 13406746780720711,
        messages: [{
            crypto: None,
            entry: 'Pub4',
            timetoken: None
        },{
            crypto: None,
            entry: 'Pub5',
            timetoken: None
        },{
            crypto: None,
            entry: 'Pub6',
            timetoken: None
        }]
    }
  4.  
    Usage!
    You can call the method by passing 0 or a valid time token as the argument.
    def get_all_messages(start_tt):
        def history_callback(result, status):
            msgs = result.messages
            start = result.start_timetoken
            end = result.end_timetoken
            count = len(msgs)
    
            if count > 0:
                print("%d" % count)
                print("start %d" % start)
                print("end %d" % end)
    
            if count == 100:
                get_all_messages(start)
    
        pubnub.history()\
            .channel('history_channel')\
            .count(100)\
            .start(start_tt)\
            .pn_async(history_callback)
    
    
    get_all_messages(14759343456292767)
  5. pubnub.history()\
        .channel("my_channel")\
        .count(100)\
        .include_tometoken()
        .sync()
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 Python V4 SDK.
  1. ParameterTypeRequiredDefaultsDescription
    channelStringYesSpecifies channels to delete messages from.
    startIntOptionalTime token delimiting the start of time slice (inclusive) to delete messages from.
    endIntOptionalTime token delimiting the end of time slice (exclusive) to delete messages from.
envelope = PubNub(pnconf).delete_messages() \
    .channel("my-ch") \
    .start(123) \
    .end(456) \
    .sync()

  1. 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.
    envelope = PubNub(pnconf).delete_messages() \
        .channel("my-ch") \
        .start(15526611838554309) \
        .end(15526611838554310) \
        .sync()
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 channel_timetokensparameter.
 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 Python V4 SDK:
  1. ParameterTypeRequiredDefaultsDescription
    channel StringYesThe channels to fetch the message count. Single channel or multiple channels, separated by comma are accepted.
    channel_timetokens ListYesnullA list of timetokens ordered the same way as channels. Timetokens can be str or int type.
envelope = pn.message_counts().channel('unique_1').channel_timetokens([15510391957007182]).sync()
print(envelope.result.channels['unique_1'])
  1. envelope = pn.message_counts().channel('unique_1,unique_100').channel_timetokens([15510391957007182, 15510391957007184]).sync()
    print(envelope.result.channels)

Go to Mobile Push