Utility Methods API for Python-Asyncio SDK

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

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

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

import asyncio
import os
from pubnub.pnconfiguration import PNConfiguration
from pubnub.pubnub_asyncio import PubNubAsyncio
from pubnub.exceptions import PubNubException


async def get_pubnub_time(pubnub: PubNubAsyncio):
    try:
        # Get PubNub Timetoken
        envelope = await pubnub.time().future()
        print(f"Current time: {envelope.result}")

    except PubNubException as e:
        print(f"Error: {e}")

show all 33 lines

Returns

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

Method	Description
int Type: Int	Returns an int representation of current timetoken.
str Type: String	Returns a str representation of current timetoken.
date_time Type: 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-asyncio 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-asyncio SDK:

pubnub.get_subscribed_channel_groups()

Basic Usage

Get Subscribed Channel Groups

channels = pubnub.get_subscribed_channel_groups()

Returns

List

["my_group1", "my_group2"]