Entitlements

Detailed Description

Inspect a player's purchase history and individual transaction statuses.

An entitlement records that a player has access rights to an item rather than outright ownership. Use this group to list all purchases, check the status of in-flight transactions, and display a transaction history — a requirement imposed by some First Party platforms.

See the LootLocker documentation.

Typedef Documentation

FLootLockerListEntitlementsResponseDelegate

typedef void(* FLootLockerListEntitlementsResponseDelegate) (FLootLockerEntitlementHistoryResponse)

C++ response delegate for listing entitlement history.

FLootLockerSingleEntitlementResponseDelegate

typedef void(* FLootLockerSingleEntitlementResponseDelegate) (FLootLockerSingleEntitlementResponse)

C++ response callback delegate; receives an FLootLockerSingleEntitlementResponse result.

Enumeration Type Documentation

ELootLockerEntitlementHistoryListingStatus

enum class ELootLockerEntitlementHistoryListingStatus : uint8

strong

Status of the entitlement.

Enumerator
None
Active
Pending
Expired
Canceled
Refunded

ELootLockerEntitlementHistoryListingStore

enum class ELootLockerEntitlementHistoryListingStore : uint8

strong

An enum with the supported stores that can generate entitlements.

Enumerator
None
Apple_app_store
Google_play_store
Steam_store
Playstation_network
Nintendo_eshop
Lootlocker

ELootLockerEntitlementHistoryListingType

enum class ELootLockerEntitlementHistoryListingType : uint8

strong

Status of the entitlement.

Enumerator
Undefined
One_time_purchase
Leaderboard_reward
Subscription

ELootLockerEntitlementRewardEntityKind

enum class ELootLockerEntitlementRewardEntityKind : uint8

strong

Possible entity kinds that rewards entries can have.

Enumerator
Asset
Currency
Progression_Points
Progression_Reset
Group

Function Documentation

GetEntitlement()

static FString ULootLockerSDKManager::GetEntitlement ( const FString &  EntitlementID, FLootLockerSingleEntitlementResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

Get entitlement details.

Parameters

EntitlementID	Entitlement id
OnComplete	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListEntitlements() [1/2]

static FString ULootLockerSDKManager::ListEntitlements ( const FLootLockerListEntitlementsResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

inlinestatic

List player's historical entitlements (default pagination).

Parameters

OnComplete	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListEntitlements() [2/2]

static FString ULootLockerSDKManager::ListEntitlements ( int  Count, const FString &  After, const FLootLockerListEntitlementsResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List player's historical entitlements (paginated, all origins: progression, purchases, rewards).

Parameters

Count	Optional: Entries to return (-1 for default)
After	Optional: Pagination cursor (empty for start)
OnComplete	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

Typedefs
typedef void(*	FLootLockerListEntitlementsResponseDelegate) (FLootLockerEntitlementHistoryResponse)
	C++ response delegate for listing entitlement history.
typedef void(*	FLootLockerSingleEntitlementResponseDelegate) (FLootLockerSingleEntitlementResponse)
	C++ response callback delegate; receives an FLootLockerSingleEntitlementResponse result.

Enumerations
enum class	ELootLockerEntitlementHistoryListingStore : uint8 {   ELootLockerEntitlementHistoryListingStore::None = 0 , ELootLockerEntitlementHistoryListingStore::Apple_app_store = 1 , ELootLockerEntitlementHistoryListingStore::Google_play_store = 2 , ELootLockerEntitlementHistoryListingStore::Steam_store = 3 ,   ELootLockerEntitlementHistoryListingStore::Playstation_network = 4 , ELootLockerEntitlementHistoryListingStore::Nintendo_eshop = 5 , ELootLockerEntitlementHistoryListingStore::Lootlocker = 6 }
	An enum with the supported stores that can generate entitlements. More...
enum class	ELootLockerEntitlementHistoryListingStatus : uint8 {   ELootLockerEntitlementHistoryListingStatus::None = 0 , ELootLockerEntitlementHistoryListingStatus::Active = 1 , ELootLockerEntitlementHistoryListingStatus::Pending = 2 , ELootLockerEntitlementHistoryListingStatus::Expired = 3 ,   ELootLockerEntitlementHistoryListingStatus::Canceled = 4 , ELootLockerEntitlementHistoryListingStatus::Refunded = 5 }
	Status of the entitlement. More...
enum class	ELootLockerEntitlementHistoryListingType : uint8 { ELootLockerEntitlementHistoryListingType::Undefined = 0 , ELootLockerEntitlementHistoryListingType::One_time_purchase = 1 , ELootLockerEntitlementHistoryListingType::Leaderboard_reward = 2 , ELootLockerEntitlementHistoryListingType::Subscription = 3 }
	Status of the entitlement. More...
enum class	ELootLockerEntitlementRewardEntityKind : uint8 {   ELootLockerEntitlementRewardEntityKind::Asset = 0 , ELootLockerEntitlementRewardEntityKind::Currency = 1 , ELootLockerEntitlementRewardEntityKind::Progression_Points = 2 , ELootLockerEntitlementRewardEntityKind::Progression_Reset = 3 ,   ELootLockerEntitlementRewardEntityKind::Group = 4 }
	Possible entity kinds that rewards entries can have. More...

Functions
static FString	ULootLockerSDKManager::ListEntitlements (int Count, const FString &After, const FLootLockerListEntitlementsResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List player's historical entitlements (paginated, all origins: progression, purchases, rewards).
static FString	ULootLockerSDKManager::ListEntitlements (const FLootLockerListEntitlementsResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List player's historical entitlements (default pagination).
static FString	ULootLockerSDKManager::GetEntitlement (const FString &EntitlementID, FLootLockerSingleEntitlementResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	Get entitlement details.