App Context API for Ruby SDK

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.

Required keyset configuration

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

Method(s)

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

1get_all_uuid_metadata(
2    sort: sort,
3    include: include,
4    filter: filter,
5    start: start,
6    end: end,
7    limit: limit,
8    http_sync: http_sync,
9    callback: callback
10)

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many UUID has been associated with metadata.
• custom - include field with additional information from metadata which has been used during UUID metadata set requests.
• type - include the type of the metadata.
• status - include the status of the metadata.

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1require 'pubnub'
2

3def get_all_uuid_metadata(pubnub)
4  pubnub.get_all_uuid_metadata(
5    limit: 5,
6    include: { custom: true }
7  ) do |envelope|
8    if envelope.status[:error]
9      puts "Error fetching UUID metadata: #{envelope.status[:error]}"
10    else
11      envelope.result[:data][:metadata].each do |uuid_data|
12        puts "UUID: #{uuid_data[:id]}"
13        puts "Name: #{uuid_data[:name]}"
14        puts "Custom: #{uuid_data[:custom]}"
15        puts "Updated: #{uuid_data[:updated]}"
16      end
17    end
18  end
19end
20

21def main
22  # Configuration for PubNub instance
23  pubnub = Pubnub.new(
24    subscribe_key: ENV.fetch('SUBSCRIBE_KEY', 'demo'),
25    user_id: 'myUniqueUserId'
26  )
27

28  # Get all UUID metadata
29  get_all_uuid_metadata(pubnub)
30  sleep 1 # Allow time for the async operation to complete
31end
32

33if __FILE__ == $0
34  main
35end

show all 35 lines

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :metadata => [
5                {
6                    :id => "mg",
7                    :name => "magnum",
8                    :externalId => nil,
9                    :profileUrl => nil,
10                    :email => nil,
11                    :custom => { "XXX" => "YYYY" },
12                    :updated => <Date>,
13                    :eTag => "Ad2eyIWXwJzBqAE"
14                }
15            ],
16            :totalCount => 1,
17            :next => "MQ",
18            :prev => nil
19        }
20    },
21    @status = {
22        :code => 200
23    }
24>

show all 24 lines

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

1get_uuid_metadata(
2    uuid: uuid,
3    include: include,
4    http_sync: http_sync,
5    callback: callback
6)

uuid#

type: Type: String

default: Default: Client UUID

Identifier for which associated metadata should be fetched. Default: configured PubNub client uuid.

include#

type: Type: Object

default: Default: { custom: true }

Additional information which should be included in response. Available options:

• custom - include field with additional information from metadata which has been used during UUID metadata set requests.
• type - include the type of the metadata.
• status - include the status of the metadata.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.get_uuid_metadata(include: { custom: true }) do |envelope|
2    puts envelope
3end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :id => "mg",
5            :name => "magnum",
6            :externalId => nil,
7            :profileUrl => nil,
8            :email => nil,
9            :custom => { "XXX" => "YYYY" },
10            :updated => <Date>,
11            :eTag => "Ad2eyIWXwJzBqAE"
12        }
13    },
14    @status = {
15        :code => 200
16    }
17>

show all 17 lines

Set user metadata

Create or update metadata for a UUID. Use the eTag (if available in the SDK) to avoid overwriting concurrent updates.

Unsupported partial updates of custom metadata

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

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

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

1set_uuid_metadata(
2    uuid: uuid,
3    metadata: metadata,
4    include: include,
5    http_sync: http_sync,
6    callback: callback
7)

* required

uuid#

type: Type: String

default: Default: Client UUID

Identifier with which new metadata should be associated. Default: configured PubNub client uuid.

metadata* required#

type: Type: Object

Default: no default

Metadata information which should be associated with UUID. Available options:

• name - Name which should be stored in metadata associated with specified UUID.
• externalId - External identifier (database, auth service) associated with specified UUID.
• profileUrl - External URL with information for specified UUID representation.
• custom - Additional information which should be stored in metadata associated with specified UUID. App Context filtering language doesn’t support filtering by custom properties.
• email - Email address which should be stored in metadata associated with specified UUID.
• type - Type of the metadata associated with specified UUID.
• status - Status of the metadata associated with specified UUID.

include#

type: Type: Object

default: Default: { custom: true }

Additional information which should be included in response. Available options:

• custom - include field with additional information from metadata which has been used during UUID metadata set requests.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

API limits

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

Sample code

