App Context API for Python SDK

This page describes App Context (formerly Objects v2). To upgrade from Objects v1, refer to the migration guide.

App Context provides easy-to-use, serverless storage for user and channel data you need to build innovative, reliable, scalable applications. Use App Context to store metadata about your application users and channels, and their membership associations, without the need to stand up your own databases.

PubNub also triggers events when object data is changed: set, updated, or removed from the database. Making a request to set the same data that already exists doesn't trigger an event. Clients can receive these events in real time and update their front-end application accordingly.

Request execution and return values

You can decide whether to perform the Python SDK operations synchronously or asynchronously.

• .sync() returns an Envelope object, which has two fields: Envelope.result, whose type differs for each API, and Envelope.status of type PnStatus.

  1pubnub.publish() \
  2    .channel("myChannel") \
  3    .message("Hello from PubNub Python SDK") \
  4    .sync()

• .pn_async(callback) returns None and passes the values of Envelope.result and Envelope.status to a callback you must define beforehand.

  1def my_callback_function(result, status):
  2    print(f'TT: {result.timetoken}, status: {status.category.name}')
  3
  
  4pubnub.publish() \
  5    .channel("myChannel") \
  6    .message("Hello from PubNub Python SDK") \
  7    .pn_async(my_callback_function)

User

Manage UUID metadata: list, fetch, set, and remove. Keep responses small by including only the fields you need.

Get metadata for all users

Get a paginated list of UUID metadata. Use filters and sorting to narrow results.

Required keyset configuration

To get all channel and user metadata, you must uncheck the Disallow Get All Channel Metadata and Disallow Get All User Metadata checkboxes in the App Context section of your keyset configuration in the Admin Portal.

Method(s)

To Get All UUID Metadata you can use the following method(s) in the Python SDK:

1pubnub.get_all_uuid_metadata() \
2    .limit(Integer) \
3    .page(PNPage Object) \
4    .filter(String) \
5    .sort(List<PNSortKey>) \
6    .include_total_count(Boolean) \
7    .include_custom(Boolean) \
8    .include_status(Boolean) \
9    .include_type(Boolean)

limit#

type: Type: Integer

Default: no default

The maximum number of objects to retrieve at a time.

page#

type: Type: PNPage

Default: no default

The paging object used for pagination.

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: List<PNSortKey>

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}.

include_total_count#

type: Type: Boolean

default: Default: False

Whether to include the total count in the paginated response. Default is false.

include_custom#

type: Type: Boolean

default: Default: False

Whether to include the Custom object in the response.

include_status#

type: Type: Boolean

default: Default: True

Whether to include the status field in the fetch response. Setting this to False will prevent this value from being returned.

include_type#

type: Type: Boolean

default: Default: True

Whether to include the type field in the fetch response. Setting this to False will prevent this value from being returned.

Sample code

Builder Pattern

Synchronous:

1import os
2from pubnub.pnconfiguration import PNConfiguration
3from pubnub.pubnub import PubNub
4from pubnub.models.consumer.objects_v2.sort import PNSortKey, PNSortKeyValue
5from pubnub.exceptions import PubNubException
6

7

8def get_all_uuid_metadata(pubnub: PubNub):
9    try:
10        result = pubnub.get_all_uuid_metadata() \
11            .include_custom(True) \
12            .limit(10) \
13            .include_total_count(True) \
14            .sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
15            .page(None) \
16            .sync()
17

18        for uuid_data in result.result.data:
19            print(f"UUID: {uuid_data['id']}")
20            print(f"Name: {uuid_data['name']}")
21            print(f"Custom: {uuid_data['custom']}")
22

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

26

27def main():
28    # Configuration for PubNub instance
29    pn_config = PNConfiguration()
30    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')
31    pn_config.publish_key = os.getenv('PUBLISH_KEY', 'demo')
32    pn_config.user_id = os.getenv('USER_ID', 'my_custom_user_id')
33

34    # Initialize PubNub client
35    pubnub = PubNub(pn_config)
36

37    # Get all UUID metadata
38    get_all_uuid_metadata(pubnub)
39

40

41if __name__ == "__main__":
42    main()
43

show all 43 lines

Asynchronous:

1import os
2from pubnub.pnconfiguration import PNConfiguration
3from pubnub.pubnub import PubNub
4from pubnub.models.consumer.objects_v2.sort import PNSortKey, PNSortKeyValue
5

6

7def callback(response, status):
8    if status.is_error():
9        print(f"Error: {status.error_data}")
10    else:
11        for uuid_data in response.data:
12            print(f"UUID: {uuid_data["id"]}")
13            print(f"Name: {uuid_data["name"]}")
14            print(f"Custom: {uuid_data["custom"]}")
15

16

17def get_all_uuid_metadata(pubnub: PubNub):
18    pubnub.get_all_uuid_metadata() \
19        .include_custom(True) \
20        .limit(10) \
21        .include_total_count(True) \
22        .sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
23        .page(None) \
24        .pn_async(callback)
25

26

27def main():
28    # Configuration for PubNub instance
29    pn_config = PNConfiguration()
30    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')
31    pn_config.publish_key = os.getenv('PUBLISH_KEY', 'demo')
32    pn_config.user_id = os.getenv('USER_ID', 'my_custom_user_id')
33

34    # Initialize PubNub client
35    pubnub = PubNub(pn_config)
36

37    # Get all UUID metadata
38    get_all_uuid_metadata(pubnub)
39

40

41if __name__ == "__main__":
42    main()
43

show all 43 lines

Named Arguments

Synchronous:

1import os
2from pubnub.pnconfiguration import PNConfiguration
3from pubnub.pubnub import PubNub
4from pubnub.models.consumer.objects_v2.sort import PNSortKey, PNSortKeyValue
5from pubnub.exceptions import PubNubException
6

7

8def get_all_uuid_metadata(pubnub: PubNub):
9    try:
10        metadata = pubnub.get_all_uuid_metadata(
11            limit=10,
12            include_custom=True,
13            include_total_count=True,
14            sort_keys=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]
15        ).sync()
16

17        for uuid_data in metadata.result.data:
18            print(f"UUID: {uuid_data["id"]}")
19            print(f"Name: {uuid_data["name"]}")
20            print(f"Custom: {uuid_data["custom"]}")
21

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

25

26def main():
27    # Configuration for PubNub instance
28    pn_config = PNConfiguration()
29    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')
30    pn_config.user_id = os.getenv('USER_ID', 'my_custom_user_id')
31

32    # Initialize PubNub client
33    pubnub = PubNub(pn_config)
34

35    # Get all UUID metadata
36    get_all_uuid_metadata(pubnub)
37

38

