---
source_url: https://www.pubnub.com/docs/chat/unreal-chat-sdk/learn/chat-entities/user
title: User object
updated_at: 2026-06-26T11:04:01.380Z
---

> 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


# User object

`User` represents a single user in a chat.

## Properties

The `User` object has the following properties:

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Id | FString | Optional |  | Unique identifier for the user. Access using `GetUserID()`. |
| UserData | FPubnubChatUserData | Optional |  | Additional data. Access using `GetUserData()`. |
| > UserName | FString | Optional |  | Display name for the user (must not be empty or consist only of whitespace characters). |
| > ExternalID | FString | Optional |  | User's identifier in an external system. You can use it to match `id` with a similar identifier from an external database. |
| > ProfileUrl | FString | Optional |  | URL of the user's profile picture. |
| > Email | FString | Optional |  | User's email address. |
| > Custom | FString | Optional |  | JSON providing custom data about the user. Values must be scalar only; arrays or objects are not supported. [Filtering App Context data](https://www.pubnub.com/docs/general/metadata/filtering) through the `custom` property is not recommended in SDKs. |
| > Status | FString | Optional |  | Tag that lets you categorize your app users by their current state. The tag choice is entirely up to you and depends on your use case. For example, you can use `status` to mark users in your chat app as `invited`, `active`, or `archived`. Maximum length is 50 characters. |
| > Type | FString | Optional |  | Tag that lets you categorize your app users by their functional roles. The tag choice is entirely up to you and depends on your use case. For example, you can use `type` to group users by their roles in your app, such as `moderator`, `player`, or `support-agent`. Maximum length is 50 characters. |

:::tip API limits
To learn about the maximum length of parameters used to set user metadata, refer to [REST API docs](https://www.pubnub.com/docs/sdks/rest-api/set-user-metadata).
:::

## Methods

You can call the following methods on the `User` object.

Click on each method for more details.

* [Delete()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/delete)
* [GetChannelRestrictions()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/moderation#one-user-on-one-channel)
* [GetChannelsRestrictions()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/moderation#one-user-on-all-channels)
* [GetLastActiveTimestamp()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/presence#check-users-last-online-activity)
* [GetMembership()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/channels/membership#get-single-membership)
* [GetMemberships()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/channels/membership#get-membership)
* [GetUserData()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/details#get-user-data)
* [GetUserID()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/details#get-user-id)
* [IsActive()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/presence#check-users-app-presence)
* [IsMemberOn()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/channels/membership#check-channel-membership)
* [IsPresentOn()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/presence#check-users-channel-presence)
* [SetRestrictions()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/moderation#mute-or-ban-users)
* [Update()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/updates#update-user-details)
* [WherePresent()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/presence#return-channels-where-user-is-present)

## Streaming

Call these methods to subscribe to or unsubscribe from real-time events on this `User` object.

* [StreamInvitations()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/channels/invite#listen-to-invite-events)
* [StopStreamingInvitations()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/channels/invite#listen-to-invite-events)
* [StreamMentions()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/mentions#user-delegate)
* [StopStreamingMentions()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/mentions#user-delegate)
* [StreamRestrictions()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/moderation#listen-to-moderation-events)
* [StopStreamingRestrictions()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/moderation#listen-to-moderation-events)
* [StreamUpdates()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/updates#get-user-updates)
* [StopStreamingUpdates()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/updates#get-user-updates)
* [StreamUpdatesOn()](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/updates#get-user-updates)

## Use case

`User` methods enable:

* [Creating and managing](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/create) users
* Configuring channel [memberships](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/channels/membership)
* [Mentioning](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/mentions) others in conversations
* Checking user [presence](https://www.pubnub.com/docs/chat/unreal-chat-sdk/build/features/users/presence) status