---
source_url: https://www.pubnub.com/docs/sdks/unreal/entities/channel-metadata
title: ChannelMetadata Entity
updated_at: 2026-06-16T12:52:55.363Z
sdk_name: PubNub Unreal SDK
sdk_version: 2.0.5
---

> Documentation Index
> For a curated overview of PubNub documentation, see: https://www.pubnub.com/docs/llms.txt
> For the full list of all documentation pages, see: https://www.pubnub.com/docs/llms-full.txt


# ChannelMetadata Entity

PubNub Unreal SDK, use the latest version: 2.0.5

As of version 1.1.0, the Unreal Engine software development kit (SDK) supports entities. Entities are SDK objects that bundle operations for a specific resource type and simplify working with PubNub application programming interfaces (APIs).

Use entities to perform common tasks without manually wiring requests. Some PubNub APIs are exposed via entities. Other operations are available on `UPubnubClient` (recommended) or on the `UPubnubSubsystem` object; see [Configuration](https://www.pubnub.com/docs/sdks/unreal/api-reference/configuration) and the API reference for details.

## Create ChannelMetadata

Use this factory method to return a local `ChannelMetadata` entity for a single channel metadata object. A `ChannelMetadata` entity centralizes operations related to App Context channel metadata.

```cpp
UPubnubChannelMetadataEntity* CreateChannelMetadataEntity(FString Channel);
```

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Channel | FString | Yes |  | Identifier of the [channel metadata](https://www.pubnub.com/docs/general/metadata/channel-metadata) for which to create the entity. |

#### Sample code

:::tip Reference code
This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.
:::

###### C++

```cpp
void ASample_ChannelMetadataEntity::CreateChannelMetadataEntitySample()
{
	// snippet.hide
	UPubnubClient* PubnubClient = GetPubnubClient();
	// snippet.show
	
	//Assumes PubnubClient is created and UserID is set

	// Create a channel metadata entity for the channel you want to monitor metadata changes
	FString ChannelName = TEXT("lobby_settings");
	UPubnubChannelMetadataEntity* ChannelMetadataEntity = PubnubClient->CreateChannelMetadataEntity(ChannelName);
}
```

###### Blueprint

## Available operations

The `ChannelMetadata` entity provides operations for PubNub App Context [channel metadata](https://www.pubnub.com/docs/general/metadata/channel-metadata).

| Operation (click for more information) | Description |
| --- | --- |
| [CreateSubscription(SubscribeSettings)](https://www.pubnub.com/docs/sdks/unreal/api-reference/publish-and-subscribe#subscribe) | Returns a local channel metadata [subscription object](https://www.pubnub.com/docs/general/channels/subscribe#subscription-types) with [optional parameters](https://www.pubnub.com/docs/general/channels/subscribe#subscription-options). You can then subscribe to receive real-time updates for that channel metadata. |
| [SetChannelMetadata(ChannelMetadata, OnSetChannelMetadataResponse, Include)](https://www.pubnub.com/docs/sdks/unreal/api-reference/objects#set-channel-metadata) | Sets metadata for a specified channel in the PubNub App Context. Requires the App Context add-on. |
| [GetChannelMetadata(OnGetChannelMetadataResponse, Include)](https://www.pubnub.com/docs/sdks/unreal/api-reference/objects#get-channel-metadata) | Retrieves metadata for a specified channel from the PubNub App Context. Requires the App Context add-on. |
| [RemoveChannelMetadata(OnRemoveChannelMetadataResponse)](https://www.pubnub.com/docs/sdks/unreal/api-reference/objects#remove-channel-metadata) | Removes all metadata associated with a specified channel from the PubNub App Context. Requires the App Context add-on. |