39if __name__ == "__main__":
40    main()
41

show all 41 lines

Asynchronous:

1import os
2from pubnub.pnconfiguration import PNConfiguration
3from pubnub.pubnub import PubNub
4from pubnub.models.consumer.objects_v2.sort import PNSortKey, PNSortKeyValue
5

6

7def callback(response, status):
8    if status.is_error():
9        print(f"Error: {status.error_data}")
10    else:
11        for uuid_data in response.data:
12            print(f"UUID: {uuid_data["id"]}")
13            print(f"Name: {uuid_data["name"]}")
14            print(f"Custom: {uuid_data["custom"]}")
15

16

17def get_all_uuid_metadata(pubnub: PubNub):
18    pubnub.get_all_uuid_metadata(
19        limit=10,
20        include_custom=True,
21        include_total_count=True,
22        sort_keys=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]
23    ).pn_async(callback)
24

25

26def main():
27    # Configuration for PubNub instance
28    pn_config = PNConfiguration()
29    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')
30    pn_config.user_id = os.getenv('USER_ID', 'my_custom_user_id')
31

32    # Initialize PubNub client
33    pubnub = PubNub(pn_config)
34

35    # Get all UUID metadata
36    get_all_uuid_metadata(pubnub)
37

38

39if __name__ == "__main__":
40    main()
41

show all 41 lines

Returns

The get_all_uuid_metadata() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNGetAllUUIDMetadataResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNGetAllUUIDMetadataResult

Property Name	Type	Description
data	[]	List of dictionaries containing UUID metadata
status	PNStatus	Status of the operation

Each element in data contains a dictionary with UUID metadata.

Key	Description
id	UUID
name	Name associated with UUID object
externalId	External ID associated with UUID object
profileUrl	Profile URL associated with UUID object
email	Email address associated with UUID object
custom	Custom object associated with UUID object in form of dictionary containing string to string pairs
status	User status value
type	User type value

Get user metadata

Fetch metadata for a single UUID. Include the Custom object if you need custom fields.

Method(s)

To Get UUID Metadata you can use the following method(s) in the Python SDK:

1pubnub.get_uuid_metadata() \
2        .uuid(String) \
3        .include_custom(Boolean)

uuid#

type: Type: String

default: Default: pubnub.configuration.uuid

Unique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

include_custom#

type: Type: Boolean

default: Default: False

Whether to include the Custom object in the response.

include_status#

type: Type: Boolean

default: Default: True

Whether to include the status field in the fetch response, which is included by default.

include_type#

type: Type: Boolean

default: Default: True

Whether to include the type field in the fetch response, which is included by default.

Sample code

Builder Pattern

Synchronous:

1pubnub.get_uuid_metadata() \
2    .include_custom(True) \
3    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_uuid_metadata() \
5    .include_custom(True) \
6    .pn_async(callback)

Named Arguments

Synchronous:

1metadata = pubnub.get_uuid_metadata(include_custom=True).sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4metadata = pubnub.get_uuid_metadata(include_custom=True).pn_async(callback)

Returns

The get_uuid_metadata() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNGetUUIDMetadataResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNGetUUIDMetadataResult

operation returns a PNGetUUIDMetadataResult which contains the following properties:

Property Name	Type	Description
data		Dictionary containing UUID metadata
status	PNStatus	Status of the operation

Where each element in data contains a dictionary with UUID metadata.

Key	Description
id	UUID
name	Name associated with UUID object
externalId	External ID associated with UUID object
profileUrl	Profile URL associated with UUID object
email	Email address associated with UUID object
status	Status value associated with UUID object
type	Type value associated with UUID object
custom	Custom object associated with UUID object in form of dictionary containing string to string pairs

Set user metadata

Create or update metadata for a UUID. Use the eTag to avoid overwriting concurrent updates.

Unsupported partial updates of custom metadata

The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:

1. Get the existing metadata and store it locally.
2. Append the new custom metadata to the existing one.
3. Set the entire updated custom object.

Method(s)

To Set UUID Metadata you can use the following method(s) in the Python SDK:

1pubnub.set_uuid_metadata() \
2    .uuid(String) \
3    .set_name(String) \
4    .set_status(String) \
5    .set_type(String) \
6    .external_id(String) \
7    .profile_url(String) \
8    .email(String) \
9    .custom(Dictionary) \
10    .include_custom(Boolean) \
11    .include_status(Boolean) \
12    .include_type(Boolean) \
13    .if_matches_etag(String)

uuid#

type: Type: String

default: Default: pubnub.configuration.uuid

Unique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

set_name#

type: Type: String

Default: no default

Display name for the user.

set_status#

type: Type: String

Default: no default

User status. Max. 50 characters.

set_type#

type: Type: String

Default: no default

User type. Max. 50 characters.

external_id#

type: Type: String

Default: no default

User's identifier in an external system.

profile_url#

type: Type: String

Default: no default

The URL of the user's profile picture.

email#

type: Type: String

Default: no default

The user's email address.

custom#

type: Type: Any

Default: no default

Any object of key-value pairs with supported data types. App Context filtering language doesn't support filtering by custom properties.

include_custom#

type: Type: Boolean

default: Default: False

Whether to include the Custom object in the response.

include_status#

type: Type: Boolean

default: Default: False

Whether to include the status object in the fetch response.

include_type#

type: Type: Boolean

default: Default: False

Whether to include the type object in the fetch response.

if_matches_etag#

type: Type: String

Default: no default

The entity tag to be used to ensure updates only happen if the object hasn't been modified since it was read. Use the eTag you received from an applicable get metadata method to check against the server entity tag. If the eTags don't match, an HTTP 412 error is thrown.

API limits

To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.

Sample code

Builder Pattern

Synchronous:

1pubnub.set_uuid_metadata() \
2    .include_custom(True) \
3    .uuid("Some UUID") \
4    .set_name("Some Name") \
5    .set_status("Active") \
6    .set_type("User") \
7    .email("test@example.com") \
8    .profile_url("http://example.com") \
9    .external_id("1234567890") \
10    .custom({"key1": "val1", "key2": "val2"}) \
11    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.set_uuid_metadata() \
5    .include_custom(True) \
6    .uuid("Some UUID") \
7    .set_name("Some Name") \
8    .set_status("Active") \
9    .set_type("User") \
10    .email("test@example.com") \
11    .profile_url("http://example.com") \
12    .external_id("1234567890") \
13    .custom({"key1": "val1", "key2": "val2"}) \
14    pn_async(callback)

Named Arguments

Synchronous:

