Utility Methods API for PubNub Python SDK

The methods on this page are utility methods that don't fit into other categories.

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 Python SDK.

disconnect()

This method doesn't take any arguments.

Basic Usage

pubnub._subscription_manager.disconnect()

Reconnect

Call the reconnect() method to force the SDK to try and reach out PubNub.

Method(s)

To reconnect() the data transmission you can use the following method(s) in Python SDK.

pubnub.reconnect()

This method doesn't take any arguments.

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 Python SDK:

pubnub.time()

Basic Usage

Get PubNub Timetoken

envelope = pubnub.time().sync()

Returns

The time() operation returns a PNTimeResponse which contains the following operations:

Method	Type	Description
int	Int	Returns an int representation of current timetoken.
str	String	Returns a str representation of current timetoken.
date_time	Date	Returns a date representation of current timetoken.

Do not confuse with timestamp() method, which is a shortcut to int(time.time())

Get Subscribed Channels

Returns all the subscribed channels in a list.

Method(s)

To Get Subscribed Channels you can use the following method(s) in the Python SDK:

pubnub.get_subscribed_channels()

Basic Usage

Get Subscribed Channels

channels = pubnub.get_subscribed_channels()

Returns

List

["my_ch1", "my_ch2"]

Get Subscribed Channel Groups

Returns all the subscribed channel groups in a list.

Method(s)

To Get Subscribe Channel Groups you can use the following method(s) in the Python SDK:

pubnub.get_subscribed_channel_groups()

Basic Usage

Get Subscribed Channel Groups

channels = pubnub.get_subscribed_channel_groups()

Returns

List

["my_group1", "my_group2"]

Encrypt file

This function allows to encrypt the data.

Method(s)

To encrypt the data you can use the following method(s) in Python SDK.

pubnub.crypto.encrypt_file(file)

Parameter	Type	Required	Description
file	bytes	Yes	The file to encrypt.

Basic Usage

payload_to_encrypt = 'knights_who_say_ni'

encrypted_payload = pubnub.encrypt(payload_to_encrypt)

Returns

Bytes object with encrypted data.

Decrypt file

This function allows to decrypt the data.

Method(s)

To decrypt the data you can use the following method(s) in Python SDK.

pubnub.crypto.decrypt_file(file)

Parameter	Type	Required	Description
file	bytes	Yes	The file to decrypt.

Basic Usage

decrypted_payload = pubnub.decrypt(payload_to_decrypt_in_bytes)

Returns

Bytes object with decrypted data.