Provide information of entitlements owned by the user. More...

Inheritance diagram for AccelByte.Api.Entitlement:

Public Member Functions
void	QueryUserEntitlements (string entitlementName=null, string itemId=null, int offset=0, int limit=20, ResultCallback< EntitlementPagingSlicedResult > callback=null, EntitlementClazz entitlementClazz=EntitlementClazz.NONE, EntitlementAppType entitlementAppType=EntitlementAppType.NONE, string[] features=null)
	Query user entitlements.
void	QueryUserEntitlements (QueryUserEntitlementsOptionalParameters optionalParameters, ResultCallback< EntitlementPagingSlicedResult > callback)
	Query user entitlements.
void	QueryUserEntitlements (string targetUserId, ResultCallback< EntitlementPagingSlicedResult > callback)
	Query user entitlements.
void	QueryUserEntitlements (string targetUserId, QueryUserEntitlementsOptionalParameters optionalParameters, ResultCallback< EntitlementPagingSlicedResult > callback)
	Query user entitlements.
void	QueryUserSubscription (PlatformStoreId platformStoreId, string userId, ResultCallback< SubscriptionPagingSlicedResult > callback)
	Query other user's thirdparty subscription.
void	QueryUserSubscription (PlatformStoreId platformStoreId, string userId, QueryUserSubscriptionRequestOptionalParameters optionalParameters, ResultCallback< SubscriptionPagingSlicedResult > callback)
	Query other user's thirdparty subscription.
void	GetUserEntitlementById (string entitlementId, ResultCallback< EntitlementInfo > callback)
	Get user's entitlement by the entitlementId.
void	GetUserEntitlementOwnershipByAppId (string appId, ResultCallback< Ownership > callback)
	Get user entitlement ownership by app id.
void	GetUserEntitlementOwnershipBySku (string sku, ResultCallback< Ownership > callback)
	Get user entitlement ownership by SKU.
void	GetUserEntitlementOwnershipByItemId (string ItemId, ResultCallback< Ownership > callback)
	Get user entitlement ownership by ItemId.
void	GetUserEntitlementOwnershipAny (string[] itemIds, string[] appIds, string[] skus, ResultCallback< Ownership > callback)
	Get user entitlement ownership if any of item IDs, app IDs, or SKUs are true.
void	GetUserEntitlementOwnershipToken (string key, string[] itemIds, string[] appIds, string[] skus, ResultCallback< OwnershipEntitlement[]> callback, bool verifyPublicKey=true, bool verifyExpiration=true, bool verifyUserId=true)
	Get user entitlement ownership if any of item IDs, app IDs, or SKUs are true.
void	GetUserEntitlementOwnershipTokenOnly (string[] itemIds, string[] appIds, string[] skus, ResultCallback< OwnershipToken > callback)
	Get user entitlement ownership token if any of item IDs, app IDs, or SKUs are true.
void	ConsumeUserEntitlement (string entitlementId, int useCount, ResultCallback< EntitlementInfo > callback, string[] options=null, string requestId=null)
	Consume a user entitlement.
void	GetUserEntitlementHistory (string userId, ResultCallback< UserEntitlementHistoryResponse > callback)
	Get target user's entitlement history.
void	GetUserEntitlementHistory (string userId, GetUserEntitlementHistoryOptionalParams optionalParams, ResultCallback< UserEntitlementHistoryResponse > callback)
	Get target user's entitlement history.
void	CreateDistributionReceiver (string extUserId, Attributes attributes, ResultCallback callback)
	Create distribution receiver for current user.
void	DeleteDistributionReceiver (string extUserId, ResultCallback callback)
	Delete distribution receiver from user.
void	GetDistributionReceiver (string publisherNamespace, string publisherUserId, ResultCallback< DistributionReceiver[]> callback)
	Get distribution receiver from user You can target Publisher Namespace and Publisher UserId or Game Namespace and Game UserId.
void	UpdateDistributionReceiver (string extUserId, Attributes attributes, ResultCallback callback)
	Update distribution receiver for current user.
void	SyncMobilePlatformPurchaseApple (string productId, string transactionId, string receiptData, ResultCallback callback)
	Sync (Verify and fulfil) item entitlement from Apple Store platform purchase.
void	SyncMobilePlatformPurchaseApple (string productId, string transactionId, string receiptData, PlatformSyncMobileAppleOptionalParam optionalParameters, ResultCallback callback)
	Sync (Verify and fulfil) item entitlement from Apple Store platform purchase.
void	SyncMobilePlatformSubscriptionApple (string transactionId, ResultCallback callback)
	Sync (Verify and fulfil) subscription item entitlement from Apple Store platform purchase.
