Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > PortalServices > Account > IPortalUser > IPortalUser::IsEntitledToItem

Light Theme

Dark Theme

IPortalUser::IsEntitledToItem

Returns whether the use is entitled to the specified Item Id.

Windows

MacOS

Linux

References

Module	PortalServices
Header	/Engine/Source/Runtime/Portal/Services/Public/Account/IPortalUser.h
Include	#include "Account/IPortalUser.h"

Syntax

TAsyncResult< FPortalUserIsEntitledToItemResult > IsEntitledToItem
(
const FString & ItemId,
EEntitlementCacheLevelRequest CacheLevel
)

Remarks

Returns whether the use is entitled to the specified Item Id.

Behavior will vary based on the entitlement cache level specified and whether the user is signed-in or not, or if the user is signed-in but latest entitlements have yet to be retrieved. See documentation about the entitlement cache levels for details.

In the case where there is no cached entitlement data and the latest entitlements have yet to be retrieved, then false will be returned. The Portal will not wait for the entitlements to update before returning a response. This state can be detected when the RetrievedFromCacheLevel is None.

Parameters

Parameter	Description
ItemId	The guid for the catalog item to check the entitled state for
CacheLevel	The level at which to allow referencing cached data

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss