App Context API for PHP SDK
Starting a new app? Use DataSync
DataSync is the successor to App Context. It covers the same users, channels, and memberships, and adds typed schemas, JSON Patch updates with ETags, field-level projections, and per-class expiry. Refer to the feature-by-feature comparison for details.
DataSync is currently available to new accounts and to accounts that are not actively using App Context. If your keysets already use App Context, keep using it for now. App Context remains fully supported.
This page describes App Context (formerly Objects v2). To upgrade from Objects v1, refer to the migration guide.
App Context provides easy-to-use, serverless storage for user and channel data you need to build innovative, reliable, scalable applications. Use App Context to store metadata about your application users and channels, and their membership associations, without the need to stand up your own databases.
PubNub also triggers events when object data is changed: set, updated, or removed from the database. Making a request to set the same data that already exists doesn't trigger an event. Clients can receive these events in real time and update their front-end application accordingly.
User
Manage UUID metadata: list, fetch, set, and remove. Include only the fields you need to reduce payload size.
Get metadata for all users
Get a paginated list of UUID metadata. Use filters and sorting to narrow results.
Commonly used to list chat users, build user directories, populate dropdowns for user selection, or display member profiles with names, emails, and custom data. Retrieves users whose profile information has been stored in App Context.
Required keyset configuration
Method(s)
To Get All UUID Metadata you can use the following method(s) in the PHP SDK:
1getAllUUIDMetadata()
2 ->includeFields(Array[String => Boolean])
3 ->filter(String)
4 ->sort(String | Array[String])
5 ->limit(Integer)
6 ->page(Array[String => String])
7 ->sync()
includeFields()#- Whether to include additional fields. Set
customFieldsto include the Custom object. SettotalCountto include the total count in the paginated response (default is false). sort()#- Sort by
id,name,updatedwithasc/descfor sort direction (for example,name:asc). limit()#- Number of objects to return. Default/Max: 100.
page()#- Cursor-based pagination. Use
prevandnexttokens returned by the server.
Sample code
1
Response
The getAllUUIDMetadata() operation returns a PNGetAllUUIDMetadataResult which contains the following fields:
getData()#- List of uuid metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNGetUUIDMetadataResult which contains the following fields:
Get user metadata
Fetch metadata for a single UUID. Include the Custom object if you need custom fields.
Method(s)
To Get UUID Metadata you can use the following method(s) in the PHP SDK:
1getUUIDMetadata()
2 ->uuid(String)
3 ->sync()
uuid()required#- UUID
Sample code
1
Response
The getUUIDMetadata() operation returns a PNGetUUIDMetadataResult which contains the following fields:
Set user metadata
Create or update metadata for a UUID. Use the eTag to avoid overwriting concurrent updates.
Unsupported partial updates of custom metadata
The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:
- 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, including the Custom object.
Method(s)
To Set UUID Metadata you can use the following method(s) in the PHP SDK:
1setUUIDMetadata()
2 ->uuid(String)
3 ->meta(Array | StdClass)
4 ->ifMatchesEtag(String)
5 ->sync()
UUID metadata contains the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
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 | Array or StdClass | Optional | Custom JSON values. Can be strings, numbers, or booleans. Filtering by Custom isn’t supported. |
API limits
To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.
Sample code
1
Response
The setUUIDMetadata() operation returns a PNSetUUIDMetadataResult which contains the following fields:
Remove user metadata
Delete metadata for the specified UUID.
Method(s)
To Remove UUID Metadata you can use the following method(s) in the PHP SDK:
1removeUUIDMetadata()
2 ->uuid(String)
3 ->sync()
uuid()required#- UUID
Sample code
1
Response
Returns a boolean, true for success otherwise false
Channel
Manage channel metadata: list, fetch, set, and remove.
Get metadata for all channels
Get a paginated list of channel metadata. Use filters and sorting to narrow results.
Required keyset configuration
Method(s)
To Get All Channel Metadata you can use the following method(s) in the PHP SDK:
1getAllChannelMetadata()
2 ->includeFields(Array[String => Boolean])
3 ->filter(String)
4 ->sort(String | Array[String])
5 ->limit(Integer)
6 ->page(Array[String => String])
7 ->sync()
includeFields()#- Whether to include additional fields. Set
customFieldsto include the Custom object. SettotalCountto include the total count in the paginated response (default is false). sort()#- Sort by
id,name,updatedwithasc/descfor sort direction (for example,name:asc). limit()#- Number of objects to return. Default/Max: 100.
page()#- Cursor-based pagination. Use
prevandnexttokens returned by the server.
Sample code
1
Response
The getAllChannelMetadata() operation returns a PNGetAllChannelMetadataResult which contains the following fields:
getData()#- List of channel metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNGetChannelMetadataResult which contains the following fields:
Get channel metadata
Fetch metadata for a single channel. Include the Custom object if you need custom fields.
Method(s)
To Get Channel Metadata you can use the following method(s) in the PHP SDK:
1getChannelMetadata()
2 ->channel(String)
3 ->sync()
channel()required#- Unique channel identifier
Sample code
1
Response
The getChannelMetadata() operation returns a PNGetChannelMetadataResult which contains the following fields:
Set channel metadata
Create or update metadata for a channel. Use the eTag to avoid overwriting concurrent updates.
Unsupported partial updates of custom metadata
The value of the custom metadata parameter sent in this method always overwrites the value stored on PubNub servers. If you want to add new custom data to an existing one, you must:
- 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, including the Custom object.
Method(s)
To Set Channel Metadata you can use the following method(s) in the PHP SDK:
1setChannelMetadata()
2 ->channel(String)
3 ->meta(Array | StdClass)
4 ->ifMatchesEtag(String)
5 ->sync()
Channel metadata contains the following fields
| Field | Type | Required | Description |
|---|---|---|---|
name | String | Optional | Display name for the channel. |
description | String | Optional | Description of a channel. |
custom | Array or StdClass | Optional | Custom JSON values. Can be strings, numbers, or booleans. Filtering by Custom isn’t supported. |
API limits
To learn about the maximum length of parameters used to set channel metadata, refer to REST API docs.
Sample code
1
Response
The setChannelMetadata() operation returns a PNSetChannelMetadataResult which contains the following fields:
Other examples
1
Update existing channel metadata
This example shows how to update existing channel metadata by modifying the name, description, and custom fields.
1
Remove channel metadata
Delete metadata for the specified channel.
Method(s)
To Remove Channel Metadata you can use the following method(s) in the PHP SDK:
1removeChannelMetadata()
2 ->channel(String)
3 ->sync()
channel()required#- Unique channel identifier
Sample code
1
Response
Returns a boolean, true for success otherwise false
Channel memberships
Manage the channels a UUID belongs to: list, set, remove, and manage in bulk.
Get channel memberships
List channel memberships for a UUID. This doesn't return subscriptions.
Method(s)
To Get Memberships you can use the following method(s) in the PHP SDK:
1getMemberships()
2 ->uuid(String)
3 ->include(PNMembershipIncludes)
4 ->filter(String)
5 ->sort(String | Array[String])
6 ->limit(Integer)
7 ->page(Array[String => String])
8 ->sync();
uuid()required#- UUID
include()#- Whether to include additional fields.
- →
custom# - Whether to include the Custom object in the response.
- →
status# - Whether to include the status field.
- →
type# - Whether to include the type field.
- →
total_count# - Whether to include the total count in the paginated response.
- →
channel# - Whether to include channel fields.
- →
channelCustom# - Whether to include the channel Custom object.
- →
channelType# - Whether to include the channel type field.
- →
channelStatus# - Whether to include the channel status field.
sort()#- Sort by
id,name,updatedwithasc/descfor sort direction (for example,name:asc). limit()#- Number of objects to return. Default/Max: 100.
page()#- Cursor-based pagination. Use
prevandnexttokens returned by the server.
Sample code
1
Response
The getMemberships() operation returns a PNMembershipsResult which contains the following fields:
getData()#- List of membership metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembershipsResultItem which contains the following fields:
Channel is a PNMembership which contains the following fields:
Set channel memberships
Replace or add memberships for a UUID. Provide channels (optionally with custom data).
Method(s)
To Set Memberships you can use the following method(s) in the PHP SDK:
1setMemberships()
2 ->uuid(String)
3 ->memberships(Array[PNChannelMembership])
4 ->custom(Array | StdClass)
5 ->include(PNMembershipIncludes)
6 ->filter(String)
7 ->sort(String | Array[String])
8 ->limit(Integer)
9 ->page(Array[String => String])
10 ->sync();
uuid()required#- UUID
memberships()required#- Array of memberships to set.
custom()required#- Custom JSON values. Can be strings, numbers, or booleans. Filtering by Custom isn’t supported.
include()#- Whether to include additional fields.
- →
custom# - Whether to include the Custom object in the response.
- →
status# - Whether to include the status field.
- →
type# - Whether to include the type field.
- →
total_count# - Whether to include the total count in the paginated response.
- →
channel# - Whether to include channel fields.
- →
channelCustom# - Whether to include the channel Custom object.
- →
channelType# - Whether to include the channel type field.
- →
channelStatus# - Whether to include the channel status field.
sort()#- Sort by
id,name,updatedwithasc/descfor sort direction (for example,name:asc). limit()#- Number of objects to return. Default/Max: 100.
page()#- Cursor-based pagination. Use
prevandnexttokens returned by the server. requiredDeprecated#channels()Array of channels to add to membership. Array can contain strings (channel-name only) or objects (which can include custom data).
API limits
To learn about the maximum length of parameters used to set channel membership metadata, refer to REST API docs.
Sample code
1
Response
The setMemberships() operation returns a PNMembershipsResult which contains the following fields:
getData()#- List of membership metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembershipsResultItem which contains the following fields:
Channel is a PNMembership which contains the following fields:
Remove channel memberships
Remove memberships for a UUID. Provide the channels to remove.
Method(s)
To Remove Memberships you can use the following method(s) in the PHP SDK:
1removeMemberships()
2 ->uuid(String)
3 ->memberships(Array[PNChannelMembership])
4 ->include(PNMembershipIncludes)
5 ->filter(String)
6 ->sort(String | Array[String])
7 ->limit(Integer)
8 ->page(Array[String => String])
9 ->sync();
uuid()required#- UUID.
memberships()required#- Array of memberships to remove.
include()#- Whether to include additional fields.
- →
custom# - Whether to include the Custom object in the response.
- →
status# - Whether to include the status field.
- →
type# - Whether to include the type field.
- →
total_count# - Whether to include the total count in the paginated response.
- →
channel# - Whether to include channel fields.
- →
channelCustom# - Whether to include the channel Custom object.
- →
channelType# - Whether to include the channel type field.
- →
channelStatus# - Whether to include the channel status field.
sort()#- Sort by
id,name,updatedwithasc/descfor sort direction (for example,name:asc). limit()#- Number of objects to return. Default/Max: 100.
page()#- Cursor-based pagination. Use
prevandnexttokens returned by the server. requiredDeprecated#channels()Array of channels to remove from membership.
Sample code
1
Response
The removeMemberships() operation returns a PNMembershipsResult which contains the following fields:
getData()#- List of membership metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembershipsResultItem which contains the following fields:
Channel is a PNMembership which contains the following fields:
Manage channel memberships
Add and remove memberships for a UUID in one request.
To Manage Channel Memberships you can use the following method(s) in the PHP SDK:
1manageMemberships()
2 ->uuid(String)
3 ->setMemberships(Array[PNChannelMembership])
4 ->removeMemberships(Array[PNChannelMembership])
5 ->include(PNMembershipIncludes)
6 ->filter(String)
7 ->sort(String | Array[String])
8 ->limit(Integer)
9 ->page(Array[String => String])
10 ->sync();
uuid()required#- Unique user identifier whose memberships to manage
setMemberships()#- Array of
PNChannelMembershipobjects to add to the user's memberships. removeMemberships()#- Array of
PNChannelMembershipobjects to remove from the user's memberships. include()#- The additional information to include in the membership response.
- →
custom# - Indicates whether custom data should be included in the response.
- →
status# - Indicates whether the status should be included in the response.
- →
type# - Indicates whether the type should be included in the response.
- →
total_count# - Indicates whether the total count should be included in the response.
- →
channel# - Indicates whether the channel ID information should be included in the response.
- →
channelCustom# - Indicates whether custom data for the channel should be included in the response.
- →
channelType# - Indicates whether the type of the channel should be included in the response.
- →
channelStatus# - Indicates whether the status of the channel should be included in the response.
filter()#- Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sort()#- String or Array of String property names to sort by, and an optional sort direction. Available options are
id,name, andupdated. Useascordescto specify sort direction, or omit to take the default sort direction (ascending). For example:name:asc limit()#- Number of objects to return in response. Default is
100, which is also the maximum value. page()#- Use for pagination. Key value array where keys are one of
nextorprevand value is a random string returned from the server, indicating a specific position in a data set. Setprevto a previously-returned string for fetching the previous page. Setnextto a previously-returned string for fetching the next page.
Sample code
1
Response
The manageMemberships() operation returns a PNMembershipsResult which contains the following fields:
getData()#- List of membership metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembershipsResultItem which contains the following fields:
Channel is a PNMembership which contains the following fields:
Channel members
Manage the users in a channel: list, set, remove, and manage in bulk.
Get channel members
List users in a channel. Include user metadata if needed.
Method(s)
To Get Channel Members you can use the following method(s) in the PHP SDK:
1getMembers()
2 ->channel(String)
3 ->include(PNMemberIncludes)
4 ->filter(String)
5 ->sort(String | Array[String])
6 ->limit(Integer)
7 ->page(Array[String => String])
8 ->sync();
channel()required#- Unique channel identifier
include()#- The additional information to include in the member response.
- →
custom# - Indicates whether custom data should be included in the response.
- →
status# - Indicates whether the status should be included in the response.
- →
type# - Indicates whether the type should be included in the response.
- →
total_count# - Indicates whether the total count should be included in the response.
- →
user# - Indicates whether the user ID information should be included in the response.
- →
userCustom# - Indicates whether custom data for the user should be included in the response.
- →
userType# - Indicates whether the type of the user should be included in the response.
- →
userStatus# - Indicates whether the status of the user should be included in the response.
filter()#- Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sort()#- String or Array of String property names to sort by, and an optional sort direction. Available options are
id,name, andupdated. Useascordescto specify sort direction, or omit to take the default sort direction (ascending). For example:name:asc limit()#- Number of objects to return in response. Default is
100, which is also the maximum value. page()#- Use for pagination. Key value array where keys are one of
nextorprevand value is a random string returned from the server, indicating a specific position in a data set. Setprevto a previously-returned string for fetching the previous page. Setnextto a previously-returned string for fetching the next page.
Sample code
1
Response
The getMembers() operation returns a PNMembersResult which contains the following fields:
getData()#- List of member metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembersResultItem which contains the following fields:
Channel is a PNMember which contains the following fields:
getId()#- Unique user identifier
getName()#- Display name for the user
getExternalId()#- User's identifier in an external system
getProfileUrl()#- The URL of the user's profile picture
getEmail()#- The user's email address
getCustom()#- Object containing your custom fields
getUpdated()#- The last updated date and time
getETag()#- The entity tag
Set channel members
Set users in a channel. Provide UUIDs (optionally with custom data).
Method(s)
To Set Channel Members you can use the following method(s) in the PHP SDK:
1setMembers()
2 ->channel(String)
3 ->uuids(Array[String | Array])
4 ->custom(Array | StdClass)
5 ->include(PNMemberIncludes)
6 ->filter(String)
7 ->sort(String | Array[String])
8 ->limit(Integer)
9 ->page(Array[String => String])
10 ->sync();
channel()required#- Unique channel identifier
uuids()required#- Array of members to add to the channel. Array can contain strings (uuid only) or arrays/objects (which can include custom data).
custom()required#- Object of key-value pairs with supported data types.
include()#- The additional information to include in the member response.
- →
custom# - Indicates whether custom data should be included in the response.
- →
status# - Indicates whether the status should be included in the response.
- →
type# - Indicates whether the type should be included in the response.
- →
total_count# - Indicates whether the total count should be included in the response.
- →
user# - Indicates whether the user ID information should be included in the response.
- →
userCustom# - Indicates whether custom data for the user should be included in the response.
- →
userType# - Indicates whether the type of the user should be included in the response.
- →
userStatus# - Indicates whether the status of the user should be included in the response.
filter()#- Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. The filter language is defined here.
sort()#- String or Array of String property names to sort by, and an optional sort direction. Available options are
id,name, andupdated. Useascordescto specify sort direction, or omit to take the default sort direction (ascending). For example:name:asc limit()#- Number of objects to return in response. Default is
100, which is also the maximum value. page()#- Use for pagination. Key value array where keys are one of
nextorprevand value is a random string returned from the server, indicating a specific position in a data set. Setprevto a previously-returned string for fetching the previous page. Setnextto a previously-returned string for fetching the next page.
API limits
To learn about the maximum length of parameters used to set channel members metadata, refer to REST API docs.
Sample code
1
Response
The setMembers() operation returns a PNMembersResult which contains the following fields:
getData()#- List of member metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembersResultItem which contains the following fields:
Channel is a PNMember which contains the following fields:
getId()#- Unique user identifier
getName()#- Display name for the user
getExternalId()#- User's identifier in an external system
getProfileUrl()#- The URL of the user's profile picture
getEmail()#- The user's email address
getCustom()#- Object containing your custom fields
getUpdated()#- The last updated date and time
getETag()#- The entity tag
Remove channel members
Remove users from a channel. Provide the UUIDs to remove.
Method(s)
To Remove Channel Members you can use the following method(s) in the PHP SDK:
1removeMembers()
2 ->channel(String)
3 ->members(PNChannelMember[])
4 ->include(PNMemberIncludes)
5 ->filter(String)
6 ->sort(String | Array[String])
7 ->limit(Integer)
8 ->page(Array[String => String])
9 ->sync();
channel()required#- Unique channel identifier
members()required#- Array of members to remove from the channel
include()#- Whether to include additional fields.
- →
custom# - Whether to include the Custom object in the response.
- →
status# - Whether to include the status field.
- →
type# - Whether to include the type field.
- →
total_count# - Whether to include the total count in the paginated response.
- →
user# - Whether to include user fields.
- →
userCustom# - Whether to include the user Custom object.
- →
userType# - Whether to include the user type field.
- →
userStatus# - Whether to include the user status field.
sort()#- Sort by
id,name,updatedwithasc/descfor sort direction (for example,name:asc). limit()#- Number of objects to return. Default/Max: 100.
page()#- Cursor-based pagination. Use
prevandnexttokens returned by the server.
Sample code
1
Response
The removeMembers() operation returns a PNMembersResult which contains the following fields:
getData()#- List of member metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembersResultItem which contains the following fields:
Channel is a PNMember which contains the following fields:
getId()#- Unique user identifier
getName()#- Display name for the user
getExternalId()#- User's identifier in an external system
getProfileUrl()#- The URL of the user's profile picture
getEmail()#- The user's email address
getCustom()#- Object containing your custom fields
getUpdated()#- The last updated date and time
getETag()#- The entity tag
Manage channel members
Add and remove users in a channel in one request.
To Manage Channel Members you can use the following method(s) in the PHP SDK:
1manageMembers()
2 ->channel(String)
3 ->setUuids(Array[String])
4 ->removeUuids(Array[String])
5 ->setMembers(Array[PNChannelMember])
6 ->removeMembers(Array[PNChannelMember])
7 ->custom(Array | StdClass)
8 ->include(PNMemberIncludes)
9 ->filter(String)
10 ->sort(String | Array[String])
11 ->limit(Integer)
12 ->page(Array[String => String])
13 ->sync();
channel()required#- Unique channel identifier
channel()required#- Unique channel identifier
setUuids()required#- Array of UUIDs to add to the channel.
removeUuids()required#- Array of UUIDs to remove from the channel.
setMembers()required#- Array of
PNChannelMemberobjects to add to the channel. removeMembers()required#- Array of
PNChannelMemberobjects to remove from the channel. custom()required#- Custom JSON values. Can be strings, numbers, or booleans. Filtering by Custom isn’t supported.
include()#- Whether to include additional fields.
- →
custom# - Whether to include the Custom object in the response.
- →
status# - Whether to include the status field.
- →
type# - Whether to include the type field.
- →
total_count# - Whether to include the total count in the paginated response.
- →
user# - Whether to include user fields.
- →
userCustom# - Whether to include the user Custom object.
- →
userType# - Whether to include the user type field.
- →
userStatus# - Whether to include the user status field.
sort()#- Sort by
id,name,updatedwithasc/descfor sort direction (for example,name:asc). limit()#- Number of objects to return. Default/Max: 100.
page()#- Cursor-based pagination. Use
prevandnexttokens returned by the server.
Sample code
1
Response
The manageMembers() operation returns a PNMembersResult which contains the following fields:
getData()#- List of member metadata results
getTotalCount()#- Number of items returned in the data
getPrev()#- 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.
getNext()#- 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.
Data is an array of PNMembersResultItem which contains the following fields:
Channel is a PNMember which contains the following fields:
getId()#- Unique user identifier
getName()#- Display name for the user
getExternalId()#- User's identifier in an external system
getProfileUrl()#- The URL of the user's profile picture
getEmail()#- The user's email address
getCustom()#- Object containing your custom fields
getUpdated()#- The last updated date and time
getETag()#- The entity tag