1pubnub.set_uuid_metadata(uuid="Some UUID",
2                         name="Some Name",
3                         status="Active", type="User",
4                         email="test@example.com",
5                         profile_url="http://example.com",
6                         external_id="1234567890",
7                         custom={"key1": "val1", "key2": "val2"}) \
8    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.set_uuid_metadata(uuid="Some UUID",
5                         name="Some Name",
6                         status="Active", type="User",
7                         email="test@example.com",
8                         profile_url="http://example.com",
9                         external_id="1234567890",
10                         custom={"key1": "val1", "key2": "val2"}) \
11    .pn_async(callback)

Returns

The set_uuid_metadata() returns a PNSetUUIDMetadataResult which contains the following properties:

Property Name	Type	Description
data		Dictionary containing UUID metadata
status	PNStatus	Status of the operation

Where each element in data contains a dictionary with UUID metadata.

Key	Description
id	UUID
name	Name associated with UUID object
externalId	External ID associated with UUID object
profileUrl	Profile URL associated with UUID object
email	Email address associated with UUID object
status	User status
type	User type
custom	Custom object associated with UUID object in form of dictionary containing string to string pairs

Remove user metadata

Delete metadata for the specified UUID.

Method(s)

To Remove UUID Metadata you can use the following method(s) in the Python SDK:

1pubnub.remove_uuid_metadata() \
2    .uuid(String)

uuid#

type: Type: String

default: Default: pubnub.configuration.uuid

Unique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

Sample code

Builder Pattern

Synchronous:

1pubnub.remove_uuid_metadata() \
2        .uuid("Some UUID").sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_uuid_metadata() \
5        .uuid("Some UUID").pn_async(callback)

Named Arguments

1pubnub.remove_uuid_metadata(uuid="Some UUID").sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_uuid_metadata(uuid="Some UUID").pn_async(callback)

Returns

The remove_uuid_metadata() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNRemoveUUIDMetadataResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNRemoveUUIDMetadataResult

Property Name	Type	Description
status	PNStatus	Status of the operation

Channel

Manage channel metadata: list, fetch, set, and remove.

Get metadata for all channels

Get a paginated list of channel metadata. Use filters and sorting to narrow results.

Required keyset configuration

To get all channel and user metadata, you must uncheck the Disallow Get All Channel Metadata and Disallow Get All User Metadata checkboxes in the App Context section of your keyset configuration in the Admin Portal.

Method(s)

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

1pubnub.get_all_channel_metadata() \
2    .limit(Integer) \
3    .page(PNPage) \
4    .filter(String) \
5    .sort(PNSortKey) \
6    .include_total_count(Boolean) \
7    .include_custom(Boolean) \
8    .include_status(Boolean) \
9    .include_type(Boolean)

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time.

page#

type: Type: PNPage

Default: no default

The paging object used for pagination.

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: [PNSortKey]

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}.

include_total_count#

type: Type: Boolean

default: Default: False

Whether to include the total count in the paginated response. Default is false.

include_custom#

type: Type: Boolean

default: Default: False

Whether to include the Custom object in the response.

include_status#

type: Type: Boolean

default: Default: True

Whether to include the status field in the fetch response. Setting this to False will prevent this value from being returned.

include_type#

type: Type: Boolean

default: Default: True

Whether to include the type field in the fetch response. Setting this to False will prevent this value from being returned.

Sample code

Builder Pattern

Synchronous:

1pubnub.get_all_channel_metadata() \
2    .include_custom(True) \
3    .limit(10) \
4    .include_total_count(True) \
5    .sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
6    .page(None) \
7    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_all_channel_metadata() \
5    .include_custom(True) \
6    .limit(10) \
7    .include_total_count(True) \
8    .sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
9    .page(None) \
10    .pn_async(callback)

Named Arguments

Synchronous:

1metadata = pubnub.get_all_channel_metadata(limit=10,
2                                           include_custom=True,
3                                           include_total_count=True,
4                                           sort=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]) \
5    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_all_channel_metadata(limit=10,
5                                include_custom=True,
6                                include_total_count=True,
7                                sort=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]) \
8    .pn_async(callback)

Returns

The get_all_channel_metadata() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNGetAllChannelMetadataResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNGetAllChannelMetadataResult

Property Name	Type	Description
data	[]	List of dictionaries containing channel metadata
status	PNStatus	Status of the operation

Where each element in data contains a dictionary with channel metadata.

Key	Description
id	Channel metadata ID
name	Name associated with channel metadata object
description	Description associated with channel metadata object
status	Channel status value
type	Channel type value
custom	Custom object associated with channel metadata object in form of dictionary containing string to string pairs

Get channel metadata

Fetch metadata for a single channel. Include the Custom object if you need custom fields.

Method(s)

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

1pubnub.get_channel_metadata() \
2    .channel(String) \
3    .include_custom(Boolean) \
4    .include_status(Boolean) \
5    .include_type(Boolean)

channel#

type: Type: str

Default: no default

Channel name

include_custom#

type: Type: bool

default: Default: False

Whether to include the custom object in the fetch response.

include_status#

type: Type: Boolean

default: Default: True

Whether to include the status field in the fetch response. Setting this to False will prevent this value from being returned.

include_type#

type: Type: Boolean

default: Default: True

Whether to include the type field in the fetch response. Setting this to False will prevent this value from being returned.

Sample code

Builder Pattern

Synchronous:

1pubnub.get_channel_metadata() \
2    .include_custom(True) \
3    .channel("channel") \
4    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_channel_metadata() \
5    .include_custom(True) \
6    .channel("channel") \
7    .pn_async(callback)

Named Arguments

Synchronous:

1pubnub.get_channel_metadata(channel="channel", include_custom=True).sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_channel_metadata(channel="channel", include_custom=True).pn_async(callback)

Returns

The get_channel_metadata() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNGetChannelMetadataResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNGetChannelMetadataResult

Property Name	Type	Description
data		Dictionary containing channel metadata
status	PNStatus	Status of the operation

Where each element in data contains a dictionary with channel metadata.

Key	Description
id	Channel metadata ID
name	Name associated with channel metadata object
description	Description associated with channel metadata object
status	Channel status value
type	Channel type value
custom	Custom object associated with channel metadata object in form of dictionary containing string to string pairs

Set channel metadata

Create or update metadata for a channel. Use the eTag to avoid overwriting concurrent updates.

Set metadata for a channel in the database, optionally including its custom data object.

Unsupported partial updates of custom metadata

The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:

1. Get the existing metadata and store it locally.
2. Append the new custom metadata to the existing one.
3. Set the entire updated custom object.

Method(s)

To Set Channel Metadata you can use the following method(s) in the Python SDK:

1pubnub.set_channel_metadata() \
2    .channel(String) \
3    .set_name(String) \
4    .set_status(String) \
5    .set_type(String) \
6    .description(String) \
7    .custom(Dictionary) \
8    .include_custom(Boolean) \
9    .include_status(Boolean) \
10    .include_type(Boolean) \
11    .if_matches_etag(String)

channel#

type: Type: String

Default: no default

Channel ID.

set_name#

type: Type: String

Default: no default

Name of the channel.

set_status#

type: Type: String

Default: no default

Channel status. Max. 50 characters.

set_type#

type: Type: String

Default: no default

Channel type. Max. 50 characters.

description#

type: Type: String

Default: no default

Description of a channel.

custom#

type: Type: Map<String, Object>

Default: no default

Any object of key-value pairs with supported data types. App Context filtering language doesn't support filtering by custom properties.

include_custom#

type: Type: Boolean

default: Default: False

Whether to include the custom object in the fetch response.

include_status#

type: Type: Boolean

default: Default: False

Whether to include the status object in the fetch response.

include_type#

type: Type: Boolean

default: Default: False

Whether to include the type object in the fetch response.

if_matches_etag#

type: Type: String

Default: no default

The entity tag to be used to ensure updates only happen if the object hasn't been modified since it was read. Use the eTag you received from an applicable get metadata method to check against the server entity tag. If the eTags don't match, an HTTP 412 error is thrown.

API limits

To learn about the maximum length of parameters used to set channel metadata, refer to REST API docs.

Sample code

Builder Pattern

Synchronous:

1pubnub.set_channel_metadata() \
2    .include_custom(True) \
3    .channel("channel id") \
4    .set_name("Channel Name") \
5    .set_status("Archived") \
6    .set_type("Archived") \
7    .description("Description") \
8    .custom({ "key1": "val1", "key2": "val2" }) \
9    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.set_channel_metadata() \
5    .include_custom(True) \
6    .channel("channel id") \
7    .set_name("Channel Name") \
8    .set_status("Archived") \
9    .set_type("Archived") \
10    .description("Description") \
11    .custom({ "key1": "val1", "key2": "val2" }) \
12    .pn_async(callback)

Named Arguments

Synchronous:

1pubnub.set_channel_metadata(channel="channel id",
2                            name="Channel Name",
3                            status="Archived",
4                            type="Archived",
5                            description="Description",
6                            custom={ "key1": "val1", "key2": "val2" },
7                            include_custom=True) \
8    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.set_channel_metadata(channel="channel id",
5                            name="Channel Name",
6                            status="Archived",
7                            type="Archived",
8                            description="Description",
9                            custom={ "key1": "val1", "key2": "val2" },
10                            include_custom=True) \
11    .pn_async(callback)

Returns

The set_channel_metadata() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNSetChannelMetadataResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNSetChannelMetadataResult

Property Name	Type	Description
data		Dictionary containing channel metadata
status	PNStatus	Status of the operation

Where each element in data contains a dictionary with channel metadata.

Key	Description
id	channel metadata id
name	Name associated with channel metadata object
description	Description associated with channel metadata object
status	Channels status value
type	Channels type value
custom	Custom object associated with channel metadata object in form of dictionary containing string to string pairs

Other examples

Iteratively update existing metadata

1

Remove channel metadata

Delete metadata for the specified channel.

Removes the metadata from a specified channel.

Method(s)

To Remove Channel Metadata you can use the following method(s) in the Python SDK:

1pubnub.remove_channel_metadata() \
2    .channel(String)

channel#

type: Type: String

Default: no default

Channel name

Sample code

Builder Pattern

Synchronous:

1pubnub.remove_channel_metadata() \
2    .channel("channel id") \
3    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_channel_metadata() \
5    .channel("channel id") \
6    .pn_async(callback)

Named Arguments

Synchronous:

1pubnub.remove_channel_metadata(channel="channel id").sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_channel_metadata(channel="channel id").pn_async(callback)

Returns

The remove_channel_metadata() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNRemoveChannelMetadataResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNRemoveChannelMetadataResult

Property Name	Type	Description
status	PNStatus	Status of the operation

Channel memberships

Manage the channels a UUID belongs to: list, set, remove, and manage in bulk.

Get channel memberships

List channel memberships for a UUID. This does not return subscriptions.

Method(s)

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

1pubnub.get_memberships() \
2    .uuid(String) \
3    .limit(Integer) \
4    .page(PNPage Object) \
5    .filter(String) \
6    .sort(* PNSortKey Object) \
7    .include(MembershipIncludes)

uuid#

type: Type: String

default: Default: pubnub.configuration.uuid

Unique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time

page#

type: Type: PNPage

Default: no default

The paging object used for pagination

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include#

type: Type: MembershipIncludes

Default: no default

The additional information to include in the membership response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Request totalCount to be included in paginated response, which is omitted by default

property of include: custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data should be included in the response.

property of include: status#

type: Type: Boolean

default: Default: False

Indicates whether the status should be included in the response.

property of include: type#

type: Type: Boolean

default: Default: False

Indicates whether the type should be included in the response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Indicates whether the total count should be included in the response.

property of include: channel#

type: Type: Boolean

default: Default: False

Indicates whether the channel information should be included in the response.

property of include: channel_custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data for the channel should be included in the response.

property of include: channel_type#

type: Type: Boolean

default: Default: False

Indicates whether the type of the channel should be included in the response.

property of include: channel_status#

type: Type: Boolean

default: Default: False

Indicates whether the status of the channel should be included in the response.

Sample code

Builder Pattern

Synchronous:

1pubnub.get_memberships() \
2    .include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
3    .uuid("Some UUID").sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_memberships() \
5    .include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
6    .uuid("Some UUID").pn_async(callback)

Named Arguments

Synchronous:

1pubnub.get_memberships(uuid="Some UUID",
2                       include=MembershipIncludes(custom=True, channel=True, channel_custom=True))
3    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_memberships(uuid="Some UUID",
5                       include=.MembershipIncludes(custom=True, channel=True, channel_custom=True))
6    .pn_async(callback)

Returns

The get_memberships() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNGetMembershipsResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNGetMembershipsResult

Property Name	Type	Description
data		List of dictionaries containing memberships metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
channel	Dictionary containing channel metadata (id, name, description, custom)
custom	Custom object associated with membership in form of dictionary containing string to string pairs

Set channel memberships

Replace or add memberships for a UUID. Provide channels (optionally with custom data).

Set channel memberships for a UUID.

Method(s)

To Set Channel Memberships you can use the following method(s) in the Python SDK:

1pubnub.set_memberships() \
2    .channel_memberships([PNChannelMembership]) \
3    .uuid(String) \
4    .limit(Integer) \
5    .page(PNPage) \
6    .filter(String) \
7    .sort(* PNSort Object) \
8    .include(MembershipIncludes)

channelMemberships#

type: Type: [PNChannelMembership]

Default: no default

Collection of PNChannelMembership to add to membership

uuid#

type: Type: String

default: Default: pubnub.configuration.uuid

Unique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time

page#

type: Type: PNPage

Default: no default

The paging object used for pagination

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include#

type: Type: MembershipIncludes

Default: no default

The additional information to include in the membership response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Request totalCount to be included in paginated response, which is omitted by default

property of include: custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data should be included in the response.

property of include: status#

type: Type: Boolean

default: Default: False

Indicates whether the status should be included in the response.

property of include: type#

type: Type: Boolean

default: Default: False

Indicates whether the type should be included in the response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Indicates whether the total count should be included in the response.

property of include: channel#

type: Type: Boolean

default: Default: False

Indicates whether the channel information should be included in the response.

property of include: channel_custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data for the channel should be included in the response.

property of include: channel_type#

type: Type: Boolean

default: Default: False

Indicates whether the type of the channel should be included in the response.

property of include: channel_status#

type: Type: Boolean

default: Default: False

Indicates whether the status of the channel should be included in the response.

API limits

To learn about the maximum length of parameters used to set channel membership metadata, refer to REST API docs.

Sample code

Builder Pattern

Synchronous:

1some_channel = "somechannel"
2some_channel_with_custom = "somechannel_with_custom"
3

4pubnub.set_channel_metadata() \
5    .channel(some_channel) \
6    .set_name("some name") \
7    .sync()
8

9custom_1 = {
10    "key3": "val1",
11    "key4": "val2",
12}
13

14pubnub.set_channel_metadata() \
15    .channel(some_channel_with_custom) \
16    .set_name("some name with custom") \
17    .custom(custom_1) \
18    .sync()
19

20custom_2 = {
21    "key5": "val1",
22    "key6": "val2",
23}
24

25channel_memberships_to_set = [
26    PNChannelMembership.channel(some_channel),
27    PNChannelMembership.channel_with_custom(some_channel_with_custom, custom_2),
28]
29

30pubnub.set_memberships() \
31    .uuid("some-uuid") \
32    .channel_memberships(channel_memberships_to_set) \
33    .include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
34    .sync()

show all 34 lines

Asynchronous:

1def callback(response, status):
2    pass
3

4some_channel = "somechannel"
5some_channel_with_custom = "somechannel_with_custom"
6

7pubnub.set_channel_metadata() \
8    .channel(some_channel) \
9    .set_name("some name") \
10    .sync()
11

12custom_1 = {
13    "key3": "val1",
14    "key4": "val2"
15}
16

17pubnub.set_channel_metadata() \
18    .channel(some_channel_with_custom) \
19    .set_name("some name with custom") \
20    .custom(custom_1) \
21    .sync()
22

23custom_2 = {
24    "key5": "val1",
25    "key6": "val2",
26}
27

28channel_memberships_to_set = [
29    PNChannelMembership.channel(some_channel),
30    PNChannelMembership.channel_with_custom(some_channel_with_custom, custom_2),
31]
32

33pubnub.set_memberships() \
34    .uuid("some-uuid") \
35    .channel_memberships(channel_memberships_to_set) \
36    .include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
37    .pn_async(callback)

show all 37 lines

Named Arguments

Synchronous:

1some_channel = "somechannel"
2some_channel_with_custom = "somechannel_with_custom"
3

4pubnub.set_channel_metadata(channel=some_channel, name="some name").sync()
5

6custom_1 = {
7    "key3": "val1",
8    "key4": "val2",
9}
10

11pubnub.set_channel_metadata(channel=some_channel_with_custom,
12                            name="some name with custom",
13                            custom=custom_1) \
14    .sync()
15

16custom_2 = {
17    "key5": "val1",
18    "key6": "val2",
19}
20

21channel_memberships_to_set = [
22    PNChannelMembership.channel(some_channel),
23    PNChannelMembership.channel_with_custom(some_channel_with_custom, custom_2),
24]
25

26pubnub.set_memberships(uuid="some-uuid",
27                       channel_memberships=channel_memberships_to_set,
28                       include(MembershipIncludes(custom=True, channel=True, channel_custom=True))) \
29    .sync()

show all 29 lines

Asynchronous:

1def callback(response, status):
2    pass
3

4some_channel = "somechannel"
5some_channel_with_custom = "somechannel_with_custom"
6

7pubnub.set_channel_metadata(channel=some_channel, name="some name").pn_async(callback)
8

9custom_1 = {
10    "key3": "val1",
11    "key4": "val2"
12}
13

14pubnub.set_channel_metadata(channel=some_channel_with_custom,
15                            name="some name with custom",
16                            custom=custom_1) \
17    .pn_async(callback)
18

19custom_2 = {
20    "key5": "val1",
21    "key6": "val2",
22}
23

24channel_memberships_to_set = [
25    PNChannelMembership.channel(some_channel),
26    PNChannelMembership.channel_with_custom(some_channel_with_custom, custom_2),
27]
28

29pubnub.set_memberships(uuid="some-uuid",
30                       channel_memberships=channel_memberships_to_set,
31                       include(MembershipIncludes(custom=True, channel=True, channel_custom=True))) \
32    .pn_async(callback)

show all 32 lines

Returns

The set_memberships() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNSetMembershipsResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNSetMembershipsResult

Property Name	Type	Description
data		List of dictionaries containing memberships metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
channel	Dictionary containing channel metadata (id, name, description, custom)
custom	Custom object associated with membership in form of dictionary containing string to string pairs

Remove channel memberships

Remove memberships for a UUID. Provide the channels to remove.

Method(s)

To Remove Channel Memberships you can use the following method(s) in the Python SDK:

1pubnub.remove_memberships() \
2    .channel_memberships([PNChannelMembership]) \
3    .uuid(String) \
4    .limit(Integer) \
5    .page(PNPage) \
6    .filter(String) \
7    .sort(* PNSort) \
8    .include_total_count(Boolean) \
9    .include_custom(Boolean) \
10    .include_channel(Integer)

channel_memberships#

type: Type: [PNChannelMembership]

Default: no default

List of channels (as PNChannelMembership) to remove from membership.

uuid#

type: Type: String

default: Default: pubnub.configuration.uuid

Unique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time.

page#

type: Type: PNPage

Default: no default

The paging object used for pagination.

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include_total_count#

type: Type: Boolean

default: Default: False

Whether to include the total count in the paginated response. Default is false.

include_custom#

type: Type: Boolean

default: Default: False

Whether to include the custom object in the fetch response.

include_channel#

type: Type: Integer

Default: no default

The level of channel details to return in the membership. Possible values are defined as constants in ChannelIncludeEndpoint: ChannelIncludeEndpoint.CHANNEL and ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM

Sample code

Builder Pattern

Synchronous:

1pubnub.remove_memberships() \
2    .uuid("some_uuid") \
3    .channel_memberships([PNChannelMembership.channel(some_channel)]) \
4    .include_custom(True) \
5    .include_channel(ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM) \
6    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_memberships() \
5    .uuid("some_uuid") \
6    .channel_memberships([PNChannelMembership.channel(some_channel)]) \
7    .include_custom(True) \
8    .include_channel(ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM) \
9    .pn_async(callback)

Named Arguments

Synchronous:

1pubnub.remove_memberships(uuid="some_uuid",
2                          channel_memberships=[PNChannelMembership.channel(some_channel)],
3                          include_channel=ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM
4                          include_custom=True) \
5    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_memberships(uuid="some_uuid",
5                          channel_memberships=[PNChannelMembership.channel(some_channel)],
6                          include_channel=ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM
7                          include_custom=True) \
8    .pn_async(callback)

Returns

The remove_memberships() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNRemoveMembershipsResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNRemoveMembershipsResult

Property Name	Type	Description
data		List of dictionaries containing memberships metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
channel	Dictionary containing channel metadata (id, name, description, custom)
custom	Custom object associated with membership in form of dictionary containing string to string pairs

Manage channel memberships

Add and remove memberships for a UUID in one request.

Method(s)

To Manage Channel Memberships you can use the following method(s) in the Python SDK:

1pubnub.manage_memberships() \
2    .uuid(String) \
3    .set([PNChannelMembership>]) \
4    .remove([PNChannelMembership]) \
5    .limit(Integer) \
6    .page(PNPage) \
7    .filter(String) \
8    .sort(* PNSortKey) \
9    .include(MembershipIncludes)

uuid#

type: Type: String

default: Default: pubnub.configuration.uuid

Unique UUID Metadata identifier.
If not supplied, then UUID from configuration will be used.

set#

type: Type: [PNChannelMembership]

Default: no default

List of members PNChannelMembership to add to channel

remove#

type: Type: [PNChannelMembership]

Default: no default

List of members PNChannelMembership to remove from channel

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time

page#

type: Type: PNPage

default: Default: null

The paging object used for pagination

filter#

type: Type: String

default: Default: null

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include#

type: Type: MembershipIncludes

Default: no default

The additional information to include in the membership response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Request totalCount to be included in paginated response, which is omitted by default

property of include: custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data should be included in the response.

property of include: status#

type: Type: Boolean

default: Default: False

Indicates whether the status should be included in the response.

property of include: type#

type: Type: Boolean

default: Default: False

Indicates whether the type should be included in the response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Indicates whether the total count should be included in the response.

property of include: channel#

type: Type: Boolean

default: Default: False

Indicates whether the channel information should be included in the response.

property of include: channel_custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data for the channel should be included in the response.

property of include: channel_type#

type: Type: Boolean

default: Default: False

Indicates whether the type of the channel should be included in the response.

property of include: channel_status#

type: Type: Boolean

default: Default: False

Indicates whether the status of the channel should be included in the response.

Sample code

Builder Pattern

Synchronous:

1pubnub.manage_memberships() \
2    .uuid("some_uuid") \
3    .set([PNChannelMembership.channel(some_channel)]) \
4    .remove([PNChannelMembership.channel(some_channel_with_custom)]) \
5    .include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
6    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.manage_memberships() \
5    .uuid("some_uuid") \
6    .set([PNChannelMembership.channel(some_channel)]) \
7    .remove([PNChannelMembership.channel(some_channel_with_custom)]) \
8    .include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
9    .pn_async(callback)

Named Arguments

Synchronous:

