1. Epic GamesDeveloper
  3. IOnlineEntitlements

IOnlineEntitlements

Interface for retrieving user entitlements

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

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

  Type Name Description
Public variable FOnQueryEntitlementsComplete OnQueryEntitlementsCompleteDelegates Delegate instanced called when enumerating entitlements has completed

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual void  
Public function Virtual void  
Public function void

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

 Gets the cached entitlement set for the requested user
Public function TSharedPtr< FOnlineEntitlement >

GetEntitlement ( const FUniqueNetId& UserId,
const FUniqueEntitlementId& EntitlementId
)

 Checks for and retrieves a single cached entitlement for a user
Public function TSharedPtr< FOnlineEntitlement >

GetItemEntitlement ( const FUniqueNetId& UserId,
const FString& ItemId
)

 Checks for and retrieves a single cached entitlement for a user
Public function 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
Public function Virtual void

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page