1pubnub.set_uuid_metadata(
2    uuid: 'mg',
3    metadata: { name: 'magnum', custom: { XXX: 'YYYY' } },
4    include: { custom: true }
5) do |envelope|
6    puts envelope
7end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :id => "mg",
5            :name => "magnum",
6            :externalId => nil,
7            :profileUrl => nil,
8            :email => nil,
9            :custom => { "XXX" => "YYYY" },
10            :updated => <Date>,
11            :eTag => "Ad2eyIWXwJzBqAE"
12        }
13    },
14    @status = {
15        :code => 200
16    }
17>

show all 17 lines

Remove user metadata

Delete metadata for the specified UUID.

Method(s)

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

1remove_uuid_metadata(
2    uuid: uuid,
3    http_sync: http_sync,
4    callback: callback
5)

uuid#

type: Type: String

default: Default: Client UUID

Identifier for which associated metadata should be removed. Default: configured PubNub client uuid.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.remove_uuid_metadata(uuid: 'mg') do |envelope|
2    puts envelope
3end

Response

1#<Pubnub::Envelope
2    @status = {
3        :code => 200,
4        :operation => :remove_uuid_metadata,
5        :category => :ack,
6        :error => false,
7        # [...]
8    },
9    # [...]
10>

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.

Method(s)

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

1get_all_channels_metadata(
2    sort: sort,
3    include: include,
4    filter: filter,
5    start: start,
6    end: end,
7    limit: limit,
8    http_sync: http_sync,
9    callback: callback
10)

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many channels has been associated with metadata.
• custom - include field with additional information from metadata which has been used during channel metadata set requests.
• type - include the type of the metadata.
• status - include the status of the metadata.

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.get_all_channels_metadata(
2    limit: 5,
3    include: { custom: true }
4) do |envelope|
5    puts envelope
6end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :metadata => [
5                {
6                    :id => "rb_channel1",
7                    :name => "some_name",
8                    :description => nil,
9                    :custom => { "XXX" => "YYYY" },
10                    :updated => <Date>,
11                    :eTag => "AZTUtcvx6NDGLQ"
12                },
13                # {...}
14            ],
15            :totalCount => 2,
16            :next => "MQ",
17            :prev => nil
18        }
19    },
20    @status = {
21        :code => 200
22    }
23>

show all 23 lines

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

1get_channel_metadata(
2    channel: channel,
3    include: include,
4    http_sync: http_sync,
5    callback: callback
6)

* required

channel* required#

type: Type: String

Default: no default

Name of channel for which associated metadata should be fetched.

include#

type: Type: Object

default: Default: { custom: true }

Additional information which should be included in response. Available options:

• custom - include field with additional information from metadata which has been used during channel metadata set requests.
• type - include the type of the metadata.
• status - include the status of the metadata.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.get_channel_metadata(
2    channel: 'channel',
3    include: { custom: true }
4) do |envelope|
5    puts envelope
6end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :id => "channel",
5            :name => "some_name",
6            :description => nil,
7            :custom => { "XXX" => "YYYY" },
8            :updated => <Date>,
9            :eTag => "AZTUtcvx6NDGLQ"
10        }
11    },
12    @status = {
13        :code => 200
14    }
15>

Set channel metadata

Create or update metadata for a channel. Use concurrency controls if available.

Unsupported partial updates of custom metadata

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

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

Method(s)

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

1set_channel_metadata(
2    channel: channel,
3    metadata: metadata,
4    include: include,
5    http_sync: http_sync,
6    callback: callback
7)

* required

channel* required#

type: Type: String

Default: no default

Name of channel with which new metadata should be associated.

metadata* required#

type: Type: Object

Default: no default

Metadata information which should be associated with channel. Available options:

• name - Name which should stored in metadata associated with specified channel.
• information - Description which should be stored in metadata associated with specified channel.
• custom - Additional information which should be stored in metadata associated with specified channel. App Context filtering language doesn’t support filtering by custom properties.
• type - Type of the metadata associated with specified channel.
• status - Status of the metadata associated with specified channel.

include#

type: Type: Object

default: Default: { custom: true }

Additional information which should be included in response. Available options:

• custom - include field with additional information from metadata which has been used during UUID metadata set requests.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

API limits

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

Sample code

1pubnub.set_channel_metadata(
2    channel: 'channel',
3    metadata: { name: 'some_name', custom: { XXX: 'YYYY' } }
4) do |envelope|
5    puts envelope
6end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :id => "channel",
5            :name => "some_name",
6            :description => nil,
7            :custom => { "XXX" => "YYYY" },
8            :updated => <Date>,
9            :eTag => "AZTUtcvx6NDGLQ"
10        }
11    },
12    @status = {
13        :code => 200
14    }
15>

