1. Epic GamesDeveloper
  3. IOnlineEntitlements

IOnlineEntitlements

Interface for retrieving user entitlements

API > API/Plugins > API/Plugins/OnlineSubsystem

Interface for retrieving user entitlements

   
Name IOnlineEntitlements
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineEntitlementsInterface.h
Include Path #include "Interfaces/OnlineEntitlementsInterface.h"

Syntax

class IOnlineEntitlements

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineEntitlements()

   Interfaces/OnlineEntitlementsInterface.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnQueryEntitlementsCompleteDelegates FOnQueryEntitlementsComplete Delegate instanced called when enumerating entitlements has completed Interfaces/OnlineEntitlementsInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FDelegateHandle AddOnQueryEntitlementsCompleteDelegate_Handle ( const FOnQueryEntitlementsCompleteDelegate& Delegate
)

   Interfaces/OnlineEntitlementsInterface.h  

virtual void ClearOnQueryEntitlementsCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineEntitlementsInterface.h  

virtual void ClearOnQueryEntitlementsCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineEntitlementsInterface.h  

void GetAllEntitlements ( const FUniqueNetId& UserId,
const FString& Namespace,
TArray< TSharedRef< FOnlineEntitlement > >& OutUserEntitlements
)

 Gets the cached entitlement set for the requested user Interfaces/OnlineEntitlementsInterface.h  

TSharedPtr< FOnlineEntitlement > GetEntitlement ( const FUniqueNetId& UserId,
const FUniqueEntitlementId& EntitlementId
)

 Checks for and retrieves a single cached entitlement for a user Interfaces/OnlineEntitlementsInterface.h  

TSharedPtr< FOnlineEntitlement > GetItemEntitlement ( const FUniqueNetId& UserId,
const FString& ItemId
)

 Checks for and retrieves a single cached entitlement for a user Interfaces/OnlineEntitlementsInterface.h  

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 Interfaces/OnlineEntitlementsInterface.h  

virtual void TriggerOnQueryEntitlementsCompleteDelegates ( bool Param1,
const FUniqueNetId& Param2,
const FString& Param3,
const FString& Param4
)

   Interfaces/OnlineEntitlementsInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page