UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FPortalUserProxy Class Reference
+ Inheritance diagram for FPortalUserProxy:

Public Member Functions

virtual ~FPortalUserProxy ()
 
virtual bool IsAvailable () const override
 
virtual TAsyncResult< FPortalUserDetailsGetUserDetails () override
 
virtual TAsyncResult< FPortalUserIsEntitledToItemResultIsEntitledToItem (const FString &ItemId, EEntitlementCacheLevelRequest CacheLevel) override
 
- Public Member Functions inherited from IPortalUser
virtual ~IPortalUser ()
 
- Public Member Functions inherited from IPortalService
virtual ~IPortalService ()
 

Constructor & Destructor Documentation

◆ ~FPortalUserProxy()

virtual FPortalUserProxy::~FPortalUserProxy ( )
inlinevirtual

Member Function Documentation

◆ GetUserDetails()

virtual TAsyncResult< FPortalUserDetails > FPortalUserProxy::GetUserDetails ( )
inlineoverridevirtual

Requests the details of the last or currently signed in user

Implements IPortalUser.

◆ IsAvailable()

virtual bool FPortalUserProxy::IsAvailable ( ) const
inlineoverridevirtual

Implements IPortalService.

◆ IsEntitledToItem()

virtual TAsyncResult< FPortalUserIsEntitledToItemResult > FPortalUserProxy::IsEntitledToItem ( const FString &  ItemId,
EEntitlementCacheLevelRequest  CacheLevel 
)
inlineoverridevirtual

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

Parameters
ItemIdThe guid for the catalog item to check the entitled state for
CacheLevelThe level at which to allow referencing cached data

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.

Implements IPortalUser.


The documentation for this class was generated from the following file: