RubyFeatures Matrix for PubNub Ruby V4 SDK

 

These docs are for PubNub 4.0 for Ruby which is our latest and greatest! For the docs of the older versions of the SDK, please check PubNub 3.0 for Ruby.

If you have questions about the PubNub for Ruby SDK, please contact us at support@pubnub.com.

NameDescription
GrantThis function establishes access permissions for PubNub Access Manager (PAM) by setting the read or write attributes.
Root permissions for the Access ManagerWhen you init with secret key, you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels.
NameDescription
Add ChannelsAdd channel to a channel group.
List Channels In Channel GroupList all channels of a channel group.
Remove ChannelsRemove channel from channel group.
Remove Channels GroupsRemove channel groups.
NameDescription
Request message count exceededWhen the number of messages arrived on a subscribe response are equal to or greater the number set in the init config, a new status message on the status callback, with the category PNRequestMessageCountExceededCategory, will be invoked.
NameDescription
Get StateGet state is used to get the key/value pairs specific to a subscriber uuid.
HeartbeatTimeout events are triggered when the server does not hear a hearbeat from the client within a default timeout time of 280 seconds.
Here NowObtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count of the channel.
Set StateSet state is used to set key/value pairs specific to a subscriber uuid.
Where NowObtain information about the current list of a channels to which a uuid is subscribed to.
NameDescription
Publish AsynchronouslyPublish the message asynchronously.
Publish RAW JSONPublish JSON as is.
Publish SynchronouslyPublish the message synchronously.
Publish using GETPublish using HTTP GET
Publish using POSTPublish using HTTP POST
Publish with MetadataPublish extra meta with the request used for Message Filtering.
Store FlagAbility to skip message from storage.
TTL per published messageOffer the ability to set a per message time to live in storage.
NameDescription
Send a SignalHas support to send a Signal
NameDescription
CountSpecifies the number of historical messages to return.
Count of Messages on ChannelsThe API is a history based API that simply does a mostly normal history operation but instead of returning the messages in a channel it returns the count of messages. Without actually calling history on those channels this API gives you the ability to say if there are messages in the chat channel you can go look at further.
Delete messages from storageRemoves the messages from the history of a specific channel.
Include TimetokenWhether event dates time tokens should be included in response or not.
ReverseTraverse the timeline in reverse starting with the oldest message first.
Start EndTime token delimiting the start/end of time slice (exclusive) to pull messages from.
NameDescription
Filter ExpressionStream Filter allows a subscriber to apply a filter to only receive messages that satisfy the conditions of the filter. The message filter is set by the subscribing client(s) but it is applied on the server side thus preventing unwanted messages (those that do not meet the conditions of the filter) from reaching the subscriber.
Subscribe to channel groupsAbility to subscribe to channel groups.
Subscribe to channelsAbility to subscribe to channels.
Subscribe to presence channel groupsAbility to subscribe to presence channel groups.
Subscribe to presence channelsAbility to subscribe to presence channels.
Subscribe with timetokenSubscribe with timetoken.
Wildcard subscribeWildcard subscribes allow the client to subscribe to multiple channels using wildcard. E.g., if you subscribe to a.* you will get all messages for a.b, a.c, a.x. The wildcarded * portion refers to any portion of the channel string name after the dot (.).
NameDescription
TimeThis function will return a 17 digit precision Unix epoch from the server.