1pubnub.manage_memberships(uuid="some_uuid",
2                          set=[PNChannelMembership.channel(some_channel)],
3                          remove=[PNChannelMembership.channel(some_channel_with_custom)],
4                          include=MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
5    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.manage_memberships(uuid="some_uuid",
5                          set=[PNChannelMembership.channel(some_channel)],
6                          remove=[PNChannelMembership.channel(some_channel_with_custom)],
7                          include=MembershipIncludes(custom=True, channel=True, channel_custom=True))
8    .pn_async(callback)

Returns

The manage_memberships() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNManageMembershipsResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNManageMembershipsResult

Property Name	Type	Description
data		List of dictionaries containing memberships metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
channel	Dictionary containing channel metadata (id, name, description, custom)
custom	Custom object associated with membership in form of dictionary containing string to string pairs

Channel members

Manage the users in a channel: list, set, remove, and manage in bulk.

Get channel members

List users in a channel. Include user metadata if needed.

Method(s)

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

1pubnub.get_channel_members() \
2    .channel(String) \
3    .limit(Integer) \
4    .page(PNPage) \
5    .filter(String) \
6    .sort(* PNSortKey) \
7    .include(MemberIncludes)

channel#

type: Type: String

Default: no default

Channel name

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time

page#

type: Type: PNPage

Default: no default

The paging object used for pagination

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include#

type: Type: MemberIncludes

Default: no default

The additional information to include in the member response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Request totalCount to be included in paginated response, which is omitted by default

property of include: custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data should be included in the response.

property of include: status#

type: Type: Boolean

default: Default: False

Indicates whether the status should be included in the response.

property of include: type#

type: Type: Boolean

default: Default: False

Indicates whether the type should be included in the response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Indicates whether the total count should be included in the response.

property of include: user#

type: Type: Boolean

default: Default: False

Indicates whether the user ID information should be included in the response.

property of include: user_custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data for the user should be included in the response.

property of include: user_type#

type: Type: Boolean

default: Default: False

Indicates whether the type of the user should be included in the response.

property of include: user_status#

type: Type: Boolean

default: Default: False

Indicates whether the status of the user should be included in the response.

Sample code

Builder Pattern

Synchronous:

1pubnub.get_channel_members() \
2    .channel("channel") \
3    .include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
4    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_channel_members() \
5    .channel("channel") \
6    .include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
7    .pn_async(callback)

Named Arguments

Synchronous:

1pubnub.get_channel_members(channel="channel",
2                           include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
3    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.get_channel_members(channel="channel",
5                           include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
6    .pn_async(callback)

Returns

The get_channel_members() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNManageMembershipsResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNGetChannelMembersResult

Property Name	Type	Description
data	[]	List of dictionaries containing channel members metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
uuid	Dictionary containing UUID metadata (id, name, email, externalId, profileUrl, custom)
custom	Custom object associated with channel member in form of dictionary containing string to string pairs

Set channel members

Set users in a channel. Provide UUIDs (optionally with custom data).

Method(s)

To Set Channel Members you can use the following method(s) in the Python SDK:

1pubnub.set_channel_members() \
2    .channel(String) \
3    .uuids([PNUUID object]) \
4    .limit(Integer) \
5    .page(PNPage) \
6    .filter(String) \
7    .sort(* PNSortKey) \
8    .include(MemberIncludes)

channel#

type: Type: String

Default: no default

Channel name

uuids#

type: Type: [PNUUID]

Default: no default

List of members PNUUID to add to channel

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time

page#

type: Type: PNPage

default: Default: null

The paging object used for pagination

filter#

type: Type: String

default: Default: null

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include#

type: Type: MemberIncludes

Default: no default

The additional information to include in the member response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Request totalCount to be included in paginated response, which is omitted by default

property of include: custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data should be included in the response.

property of include: status#

type: Type: Boolean

default: Default: False

Indicates whether the status should be included in the response.

property of include: type#

type: Type: Boolean

default: Default: False

Indicates whether the type should be included in the response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Indicates whether the total count should be included in the response.

property of include: user#

type: Type: Boolean

default: Default: False

Indicates whether the user ID information should be included in the response.

property of include: user_custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data for the user should be included in the response.

property of include: user_type#

type: Type: Boolean

default: Default: False

Indicates whether the type of the user should be included in the response.

property of include: user_status#

type: Type: Boolean

default: Default: False

Indicates whether the status of the user should be included in the response.

API limits

To learn about the maximum length of parameters used to set channel members metadata, refer to REST API docs.

Sample code

Builder Pattern

Synchronous:

1pubnub.set_uuid_metadata() \
2    .uuid("some_uuid") \
3    .set_name("some name") \
4    .sync()
5

6custom_1 = {
7    "key3": "val1",
8    "key4": "val2"
9}
10

11pubnub.set_uuid_metadata() \
12    .uuid("some_uuid_with_custom") \
13    .set_name("some name with custom") \
14    .custom(custom_1) \
15    .sync()
16

17uuids_to_set = [
18    PNUUID.uuid("some_uuid"),
19    PNUUID.uuid_with_custom("some_uuid_with_custom", custom_2)
20]
21

22pubnub.set_channel_members() \
23    .channel("channel id") \
24    .uuids(uuids_to_set) \
25    .include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
26    .sync()

show all 26 lines

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.set_uuid_metadata() \
5    .uuid("some_uuid") \
6    .set_name("some name") \
7    .sync()
8

9custom_1 = {
10    "key3": "val1",
11    "key4": "val2"
12}
13

14pubnub.set_uuid_metadata() \
15    .uuid("some_uuid_with_custom") \
16    .set_name("some name with custom") \
17    .custom(custom_1) \
18    .sync()
19

20uuids_to_set = [
21    PNUUID.uuid("some_uuid"),
22    PNUUID.uuid_with_custom("some_uuid_with_custom", custom_2)
23]
24

25pubnub.set_channel_members() \
26    .channel("channel id") \
27    .uuids(uuids_to_set) \
28    .include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
29    .pn_async(callback)

show all 29 lines

Named Arguments

Synchronous:

1pubnub.set_uuid_metadata(uuid=some_uuid, name="some name").sync()
2

3custom_1 = {
4    "key3": "val1",
5    "key4": "val2"
6}
7

8pubnub.set_uuid_metadata(uuid=some_uuid_with_custom,
9                         name="some name with custom",
10                         custom=custom_1) \
11    .sync()
12

13uuids_to_set = [
14    PNUUID.uuid(some_uuid),
15    PNUUID.uuid_with_custom(some_uuid_with_custom, custom_2)
16]
17

18pubnub.set_channel_members(channel="channel id",
19                           uuids=uuids_to_set,
20                           include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
21    .sync()

show all 21 lines

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.set_uuid_metadata(uuid=some_uuid, name="some name").sync().sync()
5

6custom_1 = {
7    "key3": "val1",
8    "key4": "val2"
9}
10

11pubnub.set_uuid_metadata(uuid=some_uuid_with_custom,
12                         name="some name with custom",
13                         custom=custom_1) \
14    .sync()
15

16uuids_to_set = [
17    PNUUID.uuid(some_uuid),
18    PNUUID.uuid_with_custom(some_uuid_with_custom, custom_2)
19]
20

21pubnub.set_channel_members(channel="channel id",
22                           uuids=uuids_to_set,
23                           include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
24    .pn_async(callback)

show all 24 lines

Returns

The set_channel_members() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNSetChannelMembersResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNSetChannelMembersResult

Property Name	Type	Description
data	[]	List of dictionaries containing channel members metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
uuid	Dictionary containing UUID metadata (id, name, email, externalId, profileUrl, custom)
custom	Custom object associated with channel member in form of dictionary containing string to string pairs

Remove channel members

Remove users from a channel.

Method(s)

To Remove Channel Members you can use the following method(s) in the Python SDK:

1pubnub.remove_channel_members() \
2    .channel(String) \
3    .uuids([PNUUID]) \
4    .limit(Integer) \
5    .page(PNPage) \
6    .filter(String) \
7    .sort(* PNSortKey) \
8    .include_total_count(Boolean) \
9    .include_custom(Boolean) \
10    .includeUUID(Integer)

channel#

type: Type: String

Default: no default

Channel name

uuids#

type: Type: [PNUUID]

Default: no default

List of members (as PNUUID) to remove from channel

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time

page#

type: Type: PNPage

Default: no default

The paging object used for pagination

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include_total_count#

type: Type: Boolean

default: Default: False

Request include_total_count to be included in paginated response, which is omitted by default

include_custom#

type: Type: Boolean

default: Default: False

Whether to include the Custom object in the response.

include_uuid#

type: Type: Integer

Default: no default

The level of uuid metadata details to return in the channel member. Possible values are defined as constants in UUIDIncludeEndpoint: UUIDIncludeEndpoint.UUID and UUIDIncludeEndpoint.UUID_WITH_CUSTOM

Sample code

Builder Pattern

Synchronous:

1pubnub.remove_channel_members() \
2    .channel("channel id") \
3    .uuids([PNUUID.uuid(some_uuid)]) \
4    .include_custom(True) \
5    .include_uuid(UUIDIncludeEndpoint.UUID_WITH_CUSTOM) \
6    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_channel_members() \
5    .channel("channel id") \
6    .uuids([PNUUID.uuid(some_uuid)]) \
7    .include_custom(True) \
8    .include_uuid(UUIDIncludeEndpoint.UUID_WITH_CUSTOM).pn_async(callback)

Named Arguments

Synchronous:

1pubnub.remove_channel_members(channel="channel id",
2                              uuids=[PNUUID.uuid(some_uuid)],
3                              include_custom=True,
4                              include_uuid=UUIDIncludeEndpoint.UUID_WITH_CUSTOM) \
5    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.remove_channel_members(channel="channel id",
5                              uuids=[PNUUID.uuid(some_uuid)],
6                              include_custom=True,
7                              include_uuid=UUIDIncludeEndpoint.UUID_WITH_CUSTOM) \
8    .pn_async(callback)
9

Returns

The remove_channel_members() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNRemoveChannelMembersResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNRemoveChannelMembersResult

Property Name	Type	Description
data	[]	List of dictionaries containing channel members metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
uuid	Dictionary containing UUID metadata (id, name, email, externalId, profileUrl, custom)
custom	Custom object associated with channel member in form of dictionary containing string to string pairs

Manage channel members

Add and remove users in a channel in one request.

Method(s)

To Manage Channel Members you can use the following method(s) in the Python SDK:

1pubnub.manage_channel_members() \
2    .channel(String) \
3    .set([PNUUID]) \
4    .remove([PNUUID]) \
5    .limit(Integer) \
6    .page(PNPage) \
7    .filter(String) \
8    .sort(* PNSortKey) \
9    .include(MemberIncludes)

channel#

type: Type: String

Default: no default

Channel name

set#

type: Type: [PNUUID]

Default: no default

List of members PNUUID to add to channel

remove#

type: Type: [PNUUID]

Default: no default

List of members PNUUID to remove from channel

limit#

type: Type: Integer

default: Default: 100

The maximum number of objects to retrieve at a time

page#

type: Type: PNPage

Default: no default

The paging object used for pagination

filter#

type: Type: String

Default: no default

Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined in the filtering reference.

sort#

type: Type: PNSortKey

Default: no default

List of properties to sort by. Available options are id, name, and updated. Use asc or desc to specify sort direction. For example: {name: 'asc'}

include#

type: Type: MemberIncludes

Default: no default

The additional information to include in the member response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Request totalCount to be included in paginated response, which is omitted by default

property of include: custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data should be included in the response.

property of include: status#

type: Type: Boolean

default: Default: False

Indicates whether the status should be included in the response.

property of include: type#

type: Type: Boolean

default: Default: False

Indicates whether the type should be included in the response.

property of include: total_count#

type: Type: Boolean

default: Default: False

Indicates whether the total count should be included in the response.

property of include: user#

type: Type: Boolean

default: Default: False

Indicates whether the user ID information should be included in the response.

property of include: user_custom#

type: Type: Boolean

default: Default: False

Indicates whether custom data for the user should be included in the response.

property of include: user_type#

type: Type: Boolean

default: Default: False

Indicates whether the type of the user should be included in the response.

property of include: user_status#

type: Type: Boolean

default: Default: False

Indicates whether the status of the user should be included in the response.

Sample code

Builder Pattern

Synchronous:

1pubnub.manage_channel_members() \
2    .channel("channel id") \
3    .set([PNUUID.uuid(some_uuid)]) \
4    .remove([PNUUID.uuid(some_uuid_with_custom)]) \
5    .include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
6    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.manage_channel_members() \
5    .channel("channel id") \
6    .set([PNUUID.uuid(some_uuid)]) \
7    .remove([PNUUID.uuid(some_uuid_with_custom)]) \
8    .include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
9    .pn_async(callback)

Named Arguments

Synchronous:

1pubnub.manage_channel_members(channel="channel id",
2                              set=[PNUUID.uuid(some_uuid)],
3                              remove=[PNUUID.uuid(some_uuid_with_custom)],
4                              include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
5    .sync()

Asynchronous:

1def callback(response, status):
2    pass
3

4pubnub.manage_channel_members(channel="channel id",
5                              set=[PNUUID.uuid(some_uuid)],
6                              remove=[PNUUID.uuid(some_uuid_with_custom)],
7                              include=MemberIncludes(custom=True, channel=True, user_custom=True))
8    .pn_async(callback)

Returns

The manage_channel_members() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	PNManageChannelMembersResult	A detailed object containing the result of the operation.
status	PNStatus	A status object with additional information.

PNManageChannelMembersResult

Property Name	Type	Description
data	[]	List of dictionaries containing channel members metadata
status	PNStatus	Status of the operation
total_count	int	Total count of results (if include_total_count was set)
prev	PNPage.Previous	PNPage instance to be used if further requests
next	PNPage.Next	PNPage instance to be used if further requests

Where each element in data contains a dictionary with membership metadata.

Key	Description
uuid	Dictionary containing UUID metadata (id, name, email, externalId, profileUrl, custom)
custom	Custom object associated with channel member in form of dictionary containing string to string pairs

PNChannelMembership class

PNChannelMembership is a utility class that exposes two factory methods: channel(channel) constructs a channel membership, and channel_with_custom(channelId, custom) constructs a channel membership with additional custom metadata.

1class PNChannelMembership:
2    __metaclass__ = ABCMeta
3

4    def __init__(self, channel):
5        self._channel = channel
6

7    @staticmethod
8    def channel(channel):
9        return JustChannel(channel)
10

11    @staticmethod
12    def channel_with_custom(channel, custom):
13        return ChannelWithCustom(channel, custom)
14

15

16class JustChannel(PNChannelMembership):
17    def __init__(self, channel):
18        PNChannelMembership.__init__(self, channel)
19

20

21class ChannelWithCustom(PNChannelMembership):
22    def __init__(self, channel, custom):
23        PNChannelMembership.__init__(self, channel)
24        self._custom = custom

show all 24 lines

PNUUID class

PNUUID is a utility class that exposes two factory methods: uuid(uuid) constructs a UUID, and uuid_with_custom(channel_id, custom) constructs a UUID with additional custom metadata.

1class PNUUID:
2    __metaclass__ = ABCMeta
3

4    def __init__(self, uuid):
5        self._uuid = uuid
6

7    @staticmethod
8    def uuid(uuid):
9        return JustUUID(uuid)
10

11    @staticmethod
12    def uuid_with_custom(uuid, custom):
13        return UUIDWithCustom(uuid, custom)
14

15

16class JustUUID(PNUUID):
17    def __init__(self, uuid, custom):
18        PNUUID.__init__(self, uuid)
19

20

21class UUIDWithCustom(PNUUID):
22    def __init__(self, uuid, custom):
23        PNUUID.__init__(self, uuid)
24        self._custom = custom

show all 24 lines