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

Light Theme

Dark Theme

IOnlineEntitlements

Interface for retrieving user entitlements

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineEntitlementsInterface.h
Include	#include "Interfaces/OnlineEntitlementsInterface.h"

Syntax

class IOnlineEntitlements

Remarks

Interface for retrieving user entitlements

Variables

		Name	Description
	FOnQueryEntitle...	OnQueryEntitlementsCompleteDelegates	Delegate instanced called when enumerating entitlements has completed

Destructors

	Name	Description
	~IOnlineEntitlements()

Functions

	Name	Description
FDelegateHan...	AddOnQueryEntitlementsCompleteDelegate_Handle ( const FOnQueryEntitlementsCompleteD... )
void	ClearOnQueryEntitlementsCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnQueryEntitlementsCompleteDelegates ( void* Object )
void	GetAllEntitlements ( const FUniqueNetId& UserId, const FString& Namespace, TArray< TSharedRef< FOnlineEntitlem... )	Gets the cached entitlement set for the requested user
TSharedPtr< ...	GetEntitlement ( const FUniqueNetId& UserId, const FUniqueEntitlementId& Entitl... )	Checks for and retrieves a single cached entitlement for a user
TSharedPtr< ...	GetItemEntitlement ( const FUniqueNetId& UserId, const FString& ItemId )	Checks for and retrieves a single cached entitlement for a user
bool	QueryEntitlements ( const FUniqueNetId& UserId, const FString& Namespace, const FPagedQuery& Page )	Contacts server and retrieves the list of the user's entitlements, caching them locally
void	TriggerOnQueryEntitlementsCompleteDelegates ( bool Param1, const FUniqueNetId& Param2, const FString& Param3, const FString& Param4 )

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

Take our survey

Dismiss