void	SyncMobilePlatformPurchaseGoogle (string orderId, string packageName, string productId, long purchaseTime, string purchaseToken, bool autoAck, ResultCallback< GoogleReceiptResolveResult > callback)
	Sync (Verify and fulfil) item entitlement from Google Play platform purchase.
void	SyncMobilePlatformPurchaseGoogle (string orderId, string packageName, string productId, long purchaseTime, string purchaseToken, bool autoAck, PlatformSyncMobileGoogleOptionalParameters optionalParameters, ResultCallback< GoogleReceiptResolveResult > callback)
	Sync (Verify and fulfil) item entitlement from Google Play platform purchase.
void	SyncMobilePlatformSubscriptionGoogle (string orderId, string packageName, string productId, long purchaseTime, string purchaseToken, bool autoAck, ResultCallback< GoogleReceiptResolveResult > callback)
	Sync (Verify and fulfil) item subscription from Google Play platform purchase.
void	SyncMobilePlatformSubscriptionGoogle (string orderId, string packageName, string productId, long purchaseTime, string purchaseToken, bool autoAck, PlatformSyncMobileGoogleOptionalParameters optionalParameters, ResultCallback< GoogleReceiptResolveResult > callback)
	Sync (Verify and fulfil) item subscription from Google Play platform purchase.
void	SyncXBoxDLC (XBoxDLCSync XboxDLCSync, ResultCallback callback)
	Synchronize Xbox inventory's DLC items.
void	SyncSteamDLC (string userSteamId, string userAppId, ResultCallback callback)
	Synchronize Steam DLC.
void	SyncSteamInventory (string userSteamId, string appId, string productId, double price, string currencyCode, ResultCallback callback)
	Sync steam inventory's items.
void	SyncSteamInventory (string userSteamId, string appId, string productId, double price, string currencyCode, SyncSteamInventoryOptionalParameters optionalParameters=null, ResultCallback callback=null)
	Sync steam inventory's items.
void	SyncPSNDLC (PlayStationDLCSync PSSyncModel, ResultCallback callback)
	Synchronize with DLC entitlements in PSN Store.
void	SyncTwitchDropItem (TwitchDropSync TwitchDropSyncReq, ResultCallback callback)
	Synchronize with Twitch entitlements in Twitch Drop.
void	SyncEpicGamesDurableItems (string epicGamesJwtToken, ResultCallback callback)
	Synchronize Epic Game Durable/dlc Items.
void	SyncPSNDLCMultipleService (PlayStationDLCSyncMultipleService playStationDlcSyncMultipleService, ResultCallback callback)
	Synchronize with dlc entitlements in PSN Store with multiple service labels.
void	ValidateUserItemPurchaseCondition (string[] items, ResultCallback< PlatformValidateUserItemPurchaseResponse[]> callback)
	Validate User Item Purchase Condition.
void	GetUserEntitlementOwnershipByItemIds (string[] ids, ResultCallback< EntitlementOwnershipItemIds[]> callback)
	Get user entitlement ownership by itemIds.
void	SyncEntitlementPSNStore (PlayStationDLCSync psnModel, ResultCallback callback)
	Synchronize with entitlements in PSN Store.
void	SyncXboxInventory (XboxInventoryRequest model, ResultCallback< XboxInventoryResponse[]> callback)
	Synchronize Comsumable Entitlement in XBOX Inventory.
void	SyncEntitlementPSNMultipleService (PlayStationMultipleServiceRequest playStationMultipleServiceRequest, ResultCallback< PlayStationMultipleServiceResponse[]> callback)
	Synchronize with entitlements in PSN Store with multiple service labels.
void	SellUserEntitlement (UserEntitlementSoldParams userEntitlementSoldParams, EntitlementSoldRequest entitlementSoldRequest, ResultCallback< SellItemEntitlementInfo > callback)
	Sell User Entitlement back to the platform if the item is configured to be sellable.
void	SellUserEntitlement (UserEntitlementSoldParams userEntitlementSoldParams, EntitlementSoldRequest entitlementSoldRequest, SellUserEntitlementOptionalParameters optionalParameters, ResultCallback< SellItemEntitlementInfo > callback)
	Sell User Entitlement back to the platform if the item is configured to be sellable.
void	SellUserEntitlement (string entitlementId, EntitlementSoldRequest entitlementSoldRequest, ResultCallback< SellItemEntitlementInfo > callback)
	Sell User Entitlement back to the platform if the item is configured to be sellable.