Other examples

Iteratively update existing metadata

1require 'pubnub'
2require 'json'
3

4pubnub = Pubnub.new(
5  publish_key: 'demo',
6  subscribe_key: 'demo',
7  uuid: 'example'
8)
9

10channel = 'demo_example'
11help_string = <<-HELP
12  To exit type '/exit'
13  To show the current object type '/show'
14  To show this help type '/help'
15HELP
16

17puts "We're setting the channel's #{channel} additional info. \n#{help_string}\n"
18

19puts 'Enter the channel name:'
20name = gets.chomp
21puts 'Enter the channel description:'
22description = gets.chomp
23

24# Setting the basic channel info
25pubnub.set_channel_metadata(
26  channel: channel,
27  metadata: { name: name, information: description }
28) do |envelope|
29  puts "The channel has been created with name and description.\n" if envelope.status[:code] == 200
30end
31

32# We start to iterate over the custom fields
33loop do
34  # First we have to get the current object to know what fields are already set
35  current_object = nil
36  pubnub.get_channel_metadata(
37    channel: channel,
38    include: { custom: true }
39  ) do |envelope|
40    current_object = envelope.result[:data] if envelope.status[:code] == 200
41  end
42

43  # Ask for new data
44  puts 'Enter the field name:'
45  field_name = gets.chomp
46  break if field_name == '/exit'
47

48  if field_name == '/show'
49    puts JSON.pretty_generate(current_object)
50    puts "\n"
51    next
52  end
53

54  if field_name == '/help'
55    puts help_string
56    next
57  end
58

59  puts 'Enter the field value:'
60  field_value = gets.chomp
61

62  custom = current_object[:custom] || {}
63

64  if custom.key?(field_name)
65    puts "Field #{field_name} already has a value. Overwrite? (y/n):"
66    confirm = gets.chomp.downcase
67    until %w[y n].include?(confirm)
68      puts "Please enter 'y' or 'n':"
69      confirm = gets.chomp.downcase
70    end
71

72    if confirm == 'n'
73      puts "Object will not be updated.\n"
74      next
75    else
76      custom[field_name] = field_value
77    end
78  else
79    custom[field_name] = field_value
80  end
81

82  # Writing the updated object back to the server
83  pubnub.set_channel_metadata(
84    channel: channel,
85    metadata: { custom: custom, name: current_object[:name], information: current_object[:description] }
86  ) do |envelope|
87    puts "Object has been updated.\n" if envelope.status[:code] == 200
88  end
89end

show all 89 lines

Remove channel metadata

Delete metadata for the specified channel.

Method(s)

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

1remove_channel_metadata(
2    channel: channel,
3    http_sync: http_sync,
4    callback: callback
5)

* required

channel* required#

type: Type: String

Default: no default

Name of channel with which the metadata should be removed.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.remove_channel_metadata(channel: 'channel') do |envelope|
2    puts envelope
3end

Response

1#<Pubnub::Envelope
2    @status = {
3        :code => 200,
4        :operation => :remove_channel_metadata,
5        :category => :ack,
6        :error => false,
7        # [...]
8    },
9    # [...]
10>

Channel memberships

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

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

1get_memberships(
2    uuid: uuid,
3    sort: sort,
4    include: include,
5    filter: filter,
6    start: start,
7    end: end,
8    limit: limit,
9    http_sync: http_sync,
10    callback: callback
11)

uuid#

type: Type: String

default: Default: Client UUID

Identifier for which memberships in channels should be fetched. Default: configured PubNub client uuid.

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many memberships UUID has.
• custom - include field with additional information from metadata which has been associated with UUID during membership add requests.
• channel_metadata - include channel's metadata into response (not only name).
• channel_custom - include channel's additional information which has been used during channel metadata set requests.
• status - include the status of the membership.
• type - include the type of the membership.
• channel_type - include the type of the channel.
• channel_status - include the status of the channel.

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.get_memberships(
2    uuid: 'mg',
3    include: { count: true, custom: true, channel_metadata: true }
4) do |envelope|
5    puts envelope
6end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :memberships => [
5                {
6                    :channel => {
7                        :id => "channel-identifier1",
8                        :name => "Channel1",
9                        :description => nil,
10                        # {...}
11                    },
12                    :custom => { "membership-custom" => "custom-data-1" },
13                    :updated => <Date>,
14                    :eTag => "AYbepevg39XeDA"
15                },
16                # {...}
17            ],
18            :totalCount => 2,
19            :next => "MQ",
20            :prev => nil
21        }
22    },
23    @status = {
24        :code => 200
25    }
26>

