#include <IPortalUser.h>

Inheritance diagram for IPortalUser:

Public Member Functions
virtual TAsyncResult< FPortalUserDetails >	GetUserDetails ()=0

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

virtual	~IPortalUser ()

Public Member Functions inherited from IPortalService
virtual	~IPortalService ()

virtual bool	IsAvailable () const =0

Detailed Description

Interface for the Portal application's user services. Specializes in readonly requests for information about the last or currently signed-in user.

Constructor & Destructor Documentation

◆ ~IPortalUser()

virtual IPortalUser::~IPortalUser ( )

inlinevirtual

Member Function Documentation

◆ GetUserDetails()

virtual TAsyncResult< FPortalUserDetails > IPortalUser::GetUserDetails ( )

pure virtual

Requests the details of the last or currently signed in user

Implemented in FPortalUserProxy.

◆ IsEntitledToItem()

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

pure virtual

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

Parameters

ItemId	The guid for the catalog item to check the entitled state for
CacheLevel	The 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.