void	SellUserEntitlement (string entitlementId, EntitlementSoldRequest entitlementSoldRequest, SellUserEntitlementOptionalParameters optionalParameters, ResultCallback< SellItemEntitlementInfo > callback)
	Sell User Entitlement back to the platform if the item is configured to be sellable.
void	SyncOculusConsumableEntitlements (ResultCallback< SyncOculusConsumableEntitlementResponse[]> callback)
	Synchronize Oculus Consumable Entitlement/IAP.
void	SyncOculusDLC (ResultCallback callback)
	Synchronize Oculus Downloadable Content/DLC.
void	SyncEpicGameInventory (string epicGamesJwtToken, ResultCallback< SyncEpicGamesInventoryResponse[]> callback)
	Synchronize Epic Games Inventory/IAP.
void	GetDlcDurableRewardSimpleMap (PlatformType platformType, ResultCallback< DlcConfigRewardShortInfo > callback)
	Get any "Durable" DLC type from a specific namespace It will not get "Consumables".
void	GetDlcDurableRewardSimpleMap (string platformTypeId, ResultCallback< DlcConfigRewardShortInfo > callback)
	Get any "Durable" DLC type from a specific namespace It will not get "Consumables".

Static Public Member Functions
static string	ConvertActivePlatformToGetDlcDurableReward (PlatformType platformType)

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator `[get]`

Detailed Description

Provide information of entitlements owned by the user.

Member Function Documentation

◆ ConsumeUserEntitlement()

void AccelByte.Api.Entitlement.ConsumeUserEntitlement	(	string	entitlementId,
		int	useCount,
		ResultCallback< EntitlementInfo >	callback,
		string[]	options = null,
		string	requestId = null )

inline

Consume a user entitlement.

Parameters

entitlementId The id of the user entitlement.

useCount Number of consumed entitlement

callback

Returns a Result that contains EntitlementInfo via callback when completed

Parameters

options	Options of consumed entitlement
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

◆ CreateDistributionReceiver()

void AccelByte.Api.Entitlement.CreateDistributionReceiver	(	string	extUserId,
		Attributes	attributes,
		ResultCallback	callback )

inline

Create distribution receiver for current user.

Parameters

extUserId	External user id is a random string that can be generated by yourself for the receiver
attributes	Attributes that contain of serverId, serverName, characterId, and characterName
callback	Returns a Result via callback when completed

◆ DeleteDistributionReceiver()

void AccelByte.Api.Entitlement.DeleteDistributionReceiver	(	string	extUserId,
		ResultCallback	callback )

inline

Delete distribution receiver from user.

Parameters

extUserId	External User Id that want to be deleted in receiver
callback	Returns a Result via callback when completed

◆ GetDistributionReceiver()

void AccelByte.Api.Entitlement.GetDistributionReceiver	(	string	publisherNamespace,
		string	publisherUserId,
		ResultCallback< DistributionReceiver[]>	callback )

inline

Get distribution receiver from user You can target Publisher Namespace and Publisher UserId or Game Namespace and Game UserId.

Parameters

publisherNamespace	Publisher Namespace that used to find user
publisherUserId	Publisher UserId that want to be get
callback	Returns a Result of Distribution Receivers via callback when completed

◆ GetDlcDurableRewardSimpleMap() [1/2]

void AccelByte.Api.Entitlement.GetDlcDurableRewardSimpleMap	(	PlatformType	platformType,
		ResultCallback< DlcConfigRewardShortInfo >	callback )

inline

Get any "Durable" DLC type from a specific namespace It will not get "Consumables".

Parameters

platformType	Target platform to be queried
callback	Returns a result via callback when completed

◆ GetDlcDurableRewardSimpleMap() [2/2]

void AccelByte.Api.Entitlement.GetDlcDurableRewardSimpleMap	(	string	platformTypeId,
		ResultCallback< DlcConfigRewardShortInfo >	callback )

inline

Get any "Durable" DLC type from a specific namespace It will not get "Consumables".

Parameters

platformTypeId	Target platform to be queried
callback	Returns a result via callback when completed

◆ GetUserEntitlementById()

void AccelByte.Api.Entitlement.GetUserEntitlementById	(	string	entitlementId,
		ResultCallback< EntitlementInfo >	callback )

inline

Get user's entitlement by the entitlementId.

Parameters

entitlementId	The id of the entitlement
callback	Returns a Result that contains EntitlementInfo via callback when completed

◆ GetUserEntitlementHistory() [1/2]

void AccelByte.Api.Entitlement.GetUserEntitlementHistory	(	string	userId,
		GetUserEntitlementHistoryOptionalParams	optionalParams,
		ResultCallback< UserEntitlementHistoryResponse >	callback )

