Entitlement API for checking user's ownership. User can query a list of item that belongs to him/her. More...

#include <AccelByteEntitlementApi.h>

Inheritance diagram for AccelByte::Api::Entitlement:

Public Member Functions
	Entitlement (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Entitlement (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetCurrentUserEntitlementHistory (THandler< FAccelByteModelsUserEntitlementHistoryPagingResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteEntitlementClass const &EntitlementClass=EAccelByteEntitlementClass::NONE, FDateTime const &StartDate=0, FDateTime const &EndDate=0, int32 Limit=20, int32 Offset=0)
	Get current user entitlements history.
FAccelByteTaskWPtr	QueryUserEntitlements (FString const &EntitlementName, FString const &ItemId, int32 Offset, int32 Limit, THandler< FAccelByteModelsEntitlementPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteEntitlementClass EntitlementClass=EAccelByteEntitlementClass::NONE, EAccelByteAppType AppType=EAccelByteAppType::NONE, TArray< FString > const &Features={})
	Get list of user's Entitlement(s).
FAccelByteTaskWPtr	QueryUserEntitlements (FString const &EntitlementName, TArray< FString > const &ItemIds, int32 Offset, int32 Limit, THandler< FAccelByteModelsEntitlementPagingSlicedResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteEntitlementClass EntitlementClass=EAccelByteEntitlementClass::NONE, EAccelByteAppType AppType=EAccelByteAppType::NONE, TArray< FString > const &Features={})
	Get list of user's Entitlement(s).
FAccelByteTaskWPtr	GetUserEntitlementById (FString const &EntitlementId, THandler< FAccelByteModelsEntitlementInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get user's Entitlement by the EntitlementId.
FAccelByteTaskWPtr	GetUserEntitlementByIds (TArray< FString > const &EntitlementIds, THandler< TArray< FAccelByteModelsEntitlementInfo > > const &OnSuccess, FErrorHandler const &OnError, bool bAvailablePlatformOnly=true)
	Get user's entitlements based on the Entitlement Ids.
FAccelByteTaskWPtr	GetUserEntitlementOwnershipByAppId (FString const &AppId, THandler< FAccelByteModelsEntitlementOwnership > const &OnSuccess, FErrorHandler const &OnError, bool bUsePublisherNamespace=true)
	Get user's Entitlement ownership of the AppId.
FAccelByteTaskWPtr	GetUserEntitlementOwnershipBySku (FString const &Sku, THandler< FAccelByteModelsEntitlementOwnership > const &OnSuccess, FErrorHandler const &OnError, bool bUsePublisherNamespace=true)
	Get user's Entitlement ownership of the sku.
FAccelByteTaskWPtr	GetUserEntitlementOwnershipByItemId (FString const &ItemId, THandler< FAccelByteModelsEntitlementOwnership > const &OnSuccess, FErrorHandler const &OnError, bool bUsePublisherNamespace=false)
	Get user's Entitlement ownership of the ItemId.
FAccelByteTaskWPtr	GetUserEntitlementOwnershipAny (TArray< FString > const &ItemIds, TArray< FString > const &AppIds, TArray< FString > const &Skus, THandler< FAccelByteModelsEntitlementOwnership > const &OnSuccess, FErrorHandler const &OnError, bool bUsePublisherNamespace=true)
	Get user's Entitlement ownership for multiple checks.
FAccelByteTaskWPtr	GetUserEntitlementOwnershipViaToken (FString const &PublicKey, TArray< FString > const &ItemIds, TArray< FString > const &AppIds, TArray< FString > const &Skus, THandler< FAccelByteModelsEntitlementOwnershipDetails > const &OnSuccess, FErrorHandler const &OnError, bool VerifySignature=true, bool VerifyExpiration=true, FString const &VerifySub=TEXT(""), bool bUsePublisherNamespace=true)
	Get user entitlement ownership if any of item IDs, app IDs, or SKUs are true.
FAccelByteTaskWPtr	GetUserEntitlementOwnershipTokenOnly (TArray< FString > const &ItemIds, TArray< FString > const &AppIds, TArray< FString > const &Skus, THandler< FAccelByteModelsOwnershipToken > const &OnSuccess, FErrorHandler const &OnError, bool bUsePublisherNamespace=true)
	Get user entitlement ownership token if any of item IDs, app IDs, or SKUs are true.
FAccelByteTaskWPtr	ConsumeUserEntitlement (FString const &EntitlementId, int32 UseCount, THandler< FAccelByteModelsEntitlementInfo > const &OnSuccess, FErrorHandler const &OnError, TArray< FString > const &Options={}, FString const &RequestId=TEXT(""))
	Consume a use entitlement.
FAccelByteTaskWPtr	CreateDistributionReceiver (FString const &ExtUserId, FAccelByteModelsAttributes const &Attributes, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Create Distribution Receiver.
FAccelByteTaskWPtr	DeleteDistributionReceiver (FString const &ExtUserId, FString const &UserId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete Distribution Receiver.
FAccelByteTaskWPtr	GetDistributionReceiver (FString const &PublisherNamespace, FString const &PublisherUserId, THandler< TArray< FAccelByteModelsDistributionReceiver > > const &OnSuccess, FErrorHandler const &OnError)
	Get Distribution Receiver.
FAccelByteTaskWPtr	UpdateDistributionReceiver (FString const &ExtUserId, FAccelByteModelsAttributes const &Attributes, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Update Distribution Receiver.
FAccelByteTaskWPtr	SyncPlatformPurchase (EAccelBytePlatformSync PlatformType, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Sync entitlement from 3rd party platform purchase.
FAccelByteTaskWPtr	SyncPlatformPurchase (EAccelBytePlatformSync PlatformType, FAccelByteModelsPlayStationDLCSync const &PSSyncModel, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Sync entitlement from 3rd party platform purchase.
FAccelByteTaskWPtr	SyncPlatformPurchase (FAccelByteModelsEntitlementSyncBase const &EntitlementSyncBase, EAccelBytePlatformSync PlatformType, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Sync entitlement from 3rd party platform purchase.
FAccelByteTaskWPtr	SyncMobilePlatformPurchaseGoogle (FAccelByteModelsPlatformSyncMobileGoogle const &SyncRequest, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Sync (Verify and fulfil) item entitlement from Google Play platform purchase.
FAccelByteTaskWPtr	SyncMobilePlatformPurchaseGooglePlay (FAccelByteModelsPlatformSyncMobileGoogle const &SyncRequest, THandler< FAccelByteModelsPlatformSyncMobileGoogleResponse > const &OnSuccess, FErrorHandler const &OnError)
	Sync (Verify and fulfil) item entitlement from Google Play item platform purchase.
FAccelByteTaskWPtr	SyncMobilePlatformPurchaseApple (FAccelByteModelsPlatformSyncMobileApple const &SyncRequest, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Sync (Verify and fulfil) item entitlement from Apple Store platform purchase.
FAccelByteTaskWPtr	SyncXBoxDLC (FAccelByteModelsXBoxDLCSync const &XboxDLCSync, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Xbox inventory's DLC items.
FAccelByteTaskWPtr	SyncSteamDLC (FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Steam DLC.
FAccelByteTaskWPtr	SyncPSNDLC (FAccelByteModelsPlayStationDLCSync const &PSSyncModel, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize with DLC entitlements in PSN Store.
FAccelByteTaskWPtr	SyncTwitchDropEntitlement (FAccelByteModelsTwitchDropEntitlement const &TwitchDropModel, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Twitch drop entitlement.
FAccelByteTaskWPtr	SyncEpicGameDurableItems (FString const &EpicGamesJwtToken, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Epic Game Durable/dlc Items.
FAccelByteTaskWPtr	ValidateUserItemPurchaseCondition (TArray< FString > const &Items, THandler< TArray< FAccelByteModelsPlatformValidateUserItemPurchaseResponse > > const &OnSuccess, FErrorHandler const &OnError)
	Validate user item purchase condition.
FAccelByteTaskWPtr	GetUserEntitlementOwnershipByItemIds (TArray< FString > const &Ids, THandler< TArray< FAccelByteModelsEntitlementOwnershipItemIds > > const &OnSuccess, FErrorHandler const &OnError)
	Get user entitlement ownership by itemIds.
FAccelByteTaskWPtr	SyncWithDLCEntitlementInPSNStore (FAccelByteModelsPlayStationDLCSync const &PlaystationModel, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize with DLC entitlements in PSN Store.
FAccelByteTaskWPtr	SyncWithEntitlementInPSNStore (FAccelByteModelsPlayStationIAPSync const &PlaystationModel, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize with entitlements in PSN Store.
FAccelByteTaskWPtr	SellUserEntitlement (FString const &EntitlementId, int32 UseCount, FString const &RequestId, THandler< FAccelByteModelsSellItemEntitlementInfo > const &OnSuccess, FErrorHandler const &OnError)
	Sell user entitlement.
FAccelByteTaskWPtr	SyncOculusConsumableEntitlements (THandler< TArray< FAccelByteModelsSyncOculusConsumableEntitlementInfo > > const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Oculus Consumable Entitlement/IAP.
FAccelByteTaskWPtr	SyncOculusDLC (FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Oculus Downloadable Content/DLC.
FAccelByteTaskWPtr	SyncOculusSubscription (FAccelByteModelsSyncOculusSubscriptionRequest const &SyncRequest, THandler< TArray< FAccelByteModelsThirdPartySubscriptionTransactionInfo > > const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Oculus Subscription.
FAccelByteTaskWPtr	SyncDLCPSNMultipleService (FAccelByteModelsMultipleServicePSNDLCSync const &PlaystationModel, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize with DLC entitlements in PSN Store with multiple service labels.
FAccelByteTaskWPtr	SyncEntitlementPSNMultipleService (FAccelByteModelsMultipleServicePSNIAPSync const &PlaystationModel, THandler< TArray< FAccelByteModelsMultipleServicePlayStationInfo > > const &OnSuccess, FErrorHandler const &OnError)
	Synchronize with IAP entitlements in PSN Store with multiple service labels.
FAccelByteTaskWPtr	QueryUserSubcriptions (EAccelBytePlatformSync PlatformType, FAccelByteModelsThirdPartyUserSubscriptionQueryRequest const &Request, THandler< FAccelByteModelsThirdPartyUserSubscriptions > const &OnSuccess, FErrorHandler const &OnError)
	Query Platform's subscription items.
FAccelByteTaskWPtr	SyncSteamIAPTransaction (FAccelByteModelsSyncSteamIAPTransactionRequest const &Request, THandler< FAccelByteModelsSyncSteamIAPTransactionResponse > const &OnSuccess, FErrorHandler const &OnError)
	Synchronize Steam IAP using a specific order ID. Only to be used when Steam sync mode is set to TRANSACTION in the admin portal.
FAccelByteTaskWPtr	SyncSteamAbnormalIAPTransaction (FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Synchronize abornal Steam IAP purchases. Such as when a user purchases an item from Steam, but has not yet linked an AGS account. Only to be used when Steam sync mode is set to TRANSACTION in the admin portal.
Public Member Functions inherited from AccelByte::FApiBase
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Additional Inherited Members
Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool	ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe >	CredentialsRef
Settings const &	SettingsRef
FHttpRetrySchedulerBase &	HttpRef
FHttpClient	HttpClient
FAccelBytePlatformPtr	AccelBytePlatformPtr

Detailed Description

Entitlement API for checking user's ownership. User can query a list of item that belongs to him/her.

Member Function Documentation

◆ ConsumeUserEntitlement()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::ConsumeUserEntitlement	(	FString const &	EntitlementId,
		int32	UseCount,
		THandler< FAccelByteModelsEntitlementInfo > const &	OnSuccess,
		FErrorHandler const &	OnError,
		TArray< FString > const &	Options = {},
		FString const &	RequestId = TEXT("") )

Consume a use entitlement.

Parameters

EntitlementId	The id of the entitlement.
UseCount	Number of consumed entitlement.
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementInfo.
OnError	This will be called when the operation failed.
Options	Options of consumed entitlements.
RequestId	Request id(Optional), A unique tracking ID provided by the developer, can just left it empty if they don't want to track When a request id is submitted, it will return original successful response

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateDistributionReceiver()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::CreateDistributionReceiver	(	FString const &	ExtUserId,
		FAccelByteModelsAttributes const &	Attributes,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Create Distribution Receiver.

Parameters

ExtUserId	The external user id is a random string that can be generated by yourself for the receiver.
Attributes	That contain of ServerId, ServerName, CharacterId, and CharacterName.
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteDistributionReceiver()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::DeleteDistributionReceiver	(	FString const &	ExtUserId,
		FString const &	UserId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete Distribution Receiver.

Parameters

ExtUserId	The external user id that want to be deleted in receiver.
UserId	The user id from the game.
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetCurrentUserEntitlementHistory()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetCurrentUserEntitlementHistory	(	THandler< FAccelByteModelsUserEntitlementHistoryPagingResult > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteEntitlementClass const &	EntitlementClass = EAccelByteEntitlementClass::NONE,
		FDateTime const &	StartDate = 0,
		FDateTime const &	EndDate = 0,
		int32	Limit = 20,
		int32	Offset = 0 )

Get current user entitlements history.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is const FAccelByteModelsUserEntitlementHistoryPagingResult&.
OnError	This will be called when the operation fails.
EntitlementClass	Class of the entitlement (optional).
StartDate	Defines the preferred starting date or time to query user entitlement history (optional).
EndDate	Defines the preferred ending date or time to query user entitlement history (optional).
Limit	Number of content per page to retrieve. Default value : 20
Offset	Number of page to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetDistributionReceiver()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetDistributionReceiver	(	FString const &	PublisherNamespace,
		FString const &	PublisherUserId,
		THandler< TArray< FAccelByteModelsDistributionReceiver > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get Distribution Receiver.

Parameters

PublisherNamespace	The namespace of the publisher or namespace of the game.
PublisherUserId	The user id from the publisher or user id from the game.
OnSuccess	This will be called when the operation success. The result is const TArray<FAccelByteModelsDistributionReceiver>.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementById()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementById	(	FString const &	EntitlementId,
		THandler< FAccelByteModelsEntitlementInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's Entitlement by the EntitlementId.

Parameters

EntitlementId	The id of the entitlement.
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementByIds()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementByIds	(	TArray< FString > const &	EntitlementIds,
		THandler< TArray< FAccelByteModelsEntitlementInfo > > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bAvailablePlatformOnly = true )

Get user's entitlements based on the Entitlement Ids.

Parameters

EntitlementIds	The IDs of the entitlements to retrieve.
OnSuccess	Callback invoked when the operation succeeds. The result is const TArray<FAccelByteModelsEntitlementInfo>.
OnError	Callback invoked when the operation fails.
bAvailablePlatformOnly	If true, only checks for available platform entitlements; defaults to true.

Note

This operation depends on the entitlement origin feature being enabled by the admin.
If bAvailablePlatformOnly is true, the backend returns entitlements specific to the current user's IAM client platform.
If bAvailablePlatformOnly is false, the backend returns all entitlements, regardless of platform availability.

Returns: An AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementOwnershipAny()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementOwnershipAny	(	TArray< FString > const &	ItemIds,
		TArray< FString > const &	AppIds,
		TArray< FString > const &	Skus,
		THandler< FAccelByteModelsEntitlementOwnership > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bUsePublisherNamespace = true )

Get user's Entitlement ownership for multiple checks.

Parameters

ItemIds	The item's IDs to check.
AppIds	the app IDs to check.
Skus	the skus to check
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementOwnership will return true if any one parameters are owned.
OnError	This will be called when the operation failed.
bUsePublisherNamespace	check user entitlement in publisher namespace, by default is true.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementOwnershipByAppId()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementOwnershipByAppId	(	FString const &	AppId,
		THandler< FAccelByteModelsEntitlementOwnership > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bUsePublisherNamespace = true )

Get user's Entitlement ownership of the AppId.

Parameters

AppId	The App ID.
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementOwnership.
OnError	This will be called when the operation failed.
bUsePublisherNamespace	check user entitlement in publisher namespace, by default is true.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementOwnershipByItemId()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementOwnershipByItemId	(	FString const &	ItemId,
		THandler< FAccelByteModelsEntitlementOwnership > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bUsePublisherNamespace = false )

Get user's Entitlement ownership of the ItemId.

Parameters

ItemId	The item's ItemId.
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementOwnership.
OnError	This will be called when the operation failed.
bUsePublisherNamespace	check user entitlement in publisher namespace, by default is false (to preserve the previous behaviour).

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementOwnershipByItemIds()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementOwnershipByItemIds	(	TArray< FString > const &	Ids,
		THandler< TArray< FAccelByteModelsEntitlementOwnershipItemIds > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user entitlement ownership by itemIds.

Parameters

Ids	ItemsIds.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementOwnershipBySku()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementOwnershipBySku	(	FString const &	Sku,
		THandler< FAccelByteModelsEntitlementOwnership > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bUsePublisherNamespace = true )

Get user's Entitlement ownership of the sku.

Parameters

Sku	The item's SKU.
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementOwnership.
OnError	This will be called when the operation failed.
bUsePublisherNamespace	check user entitlement in publisher namespace, by default is true.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementOwnershipTokenOnly()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementOwnershipTokenOnly	(	TArray< FString > const &	ItemIds,
		TArray< FString > const &	AppIds,
		TArray< FString > const &	Skus,
		THandler< FAccelByteModelsOwnershipToken > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bUsePublisherNamespace = true )

Get user entitlement ownership token if any of item IDs, app IDs, or SKUs are true.

Parameters

ItemIds	The item's IDs to check.
AppIds	the app IDs to check.
Skus	the skus to check
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsOwnershipToken.
OnError	This will be called when the operation failed.
bUsePublisherNamespace	check user entitlement in publisher namespace, by default is true.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserEntitlementOwnershipViaToken()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::GetUserEntitlementOwnershipViaToken	(	FString const &	PublicKey,
		TArray< FString > const &	ItemIds,
		TArray< FString > const &	AppIds,
		TArray< FString > const &	Skus,
		THandler< FAccelByteModelsEntitlementOwnershipDetails > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	VerifySignature = true,
		bool	VerifyExpiration = true,
		FString const &	VerifySub = TEXT(""),
		bool	bUsePublisherNamespace = true )

Get user entitlement ownership if any of item IDs, app IDs, or SKUs are true.

Parameters

PublicKey	The Public Key that will be used to verify token
ItemIds	The item's IDs to check.
AppIds	the app IDs to check.
Skus	the skus to check
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsOwnershipToken.
OnError	This will be called when the operation failed.
VerifySignature	Optional param, if true will verify the token's signature.
VerifyExpiration	Optional param, if true will verify the token's expiration.
VerifySub	Optional param, verify the token's sub field content.
bUsePublisherNamespace	check user entitlement in publisher namespace, by default is true.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ QueryUserEntitlements() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Entitlement::QueryUserEntitlements	(	FString const &	EntitlementName,
		FString const &	ItemId,
		int32	Offset,
		int32	Limit,
		THandler< FAccelByteModelsEntitlementPagingSlicedResult > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteEntitlementClass	EntitlementClass = EAccelByteEntitlementClass::NONE,
		EAccelByteAppType	AppType = EAccelByteAppType::NONE,
		TArray< FString > const &	Features = {} )

Get list of user's Entitlement(s).

Parameters

EntitlementName	The name of the entitlement (optional).
ItemId	Item's id (optional).
Offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0).
Limit	The limit of item on page (optional).
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementPagingSlicedResult.
OnError	This will be called when the operation failed.
EntitlementClass	Class of the entitlement (optional).
AppType	This is the type of application that entitled (optional).

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ QueryUserEntitlements() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Entitlement::QueryUserEntitlements	(	FString const &	EntitlementName,
		TArray< FString > const &	ItemIds,
		int32	Offset,
		int32	Limit,
		THandler< FAccelByteModelsEntitlementPagingSlicedResult > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteEntitlementClass	EntitlementClass = EAccelByteEntitlementClass::NONE,
		EAccelByteAppType	AppType = EAccelByteAppType::NONE,
		TArray< FString > const &	Features = {} )

Get list of user's Entitlement(s).

Parameters

EntitlementName	The name of the entitlement (optional).
ItemIds	Item's id (optional).
Offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0).
Limit	The limit of item on page (optional).
OnSuccess	This will be called when the operation success. The result is const FAccelByteModelsEntitlementPagingSlicedResult.
OnError	This will be called when the operation failed.
EntitlementClass	Class of the entitlement (optional).
AppType	This is the type of application that entitled (optional).
Features	The feature array.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ QueryUserSubcriptions()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::QueryUserSubcriptions	(	EAccelBytePlatformSync	PlatformType,
		FAccelByteModelsThirdPartyUserSubscriptionQueryRequest const &	Request,
		THandler< FAccelByteModelsThirdPartyUserSubscriptions > const &	OnSuccess,
		FErrorHandler const &	OnError )

Query Platform's subscription items.

Parameters

PlatformType	The platform type identifier for subscription query
Request	Query parameters for the request
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SellUserEntitlement()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SellUserEntitlement	(	FString const &	EntitlementId,
		int32	UseCount,
		FString const &	RequestId,
		THandler< FAccelByteModelsSellItemEntitlementInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Sell user entitlement.

Parameters

EntitlementId	The id of the entitlement.
UseCount	The count be consumed.
RequestId	The id of the request.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncDLCPSNMultipleService()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncDLCPSNMultipleService	(	FAccelByteModelsMultipleServicePSNDLCSync const &	PlaystationModel,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize with DLC entitlements in PSN Store with multiple service labels.

Parameters

PlaystationModel	Contains ServiceLabel needed for PlayStation DLC Multiple Service sync.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncEntitlementPSNMultipleService()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncEntitlementPSNMultipleService	(	FAccelByteModelsMultipleServicePSNIAPSync const &	PlaystationModel,
		THandler< TArray< FAccelByteModelsMultipleServicePlayStationInfo > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize with IAP entitlements in PSN Store with multiple service labels.

Parameters

PlaystationModel	Contains ServiceLabel needed for PlayStation IAP Multiple Service sync.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncEpicGameDurableItems()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncEpicGameDurableItems	(	FString const &	EpicGamesJwtToken,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Epic Game Durable/dlc Items.

Parameters

EpicGamesJwtToken	Epic game Jwt token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncMobilePlatformPurchaseApple()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncMobilePlatformPurchaseApple	(	FAccelByteModelsPlatformSyncMobileApple const &	SyncRequest,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Sync (Verify and fulfil) item entitlement from Apple Store platform purchase.

Parameters

SyncRequest	That contain of ProductId, TransactionId, ReceiptData, and ExcludeOldTransactions to verify and sync item user bought from Apple Store.
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncMobilePlatformPurchaseGoogle()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncMobilePlatformPurchaseGoogle	(	FAccelByteModelsPlatformSyncMobileGoogle const &	SyncRequest,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Sync (Verify and fulfil) item entitlement from Google Play platform purchase.

Parameters

SyncRequest	That contain of OrderId, PackageName, ProductId, PurchaseTime, and PurchaseToken to verify and sync item user bought from Google Play.
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncMobilePlatformPurchaseGooglePlay()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncMobilePlatformPurchaseGooglePlay	(	FAccelByteModelsPlatformSyncMobileGoogle const &	SyncRequest,
		THandler< FAccelByteModelsPlatformSyncMobileGoogleResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Sync (Verify and fulfil) item entitlement from Google Play item platform purchase.

Parameters

SyncRequest	That contain of OrderId, PackageName, ProductId, PurchaseTime, and PurchaseToken to verify and sync item user bought from Google Play.
OnSuccess	This will be called when the operation success. The result is boolean with true value.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncOculusConsumableEntitlements()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncOculusConsumableEntitlements	(	THandler< TArray< FAccelByteModelsSyncOculusConsumableEntitlementInfo > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Oculus Consumable Entitlement/IAP.

Parameters

OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncOculusDLC()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncOculusDLC	(	FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Oculus Downloadable Content/DLC.

Parameters

OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncOculusSubscription()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncOculusSubscription	(	FAccelByteModelsSyncOculusSubscriptionRequest const &	SyncRequest,
		THandler< TArray< FAccelByteModelsThirdPartySubscriptionTransactionInfo > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Oculus Subscription.

Parameters

FAccelByteModelsSyncOculusSubscriptionRequest	This is the request to specify the sync
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncPlatformPurchase() [1/3]

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncPlatformPurchase	(	EAccelBytePlatformSync	PlatformType,
		FAccelByteModelsPlayStationDLCSync const &	PSSyncModel,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Sync entitlement from 3rd party platform purchase.

Parameters

PlatformType	The platform type identifier for sync entitlement.
PSSyncModel	Contains ServiceLabel needed for PlayStation DLC sync
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncPlatformPurchase() [2/3]

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncPlatformPurchase	(	EAccelBytePlatformSync	PlatformType,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Sync entitlement from 3rd party platform purchase.

Parameters

PlatformType	The platform type identifier for sync entitlement.
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncPlatformPurchase() [3/3]

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncPlatformPurchase	(	FAccelByteModelsEntitlementSyncBase const &	EntitlementSyncBase,
		EAccelBytePlatformSync	PlatformType,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Sync entitlement from 3rd party platform purchase.

Parameters

EntitlementSyncBase	Base information needed by some platforms.
PlatformType	The platform type identifier for sync entitlement.
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncPSNDLC()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncPSNDLC	(	FAccelByteModelsPlayStationDLCSync const &	PSSyncModel,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize with DLC entitlements in PSN Store.

Parameters

PSSyncModel	Contains ServiceLabel needed for PlayStation DLC sync
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncSteamAbnormalIAPTransaction()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncSteamAbnormalIAPTransaction	(	FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize abornal Steam IAP purchases. Such as when a user purchases an item from Steam, but has not yet linked an AGS account. Only to be used when Steam sync mode is set to TRANSACTION in the admin portal.

Parameters

OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncSteamDLC()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncSteamDLC	(	FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Steam DLC.

Parameters

OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncSteamIAPTransaction()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncSteamIAPTransaction	(	FAccelByteModelsSyncSteamIAPTransactionRequest const &	Request,
		THandler< FAccelByteModelsSyncSteamIAPTransactionResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Steam IAP using a specific order ID. Only to be used when Steam sync mode is set to TRANSACTION in the admin portal.

Parameters

Request	Data to attach to this request, such as Steam order ID
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncTwitchDropEntitlement()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncTwitchDropEntitlement	(	FAccelByteModelsTwitchDropEntitlement const &	TwitchDropModel,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Twitch drop entitlement.

Parameters

TwitchDropModel	Contains GameId, Region, and Language.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncWithDLCEntitlementInPSNStore()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncWithDLCEntitlementInPSNStore	(	FAccelByteModelsPlayStationDLCSync const &	PlaystationModel,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize with DLC entitlements in PSN Store.

Parameters

PlaystationModel	Playstation's DLC Model Sync Request
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncWithEntitlementInPSNStore()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncWithEntitlementInPSNStore	(	FAccelByteModelsPlayStationIAPSync const &	PlaystationModel,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize with entitlements in PSN Store.

Parameters

PlaystationModel	Playstation's IAP Model Sync Request
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SyncXBoxDLC()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::SyncXBoxDLC	(	FAccelByteModelsXBoxDLCSync const &	XboxDLCSync,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Synchronize Xbox inventory's DLC items.

Parameters

XboxDLCSync	Contains XSTSToken needed for Xbox DLC sync
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateDistributionReceiver()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::UpdateDistributionReceiver	(	FString const &	ExtUserId,
		FAccelByteModelsAttributes const &	Attributes,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Update Distribution Receiver.

Parameters

ExtUserId	The external user id that has been created before for receiver.
Attributes	That contain of ServerId, ServerName, CharacterId, and CharacterName.
OnSuccess	This will be called when the operation success.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ValidateUserItemPurchaseCondition()

FAccelByteTaskWPtr AccelByte::Api::Entitlement::ValidateUserItemPurchaseCondition	(	TArray< FString > const &	Items,
		THandler< TArray< FAccelByteModelsPlatformValidateUserItemPurchaseResponse > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Validate user item purchase condition.

Parameters

Items	Items to be validated.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ConsumeUserEntitlement()

◆ CreateDistributionReceiver()

◆ DeleteDistributionReceiver()

◆ GetCurrentUserEntitlementHistory()

◆ GetDistributionReceiver()

◆ GetUserEntitlementById()

◆ GetUserEntitlementByIds()

◆ GetUserEntitlementOwnershipAny()

◆ GetUserEntitlementOwnershipByAppId()

◆ GetUserEntitlementOwnershipByItemId()

◆ GetUserEntitlementOwnershipByItemIds()

◆ GetUserEntitlementOwnershipBySku()

◆ GetUserEntitlementOwnershipTokenOnly()

◆ GetUserEntitlementOwnershipViaToken()

◆ QueryUserEntitlements() [1/2]

◆ QueryUserEntitlements() [2/2]

◆ QueryUserSubcriptions()

◆ SellUserEntitlement()

◆ SyncDLCPSNMultipleService()

◆ SyncEntitlementPSNMultipleService()

◆ SyncEpicGameDurableItems()

◆ SyncMobilePlatformPurchaseApple()

◆ SyncMobilePlatformPurchaseGoogle()

◆ SyncMobilePlatformPurchaseGooglePlay()

◆ SyncOculusConsumableEntitlements()

◆ SyncOculusDLC()

◆ SyncOculusSubscription()

◆ SyncPlatformPurchase() [1/3]

◆ SyncPlatformPurchase() [2/3]

◆ SyncPlatformPurchase() [3/3]

◆ SyncPSNDLC()

◆ SyncSteamAbnormalIAPTransaction()

◆ SyncSteamDLC()

◆ SyncSteamIAPTransaction()

◆ SyncTwitchDropEntitlement()

◆ SyncWithDLCEntitlementInPSNStore()

◆ SyncWithEntitlementInPSNStore()

◆ SyncXBoxDLC()

◆ UpdateDistributionReceiver()

◆ ValidateUserItemPurchaseCondition()