show all 26 lines

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

1set_memberships(
2    uuid: uuid,
3    channels: channels,
4    sort: sort,
5    include: include,
6    filter: filter,
7    start: start,
8    end: end,
9    limit: limit,
10    http_sync: http_sync,
11    callback: callback
12)

* required

uuid#

type: Type: String

default: Default: Client UUID

Identifier for which memberships in channels should be set. Default: configured PubNub client uuid.

channels* required#

type: Type: Array

Default: no default

List of channels for which metadata associated with each of them in context of UUID should be set. Each entry is a dictionary with channel and optional fields:

• custom - A dictionary with simple objects: String and Integer.
• type - Type of the metadata associated with specified membership.
• status - Status of the metadata associated with specified membership.

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many memberships UUID has.
• custom - include field with additional information from metadata which has been associated with UUID during membership add requests.
• channel_metadata - include channel's metadata into response (not only name).
• channel_custom - include channel's additional information which has been used during channel metadata set requests.
• status - include the status of the membership.
• type - include the type of the membership.
• channel_type - include the type of the channel.
• channel_status - include the status of the channel.

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

API limits

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

Sample code

1pubnub.set_memberships(
2    uuid: 'mg',
3    channels: [
4        { channel: 'channel-1' }
5    ],
6    include: { custom: true }
7) do |envelope|
8    puts envelope
9end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :memberships => [
5                {
6                    :channel => {
7                        :id => "channel-1",
8                        # {...}
9                    },
10                    :custom => nil,
11                    :updated => <Date>,
12                    :eTag => "AY39mJKK//C0VA"
13                }
14            ],
15            :totalCount => 1,
16            :next => "MQ",
17            :prev => nil
18        }
19    },
20    @status = {
21        :code => 200
22    }
23>

show all 23 lines

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

1remove_memberships(
2    uuid: uuid,
3    channels: channels,
4    sort: sort,
5    include: include,
6    filter: filter,
7    start: start,
8    end: end,
9    limit: limit,
10    http_sync: http_sync,
11    callback: callback
12)

* required

uuid#

type: Type: String

default: Default: Client UUID

Identifier for which memberships in channels should be removed. Default: configured PubNub client uuid.

channels* required#

type: Type: Array

Default: no default

List of channels from which UUID should be removed as member.

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many memberships UUID has.
• custom - include field with additional information from metadata which has been associated with UUID during membership add requests.
• channel_metadata - include channel's metadata into response (not only name).
• channel_custom - include channel's additional information which has been used during channel metadata set requests..

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.remove_memberships(
2    uuid: 'mg',
3    channels: [ 'channel-1' ],
4    include: { custom: true }
5) do |envelope|
6    puts envelope
7end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :memberships => [
5                {
6                    :channel => {
7                        :id => "channel-2",
8                        # {...}
9                    },
10                    :custom => nil,
11                    :updated => <Date>,
12                    :eTag => "AY39mJKK//C0VA"
13                }
14            ],
15            :totalCount => 1,
16            :next => "MQ",
17            :prev => nil
18        }
19    },
20    @status = {
21        :code => 200
22    }
23>

show all 23 lines

Channel members

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

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

1get_channel_members(
2    channel: channel,
3    sort: sort,
4    include: include,
5    filter: filter,
6    start: start,
7    end: end,
8    limit: limit,
9    http_sync: http_sync,
10    callback: callback
11)

* required

channel* required#

type: Type: String

Default: no default

Name of channel from which members should be fetched.

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many members channel has.
• custom - include field with additional information from metadata which has been associated with UUID during channel member add requests.
• uuid_metadata - include UUID's metadata into response (not only identifier).
• uuid_custom - include UUID's additional information which has been used during UUID metadata set requests.
• status - include the status of the member.
• type - include the type of the member.
• uuid_status - include the status of the UUID.
• uuid_type - include the type of the UUID.

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.get_channel_members(
2    channel: 'channel-1',
3    include: { count: true, custom: true, uuid_metadata: true }
4) do |envelope|
5    puts envelope
6end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :members => [
5                {
6                    :uuid => {
7                        :id => "uuid-identifier1",
8                        :name => "uuid1",
9                        :externalId => nil,
10                        :profileUrl => nil,
11                        :email => nil,
12                        :updated => <Date>,
13                        :eTag => "AYfwuq+u+4C01gE",
14                        # {...}
15                    },
16                    :custom => nil,
17                    :updated => <Date>,
18                    :eTag => "AY39mJKK//C0VA"
19                },
20                # {...}
21            ],
22            :totalCount => 6,
23            :next => "Ng",
24            :prev => nil
25        }
26    },
27    @status = {
28        :code => 200
29    }
30>