inline

Get target user's entitlement history.

Parameters

userId	User Id of user to get entitlement history for.
optionalParams	Query parameters
callback	Result callback containing user's entitlement history data

◆ GetUserEntitlementHistory() [2/2]

void AccelByte.Api.Entitlement.GetUserEntitlementHistory	(	string	userId,
		ResultCallback< UserEntitlementHistoryResponse >	callback )

inline

Get target user's entitlement history.

Parameters

userId	User Id of user to get entitlement history for.
callback	Result callback containing user's entitlement history data

◆ GetUserEntitlementOwnershipAny()

void AccelByte.Api.Entitlement.GetUserEntitlementOwnershipAny	(	string[]	itemIds,
		string[]	appIds,
		string[]	skus,
		ResultCallback< Ownership >	callback )

inline

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

Parameters

itemIds	the item Ids
appIds	the app Ids
skus	the skus
callback	Returns user's entitlement ownership result if any parameters are true via callback when completed

◆ GetUserEntitlementOwnershipByAppId()

void AccelByte.Api.Entitlement.GetUserEntitlementOwnershipByAppId	(	string	appId,
		ResultCallback< Ownership >	callback )

inline

Get user entitlement ownership by app id.

Parameters

appId	The game's app id
callback	Returns a result that contains user ownership info via callback when completed

◆ GetUserEntitlementOwnershipByItemId()

void AccelByte.Api.Entitlement.GetUserEntitlementOwnershipByItemId	(	string	ItemId,
		ResultCallback< Ownership >	callback )

inline

Get user entitlement ownership by ItemId.

Parameters

ItemId	the item's ItemId
callback	Returns user's entitlement ownership result via callback when completed

◆ GetUserEntitlementOwnershipByItemIds()

void AccelByte.Api.Entitlement.GetUserEntitlementOwnershipByItemIds	(	string[]	ids,
		ResultCallback< EntitlementOwnershipItemIds[]>	callback )

inline

Get user entitlement ownership by itemIds.

Parameters

ids	Contains ids ItemIds
callback	Returns a Result via callback when completed

◆ GetUserEntitlementOwnershipBySku()

void AccelByte.Api.Entitlement.GetUserEntitlementOwnershipBySku	(	string	sku,
		ResultCallback< Ownership >	callback )

inline

Get user entitlement ownership by SKU.

Parameters

sku	the item's SKU
callback	Returns user's entitlement ownership result via callback when completed

◆ GetUserEntitlementOwnershipToken()

void AccelByte.Api.Entitlement.GetUserEntitlementOwnershipToken	(	string	key,
		string[]	itemIds,
		string[]	appIds,
		string[]	skus,
		ResultCallback< OwnershipEntitlement[]>	callback,
		bool	verifyPublicKey = true,
		bool	verifyExpiration = true,
		bool	verifyUserId = true )

inline

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

Parameters

key	the public key
itemIds	the item Ids
appIds	the app Ids
skus	the skus
callback	R eturns user's entitlement ownership result if any parameters are true via callback when completed
verifyPublicKey	Do verification on public key. Set False to skip
verifyExpiration	Do verification on expiration. Set False to skip
verifyUserId	Do verification on current user id and sub. Set False to skip

◆ GetUserEntitlementOwnershipTokenOnly()

void AccelByte.Api.Entitlement.GetUserEntitlementOwnershipTokenOnly	(	string[]	itemIds,
		string[]	appIds,
		string[]	skus,
		ResultCallback< OwnershipToken >	callback )

inline

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

Parameters

itemIds	the item Ids
appIds	the app Ids
skus	the skus
callback	Returns user's entitlement ownership token if any parameters are true via callback when completed

◆ QueryUserEntitlements() [1/4]

void AccelByte.Api.Entitlement.QueryUserEntitlements	(	QueryUserEntitlementsOptionalParameters	optionalParameters,
		ResultCallback< EntitlementPagingSlicedResult >	callback )

inline

Query user entitlements.

Parameters

optionalParameters	List of optional parameter that can be set to narrow the query result
callback	Returns a Result that contains EntitlementPagingSlicedResult via callback when completed

◆ QueryUserEntitlements() [2/4]

void AccelByte.Api.Entitlement.QueryUserEntitlements	(	string	entitlementName = null,
		string	itemId = null,
		int	offset = 0,
		int	limit = 20,
		ResultCallback< EntitlementPagingSlicedResult >	callback = null,
		EntitlementClazz	entitlementClazz = EntitlementClazz::NONE,
		EntitlementAppType	entitlementAppType = EntitlementAppType::NONE,
		string[]	features = null )

