On this page

App Context API for Dart 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 set or removed from the database. Clients can receive these events in real time and update their front-end application accordingly.

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

1pubnub.objects.getAllUUIDMetadata(
{bool? includeCustomFields,
int? limit,
String? start,
String? end,
bool? includeCount,
bool includeStatus,
bool includeType,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
13) 

* required

Parameter	Description
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`limit` Type: `int` Default: 100	Number of objects to return. Default/Max: 100.
`start` Type: `String` Default: n/a	Cursor-based pagination.
`end` Type: `String` Default: n/a	Cursor-based pagination.
`includeCount` Type: `bool` Default: `true`	Whether to include the total count in the paginated response. Default is false.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering guide.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

Reference code

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

1import 'package:pubnub/pubnub.dart';
2

3void main() async {
// Create PubNub instance with default keyset.
var pubnub = PubNub(
  defaultKeyset: Keyset(
    subscribeKey: 'demo',
    publishKey: 'demo',
    userId: UserId('myUniqueUserId'),
  ),
);
12

// Get metadata for all users
try {
  var result = await pubnub.objects.getAllUUIDMetadata(
    includeCustomFields: true,
    limit: 20,
  );
19

  // Print the result
  for (var metadata in result.data) {
    print('UUID: ${metadata.id}, Name: ${metadata.name}');
  }
} catch (e) {
  print('Failed to get all UUID metadata: $e');
}
27}
show all 27 lines

Response

1{
  "status": 200,
  "data": [
      {
          "id": "uuid-1",
          "name": "John Doe",
          "externalId": null,
          "profileUrl": null,
          "email": "johndoe@pubnub.com",
          "custom": null,
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "MDcyQ0REOTUtNEVBOC00QkY2LTgwOUUtNDkwQzI4MjgzMTcwCg=="
      },
      {
          "id": "uuid-2",
          "name": "Bob Cat",
          "externalId": null,
          "profileUrl": null,
          "email": "bobc@example.com",
          "custom": {
              "phone": "999-999-9999"
          },
          "updated": "2019-02-21T03:29:00.173452",
          "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
      }
  ]
27}
show all 27 lines

Get user metadata

Returns metadata for the specified UUID, optionally including the custom data object for each.

Method(s)

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

1pubnub.objects.getUUIDMetadata(
{String? uuid,
Keyset? keyset,
String? using,
bool? includeCustomFields,
bool includeStatus,
bool includeType
}
9) 

* required

Parameter	Description
`uuid` Type: `String` Default: defaultKeyset UUID	The UUID to get the metadata for. If not supplied, the UUID from configuration will be used.
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.

Sample code

1var result = await pubnub.objects.getUUIDMetadata();

Response

1{
  "status": 200,
  "data": {
      "id": "uuid-1",
      "name": "John Doe",
      "externalId": null,
      "profileUrl": null,
      "email": "johndoe@pubnub.com",
      "updated": "2019-02-20T23:11:20.893755",
      "eTag": "MDcyQ0REOTUtNEVBOC00QkY2LTgwOUUtNDkwQzI4MjgzMTcwCg=="
  }
12}

Set user metadata

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.

Set metadata for a UUID in the database, optionally including the custom data object for each.

Method(s)

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

1pubnub.objects.setUUIDMetadata(
UuidMetadataInput uuidMetadataInput,
{String? uuid,
bool? includeCustomFields,
bool includeStatus,
bool includeType,
String? ifMatchesEtag,
Keyset? keyset,
String? using}
10)
11

12class UuidMetadataInput {
String? name;
String? email;
dynamic custom;
String? externalId;
String? profileUrl;
String? status;
String? type;
20}
show all 20 lines

* required

Parameter	Description
`uuidMetadataInput` * Type: `UuidMetadataInput` Default: n/a	UUID metadata details. App Context filtering language doesn’t support filtering by custom properties.
`uuid` Type: `String` Default: defaultKeyset UUID	UUID to set the metadata to. If not supplied, the UUID from configuration will be used.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`ifMatchesEtag` Type: String? Default: n/a	Use the eTag from an applicable get metadata call to ensure updates only apply if the object hasn’t changed. If the eTags differ, the server returns HTTP 412.
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

API limits

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

Sample code

1var uuidMetadataInput = UuidMetadataInput(
2    name: 'foo',
3    email: 'foo@example.domain',
4    profileUrl: 'http://sample.com');
5var result = await pubnub.objects.setUUIDMetadata(uuidMetadataInput);

Response

1{
  "status": 200,
  "data": {
      "id": "uuid-1",
      "name": "John Doe",
      "externalId": null,
      "profileUrl": null,
      "email": "johndoe@pubnub.com",
      "updated": "2019-02-20T23:11:20.893755",
      "eTag": "MDcyQ0REOTUtNEVBOC00QkY2LTgwOUUtNDkwQzI4MjgzMTcwCg=="
  }
12}

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

1pubnub.objects.removeUUIDMetadata(
2  {String? uuid,
3  Keyset? keyset,
4  String? using}
5) 

* required

Parameter	Description
`uuid` Type: `String`	Unique UUID Metadata identifier. If not supplied, the UUID from configuration will be used.
`keyset` Type: `Keyset`	Override for the PubNub default keyset configuration.
`using` Type: `String`	Keyset name from the `keysetStore` to be used for this method call.

Sample code

1var result = await pubnub.objects.removeUUIDMetadata();

Response

The removeUUIDMetadata() returns RemoveUuidMetadataResult which does not have actionable data. In case of an error, an exception with error details is thrown.

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

1pubnub.objects.getAllChannelMetadata(
{int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeCount,
bool includeStatus,
bool includeType,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
13)

* required

Parameter	Description
`limit` Type: `int` Default: 100	The number of objects to retrieve at a time.
`start` Type: `String` Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination, it fetches the next page, allowing you to continue from where you left off.
`end` Type: `String` Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination, it fetches the previous page, enabling access to earlier data. Ignored if the `start` parameter is supplied.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeCount` Type: `bool` Default: `true`	Whether to include the total count in the paginated response. Default is false.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

1var result = await pubnub.objects.getAllChannelMetadata();

Response

1{
  "status": 200,
  "data": [
      {
          "id": "my-channel",
          "name": "My channel",
          "description": "A channel that is mine",
          "custom": null,
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
      },
      {
          "id": "main",
          "name": "Main channel",
          "description": "The main channel",
          "custom": {
              "public": true,
              "motd": "Always check your spelling!"
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
      }
  ],
  "totalCount": 9,
  "next": "MUIwQTAwMUItQkRBRC00NDkyLTgyMEMtODg2OUU1N0REMTNBCg==",
  "prev": "M0FFODRENzMtNjY2Qy00RUExLTk4QzktNkY1Q0I2MUJFNDRCCg=="
27}
show all 27 lines

Get channel metadata

Returns metadata for the specified Channel, optionally including the custom data object for each.

Method(s)

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

1pubnub.objects.getChannelMetadata(
String channelId,
{Keyset? keyset,
String? using,
bool? includeCustomFields
bool includeStatus,
bool includeType}
8) 

* required

Parameter	Description
`channelId` * Type: `String` Default: n/a	Channel name.
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.

Sample code

1var channelMetadata = await pubnub.objects.getChannelMetadata('my_channel');

Response

1{
  "status": 200,
  "data": {
      "id": "my-channel",
      "name": "My channel",
      "description": "A channel that is mine",
      "updated": "2019-02-20T23:11:20.893755",
      "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
  }
10}

Set channel metadata

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.

Set metadata for a Channel in the database, optionally including the custom data object for each.

Method(s)

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

1pubnub.objects.setChannelMetadata(
2  String channelId,
3  ChannelMetadataInput channelMetadataInput,
4  {bool? includeCustomFields,
5  bool includeStatus,
6  bool includeType,
7  String? ifMatchesEtag,
8  Keyset? keyset,
9  String? using}
10) 
11

12class ChannelMetadataInput {
13  String? name;
14  String? description;
15  dynamic custom;
16  String? status;
17  String? type;
18}
show all 18 lines

* required

Parameter	Description
`channelId` * Type: `String` Default: n/a	Channel name.
`channelMetadataInput` * Type: `ChannelMetadataInput` Default: n/a	Channel metadata details. Filtering by `Custom` isn’t supported.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the `Custom` field in the fetch response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`ifMatchesEtag` Type: String? Default: n/a	Use the eTag from an applicable get metadata call to ensure updates only apply if the object hasn’t changed. If the eTags differ, the server returns HTTP 412.
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

API limits

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

Sample code

1var channelMetadataInput = ChannelMetadataInput(
2    name: 'Channel name', description: 'A channel that is mine');
3    
4var result = await pubnub.objects
5    .setChannelMetadata('my_channel', channelMetadataInput);

Response

1{
  "status": 200,
  "data": {
      "id": "my-channel",
      "name": "My channel",
      "description": "A channel that is mine",
      "updated": "2019-02-20T23:11:20.893755",
      "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
  }
10}

Other examples

Iteratively update existing metadata

1import 'dart:async';
2import 'package:pubnub/pubnub.dart';
3Future<void> main() async {
var keyset = Keyset(
    publishKey: 'demo',
    subscribeKey: 'demo',
    userId: const UserId('example'));
var pubnub = PubNub(defaultKeyset: keyset);
var channel = 'main';
var name = 'Main Channel';
var description = 'This is the main channel.';
var custom = {'users': 10};
13

// Setting the basic channel info
var channelMetadataInput = ChannelMetadataInput(
  name: name,
  description: description,
  custom: custom
);
var setResult =
    await pubnub.objects.setChannelMetadata(channel, channelMetadataInput);
print('The channel has been created with name and description.\n');
23

  // First we have to get the current object to know what fields are already set
  var currentObject = await pubnub.objects
      .getChannelMetadata(channel, includeCustomFields: true);
27

  // We may have to initialize the custom field
  var customFields = currentObject.metadata.custom;
  customFields ??= {};
31

  // Updating the custom field
  customFields['private'] = false;
34

  // Writing the updated object back to the server
  channelMetadataInput = ChannelMetadataInput(
    name: currentObject.metadata.name,
    description: currentObject.metadata.description,
    custom: customFields,
  );
41

  try {
    setResult =
        await pubnub.objects.setChannelMetadata(channel, channelMetadataInput);
    print('The channel has been updated with the custom field.\n');
  } on PubNubException catch (e) {
    print('An error occurred: ${e.message}');
  }
49}
show all 49 lines

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

1pubnub.objects.removeChannelMetadata(
2  String channelId,
3  {Keyset? keyset,
4  String? using}
5) 

* required

Parameter	Description
`channelID` * Type: `String`	Channel name.
`keyset` Type: `Keyset`	Override for the PubNub default keyset configuration.
`using` Type: `String`	Keyset name from the `keysetStore` to be used for this method call.

Sample code

1var result = await pubnub.objects.removeChannelMetadata('my_channel');

Response

The removeChannelMetadata() returns RemoveChannelMetadataResult which does not have actionable data. In case of an error, an exception with error details is thrown.

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

1pubnub.objects.getMemberships(
{String? uuid,
int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeChannelFields,
bool? includeChannelCustomFields,
bool? includeChannelStatus,
bool? includeChannelType,
bool? includeCount = true,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
16) 
show all 16 lines

* required

Parameter	Description
`uuid` Type: `String` Default: defaultKeyset UUID	Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`start` Type: `String` Default: n/a	Cursor-based pagination.
`end` Type: `String` Default: n/a	Cursor-based pagination.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeChannelFields` Type: `bool` Default: `false`	Include fields for channels metadata.
`includeCustomChannelFields` Type: `bool` Default: `false`	Include custom fields for channels metadata.
`includeChannelStatus` Type: `bool` Default: `true`	Whether to include the channel `status` object in the response.
`includeChannelType` Type: `bool` Default: `true`	Whether to include the channel `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Whether to include the total count in the paginated response. Default is false.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

1  var memberships = await pubnub.objects.getMemberships();

Response

1{
  "status": 200,
  "data": [
      {
          "channel": {
              "id": "my-channel",
              "name": "My channel",
              "description": "A channel that is mine",
              "custom": null,
              "updated": "2019-02-20T23:11:20.893755",
              "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
          },
          "custom": {
              "starred": false
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      },
      {
          "channel": {
              "id": "main",
              "name": "Main channel",
              "description": "The main channel",
              "custom": {
                  "public": true,
                  "motd": "Always check your spelling!"
              },
              "updated": "2019-02-20T23:11:20.893755",
              "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      }
  ],
  "totalCount": 7,
  "next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
  "prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
38}
show all 38 lines

Set channel memberships

Set channel memberships for a UUID.

Method(s)

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

1pubnub.objects.setMemberships(
List<MembershipMetadataInput> setMetadata,
{String? uuid,
int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeChannelFields,
bool? includeChannelCustomFields,
bool includeChannelStatus,
bool includeChannelType,
bool includeStatus,
bool includeType,
bool? includeCount = true,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
19)
20

21class MembershipMetadataInput {
String channelId;
Map<String, dynamic>? custom;
24}
show all 24 lines

* required

Parameter	Description
`setMetadata` * Type: `List<MembershipMetadataInput>` Default: n/a	The memberships to be set.
`uuid` Type: `String` Default: defaultKeyset UUID	Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`start` Type: `String` Default: n/a	Cursor-based pagination.
`end` Type: `String` Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination, it fetches the previous page, enabling access to earlier data. Ignored if the `start` parameter is supplied.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the `Custom` field in the fetch response.
`includeChannelFields` Type: `bool` Default: `false`	Include fields for channels metadata.
`includeCustomChannelFields` Type: `bool` Default: `false`	Include custom fields for channels metadata.
`includeChannelStatus` Type: `bool` Default: `true`	Whether to include the channel `status` object in the response.
`includeChannelType` Type: `bool` Default: `true`	Whether to include the channel `type` object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Whether to include the total count in the paginated response. Default is false.
`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: `Set<String>` Default: n/a	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction.
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

API limits

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

Sample code

var setMetadata = [
  MembershipMetadataInput('my_channel', custom: {'starred': 'false'})
];
4

var result = await pubnub.objects
    .setMemberships(setMetadata, includeChannelFields: true);

Response

1{
  "status": 200,
  "data": [
      {
          "channel": {
            "id": "my-channel",
            "name": "My channel",
            "description": "A channel that is mine",
            "custom": null,
            "updated": "2019-02-20T23:11:20.893755",
            "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
          },
          "custom": {
              "starred": false
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      },
      {
        "channel": {
            "id": "main",
            "name": "Main channel",
            "description": "The main channel",
            "custom": {
                "public": true,
                "motd": "Always check your spelling!"
            },
            "updated": "2019-02-20T23:11:20.893755",
            "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
        },
        "updated": "2019-02-20T23:11:20.893755",
        "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      }
  ],
  "totalCount": 7,
  "next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
  "prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
38}
show all 38 lines

Remove channel memberships

Remove channel memberships for a UUID.

Method(s)

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

1pubnub.objects.removeMemberships(
Set<String> channelIds,
{String? uuid,
int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeChannelFields,
bool? includeChannelCustomFields,
bool includeStatus,
bool includeType,
bool includeChannelStatus,
bool includeChannelType,
bool? includeCount = true,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
19)
show all 19 lines

* required

Parameter	Description
`channelIds` * Type: `Set<String>` Default: n/a	List of channels to remove from membership.
`uuid` Type: `String` Default: n/a	Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`start` Type: `String` Default: n/a	Cursor-based pagination.
`end` Type: `String` Default: n/a	Cursor-based pagination.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the `Custom` field in the fetch response.
`includeChannelFields` Type: `bool` Default: `false`	Include fields for channels metadata.
`includeCustomChannelFields` Type: `bool` Default: `false`	Include custom fields for channels metadata.
`includeChannelStatus` Type: `bool` Default: `true`	Whether to include the channel `status` object in the response.
`includeChannelType` Type: `bool` Default: `true`	Whether to include the channel `type` object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Request `IncludeCount` to be included in paginated response. By default, `includeCount` is omitted.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

var result = await pubnub.objects.removeMemberships({'my_channel', 'main_channel'});
2

// for other uuid
var result = await pubnub.objects.removeMemberships({'my_channel'}, uuid: 'uuid1');

Response

1{
  "status": 200,
  "data": [
      {
          "channel": {
            "id": "my-channel",
            "name": "My channel",
            "description": "A channel that is mine",
            "custom": null,
            "updated": "2019-02-20T23:11:20.893755",
            "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
          },
          "custom": {
              "starred": false
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      },
      {
          "channel": {
            "id": "main",
            "name": "Main channel",
            "description": "The main channel",
            "custom": {
                "public": true,
                "motd": "Always check your spelling!"
            },
            "updated": "2019-02-20T23:11:20.893755",
            "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      }
  ],
  "totalCount": 7,
  "next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
  "prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
38}
show all 38 lines

Manage channel memberships

Manage a user's channel memberships.

Method(s)

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

1pubnub.objects.manageMemberships(
List<MembershipMetadataInput> setMetadata,
Set<String> removeChannelIds,
{String? uuid,
int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeChannelFields,
bool? includeChannelCustomFields,
bool includeStatus,
bool includeType,
bool includeChannelStatus,
bool includeChannelType,
bool? includeCount,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
20)
21

22class MembershipMetadataInput {
String channelId;
Map<String, dynamic>? custom;
25}
show all 25 lines

* required

Parameter	Description
`setMetadata` * Type: `List<MembershipMetadataInput>` Default: n/a	The memberships to be set.
`channelIds` * Type: `Set<String>` Default: n/a	List of channels to remove from membership.
`uuid` Type: `String` Default: n/a	Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`start` Type: `String` Default: n/a	Cursor-based pagination.
`end` Type: `String` Default: n/a	Cursor-based pagination.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeChannelFields` Type: `bool` Default: `false`	Include fields for channels metadata.
`includeCustomChannelFields` Type: `bool` Default: `false`	Include custom fields for channels metadata.
`includeChannelStatus` Type: `bool` Default: `true`	Whether to include the channel `status` object in the response.
`includeChannelType` Type: `bool` Default: `true`	Whether to include the channel `type` object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Request `IncludeCount` to be included in paginated response. By default, `includeCount` is omitted.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

var setMetadata = [
  MembershipMetadataInput('my_channel', custom: {'starred': 'false'})
];
var result =
    await pubnub.objects.manageMemberships(setMetadata, {'main_channel'});

Response

1{
  "status": 200,
  "data": [
      {
          "channel": {
            "id": "my-channel",
            "name": "My channel",
            "description": "A channel that is mine",
            "custom": null,
            "updated": "2019-02-20T23:11:20.893755",
            "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
          },
          "custom": {
              "starred": false
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      },
      {
          "channel": {
            "id": "main",
            "name": "Main channel",
            "description": "The main channel",
            "custom": {
                "public": true,
                "motd": "Always check your spelling!"
            },
            "updated": "2019-02-20T23:11:20.893755",
            "eTag": "RTc1NUQwNUItREMyNy00Q0YxLUJCNDItMEZDMTZDMzVCN0VGCg=="
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "RUNDMDUwNjktNUYwRC00RTI0LUI1M0QtNUUzNkE2NkU0MEVFCg=="
      }
  ],
  "totalCount": 7,
  "next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
  "prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
38}
show all 38 lines

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

1pubnub.objects.getChannelMembers(
String channelId,
{int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeUUIDFields,
bool? includeUUIDCustomFields,
bool includeStatus,
bool includeType,
bool includeUUIDStatus,
bool includeUUIDType,
bool? includeCount = true,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
18) 
show all 18 lines

* required

Parameter	Description
`channelId` Type: `String` Default: n/a	Channel name.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`start` Type: `String` Default: n/a	Cursor-based pagination.
`end` Type: `String` Default: n/a	Cursor-based pagination.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeUUIDFields` Type: Boolean Default: `false`	Whether to include additional fields.
`includeUUIDCustomFields` Type: Boolean Default: `false`	Whether to include additional fields.
`includeUUIDStatus` Type: `bool` Default: `true`	Whether to include the user `status` object in the response.
`includeUUIDType` Type: `bool` Default: `true`	Whether to include the user `type` object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Whether to include the total count in the paginated response. Default is false.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

1  var channelMembers = await pubnub.objects.getChannelMembers('my_channel');

Response

1{
"status": 200,
"data": [
  {
    "uuid": {
      "id": "uuid-1",
      "name": "John Doe",
      "externalId": null,
      "profileUrl": null,
      "email": "someone@pubnub.com",
      "custom": null,
      "updated": "2019-02-20T23:11:20.893755",
      "eTag": "MDcyQ0REOTUtNEVBOC00QkY2LTgwOUUtNDkwQzI4MjgzMTcwCg=="
    },
    "custom": {
      "role": "admin"
    },
    "updated": "2019-02-20T23:11:20.893755",
    "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
  },
  {
    "uuid": {
      "id": "uuid-2",
      "name": "Bob Cat",
      "externalId": null,
      "profileUrl": null,
      "email": "bobc@example.com",
      "custom": {
        "phone": "999-999-9999"
      },
      "updated": "2019-02-21T03:29:00.173452",
      "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
    },
    "updated": "2019-02-20T23:11:20.893755",
    "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
  }
],
"totalCount": 37,
"next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
"prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
41}
show all 41 lines

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

1pubnub.objects.setChannelMembers(
String channelId,
List<ChannelMemberMetadataInput> setMetadata,
{int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeUUIDFields,
bool? includeUUIDCustomFields,
bool includeStatus,
bool includeType,
bool includeUUIDStatus,
bool includeUUIDType,
bool? includeCount,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
19)
20

21class ChannelMemberMetadataInput {
String uuid;
Map<String, dynamic>? custom;
String? status;
String type;
26}
show all 26 lines

* required

Parameter	Description
`channelId` * Type: `String` Default: n/a	Channel name.
`setMetadata` * Type: `ChannelMemberMetadataInput` Default: n/a	The metadata to be added.
`limit` Type: `Int` Default: 100	Number of objects to return. Default/Max: 100.
`start` Type: `String` Default: n/a	Cursor-based pagination.
`end` Type: `String` Default: n/a	Cursor-based pagination.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeUUIDFields` Type: Boolean Default: `false`	Whether to include additional fields.
`includeUUIDCustomFields` Type: Boolean Default: `false`	Whether to include additional fields.
`includeUUIDStatus` Type: `bool` Default: `true`	Whether to include the user `status` object in the response.
`includeUUIDType` Type: `bool` Default: `true`	Whether to include the user `type` object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Whether to include the total count in the paginated response. Default is false.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

API limits

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

Sample code

var setMetadata = [
  ChannelMemberMetadataInput('myUUID', custom: {'role': 'admin'})
];
var result =
    await pubnub.objects.setChannelMembers('my_channel', setMetadata);

Response

1{
  "status": 200,
  "data": [
      {
          "uuid": {
              "id": "uuid-1",
              "name": "John Doe",
              "externalId": null,
              "profileUrl": null,
              "email": "johndoe@pubnub.com",
              "custom": null,
              "updated": "2019-02-20T23:11:20.893755",
              "eTag": "MDcyQ0REOTUtNEVBOC00QkY2LTgwOUUtNDkwQzI4MjgzMTcwCg=="
          },
          "custom": {
              "role": "admin"
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
      },
      {
          "uuid": {
              "id": "uuid-2",
              "name": "Bob Cat",
              "externalId": null,
              "profileUrl": null,
              "email": "bobc@example.com",
              "custom": {
                  "phone": "999-999-9999"
              },
              "updated": "2019-02-21T03:29:00.173452",
              "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
      }
  ],
  "totalCount": 37,
  "next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
  "prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
41}
show all 41 lines

Remove channel members

Remove members from a Channel.

Method(s)

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

1pubnub.objects.removeChannelMembers(
String channelId,
Set<String> uuids,
{int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeUUIDFields,
bool? includeUUIDCustomFields,
bool includeStatus,
bool includeType,
bool includeUUIDStatus,
bool includeUUIDType,
bool? includeCount,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
19) 
show all 19 lines

* required

Parameter	Description
`channelId` * Type: `String` Default: n/a	Channel name.
`uuids` * Type: `Set<String>` Default: n/a	UUIDs to remove from the channel.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`start` Type: `String` Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination, it fetches the next page, allowing you to continue from where you left off.
`end` Type: `String` Default: n/a	Cursor-based pagination.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the Custom object in the response.
`includeUUIDFields` Type: Boolean Default: `false`	Whether to include additional fields.
`includeUUIDCustomFields` Type: Boolean Default: `false`	Whether to include additional fields.
`includeUUIDStatus` Type: `bool` Default: `true`	Whether to include the user `status` object in the response.
`includeUUIDType` Type: `bool` Default: `true`	Whether to include the user `type` object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Whether to include the total count in the paginated response. Default is false.
`filter` Type: `String` Default: `null`	Filter expression. Only matching objects are returned. See filtering.
`sort` Type: `Set<String>` Default: n/a	Sort by `id`, `name`, `updated` with `asc`/`desc` for sort direction (for example, `{name: 'asc'}`).
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

1  var result = await pubnub.objects
2      .removeChannelMembers('my_channel', {'uuid-1', 'uuid-2'});

Response

1{
  "status": 200,
  "data": [
      {
          "uuid": {
              "id": "uuid-1",
              "name": "John Doe",
              "externalId": null,
              "profileUrl": null,
              "email": "johndoe@pubnub.com",
              "custom": null,
              "updated": "2019-02-20T23:11:20.893755",
              "eTag": "MDcyQ0REOTUtNEVBOC00QkY2LTgwOUUtNDkwQzI4MjgzMTcwCg=="
          },
          "custom": {
              "role": "admin"
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
      },
      {
          "uuid": {
              "id": "uuid-2",
              "name": "Bob Cat",
              "externalId": null,
              "profileUrl": null,
              "email": "bobc@example.com",
              "custom": {
                  "phone": "999-999-9999"
              },
              "updated": "2019-02-21T03:29:00.173452",
              "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
      }
  ],
  "totalCount": 37,
  "next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
  "prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
41}
show all 41 lines

Manage channel members

Set and Remove channel memberships for a user.

Method(s)

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

1pubnub.objects.manageChannelMembers(
String channelId,
List<ChannelMemberMetadataInput> setMetadata,
Set<String> removeMemberUuids,
{int? limit,
String? start,
String? end,
bool? includeCustomFields,
bool? includeUUIDFields,
bool? includeUUIDCustomFields,
bool includeStatus,
bool includeType,
bool includeUUIDStatus,
bool includeUUIDType,
bool? includeCount = true,
String? filter,
Set<String>? sort,
Keyset? keyset,
String? using}
20)
21

22class ChannelMemberMetadataInput {
String uuid;
Map<String, dynamic>? custom;
String? status;
String type;
27}
show all 27 lines

* required

Parameter	Description
`channelId` * Type: `String` Default: n/a	Channel name.
`setMetadata` * Type: `List<ChannelMemberMetadataInput>` Default: n/a	The metadata to set.
`removeMemberUuids` * Type: `Set<String>` Default: n/a	UUIDs to remove from the channel.
`limit` Type: `Int` Default: 100	The number of objects to retrieve at a time.
`start` Type: `String` Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination, it fetches the next page, allowing you to continue from where you left off.
`end` Type: `String` Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination, it fetches the previous page, enabling access to earlier data. Ignored if the `start` parameter is supplied.
`includeCustomFields` Type: `bool` Default: `false`	Whether to include the `Custom` field in the fetch response.
`includeUUIDFields` Type: Boolean Default: `false`	Include fields for UUIDs metadata.
`includeUUIDCustomFields` Type: Boolean Default: `false`	Include custom fields for UUIDs metadata.
`includeUUIDStatus` Type: `bool` Default: `true`	Whether to include the user `status` object in the response.
`includeUUIDType` Type: `bool` Default: `true`	Whether to include the user `type` object in the response.
`includeStatus` Type: `bool` Default: `true`	Whether to include the `status` object in the response.
`includeType` Type: `bool` Default: `true`	Whether to include the `type` object in the response.
`includeCount` Type: `bool` Default: `false`	Request `IncludeCount` to be included in paginated response. By default, `includeCount` is omitted.
`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: `Set<String>` Default: n/a	List of properties to sort by. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify sort direction.
`keyset` Type: `Keyset` Default: n/a	Override for the PubNub default keyset configuration.
`using` Type: `String` Default: n/a	Keyset name from the `keysetStore` to be used for this method call.

Sample code

var setMetadata = [
  ChannelMemberMetadataInput('uuidToSet', custom: {'role': 'admin'})
];
var result = await pubnub.objects
    .manageChannelMembers('my_channel', setMetadata, {'uuidToRemove'});

Response

1{
  "status": 200,
  "data": [
      {
          "uuid": {
              "id": "uuid-1",
              "name": "John Doe",
              "externalId": null,
              "profileUrl": null,
              "email": "johndoe@pubnub.com",
              "custom": null,
              "updated": "2019-02-20T23:11:20.893755",
              "eTag": "MDcyQ0REOTUtNEVBOC00QkY2LTgwOUUtNDkwQzI4MjgzMTcwCg=="
          },
          "custom": {
              "role": "admin"
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
      },
      {
          "uuid": {
              "id": "uuid-2",
              "name": "Bob Cat",
              "externalId": null,
              "profileUrl": null,
              "email": "bobc@example.com",
              "custom": {
                  "phone": "999-999-9999"
              },
              "updated": "2019-02-21T03:29:00.173452",
              "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
          },
          "updated": "2019-02-20T23:11:20.893755",
          "eTag": "QkRENDA5MjItMUZCNC00REI5LUE4QTktRjJGNUMxNTc2MzE3Cg=="
      }
  ],
  "totalCount": 37,
  "next": "RDIwQUIwM0MtNUM2Ni00ODQ5LUFGRjMtNDk1MzNDQzE3MUVCCg==",
  "prev": "MzY5RjkzQUQtNTM0NS00QjM0LUI0M0MtNjNBQUFGODQ5MTk2Cg=="
41}
show all 41 lines

User​

Get metadata for all users​

Method(s)​

Sample code​

Reference code

Response​

Get user metadata​

Method(s)​

Sample code​

Response​

Set user metadata​

Unsupported partial updates of custom metadata

Method(s)​

API limits

Sample code​

Response​

Remove user metadata​

Method(s)​

Sample code​

Response​

Channel​

Get metadata for all channels​

Method(s)​

Sample code​

Response​

Get channel metadata​

Method(s)​

Sample code​

Response​

Set channel metadata​

Unsupported partial updates of custom metadata

Method(s)​

API limits

Sample code​

Response​

Other examples​

Iteratively update existing metadata​

Remove channel metadata​

Method(s)​

Sample code​

Response​

Channel memberships​

Get channel memberships​

Method(s)​

Sample code​

Response​

Set channel memberships​

Method(s)​

API limits

Sample code​

Response​

Remove channel memberships​

Method(s)​

Sample code​

Response​

Manage channel memberships​

Method(s)​

Sample code​

Response​

Channel members​

Get channel members​

Method(s)​

Sample code​

Response​

Set channel members​

Method(s)​

API limits

Sample code​

Response​

Remove channel members​

Method(s)​

Sample code​

Response​

Manage channel members​

Method(s)​

Sample code​

Response​

User

Get metadata for all users

Method(s)

Sample code

Response

Get user metadata

Method(s)

Sample code

Response

Set user metadata

Method(s)

Sample code

Response

Remove user metadata

Method(s)

Sample code

Response

Channel

Get metadata for all channels

Method(s)

Sample code

Response

Get channel metadata

Method(s)

Sample code

Response

Set channel metadata

Method(s)

Sample code

Response

Other examples

Iteratively update existing metadata

Remove channel metadata

Method(s)

Sample code

Response

Channel memberships

Get channel memberships

Method(s)

Sample code

Response

Set channel memberships

Method(s)

Sample code

Response

Remove channel memberships

Method(s)

Sample code

Response

Manage channel memberships

Method(s)

Sample code

Response

Channel members

Get channel members

Method(s)

Sample code

Response

Set channel members

Method(s)

Sample code

Response

Remove channel members

Method(s)

Sample code

Response

Manage channel members

Method(s)

Sample code

Response