GoFeatures Matrix for Go V4 SDK

 

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

If you have questions about the PubNub for Go 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.
Grant DeleteThis function establishes access permissions for PubNub Access Manager (PAM) by setting the Delete attribute.
Grant ManageThis function establishes access permissions for PubNub Access Manager (PAM) by setting the Manage attribute.
Grant version 3The SDK has support for Grant version 3
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
Delete FileAllows users to delete a file from specified channel.
Download FileAllows users to download a file from specified channel.
Get File URLAllows users to generate URL which can be used to download a file from a target channel.
List FilesAllows users to retrieve list of files uploaded to a channel.
Send FileAllows users to upload file / data to specified channel.
NameDescription
Add Message ActionsSDK has support to Add Message Actions
Get Message ActionsSDK has support to Get Message Actions
Remove Message ActionsSDK has support to Remove Message Actions
NameDescription
Add Device To ChannelsEnables push notifications on provided set of channels.
APNS SupportSDK has support to send notifications using APNS
APNS2 SupportSDK has support to send notifications using APNS2
FCM SupportSDK has support to send notifications using FCM
List Channels From DeviceList all channels on which push notification has been enabled.
MPNS SupportSDK has support to send notifications using MPNS
Remove DeviceDisable push notifications from all channels which is registered.
Remove Device From ChannelsDisable push notifications on provided set of channels.
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
Delete a channel's metadataDeletes metadata for the specified channel.
Delete a UUID's metadataDeletes metadata for the specified UUID.
Get a channel's metadataReturns metadata for the specified channel, optionally including custom properties.
Get a UUID's channel membership metadataReturns channel membership metadata for the specified UUID.
Get a UUID's metadataReturns metadata for the specified UUID, optionally including custom properties.
Get all members' metadata in the channelReturns the members' metadata in the specified channel.
Get metadata for all channelsReturns metadata for all channels, optionally including custom properties.
Get metadata for all UUIDsReturns a paginated list of UUID metadata, optionally including custom properties.
Manage a UUID's channel membership metadataSets/Removes channel membership metadata for the specified UUID.
Manage members' metadata in the channelSets/Removes members' metadata in the specified channel.
Objects FilteringSupports filtering in Objects API
Objects SortingSupports sorting in Objects API
Remove a UUID's channel membership metadataRemoves channel membership metadata for the specified UUID.
Remove members' metadata in the channelRemoves members' metadata in the specified channel.
Set a channel's metadataSets metadata for the specified channel.
Set a UUID's channel membership metadataSets channel membership metadata for the specified UUID.
Set a UUID's metadataSets metadata for the specified UUID.
Set members' metadata in the channelSets members' metadata in the specified channel.
NameDescription
Create Push PayloadThe SDK has support to create the push payload for use in the appropriate endpoint calls.
Process pn_other in messageWhen a message with JSON key named `pn_other` is published and encryption is enabled, only the value of `pn_other` will be encrypted and the rest of the message will be in plain text. This feature is useful when you want to send out encrypted push notifications. On the subscribe end, if `pn_other` is detected in the received message and encryption is enabled, only the value of `pn_other` wil be decrypted. Rest of the message will be not be decrypted. Same goes for History and Fetch.
QueryParam in all API callsThe keys and values of the variable are passed as the query string parameters of the URL called by the API.
Random Initialization VectorWhen true the IV used in encryption will be random for all requests and not just file upload. When false the IV will be hardcoded for all requests except File Upload.
TelemetrySends back latency info to the server.
NameDescription
Configurable Heartbeats per channelUser can start/stop heartbeats without subscription to channel or channel group.
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 heartbeat 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.
Here Now RefreshIf the full interval message is greater than 30KB (since the max publish payload is ∼32KB), none of the extra fields will be present. Instead there will be a here_now_refresh boolean field set to true. This indicates to the user that they should do a hereNow request to get the complete list of users present in the channel.
Presence Heartbeat call optimizations.Presence Heartbeat call is delayed if a Subscribe call precedes it within the presence heartbeat interval.
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.
NameDescription
FireFire method used for publishing. When a message is sent using fire, it will not be replicated to other Points of Presence, it will remain at the originating Point of Presence, and is not eligible for archiving via the Storage and Playback feature.
Publish File MessageAllows users to publish file message to a specified channel.
Publish RAW JSONPublish JSON as is.
Publish using GETPublish using HTTP GET
Publish using POSTPublish using HTTP POST
Publish with MetadataPublish extra meta with the request used for Message Filtering.
Replication FlagControls whether the message should be replicated across stores.
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.
Fetch messages from storageThis function fetches historical messages from multiple channels.
Fetch messages from storage with message actionsThis function fetches historical messages from multiple channels with message actions data
Fetch messages from storage with Message TypeThis function fetches historical messages from multiple channels with Message Type param in each message
Fetch messages from storage with metaThis function fetches historical messages from multiple channels with metadata
Fetch messages from storage with UUIDThis function fetches historical messages from multiple channels with UUID param in each message
Fetch messages with file eventsHas the ability to fetch messages with file events
History with metaThe SDK has support to retrieve History with metadata
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
Files Events ListenerHas support to listen to Files Events from Files API.
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.
Message Actions events listenerHas support to listen to Action Events from Message Actions API
Objects API Membership events listenerHas support to listen to Membership Events from Objects API
Objects API Space events listenerHas support to listen to Space Events from Objects API
Objects API User events listenerHas support to listen to User Events from Objects API
Publisher UUIDHas the publisher UUID of the published message.
PubSub v2 compatibilityUses PubSub v2 to make subscribe calls.
Signal ListenerHas support to listen to Signal messages
Subscribe to channel groupsAbility to subscribe to channel groups.
Subscribe to channelsAbility to subscribe to channels.
Subscribe to presence channelsAbility to subscribe to presence channels.
Subscribe with timetokenSubscribe with timetoken.
Subscribe with User StateSubscribe with User State in a single call.
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.
NameDescription
Unsubscribe from allUnsubscribe from all channel/channel groups
Unsubscribe suppress leave eventsLeave request will not be sent from the SDK, if set in config.