inline

Query user entitlements.

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)
callback	Returns a Result that contains EntitlementPagingSlicedResult via callback when completed
entitlementClazz	Class of the entitlement (optional)
entitlementAppType	This is the type of application that entitled (optional)
features	The feature array

◆ QueryUserEntitlements() [3/4]

void AccelByte.Api.Entitlement.QueryUserEntitlements	(	string	targetUserId,
		QueryUserEntitlementsOptionalParameters	optionalParameters,
		ResultCallback< EntitlementPagingSlicedResult >	callback )

inline

Query user entitlements.

Parameters

targetUserId	Target user to be queried
optionalParameters	List of optional parameter that can be set to narrow the query result
callback	Returns a Result that contains EntitlementPagingSlicedResult via callback when completed

◆ QueryUserEntitlements() [4/4]

void AccelByte.Api.Entitlement.QueryUserEntitlements	(	string	targetUserId,
		ResultCallback< EntitlementPagingSlicedResult >	callback )

inline

Query user entitlements.

Parameters

targetUserId	Target user to be queried
callback	Returns a Result that contains EntitlementPagingSlicedResult via callback when completed

◆ QueryUserSubscription() [1/2]

void AccelByte.Api.Entitlement.QueryUserSubscription	(	PlatformStoreId	platformStoreId,
		string	userId,
		QueryUserSubscriptionRequestOptionalParameters	optionalParameters,
		ResultCallback< SubscriptionPagingSlicedResult >	callback )

inline

Query other user's thirdparty subscription.

Parameters

platformStoreId	A thirdparty platform id to be queried
userId	user Id to be queried
optionalParameters	optional parameter for query
callback	Returns a Result that contains SubscriptionPagingSlicedResult via callback when completed

◆ QueryUserSubscription() [2/2]

void AccelByte.Api.Entitlement.QueryUserSubscription	(	PlatformStoreId	platformStoreId,
		string	userId,
		ResultCallback< SubscriptionPagingSlicedResult >	callback )

inline

Query other user's thirdparty subscription.

Parameters

platformStoreId	A thirdparty platform id to be queried
userId	user Id to be queried
callback	Returns a Result that contains SubscriptionPagingSlicedResult via callback when completed

◆ SellUserEntitlement() [1/4]

void AccelByte.Api.Entitlement.SellUserEntitlement	(	string	entitlementId,
		EntitlementSoldRequest	entitlementSoldRequest,
		ResultCallback< SellItemEntitlementInfo >	callback )

inline

Sell User Entitlement back to the platform if the item is configured to be sellable.

Parameters

entitlementId	The user entitlement ID to sell.
entitlementSoldRequest	The entitlement sold request containing the use count and request ID.
callback	Returns a Result via callback when completed

◆ SellUserEntitlement() [2/4]

void AccelByte.Api.Entitlement.SellUserEntitlement	(	string	entitlementId,
		EntitlementSoldRequest	entitlementSoldRequest,
		SellUserEntitlementOptionalParameters	optionalParameters,
		ResultCallback< SellItemEntitlementInfo >	callback )

inline

Sell User Entitlement back to the platform if the item is configured to be sellable.

Parameters

entitlementId	The user entitlement ID to sell.
entitlementSoldRequest	The entitlement sold request containing the use count and request ID.
optionalParameters	The optional parameter that can be set.
callback	Returns a Result via callback when completed

◆ SellUserEntitlement() [3/4]

void AccelByte.Api.Entitlement.SellUserEntitlement	(	UserEntitlementSoldParams	userEntitlementSoldParams,
		EntitlementSoldRequest	entitlementSoldRequest,
		ResultCallback< SellItemEntitlementInfo >	callback )

inline

Sell User Entitlement back to the platform if the item is configured to be sellable.

Parameters

userEntitlementSoldParams	The user entitlement parameters containing the user ID and entitlement ID to sell.
entitlementSoldRequest	The entitlement sold request containing the use count and request ID.
callback	Returns a Result via callback when completed

◆ SellUserEntitlement() [4/4]

void AccelByte.Api.Entitlement.SellUserEntitlement	(	UserEntitlementSoldParams	userEntitlementSoldParams,
		EntitlementSoldRequest	entitlementSoldRequest,
		SellUserEntitlementOptionalParameters	optionalParameters,
		ResultCallback< SellItemEntitlementInfo >	callback )

inline

Sell User Entitlement back to the platform if the item is configured to be sellable.

Parameters

