App Context API for PubNub Android 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 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 Android SDK:
pubnub.getAllUUIDMetadata()
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(List<PNSortKey>)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String? | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | 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'} | |
includeTotalCount | Boolean | Optional | false | Request totalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
Basic Usage
pubnub.getAllUUIDMetadata()
.limit(20)
.sort(SortKey.asc(SortKey.Key.ID), SortKey.desc(SortKey.Key.UPDATED))
.includeTotalCount(true)
.includeCustom(true)
.async(new PNCallback<PNGetAllUUIDMetadataResult>() {
@Override
public void onResponse(@Nullable final PNGetAllUUIDMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
}
else {
//handle result
}
}
show all 16 linesResponse
public class PNGetAllUUIDMetadataResult extends EntityArrayEnvelope<PNUUIDMetadata> {
Integer totalCount;
String next;
String prev;
int status;
List<PNUUIDMetadata> data;
PNPage nextPage() {
return PNPage.next(next);
}
PNPage previousPage() {
return PNPage.previous(prev);
}
}
public class PNUUIDMetadata extends PNObject {
show all 24 linesGet 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 Android SDK:
pubnub.getUUIDMetadata()
.uuid(String)
.includeCustom(Boolean)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
uuid | String | Optional | pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
Basic Usage
pubnub.getUUIDMetadata().async(new PNCallback<PNGetUUIDMetadataResult>() {
@Override
public void onResponse(@Nullable final PNGetUUIDMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
}
else {
//handle result
}
}
});
Response
public class PNGetUUIDMetadataResult extends EntityEnvelope<PNUUIDMetadata> {
int status;
PNUUIDMetadata data;
}
public class PNUUIDMetadata extends PNObject {
String id;
Object custom;
String updated;
String eTag;
String name;
String email;
String externalId;
String profileUrl;
}
Set User Metadata
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 Android SDK:
pubnub.setUUIDMetadata()
.uuid(String)
.name(String)
.externalId(String)
.profileUrl(String)
.email(String)
.custom(Map<String, Object>)
.includeCustom(true)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
uuid | String | Optional | pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
name | String | Optional | Display name for the user. | |
externalId | String | Optional | User's identifier in an external system. | |
profileUrl | String | Optional | The URL of the user's profile picture. | |
email | String | Optional | The user's email address. | |
custom | Any | Optional | Any object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties. | |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
API limits
To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.
Basic Usage
pubnub.setUUIDMetadata()
.name("Foo")
.profileUrl("http://example.com")
.email("foo@example.com")
.includeCustom(true)
.async(new PNCallback<PNSetUUIDMetadataResult>() {
@Override
public void onResponse(@Nullable final PNSetUUIDMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
}
else {
//handle result
}
}
show all 16 linesResponse
public class PNSetUUIDMetadataResult extends EntityEnvelope<PNUUIDMetadata> {
protected int status;
protected PNUUIDMetadata data;
}
public class PNUUIDMetadata extends PNObject {
String id;
Object custom;
String updated;
String eTag;
String name;
String email;
String externalId;
String profileUrl;
}
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 Android SDK:
pubnub.removeUUIDMetadata()
.uuid(String)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
uuid | String | Optional | pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
Basic Usage
pubnub.removeUUIDMetadata()
.async(new PNCallback<PNRemoveUUIDMetadataResult>() {
@Override
public void onResponse(@Nullable final PNRemoveUUIDMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
}
else {
//handle result
}
}
});
Response
public class PNRemoveUUIDMetadataResult extends EntityEnvelope<JsonElement> {
int status;
JsonElement data;
}
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 Android SDK:
pubnub.getAllChannelsMetadata()
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(PNSortKey)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | listOf() | 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'} |
includeTotalCount | Boolean | Optional | false | Request totalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
Basic Usage
pubnub.getAllChannelsMetadata()
.async(new PNCallback<PNGetAllChannelsMetadataResult>() {
@Override
public void onResponse(@Nullable final PNGetAllChannelsMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
})
Response
public class PNGetAllChannelsMetadataResult extends EntityArrayEnvelope<PNChannelMetadata> {
int status;
List<PNChannelMetadata> data;
Integer totalCount;
String next;
String prev;
}
public class PNChannelMetadata extends PNObject {
String id;
Object custom;
String updated;
String eTag;
String name;
String description;
show all 16 linesGet 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 Android SDK:
pubnub.getChannelMetadata()
.channel(String)
.includeCustom(Boolean)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channel | String | Yes | Channel name. | |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
Basic Usage
pubnub.getChannelMetadata()
.channel("myChannel")
.async(new PNCallback<PNGetChannelMetadataResult>() {
@Override
public void onResponse(@Nullable final PNGetChannelMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNGetChannelMetadataResult extends EntityEnvelope<PNChannelMetadata> {
protected int status;
protected PNChannelMetadata data;
}
public class PNChannelMetadata extends PNObject {
String id;
Object custom;
String updated;
String eTag;
String name;
String description;
}
Set Channel Metadata
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 Android SDK:
pubnub.setChannelMetadata()
.channel(String)
.name(String)
.description(String)
.custom(Map<String, Object>)
.includeCustom(Boolean)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channel | String | Yes | Channel name. | |
name | String | Optional | Name for the channel. | |
description | String | Optional | Description of a channel. | |
custom | Map<String, Object> | Optional | Any object of key-value pairs with supported data types. App Context filtering language doesn’t support filtering by custom properties. | |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
API limits
To learn about the maximum length of parameters used to set channel metadata, refer to REST API docs.
Basic Usage
pubnub.setChannelMetadata()
.channel("myChannel")
.name("Some Name")
.includeCustom(true)
.async(new PNCallback<PNSetChannelMetadataResult>() {
@Override
public void onResponse(@Nullable final PNSetChannelMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNSetChannelMetadataResult extends EntityEnvelope<PNChannelMetadata> {
protected int status;
protected PNChannelMetadata data;
}
public class PNChannelMetadata extends PNObject {
String id;
Object custom;
String updated;
String eTag;
String name;
String description;
}
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 Android SDK:
pubnub.removeChannelMetadata()
.channel(String)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channel | String | Yes | Channel name. |
Basic Usage
pubnub.removeChannelMetadata()
.channel("myChannel")
.async(new PNCallback<PNRemoveChannelMetadataResult>() {
@Override
public void onResponse(@Nullable final PNRemoveChannelMetadataResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNRemoveChannelMetadataResult extends EntityEnvelope<JsonElement> {
int status;
protected JsonElement data;
}
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 Memberships
you can use the following method(s) in the Android SDK:
pubnub.getMemberships()
.uuid(String)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(List<PNSortKey>)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeChannel(PNChannelDetailsLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
uuid | String | Optional | pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | listOf() | 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'} |
includeTotalCount | Boolean | Optional | false | Request totalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include custom object in the fetch response. |
includeChannel | PNChannelDetailsLevel | Optional | The level of channel details to return in the membership. Possible values are PNChannelDetailsLevel.CHANNEL which includes basic channel information, and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which also includes the custom object. |
Basic Usage
pubnub.getMemberships()
.async(new PNCallback<PNGetMembershipsResult>() {
@Override
public void onResponse(@Nullable final PNGetMembershipsResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
})
Response
public class PNGetMembershipsResult extends EntityArrayEnvelope<PNMembership> {
protected Integer totalCount;
protected String next;
protected String prev;
protected int status;
protected List<PNMembership> data;
}
public class PNMembership {
PNChannelMetadata channel;
Object custom;
String updated;
String eTag;
}
Basic Usage with Pagination
final PNGetMembershipsResult getMembershipsResult = pubnub.getMemberships()
.includeTotalCount(true)
.limit(3)
.includeCustom(true)
.includeChannel("channel_1")
.sync();
if (getMembershipsResult.getNext() != null) {
final PNGetMembershipsResult getMembershipsNextPageResult = pubnub.getMemberships()
.page(getMembershipsResult.nextPage())
.includeTotalCount(true)
.limit(3)
.includeCustom(true)
.includeChannel("channel_1")
.sync();
System.out.println(getMembershipsNextPageResult);
show all 16 linesSet Channel Memberships
Set channel memberships for a UUID.
Method(s)
To Set Memberships
you can use the following method(s) in the Android SDK:
pubnub.setMemberships()
.channelMemberships(Collection<PNChannelMembership>)
.uuid(String)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(PNSort ...)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeChannel(PNChannelDetailLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channelMemberships | List<PNChannelMembership> | Yes | Collection of PNChannelMembership to add to membership. | |
uuid | String | Optional | pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | N/A | The paging object used for pagination. |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | PNSortKey | Optional | 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'} |
includeTotalCount | Boolean | Optional | false | Request totalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
includeChannel | PNChannelDetailsLevel | Optional | The level of channel details to return in the membership. Possible values are PNChannelDetailsLevel.CHANNEL which includes basic channel information, and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which also includes the custom object. |
API limits
To learn about the maximum length of parameters used to set channel membership metadata, refer to REST API docs.
Basic Usage
pubnub.setMemberships()
.channelMemberships(Collections.singletonList(PNChannelMembership.channel("channelId")))
.async(new PNCallback<PNSetMembershipResult>() {
@Override
public void onResponse(@Nullable final PNSetMembershipResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNSetMembershipResult extends EntityArrayEnvelope<PNMembership> {
Integer totalCount;
String next;
String prev;
int status;
List<PNMembership> data;
}
public class PNMembership {
PNChannelMetadata channel;
Object custom;
String updated;
String eTag;
}
Remove Channel Memberships
Remove channel memberships for a UUID.
Method(s)
To Remove Memberships
you can use the following method(s) in the Android SDK:
pubnub.removeMemberships()
.channelMemberships(Collection<PNChannelMembership>)
.uuid(String)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(PNSort ...)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeChannel(PNChannelDetailLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channelMemberships | List<PNChannelMembership> | Yes | Collection of PNChannelMembership to add to membership. | |
uuid | String | Optional | pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | PNSortKey | Optional | listOf() | 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'} |
includeTotalCount | Boolean | Optional | false | Request totalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
includeChannel | PNChannelDetailsLevel | Optional | The level of channel details to return in the membership. Possible values are PNChannelDetailsLevel.CHANNEL which includes basic channel information, and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which also includes the custom object. |
Basic Usage
pubnub.removeMemberships()
.channelMemberships(Collections.singletonList(PNChannelMembership.channel("channelId")))
.async(new PNCallback<PNRemoveMembershipResult>() {
@Override
public void onResponse(@Nullable final PNRemoveMembershipResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNRemoveMembershipResults extends EntityArrayEnvelope<PNMembership> {
Integer totalCount;
String next;
String prev;
int status;
List<PNMembership> data;
}
public class PNMembership {
PNChannelMetadata channel;
Object custom;
String updated;
String eTag;
}
Manage Channel Memberships
Manage a user's channel memberships.
Method(s)
To Manage Memberships
you can use the following method(s) in the Android SDK:
pubnub.manageMemberships()
.uuid(String)
.set(Collection<PNChannelMembership>)
.remove(Collection<PNChannelMembership>)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(List<PNSortKey>)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeChannel(PNChannelDetailsLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
uuid | String | Optional | pubnub.configuration.uuid | Unique UUID Metadata identifier. If not supplied, then UUID from configuration will be used. |
set | Collection<PNChannelMembership> | Yes | List of members PNChannelMembership to add to channel. | |
remove | Collection<PNChannelMembership> | Yes | List of members PNChannelMembership to remove from channel. | |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | 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'} |
includeTotalCount | Boolean | Optional | false | Request includeTotalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
includeChannel | PNChannelDetailsLevel | Optional | The level of UUID details to return. Possible values are PNChannelDetailsLevel.CHANNEL which includes basic UUID information, and PNChannelDetailsLevel.CHANNEL_WITH_CUSTOM which also includes the custom object. |
Basic Usage
pubnub.manageMemberships()
.set(Collections.singletonList(PNChannelMembership.channel("channelIdToSet")))
.remove(Collections.singletonList(PNChannelMembership.channel("channelIdToRemove")))
.async(new PNCallback<PNManageMembershipResult>() {
@Override
public void onResponse(@Nullable final PNManageMembershipResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNManageMembershipResult extends EntityArrayEnvelope<PNMembership> {
Integer totalCount;
String next;
String prev;
int status;
List<PNMembership> data;
}
public class PNMembership {
PNChannelMetadata channel;
Object custom;
String updated;
String eTag;
}
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 Android SDK:
pubnub.getChannelMembers()
.channel(String)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(List<PNSortKey>)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeUUID(PNUUIDDetailsLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channel | String | Yes | Channel name. | |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | listOf() | 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'} |
includeTotalCount | Boolean | Optional | false | Request includeTotalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
includeUUID | PNUUIDDetailsLevel | Optional | The level of UUID details to return. Possible values are PNUUIDDetailsLevel.UUID which includes basic UUID information, and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which also includes the custom object. |
Basic Usage
pubnub.getChannelMembers()
.channel("channelId")
.async(new PNCallback<PNGetChannelMembersResult>() {
@Override
public void onResponse(@Nullable final PNGetChannelMembersResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle response
}
}
});
Response
public class PNRemoveMembershipResults extends EntityArrayEnvelope<PNMembers> {
Integer totalCount;
String next;
String prev;
int status;
List<PNMembers> data;
}
public class PNMembers {
PNUUIDMetadata uuid;
Object custom;
String updated;
String eTag;
}
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 Android SDK:
pubnub.setChannelMembers()
.channel(String)
.uuids(Collection<PNUUID>)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(List<PNSortKey>)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeUUID(PNUUIDDetailsLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channel | String | Yes | Channel name. | |
uuids | Collection<PNUUID> | Yes | List of members PNUUID to add to channel. | |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | 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'} |
includeTotalCount | Boolean | Optional | false | Request includeTotalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
includeUUID | PNUUIDDetailsLevel | Optional | The level of UUID details to return. Possible values are PNUUIDDetailsLevel.UUID which includes basic UUID information, and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which also includes the custom object. |
API limits
To learn about the maximum length of parameters used to set channel members metadata, refer to REST API docs.
Basic Usage
pubnub.setChannelMembers()
.channel("channelId")
.uuids(Collections.singletonList(PNUUID.uuid("uuid")))
.async(new PNCallback<PNSetChannelMembersResult>() {
@Override
public void onResponse(@Nullable final PNSetChannelMembersResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNSetChannelMembersResult extends EntityArrayEnvelope<PNMembers> {
Integer totalCount;
String next;
String prev;
int status;
List<PNMembers> data;
}
public class PNMembers {
PNUUIDMetadata uuid;
Object custom;
String updated;
String eTag;
}
Remove Channel Members
Remove members from a Channel.
Method(s)
To Remove Channel Members
you can use the following method(s) in the Android SDK:
pubnub.removeChannelMembers()
.channel(String)
.uuids(Collection<PNUUID>)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(List<PNSortKey>)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeUUID(PNUUIDDetailsLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channel | String | Yes | Channel name. | |
uuids | Collection<PNUUID> | Yes | List of members PNUUID to remove from channel. | |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | 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'} |
includeTotalCount | Boolean | Optional | false | Request includeTotalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
includeUUID | PNUUIDDetailsLevel | Optional | The level of UUID details to return. Possible values are PNUUIDDetailsLevel.UUID which includes basic UUID information, and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which also includes the custom object. |
Basic Usage
pubnub.removeChannelMembers()
.channel("channelId")
.uuids(Collections.singletonList(PNUUID.uuid("uuid")))
.async(new PNCallback<PNRemoveChannelMembersResult>() {
@Override
public void onResponse(@Nullable final PNRemoveChannelMembersResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNRemoveChannelMembersResult extends EntityArrayEnvelope<PNMembers> {
Integer totalCount;
String next;
String prev;
int status;
List<PNMembers> data;
}
public class PNMembers {
PNUUIDMetadata uuid;
Object custom;
String updated;
String eTag;
}
Manage Channel Members
The method Set and Remove channel memberships for a user.
Method(s)
To Manage Channel Members
you can use the following method(s) in the Android SDK:
pubnub.manageChannelMembers()
.channel(String)
.set(Collection<PNUUID>)
.remove(Collection<PNUUID>)
.limit(Integer)
.page(PNPage)
.filter(String)
.sort(List<PNSortKey>)
.includeTotalCount(Boolean)
.includeCustom(Boolean)
.includeUUID(PNUUIDDetailsLevel)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
channel | String | Yes | Channel name. | |
set | Collection<PNUUID> | Yes | List of members PNUUID to add to channel. | |
remove | Collection<PNUUID> | Yes | List of members PNUUID to remove from channel. | |
limit | Integer | Optional | 100 | The maximum number of objects to retrieve at a time. |
page | PNPage | Optional | The paging object used for pagination. | |
filter | String | Optional | Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here | |
sort | List<PNSortKey> | Optional | 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'} |
includeTotalCount | Boolean | Optional | false | Request includeTotalCount to be included in paginated response, which is omitted by default. |
includeCustom | Boolean | Optional | false | Whether to include the custom object in the fetch response. |
includeUUID | PNUUIDDetailsLevel | Optional | The level of UUID details to return. Possible values are PNUUIDDetailsLevel.UUID which includes basic UUID information, and PNUUIDDetailsLevel.UUID_WITH_CUSTOM which also includes the custom object. |
Basic Usage
pubnub.manageChannelMembers()
.channel("channelId")
.set(Collections.singletonList(PNUUID.uuid("uuidToSet")))
.remove(Collections.singletonList(PNUUID.uuid("uuidToRemove")))
.async(new PNCallback<PNManageChannelMembersResult>() {
@Override
public void onResponse(@Nullable final PNManageChannelMembersResult result, @NotNull final PNStatus status) {
if (status.isError()) {
//handle error
} else {
//handle result
}
}
});
Response
public class PNManageChannelMembersResult extends EntityArrayEnvelope<PNMembers> {
Integer totalCount;
String next;
String prev;
int status;
List<PNMembers> data;
}
public class PNMembers {
PNUUIDMetadata uuid;
Object custom;
String updated;
String eTag;
}
PNChannelMembership class
PNChannelMembership
is a utility class that exposes two factory methods: channel(String channelId)
constructs a channel membership, and channelWithCustom(String channelId, Map<String, Object> custom)
constructs a channel membership with additional custom metadata.
public abstract class PNChannelMembership {
public static class ChannelId {
private String id;
}
private final ChannelId channel;
public static PNChannelMembership channel(final String channelId) {
return new JustChannel(new ChannelId(channelId));
}
public static PNChannelMembership channelWithCustom(final String channelId, final Map<String, Object> custom) {
return new ChannelWithCustom(new ChannelId(channelId), new HashMap<>(custom));
}
show all 22 linesPNUUID class
PNUUID
is a utility class that exposes two factory methods: uuid(String uuid)
constructs a UUID, and uuidWithCustom(String channelId, Map<String, Object> custom)
constructs a UUID with additional custom metadata.
public abstract class PNUUID {
public static class UUIDId {
private String id;
}
private final UUIDId uuid;
public static PNUUID uuid(final String uuid) {
return new JustUUID(new UUIDId(uuid));
}
public static PNUUID uuidWithCustom(final String uuid, final Map<String, Object> custom) {
return new UUIDWithCustom(new UUIDId(uuid), new HashMap<>(custom));
}
public static class JustUUID extends PNUUID {
show all 21 lines