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 easily 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. At the same time, making a request to set the same data that already exist, doesn't trigger any 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 anEnvelope
object, which has two fields:Envelope.result
, whose type differs for each API, andEnvelope.status
of typePnStatus
.pubnub.publish() \
.channel("myChannel") \
.message("Hello from PubNub Python SDK") \
.sync() -
.pn_async(callback)
returnsNone
and passes the values ofEnvelope.result
andEnvelope.status
to a callback you must define beforehand.def my_callback_function(result, status):
print(f'TT: {result.timetoken}, status: {status.category.name}')
pubnub.publish() \
.channel("myChannel") \
.message("Hello from PubNub Python SDK") \
.pn_async(my_callback_function)
User
Get Metadata for all Users
Returns a paginated list of UUID metadata objects, optionally including the custom data object for each.
Method(s)
To Get All UUID Metadata
you can use the following method(s) in the Python SDK:
pubnub.get_all_uuid_metadata() \
.limit(Integer) \
.page(PNPage Object) \
.filter(String) \
.sort(List<PNSortKey>) \
.include_total_count(Boolean) \
.include_custom(Boolean) \
.include_status(Boolean) \
.include_type(Boolean)
Parameter | Description |
---|---|
limit Type: Integer Default: N/A | The maximum number of objects to retrieve at a time. |
page Type: PNPage Default: N/A | The paging object used for pagination. |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: List<PNSortKey> Default: N/A | 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: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default. |
include_custom Type: Boolean Default: False | Whether to include the custom object in the fetch response. |
include_status Type: Boolean 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: Boolean Default: True | Whether to include the type field in the fetch response. Setting this to False will prevent this value from being returned. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.get_all_uuid_metadata() \
.include_custom(True) \
.limit(10) \
.include_total_count(True) \
.sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
.page(None) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_all_uuid_metadata() \
.include_custom(True) \
.limit(10) \
.include_total_count(True) \
.sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
.page(None) \
.pn_async(callback)
Synchronous:
metadata = pubnub.get_all_uuid_metadata(limit=10,
include_custom=True,
include_total_count=True,
sort=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_all_uuid_metadata(limit=10,
include_custom=True,
include_total_count=True,
sort=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]) \
.pn_async(callback)
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
Returns metadata for the specified UUID, optionally including its custom data object.
Method(s)
To Get UUID Metadata
you can use the following method(s) in the Python SDK:
pubnub.get_uuid_metadata() \
.uuid(String) \
.include_custom(Boolean)
Parameter | Description |
---|---|
uuid Type: String Default: pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
include_custom Type: Boolean Default: False | Whether to include the custom object in the fetch response. |
include_status Type: Boolean Default: True | Whether to include the status field in the fetch response, which is included by default. |
include_type Type: Boolean Default: True | Whether to include the type field in the fetch response, which is included by default. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.get_uuid_metadata() \
.include_custom(True) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_uuid_metadata() \
.include_custom(True) \
.pn_async(callback)
Synchronous:
metadata = pubnub.get_uuid_metadata(include_custom=True).sync()
Asynchronous:
def callback(response, status):
pass
metadata = 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
Set metadata for a UUID 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:
- Get the existing metadata and store it locally.
- Append the new custom metadata to the existing one.
- Set the entire updated custom object.
Method(s)
To Set UUID Metadata
you can use the following method(s) in the Python SDK:
pubnub.set_uuid_metadata() \
.uuid(String) \
.set_name(String) \
.set_status(String) \
.set_type(String) \
.external_id(String) \
.profile_url(String) \
.email(String) \
.custom(Dictionary) \
.include_custom(Boolean) \
.include_status(Boolean) \
.include_type(Boolean) \
.if_matches_etag(String)
Parameter | Description |
---|---|
uuid Type: String Default: pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
set_name Type: String Default: N/A | Display name for the user. |
set_status Type: String Default: N/A | User status. Max. 50 characters. |
set_type Type: String Default: N/A | User type. Max. 50 characters. |
external_id Type: String Default: N/A | User's identifier in an external system. |
profile_url Type: String Default: N/A | The URL of the user's profile picture. |
email Type: String Default: N/A | The user's email address. |
custom Type: Any Default: N/A | Any object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties. |
include_custom Type: Boolean Default: False | Whether to include the custom object in the fetch response. |
include_status Type: Boolean Default: False | Whether to include the status object in the fetch response. |
include_type Type: Boolean Default: False | Whether to include the type object in the fetch response. |
if_matches_etag Type: String Default: n/a | 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.
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.set_uuid_metadata() \
.include_custom(True) \
.uuid("Some UUID") \
.set_name("Some Name") \
.set_status("Active") \
.set_type("User") \
.email("test@example.com") \
.profile_url("http://example.com") \
.external_id("1234567890") \
.custom({"key1": "val1", "key2": "val2"}) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.set_uuid_metadata() \
.include_custom(True) \
.uuid("Some UUID") \
.set_name("Some Name") \
.set_status("Active") \
.set_type("User") \
.email("test@example.com") \
.profile_url("http://example.com") \
.external_id("1234567890") \
.custom({"key1": "val1", "key2": "val2"}) \
pn_async(callback)
Synchronous:
pubnub.set_uuid_metadata(uuid="Some UUID",
name="Some Name",
status="Active", type="User",
email="test@example.com",
profile_url="http://example.com",
external_id="1234567890",
custom={"key1": "val1", "key2": "val2"}) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.set_uuid_metadata(uuid="Some UUID",
name="Some Name",
status="Active", type="User",
email="test@example.com",
profile_url="http://example.com",
external_id="1234567890",
custom={"key1": "val1", "key2": "val2"}) \
.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
Removes the metadata from a specified UUID.
Method(s)
To Remove UUID Metadata
you can use the following method(s) in the Python SDK:
pubnub.remove_uuid_metadata() \
.uuid(String)
Parameter | Description |
---|---|
uuid Type: String Default: pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.remove_uuid_metadata() \
.uuid("Some UUID").sync()
Asynchronous:
def callback(response, status):
pass
pubnub.remove_uuid_metadata() \
.uuid("Some UUID").pn_async(callback)
pubnub.remove_uuid_metadata(uuid="Some UUID").sync()
Asynchronous:
def callback(response, status):
pass
pubnub.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
Get Metadata for all Channels
Returns a paginated list of Channel Metadata objects, optionally including the custom data object for each.
Method(s)
To Get All Channel Metadata
you can use the following method(s) in the Python SDK:
pubnub.get_all_channel_metadata() \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(PNSortKey) \
.include_total_count(Boolean) \
.include_custom(Boolean) \
.include_status(Boolean) \
.include_type(Boolean)
Parameter | Description |
---|---|
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time. |
page Type: PNPage Default: N/A | The paging object used for pagination. |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: [PNSortKey] Default: N/A | 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: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default. |
include_custom Type: Boolean Default: False | Whether to include the custom object in the fetch response. |
include_status Type: Boolean 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: Boolean Default: True | Whether to include the type field in the fetch response. Setting this to False will prevent this value from being returned. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.get_all_channel_metadata() \
.include_custom(True) \
.limit(10) \
.include_total_count(True) \
.sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
.page(None) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_all_channel_metadata() \
.include_custom(True) \
.limit(10) \
.include_total_count(True) \
.sort(PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)) \
.page(None) \
.pn_async(callback)
Synchronous:
metadata = pubnub.get_all_channel_metadata(limit=10,
include_custom=True,
include_total_count=True,
sort=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_all_channel_metadata(limit=10,
include_custom=True,
include_total_count=True,
sort=[PNSortKey.asc(PNSortKeyValue.ID), PNSortKey.desc(PNSortKeyValue.UPDATED)]) \
.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
Returns metadata for the specified channel, optionally including its custom data object.
Method(s)
To Get Channel Metadata
you can use the following method(s) in the Python SDK:
pubnub.get_channel_metadata() \
.channel(String) \
.include_custom(Boolean) \
.include_status(Boolean) \
.include_type(Boolean)
Parameter | Description |
---|---|
channel Type: str Default: n/a | Channel name |
include_custom Type: bool Default: False | Whether to include the custom object in the fetch response. |
include_status Type: Boolean 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: Boolean Default: True | Whether to include the type field in the fetch response. Setting this to False will prevent this value from being returned. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.get_channel_metadata() \
.include_custom(True) \
.channel("channel") \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_channel_metadata() \
.include_custom(True) \
.channel("channel") \
.pn_async(callback)
Synchronous:
pubnub.get_channel_metadata(channel="channel", include_custom=True).sync()
Asynchronous:
def callback(response, status):
pass
pubnub.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
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:
- Get the existing metadata and store it locally.
- Append the new custom metadata to the existing one.
- Set the entire updated custom object.
Method(s)
To Set Channel Metadata
you can use the following method(s) in the Python SDK:
pubnub.set_channel_metadata() \
.channel(String) \
.set_name(String) \
.set_status(String) \
.set_type(String) \
.description(String) \
.custom(Dictionary) \
.include_custom(Boolean) \
.include_status(Boolean) \
.include_type(Boolean) \
.if_matches_etag(String)
Parameter | Description |
---|---|
channel Type: String Default: n/a | Channel ID. |
set_name Type: String Default: N/A | Name of the channel. |
set_status Type: String Default: N/A | Channel status. Max. 50 characters. |
set_type Type: String Default: N/A | Channel type. Max. 50 characters. |
description Type: String Default: N/A | Description of a channel. |
custom Type: Map<String, Object> Default: N/A | Any object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties. |
include_custom Type: Boolean Default: False | Whether to include the custom object in the fetch response. |
include_status Type: Boolean Default: False | Whether to include the status object in the fetch response. |
include_type Type: Boolean Default: False | Whether to include the type object in the fetch response. |
if_matches_etag Type: String Default: n/a | 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.
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.set_channel_metadata() \
.include_custom(True) \
.channel("channel id") \
.set_name("Channel Name") \
.set_status("Archived") \
.set_type("Archived") \
.description("Description") \
.custom({ "key1": "val1", "key2": "val2" }) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.set_channel_metadata() \
.include_custom(True) \
.channel("channel id") \
.set_name("Channel Name") \
.set_status("Archived") \
.set_type("Archived") \
.description("Description") \
.custom({ "key1": "val1", "key2": "val2" }) \
.pn_async(callback)
Synchronous:
pubnub.set_channel_metadata(channel="channel id",
name="Channel Name",
status="Archived",
type="Archived",
description="Description",
custom={ "key1": "val1", "key2": "val2" },
include_custom=True) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.set_channel_metadata(channel="channel id",
name="Channel Name",
status="Archived",
type="Archived",
description="Description",
custom={ "key1": "val1", "key2": "val2" },
include_custom=True) \
.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
Remove Channel Metadata
Removes the metadata from a specified channel.
Method(s)
To Remove Channel Metadata
you can use the following method(s) in the Python SDK:
pubnub.remove_channel_metadata() \
.channel(String)
Parameter | Description |
---|---|
channel Type: String Default: n/a | Channel name |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.remove_channel_metadata() \
.channel("channel id") \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.remove_channel_metadata() \
.channel("channel id") \
.pn_async(callback)
Synchronous:
pubnub.remove_channel_metadata(channel="channel id").sync()
Asynchronous:
def callback(response, status):
pass
pubnub.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
Get Channel Memberships
The method returns a list of channel memberships for a user. This method doesn't return a user's subscriptions.
Method(s)
To Get Channel Memberships
you can use the following method(s) in the Python SDK:
pubnub.get_memberships() \
.uuid(String) \
.limit(Integer) \
.page(PNPage Object) \
.filter(String) \
.sort(* PNSortKey Object) \
.include(MembershipIncludes)
Parameter | Description |
---|---|
uuid Type: String Default: pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time |
page Type: PNPage Default: N/A | The paging object used for pagination |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: MembershipIncludes Default: n/a | The additional information to include in the membership response. |
→ total_count Type: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default |
→ custom Type: Boolean Default: False | Indicates whether custom data should be included in the response. |
→ status Type: Boolean Default: False | Indicates whether the status should be included in the response. |
→ type Type: Boolean Default: False | Indicates whether the type should be included in the response. |
→ total_count Type: Boolean Default: False | Indicates whether the total count should be included in the response. |
→ channel Type: Boolean Default: False | Indicates whether the channel information should be included in the response. |
→ channel_custom Type: Boolean Default: False | Indicates whether custom data for the channel should be included in the response. |
→ channel_type Type: Boolean Default: False | Indicates whether the type of the channel should be included in the response. |
→ channel_status Type: Boolean Default: False | Indicates whether the status of the channel should be included in the response. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.get_memberships() \
.include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
.uuid("Some UUID").sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_memberships() \
.include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
.uuid("Some UUID").pn_async(callback)
Synchronous:
pubnub.get_memberships(uuid="Some UUID",
include=MembershipIncludes(custom=True, channel=True, channel_custom=True))
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_memberships(uuid="Some UUID",
include=.MembershipIncludes(custom=True, channel=True, channel_custom=True))
.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
Set channel memberships for a UUID.
Method(s)
To Set Channel Memberships
you can use the following method(s) in the Python SDK:
pubnub.set_memberships() \
.channel_memberships([PNChannelMembership]) \
.uuid(String) \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(* PNSort Object) \
.include(MembershipIncludes)
Parameter | Description |
---|---|
channelMemberships Type: [PNChannelMembership] Default: n/a | Collection of PNChannelMembership to add to membership |
uuid Type: String Default: pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time |
page Type: PNPage Default: N/A | The paging object used for pagination |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: MembershipIncludes Default: n/a | The additional information to include in the membership response. |
→ total_count Type: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default |
→ custom Type: Boolean Default: False | Indicates whether custom data should be included in the response. |
→ status Type: Boolean Default: False | Indicates whether the status should be included in the response. |
→ type Type: Boolean Default: False | Indicates whether the type should be included in the response. |
→ total_count Type: Boolean Default: False | Indicates whether the total count should be included in the response. |
→ channel Type: Boolean Default: False | Indicates whether the channel information should be included in the response. |
→ channel_custom Type: Boolean Default: False | Indicates whether custom data for the channel should be included in the response. |
→ channel_type Type: Boolean Default: False | Indicates whether the type of the channel should be included in the response. |
→ channel_status Type: Boolean 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.
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
some_channel = "somechannel"
some_channel_with_custom = "somechannel_with_custom"
pubnub.set_channel_metadata() \
.channel(some_channel) \
.set_name("some name") \
.sync()
custom_1 = {
"key3": "val1",
"key4": "val2",
}
pubnub.set_channel_metadata() \
.channel(some_channel_with_custom) \
show all 34 linesAsynchronous:
def callback(response, status):
pass
some_channel = "somechannel"
some_channel_with_custom = "somechannel_with_custom"
pubnub.set_channel_metadata() \
.channel(some_channel) \
.set_name("some name") \
.sync()
custom_1 = {
"key3": "val1",
"key4": "val2"
}
show all 37 linesSynchronous:
some_channel = "somechannel"
some_channel_with_custom = "somechannel_with_custom"
pubnub.set_channel_metadata(channel=some_channel, name="some name").sync()
custom_1 = {
"key3": "val1",
"key4": "val2",
}
pubnub.set_channel_metadata(channel=some_channel_with_custom,
name="some name with custom",
custom=custom_1) \
.sync()
show all 29 linesAsynchronous:
def callback(response, status):
pass
some_channel = "somechannel"
some_channel_with_custom = "somechannel_with_custom"
pubnub.set_channel_metadata(channel=some_channel, name="some name").pn_async(callback)
custom_1 = {
"key3": "val1",
"key4": "val2"
}
pubnub.set_channel_metadata(channel=some_channel_with_custom,
name="some name with custom",
show all 32 linesReturns
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 channel memberships for a UUID.
Method(s)
To Remove Channel Memberships
you can use the following method(s) in the Python SDK:
pubnub.remove_memberships() \
.channel_memberships([PNChannelMembership]) \
.uuid(String) \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(* PNSort) \
.include_total_count(Boolean) \
.include_custom(Boolean) \
.include_channel(Integer)
Parameter | Description |
---|---|
channel_memberships Type: [PNChannelMembership] Default: n/a | List of channels (as PNChannelMembership ) to remove from membership. |
uuid Type: String Default: pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time. |
page Type: PNPage Default: N/A | The paging object used for pagination. |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default |
include_custom Type: Boolean Default: False | Whether to include the custom object in the fetch response. |
include_channel Type: Integer Default: N/A | 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 |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.remove_memberships() \
.uuid("some_uuid") \
.channel_memberships([PNChannelMembership.channel(some_channel)]) \
.include_custom(True) \
.include_channel(ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.remove_memberships() \
.uuid("some_uuid") \
.channel_memberships([PNChannelMembership.channel(some_channel)]) \
.include_custom(True) \
.include_channel(ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM) \
.pn_async(callback)
Synchronous:
pubnub.remove_memberships(uuid="some_uuid",
channel_memberships=[PNChannelMembership.channel(some_channel)],
include_channel=ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM
include_custom=True) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.remove_memberships(uuid="some_uuid",
channel_memberships=[PNChannelMembership.channel(some_channel)],
include_channel=ChannelIncludeEndpoint.CHANNEL_WITH_CUSTOM
include_custom=True) \
.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
Manage a user's channel memberships.
Method(s)
To Manage Channel Memberships
you can use the following method(s) in the Python SDK:
pubnub.manage_memberships() \
.uuid(String) \
.set([PNChannelMembership>]) \
.remove([PNChannelMembership]) \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(* PNSortKey) \
.include(MembershipIncludes)
Parameter | Description |
---|---|
uuid Type: String Default: pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
set Type: [PNChannelMembership] Default: n/a | List of members PNChannelMembership to add to channel |
remove Type: [PNChannelMembership] Default: n/a | List of members PNChannelMembership to remove from channel |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time |
page Type: PNPage Default: null | The paging object used for pagination |
filter Type: String Default: null | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: MembershipIncludes Default: n/a | The additional information to include in the membership response. |
→ total_count Type: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default |
→ custom Type: Boolean Default: False | Indicates whether custom data should be included in the response. |
→ status Type: Boolean Default: False | Indicates whether the status should be included in the response. |
→ type Type: Boolean Default: False | Indicates whether the type should be included in the response. |
→ total_count Type: Boolean Default: False | Indicates whether the total count should be included in the response. |
→ channel Type: Boolean Default: False | Indicates whether the channel information should be included in the response. |
→ channel_custom Type: Boolean Default: False | Indicates whether custom data for the channel should be included in the response. |
→ channel_type Type: Boolean Default: False | Indicates whether the type of the channel should be included in the response. |
→ channel_status Type: Boolean Default: False | Indicates whether the status of the channel should be included in the response. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.manage_memberships() \
.uuid("some_uuid") \
.set([PNChannelMembership.channel(some_channel)]) \
.remove([PNChannelMembership.channel(some_channel_with_custom)]) \
.include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.manage_memberships() \
.uuid("some_uuid") \
.set([PNChannelMembership.channel(some_channel)]) \
.remove([PNChannelMembership.channel(some_channel_with_custom)]) \
.include(MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
.pn_async(callback)
Synchronous:
pubnub.manage_memberships(uuid="some_uuid",
set=[PNChannelMembership.channel(some_channel)],
remove=[PNChannelMembership.channel(some_channel_with_custom)],
include=MembershipIncludes(custom=True, channel=True, channel_custom=True)) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.manage_memberships(uuid="some_uuid",
set=[PNChannelMembership.channel(some_channel)],
remove=[PNChannelMembership.channel(some_channel_with_custom)],
include=MembershipIncludes(custom=True, channel=True, channel_custom=True))
.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
Get Channel Members
The method returns a list of members in a channel. The list will include user metadata for members that have additional metadata stored in the database.
Method(s)
To Get Channel Members
you can use the following method(s) in the Python SDK:
pubnub.get_channel_members() \
.channel(String) \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(* PNSortKey) \
.include(MemberIncludes)
Parameter | Description |
---|---|
channel Type: String Default: n/a | Channel name |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time |
page Type: PNPage Default: N/A | The paging object used for pagination |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: MemberIncludes Default: n/a | The additional information to include in the member response. |
→ total_count Type: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default |
→ custom Type: Boolean Default: False | Indicates whether custom data should be included in the response. |
→ status Type: Boolean Default: False | Indicates whether the status should be included in the response. |
→ type Type: Boolean Default: False | Indicates whether the type should be included in the response. |
→ total_count Type: Boolean Default: False | Indicates whether the total count should be included in the response. |
→ user Type: Boolean Default: False | Indicates whether the user ID information should be included in the response. |
→ user_custom Type: Boolean Default: False | Indicates whether custom data for the user should be included in the response. |
→ user_type Type: Boolean Default: False | Indicates whether the type of the user should be included in the response. |
→ user_status Type: Boolean Default: False | Indicates whether the status of the user should be included in the response. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.get_channel_members() \
.channel("channel") \
.include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_channel_members() \
.channel("channel") \
.include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
.pn_async(callback)
Synchronous:
pubnub.get_channel_members(channel="channel",
include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.get_channel_members(channel="channel",
include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
.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
This method sets members in a channel.
Method(s)
To Set Channel Members
you can use the following method(s) in the Python SDK:
pubnub.set_channel_members() \
.channel(String) \
.uuids([PNUUID object]) \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(* PNSortKey) \
.include(MemberIncludes)
Parameter | Description |
---|---|
channel Type: String Default: n/a | Channel name |
uuids Type: [PNUUID] Default: n/a | List of members PNUUID to add to channel |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time |
page Type: PNPage Default: null | The paging object used for pagination |
filter Type: String Default: null | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: MemberIncludes Default: n/a | The additional information to include in the member response. |
→ total_count Type: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default |
→ custom Type: Boolean Default: False | Indicates whether custom data should be included in the response. |
→ status Type: Boolean Default: False | Indicates whether the status should be included in the response. |
→ type Type: Boolean Default: False | Indicates whether the type should be included in the response. |
→ total_count Type: Boolean Default: False | Indicates whether the total count should be included in the response. |
→ user Type: Boolean Default: False | Indicates whether the user ID information should be included in the response. |
→ user_custom Type: Boolean Default: False | Indicates whether custom data for the user should be included in the response. |
→ user_type Type: Boolean Default: False | Indicates whether the type of the user should be included in the response. |
→ user_status Type: Boolean 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.
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.set_uuid_metadata() \
.uuid("some_uuid") \
.set_name("some name") \
.sync()
custom_1 = {
"key3": "val1",
"key4": "val2"
}
pubnub.set_uuid_metadata() \
.uuid("some_uuid_with_custom") \
.set_name("some name with custom") \
.custom(custom_1) \
.sync()
show all 26 linesAsynchronous:
def callback(response, status):
pass
pubnub.set_uuid_metadata() \
.uuid("some_uuid") \
.set_name("some name") \
.sync()
custom_1 = {
"key3": "val1",
"key4": "val2"
}
pubnub.set_uuid_metadata() \
.uuid("some_uuid_with_custom") \
show all 29 linesSynchronous:
pubnub.set_uuid_metadata(uuid=some_uuid, name="some name").sync()
custom_1 = {
"key3": "val1",
"key4": "val2"
}
pubnub.set_uuid_metadata(uuid=some_uuid_with_custom,
name="some name with custom",
custom=custom_1) \
.sync()
uuids_to_set = [
PNUUID.uuid(some_uuid),
PNUUID.uuid_with_custom(some_uuid_with_custom, custom_2)
show all 21 linesAsynchronous:
def callback(response, status):
pass
pubnub.set_uuid_metadata(uuid=some_uuid, name="some name").sync().sync()
custom_1 = {
"key3": "val1",
"key4": "val2"
}
pubnub.set_uuid_metadata(uuid=some_uuid_with_custom,
name="some name with custom",
custom=custom_1) \
.sync()
show all 24 linesReturns
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 members from a Channel.
Method(s)
To Remove Channel Members
you can use the following method(s) in the Python SDK:
pubnub.remove_channel_members() \
.channel(String) \
.uuids([PNUUID]) \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(* PNSortKey) \
.include_total_count(Boolean) \
.include_custom(Boolean) \
.includeUUID(Integer)
Parameter | Description |
---|---|
channel Type: String Default: n/a | Channel name |
uuids Type: [PNUUID] Default: n/a | List of members (as PNUUID ) to remove from channel |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time |
page Type: PNPage Default: N/A | The paging object used for pagination |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: Boolean Default: False | Request include_total_count to be included in paginated response, which is omitted by default |
include_custom Type: Boolean Default: False | Whether to include the custom object in the fetch response |
include_uuid Type: Integer Default: N/A | 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 |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.remove_channel_members() \
.channel("channel id") \
.uuids([PNUUID.uuid(some_uuid)]) \
.include_custom(True) \
.include_uuid(UUIDIncludeEndpoint.UUID_WITH_CUSTOM) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.remove_channel_members() \
.channel("channel id") \
.uuids([PNUUID.uuid(some_uuid)]) \
.include_custom(True) \
.include_uuid(UUIDIncludeEndpoint.UUID_WITH_CUSTOM).pn_async(callback)
Synchronous:
pubnub.remove_channel_members(channel="channel id",
uuids=[PNUUID.uuid(some_uuid)],
include_custom=True,
include_uuid=UUIDIncludeEndpoint.UUID_WITH_CUSTOM) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.remove_channel_members(channel="channel id",
uuids=[PNUUID.uuid(some_uuid)],
include_custom=True,
include_uuid=UUIDIncludeEndpoint.UUID_WITH_CUSTOM) \
.pn_async(callback)
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
Manage the members of a channel.
Method(s)
To Manage Channel Members
you can use the following method(s) in the Python SDK:
pubnub.manage_channel_members() \
.channel(String) \
.set([PNUUID]) \
.remove([PNUUID]) \
.limit(Integer) \
.page(PNPage) \
.filter(String) \
.sort(* PNSortKey) \
.include(MemberIncludes)
Parameter | Description |
---|---|
channel Type: String Default: n/a | Channel name |
set Type: [PNUUID] Default: n/a | List of members PNUUID to add to channel |
remove Type: [PNUUID] Default: n/a | List of members PNUUID to remove from channel |
limit Type: Integer Default: 100 | The maximum number of objects to retrieve at a time |
page Type: PNPage Default: N/A | The paging object used for pagination |
filter Type: String Default: N/A | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here. |
sort Type: PNSortKey Default: N/A | 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: MemberIncludes Default: n/a | The additional information to include in the member response. |
→ total_count Type: Boolean Default: False | Request totalCount to be included in paginated response, which is omitted by default |
→ custom Type: Boolean Default: False | Indicates whether custom data should be included in the response. |
→ status Type: Boolean Default: False | Indicates whether the status should be included in the response. |
→ type Type: Boolean Default: False | Indicates whether the type should be included in the response. |
→ total_count Type: Boolean Default: False | Indicates whether the total count should be included in the response. |
→ user Type: Boolean Default: False | Indicates whether the user ID information should be included in the response. |
→ user_custom Type: Boolean Default: False | Indicates whether custom data for the user should be included in the response. |
→ user_type Type: Boolean Default: False | Indicates whether the type of the user should be included in the response. |
→ user_status Type: Boolean Default: False | Indicates whether the status of the user should be included in the response. |
Basic Usage
- Builder Pattern
- Named Arguments
Synchronous:
pubnub.manage_channel_members() \
.channel("channel id") \
.set([PNUUID.uuid(some_uuid)]) \
.remove([PNUUID.uuid(some_uuid_with_custom)]) \
.include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.manage_channel_members() \
.channel("channel id") \
.set([PNUUID.uuid(some_uuid)]) \
.remove([PNUUID.uuid(some_uuid_with_custom)]) \
.include(MemberIncludes(custom=True, channel=True, user_custom=True)) \
.pn_async(callback)
Synchronous:
pubnub.manage_channel_members(channel="channel id",
set=[PNUUID.uuid(some_uuid)],
remove=[PNUUID.uuid(some_uuid_with_custom)],
include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
.sync()
Asynchronous:
def callback(response, status):
pass
pubnub.manage_channel_members(channel="channel id",
set=[PNUUID.uuid(some_uuid)],
remove=[PNUUID.uuid(some_uuid_with_custom)],
include=MemberIncludes(custom=True, channel=True, user_custom=True)) \
.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.
class PNChannelMembership:
__metaclass__ = ABCMeta
def __init__(self, channel):
self._channel = channel
@staticmethod
def channel(channel):
return JustChannel(channel)
@staticmethod
def channel_with_custom(channel, custom):
return ChannelWithCustom(channel, custom)
show all 24 linesPNUUID 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.
class PNUUID:
__metaclass__ = ABCMeta
def __init__(self, uuid):
self._uuid = uuid
@staticmethod
def uuid(uuid):
return JustUUID(uuid)
@staticmethod
def uuid_with_custom(uuid, custom):
return UUIDWithCustom(uuid, custom)
show all 24 lines