userEntitlementSoldParams	The user entitlement parameters containing the user ID and entitlement ID to sell.
entitlementSoldRequest	The entitlement sold request containing the use count and request ID.
optionalParameters	The optional parameter that can be set.
callback	Returns a Result via callback when completed

◆ SyncEntitlementPSNMultipleService()

void AccelByte.Api.Entitlement.SyncEntitlementPSNMultipleService	(	PlayStationMultipleServiceRequest	playStationMultipleServiceRequest,
		ResultCallback< PlayStationMultipleServiceResponse[]>	callback )

inline

Synchronize with entitlements in PSN Store with multiple service labels.

Parameters

playStationMultipleServiceRequest	Playstation's Multiple Service Labels Model Sync Request
callback	Returns a Result via callback when completed

◆ SyncEntitlementPSNStore()

void AccelByte.Api.Entitlement.SyncEntitlementPSNStore	(	PlayStationDLCSync	psnModel,
		ResultCallback	callback )

inline

Synchronize with entitlements in PSN Store.

Parameters

psnModel	Playstation's DLC Model Sync Request
callback	Returns a Result via callback when completed

◆ SyncEpicGameInventory()

void AccelByte.Api.Entitlement.SyncEpicGameInventory	(	string	epicGamesJwtToken,
		ResultCallback< SyncEpicGamesInventoryResponse[]>	callback )

inline

Synchronize Epic Games Inventory/IAP.

Parameters

epicGamesJwtToken	Epic Game Jwt Token.
callback	Returns a Result via callback when completed

◆ SyncEpicGamesDurableItems()

void AccelByte.Api.Entitlement.SyncEpicGamesDurableItems	(	string	epicGamesJwtToken,
		ResultCallback	callback )

inline

Synchronize Epic Game Durable/dlc Items.

Parameters

epicGamesJwtToken	Contains epicGamesJwtToken needed for EpicGames Durable sync
callback	Returns a Result via callback when completed

◆ SyncMobilePlatformPurchaseApple() [1/2]

void AccelByte.Api.Entitlement.SyncMobilePlatformPurchaseApple	(	string	productId,
		string	transactionId,
		string	receiptData,
		PlatformSyncMobileAppleOptionalParam	optionalParameters,
		ResultCallback	callback )

inline

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

Parameters

productId	purchased product id or entitlement's SKU
transactionId	purchased transaction id
receiptData	purchased product Payload in form of encrypted Apple Receipt
optionalParameters	Optional parameters containing exclude old transaction, product region and language
callback	Returns a Result via callback when completed

◆ SyncMobilePlatformPurchaseApple() [2/2]

void AccelByte.Api.Entitlement.SyncMobilePlatformPurchaseApple	(	string	productId,
		string	transactionId,
		string	receiptData,
		ResultCallback	callback )

inline

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

Parameters

productId	purchased product id or entitlement's SKU
transactionId	purchased transaction id
receiptData	purchased product Payload in form of encrypted Apple Receipt
callback	Returns a Result via callback when completed

◆ SyncMobilePlatformPurchaseGoogle() [1/2]

void AccelByte.Api.Entitlement.SyncMobilePlatformPurchaseGoogle	(	string	orderId,
		string	packageName,
		string	productId,
		long	purchaseTime,
		string	purchaseToken,
		bool	autoAck,
		PlatformSyncMobileGoogleOptionalParameters	optionalParameters,
		ResultCallback< GoogleReceiptResolveResult >	callback )

inline

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

Parameters

orderId	Google receipt's order id
packageName	Google receipt's package name
productId	Google receipt's product id
purchaseTime	Google receipt's purchase time
purchaseToken	Google receipt's purchase token
autoAck	Set true if it is a durable item
optionalParameters	Optional parameters containing product region and language
callback	Returns a Result that contain whether client should confirm pending purchase or not

◆ SyncMobilePlatformPurchaseGoogle() [2/2]

void AccelByte.Api.Entitlement.SyncMobilePlatformPurchaseGoogle	(	string	orderId,
		string	packageName,
		string	productId,
		long	purchaseTime,
		string	purchaseToken,
		bool	autoAck,
		ResultCallback< GoogleReceiptResolveResult >	callback )

inline

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

Parameters

orderId	Google receipt's order id
packageName	Google receipt's package name
productId	Google receipt's product id
purchaseTime	Google receipt's purchase time
purchaseToken	Google receipt's purchase token
autoAck	Set true if it is a durable item
callback	Returns a Result that contain whether client should confirm pending purchase or not

◆ SyncMobilePlatformSubscriptionApple()

void AccelByte.Api.Entitlement.SyncMobilePlatformSubscriptionApple	(	string	transactionId,
		ResultCallback	callback )

inline

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

