Documentation Release Notes - April 2025

This April, we've focused on making our documentation more practical and easier to use.

We've updated Getting Started guides for multiple SDKs to provide clearer onboarding paths, added comprehensive documentation for status events across our C-Core, Rust, JavaScript and other SDKs, and improved support for custom events and event listeners.

Plus, we've enhanced our REST API documentation with better SEO-optimized titles and links, making it easier for you to find the information you need.

General 🛠️​

Improved REST API documentation titles & links for SEO​

Type: Enhancement

We've made significant improvements to our REST API documentation titles and internal links to enhance searchability and make it easier for you to find the information you need.

These updates include:

  • More descriptive page titles that better reflect the content
  • Optimized keywords in documentation headings
  • Improved cross-linking between related API endpoints
  • Clearer navigation paths throughout the REST API documentation

This work ensures that whether you're searching on our site or through external search engines, you'll find the relevant REST API documentation more quickly and intuitively.

Updated App Context optional fields in REST API docs​

Type: Enhancement

We've updated our REST API documentation to clarify which fields are optional when working with App Context. This update provides better guidance on the minimum required parameters for various operations, making it easier to work with our APIs without including unnecessary data.

The documentation now clearly indicates which fields can be omitted in your API requests, helping you create more concise and efficient API calls when working with channels, users, and memberships through the REST API.

Updated MAU limit information​

Type: Adjustment

We've updated the documentation regarding Monthly Active User (MAU) limits to provide clearer guidance on the maximum number of users that can authenticate simultaneously on a single device.

This information is critical for developers building applications where multiple users might share the same device, ensuring you can plan your architecture appropriately within our platform's constraints.

SDKs 📦​

Improved status event documentation across SDKs​

Type: Enhancement

We've added detailed documentation for status events across multiple SDKs to help you better understand and handle various connection states and error conditions. This documentation is now available for:

Each SDK's documentation now includes:

  • Visual flowcharts showing possible connection states
  • Detailed descriptions of each status type
  • When each status was introduced or changed
  • Code examples showing how to properly handle status events
  • Error categorization to help with troubleshooting

This enhancement makes it much easier to build reliable applications that gracefully handle network issues, reconnection scenarios, and various error conditions.

Subscribe loop and Event Listeners updates​

Type: Enhancement

We've updated our documentation for event handling across multiple SDKs, with a particular focus on the new standardized subscribe loop architecture. This update covers:

  • Standardized event listeners for message, signal, presence, and file events in JavaScript, Swift, Rust, and C-Core SDKs
  • Custom event payloads for app-specific events in Chat SDKs (JavaScript, Kotlin, Swift, Unreal)
  • Improved error handling and event type discrimination in subscription status events

Updated Getting Started guides for multiple SDKs​

Type: Enhancement

We've completely revamped the Getting Started guides for multiple SDKs to provide a more consistent, user-friendly experience across our documentation. The updated guides include:

  • Platform-specific installation instructions
  • Complete, copy-paste ready code examples
  • Clear step-by-step progression
  • Required keyset configuration information

The following SDKs now have enhanced Getting Started guides:

Each guide now follows a consistent pattern:

  1. Setup and installation
  2. Creating a PubNub instance with your keys
  3. Subscribing to channels
  4. Publishing messages
  5. Handling received messages

This standardized approach makes it easier to get started with any PubNub SDK, regardless of your preferred programming language or platform.

Membership type and status in Unreal and Unreal Chat SDKs​

Type: Enhancement

We've updated our documentation for the Unreal SDK and Unreal Chat SDK to better support membership type and status fields in user-channel relationships. These updates include:

  • Added support for Type and Status fields in memberships
  • Improved documentation on how to use membership types for role-based access
  • Enhanced examples showing proper membership management
#include "Kismet/GameplayStatics.h"
#include "PubnubChatSubsystem.h"

UGameInstance* GameInstance = UGameplayStatics::GetGameInstance(this);
UPubnubChatSubsystem* PubnubChatSubsystem = GameInstance->GetSubsystem<UPubnubChatSubsystem>();

UPubnubChat* Chat = PubnubChatSubsystem->InitChat("demo", "demo", "my_user");

// Get an existing user
UPubnubUser* User = Chat->GetUser("support_agent_15");

// Find memberships for a specific channel
FString Filter = "channel.id == 'high-priority-incidents'";
FPubnubMembershipsResponseWrapper Memberships = User->GetMemberships(Filter);

show all 24 lines

The Type field supports categorizing memberships (such as "moderator", "admin", "guest"), while the Status field helps track membership states (like "active", "pending", "blocked"). These fields make it easier to implement role-based permissions and track user engagement in your Unreal applications.

Other 🌟​

Table tooltips improvement​

Type: Enhancement

We've improved the tooltip functionality in our documentation tables to provide clearer, more contextual information when hovering over table elements.

Tooltips in tables

The improved tooltips now:

  • Appear with a blurred, centered background that ensures full visibility
  • Remain completely visible regardless of their position in the table
  • No longer get cut off at table edges or when near page boundaries
  • Provide clearer visual distinction between the tooltip and the underlying content

You'll find these enhanced tooltips throughout our API reference tables, making it easier to understand the available options at a glance.

Last updated on
On this page