show all 30 lines

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

1set_channel_members(
2    channel: channel,
3    uuids: uuids,
4    sort: sort,
5    include: include,
6    filter: filter,
7    start: start,
8    end: end,
9    limit: limit,
10    http_sync: http_sync,
11    callback: callback
12)

* required

channel* required#

type: Type: String

Default: no default

Name of channel for which members should be set.

uuids* required#

type: Type: Array

Default: no default

List of UUIDs for which metadata associated with each of them in context of channel should be set. Each entry is a dictionary with UUID and optional fields:

• custom - A dictionary with simple objects: String and Integer.
• type - Type of the metadata associated with specified UUID.
• status - Status of the metadata associated with specified UUID.

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many members channel has.
• custom - include field with additional information from metadata which has been associated with UUID during channel member add requests.
• uuid_metadata - include UUID's metadata into response (not only identifier).
• uuid_custom - include UUID's additional information which has been used during UUID metadata set requests.
• status - include the status of the member.
• type - include the type of the member.
• uuid_status - include the status of the UUID.
• uuid_type - include the type of the UUID.

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

API limits

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

Sample code

1pubnub.set_channel_members(
2    channel: 'channel',
3    uuids: [
4        { uuid: 'uuid1' }
5    ],
6    include: { custom: true }
7) do |envelope|
8    puts envelope
9end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :members=>[
5                {
6                    :uuid => {
7                        :id => "mg2",
8                        # {...}
9                    },
10                    :custom => nil,
11                    :updated=><Date>,
12                    :eTag => "AY39mJKK//C0VA"
13                }
14            ],
15            :totalCount => 1,
16            :next => "MQ",
17            :prev => nil
18        }
19    },
20    @status = {
21        :code => 200
22    }
23>

show all 23 lines

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

1remove_channel_members(
2    channel: channel,
3    uuids: uuids,
4    sort: sort,
5    include: include,
6    filter: filter,
7    start: start,
8    end: end,
9    limit: limit,
10    http_sync: http_sync,
11    callback: callback
12)

* required

channel* required#

type: Type: String

Default: no default

Name of channel from which members should be removed.

uuids* required#

type: Type: Array

Default: no default

List of UUIDs which should be removed from channel's list.

sort#

type: Type: Array

Default: no default

List of criteria (name of field) which should be used for sorting in ascending order. Available options are id, name, and updated. Use asc or desc to specify sort direction.

include#

type: Type: Object

default: Default: { count: true }

Additional information which should be included in response. Available options:

• count - include how many members channel has.
• custom - include field with additional information from metadata which has been associated with UUID during channel member add requests.
• uuid_metadata - include UUID's metadata into response (not only identifier).
• uuid_custom - include UUID's additional information which has been used during UUID metadata set requests.

filter#

type: Type: String

Default: no default

Expression to filter out results basing on specified criteria. For more details on the supported grammar, check the filtering reference

start#

type: Type: String

Default: no default

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: Type: String

Default: no default

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.

limit#

type: Type: Integer

default: Default: 100

Number of objects to return in response. Default is 100, which is also the maximum value.

http_sync#

type: Type: Boolean

default: Default: false

Method will be executed asynchronously and will return future, to get its value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope). For sync methods Envelope object will be returned.

callback#

type: Type: Lambda accepting one parameter

Default: no default

Callback that will be called for each envelope. For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

Sample code

1pubnub.remove_channel_members(
2    channel: 'channel',
3    uuids: [ 'mg1' ],
4    include: { custom: true }
5) do |envelope|
6    puts envelope
7end

Response

1#<Pubnub::Envelope
2    @result = {
3        :data => {
4            :members=>[
5                {
6                    :uuid => {
7                        :id => "uuid-identifier",
8                        # {...}
9                    },
10                    :custom => nil,
11                    :updated => <Date>,
12                    :eTag => "AY39mJKK//C0VA"
13                }
14            ],
15            :totalCount => 1,
16            :next => "MQ",
17            :prev => nil
18        }
19    },
20    @status = {
21        :code => 200
22    }
23>

show all 23 lines