Parameters

transactionId	purchased transaction id
callback	Returns a Result via callback when completed

◆ SyncMobilePlatformSubscriptionGoogle() [1/2]

void AccelByte.Api.Entitlement.SyncMobilePlatformSubscriptionGoogle	(	string	orderId,
		string	packageName,
		string	productId,
		long	purchaseTime,
		string	purchaseToken,
		bool	autoAck,
		PlatformSyncMobileGoogleOptionalParameters	optionalParameters,
		ResultCallback< GoogleReceiptResolveResult >	callback )

inline

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

Parameters

orderId	Google receipt's order id
packageName	Google receipt's package name
productId	Google receipt's product id
purchaseTime	Google receipt's purchase time
purchaseToken	Google receipt's purchase token
autoAck	Auto acknowledge the purchase. By setting it as false, Game client needs manualy acknowledge it, otherwise this transaction will be expired. By setting it as true, AGS will automatically acknowledged it
optionalParameters	Optional parameters containing product region and language
callback	Returns a Result that contain whether client should confirm pending purchase or not

◆ SyncMobilePlatformSubscriptionGoogle() [2/2]

void AccelByte.Api.Entitlement.SyncMobilePlatformSubscriptionGoogle	(	string	orderId,
		string	packageName,
		string	productId,
		long	purchaseTime,
		string	purchaseToken,
		bool	autoAck,
		ResultCallback< GoogleReceiptResolveResult >	callback )

inline

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

Parameters

orderId	Google receipt's order id
packageName	Google receipt's package name
productId	Google receipt's product id
purchaseTime	Google receipt's purchase time
purchaseToken	Google receipt's purchase token
autoAck	Auto acknowledge the purchase. By setting it as false, Game client needs manualy acknowledge it, otherwise this transaction will be expired. By setting it as true, AGS will automatically acknowledged it
callback	Returns a Result that contain whether client should confirm pending purchase or not

◆ SyncOculusConsumableEntitlements()

void AccelByte.Api.Entitlement.SyncOculusConsumableEntitlements ( ResultCallback< SyncOculusConsumableEntitlementResponse[]> callback )

inline

Synchronize Oculus Consumable Entitlement/IAP.

Parameters

callback Returns a Result via callback when completed

◆ SyncOculusDLC()

void AccelByte.Api.Entitlement.SyncOculusDLC ( ResultCallback callback )

inline

Synchronize Oculus Downloadable Content/DLC.

Parameters

callback Returns a Result via callback when completed

◆ SyncPSNDLC()

void AccelByte.Api.Entitlement.SyncPSNDLC	(	PlayStationDLCSync	PSSyncModel,
		ResultCallback	callback )

inline

Synchronize with DLC entitlements in PSN Store.

Parameters

PSSyncModel	Contains ServiceLabel needed for PlayStation DLC sync
callback	Returns a Result via callback when completed

◆ SyncPSNDLCMultipleService()

void AccelByte.Api.Entitlement.SyncPSNDLCMultipleService	(	PlayStationDLCSyncMultipleService	playStationDlcSyncMultipleService,
		ResultCallback	callback )

inline

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

Parameters

playStationDlcSyncMultipleService	Contains ServiceLabel needed for PlayStation DLC Multiple Service sync
callback	Returns a Result via callback when completed

◆ SyncSteamDLC()

void AccelByte.Api.Entitlement.SyncSteamDLC	(	string	userSteamId,
		string	userAppId,
		ResultCallback	callback )

inline

Synchronize Steam DLC.

Parameters

userSteamId	Steam ID of the user
userAppId	Steam app id
callback	Returns a Result via callback when completed

◆ SyncSteamInventory() [1/2]

void AccelByte.Api.Entitlement.SyncSteamInventory	(	string	userSteamId,
		string	appId,
		string	productId,
		double	price,
		string	currencyCode,
		ResultCallback	callback )

inline

Sync steam inventory's items.

Parameters

userSteamId	Steam user id
appId	Steam application id
productId	Steam item def id
price	Steam item price
currencyCode	Steam item currency code
callback	Returns a Result via callback when completed

◆ SyncSteamInventory() [2/2]

void AccelByte.Api.Entitlement.SyncSteamInventory	(	string	userSteamId,
		string	appId,
		string	productId,
		double	price,
		string	currencyCode,
		SyncSteamInventoryOptionalParameters	optionalParameters = null,
		ResultCallback	callback = null )

inline

Sync steam inventory's items.

Parameters

userSteamId	Steam user id
appId	Steam application id
productId	Steam item def id
price	Steam item price
currencyCode	Steam item currency code
optionalParameters	Optional parameters containing product region and language
callback	Returns a Result via callback when completed

◆ SyncTwitchDropItem()

void AccelByte.Api.Entitlement.SyncTwitchDropItem	(	TwitchDropSync	TwitchDropSyncReq,
		ResultCallback	callback )

inline

Synchronize with Twitch entitlements in Twitch Drop.

Parameters

TwitchDropSyncReq	Contains gameId, region, and language needed for Twitch Drop sync
callback	Returns a Result via callback when completed

◆ SyncXBoxDLC()

void AccelByte.Api.Entitlement.SyncXBoxDLC	(	XBoxDLCSync	XboxDLCSync,
		ResultCallback	callback )

inline

Synchronize Xbox inventory's DLC items.

Parameters

XboxDLCSync	Contains XSTSToken needed for Xbox DLC sync
callback	Returns a Result via callback when completed

◆ SyncXboxInventory()

void AccelByte.Api.Entitlement.SyncXboxInventory	(	XboxInventoryRequest	model,
		ResultCallback< XboxInventoryResponse[]>	callback )

inline

Synchronize Comsumable Entitlement in XBOX Inventory.

Parameters

model	XBOX's Consumable Entitlement Model Sync Request
callback	Returns a Result via callback when completed

◆ UpdateDistributionReceiver()

void AccelByte.Api.Entitlement.UpdateDistributionReceiver	(	string	extUserId,
		Attributes	attributes,
		ResultCallback	callback )

inline

Update distribution receiver for current user.

Parameters

extUserId	External User Id that has been created before for receiver
attributes	Attributes that contain of serverId, serverName, characterId, and characterName
callback	Returns a Result via callback when completed

◆ ValidateUserItemPurchaseCondition()

void AccelByte.Api.Entitlement.ValidateUserItemPurchaseCondition	(	string[]	items,
		ResultCallback< PlatformValidateUserItemPurchaseResponse[]>	callback )

inline

Validate User Item Purchase Condition.

Parameters

items	Contains item that needed for Validate User Item Purchase Condition
callback	Returns a Result via callback when completed

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ConsumeUserEntitlement()

◆ CreateDistributionReceiver()

◆ DeleteDistributionReceiver()

◆ GetDistributionReceiver()

◆ GetDlcDurableRewardSimpleMap() [1/2]

◆ GetDlcDurableRewardSimpleMap() [2/2]

◆ GetUserEntitlementById()

◆ GetUserEntitlementHistory() [1/2]

◆ GetUserEntitlementHistory() [2/2]

◆ GetUserEntitlementOwnershipAny()

◆ GetUserEntitlementOwnershipByAppId()

◆ GetUserEntitlementOwnershipByItemId()

◆ GetUserEntitlementOwnershipByItemIds()

◆ GetUserEntitlementOwnershipBySku()

◆ GetUserEntitlementOwnershipToken()

◆ GetUserEntitlementOwnershipTokenOnly()

◆ QueryUserEntitlements() [1/4]

◆ QueryUserEntitlements() [2/4]

◆ QueryUserEntitlements() [3/4]

◆ QueryUserEntitlements() [4/4]

◆ QueryUserSubscription() [1/2]

◆ QueryUserSubscription() [2/2]

◆ SellUserEntitlement() [1/4]

◆ SellUserEntitlement() [2/4]

◆ SellUserEntitlement() [3/4]

◆ SellUserEntitlement() [4/4]

◆ SyncEntitlementPSNMultipleService()

◆ SyncEntitlementPSNStore()

◆ SyncEpicGameInventory()

◆ SyncEpicGamesDurableItems()

◆ SyncMobilePlatformPurchaseApple() [1/2]

◆ SyncMobilePlatformPurchaseApple() [2/2]

◆ SyncMobilePlatformPurchaseGoogle() [1/2]

◆ SyncMobilePlatformPurchaseGoogle() [2/2]

◆ SyncMobilePlatformSubscriptionApple()

◆ SyncMobilePlatformSubscriptionGoogle() [1/2]

◆ SyncMobilePlatformSubscriptionGoogle() [2/2]

◆ SyncOculusConsumableEntitlements()

◆ SyncOculusDLC()

◆ SyncPSNDLC()

◆ SyncPSNDLCMultipleService()

◆ SyncSteamDLC()

◆ SyncSteamInventory() [1/2]

◆ SyncSteamInventory() [2/2]

◆ SyncTwitchDropItem()

◆ SyncXBoxDLC()

◆ SyncXboxInventory()

◆ UpdateDistributionReceiver()

◆ ValidateUserItemPurchaseCondition()