Simple IAP System  5.0
Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
PlayFabStore

Represents the public interface of the underlying store system for PlayFab. This is the store base class other PlayFab billing implementations are making use of. More...

Inheritance diagram for PlayFabStore:
PlayFabFacebookStore PlayFabFacebookStore PlayFabPayPalStore PlayFabPayPalStore PlayFabSteamStore PlayFabSteamStore

Public Member Functions

void FinishTransaction (ProductDefinition product, string transactionId)
 
void Initialize (IStoreCallback callback)
 
void Purchase (ProductDefinition product, string developerPayload)
 
void RetrieveProducts (ReadOnlyCollection< ProductDefinition > products)
 
 PlayFabStore ()
 Setting this store reference on initialization. More...
 
virtual void Initialize (IStoreCallback callback)
 Initialize the instance using the specified IStoreCallback. More...
 
virtual void RetrieveProducts (ReadOnlyCollection< ProductDefinition > products)
 Fetch the latest product metadata asynchronously with results returned via IStoreCallback. More...
 
virtual void Purchase (ProductDefinition productDefinition, string developerPayload)
 Handle a purchase request from a user. Developer payload is provided for stores that define such a concept. More...
 
void Purchase (IAPProduct product)
 Purchase overload for virtual products, as they differ in their workflow. Virtual currency funds should be checked locally before creating the request. More...
 
virtual void OnPurchaseStarted (StartPurchaseResult result)
 Callback retrieved when an (real money) order on live servers has been initiated. Here the payment request for the order is being sent off, triggering native overlays. More...
 
virtual void OnPurchaseResult (PayForPurchaseResult result)
 Callback retrieved when the payment result is received from live servers. The purchase still needs to be acknowledged in this method. More...
 
void OnPurchaseSucceeded (ConfirmPurchaseResult result)
 Callback from the billing system when a (real money) purchase completes successfully. More...
 
void OnPurchaseSucceeded (PurchaseItemResult result)
 Callback from the billing system when a (virtual) purchase completes successfully. More...
 
void Consume (IAPProduct product, string itemInstanceID, int amount)
 
void OnConsumeSucceeded (IAPProduct product, int amount)
 Callback from the service provider when a consume action completes successfully. More...
 
void RedeemCoupon (string code)
 
virtual void FinishTransaction (ProductDefinition product, string transactionId)
 Called by Unity Purchasing when a transaction has been recorded. Store systems should perform any housekeeping here, such as closing transactions or consuming consumables. More...
 
void OnSetupFailed (PlayFabError error)
 Indicate that IAP is unavailable for a specific reason, such as IAP being disabled in device settings. More...
 
void OnPurchaseFailed (PlayFabError error)
 Method we are calling for any failed (real money) results in the billing interaction. More...
 
void OnVirtualPurchaseFailed (PlayFabError error)
 Method we are calling for any failed (virtual) results in the billing interaction. More...
 
void OnConsumeFailed (PlayFabError error)
 Method we are calling for any failed consume results in the billing interaction. More...
 

Public Attributes

IStoreCallback callback
 Callback for hooking into the native Unity IAP logic. More...
 
Dictionary< string, ProductDescription > products
 List of products which are declared and retrieved by the billing system. More...
 
string storeId = "StoreName"
 Declaring the store name used in Unity IAP for product store identifiers. More...
 

Static Public Attributes

static string orderId
 Keeping track of the order that is currently being processed, so we can confirm and finish it later on. More...
 

Properties

static PlayFabStore instance [get]
 Reference to this store class, since the user needs to confirm the purchase transaction manually in-game, thus calling the confirm method of this script. More...
 

Detailed Description

Represents the public interface of the underlying store system for PlayFab. This is the store base class other PlayFab billing implementations are making use of.

Constructor & Destructor Documentation

Setting this store reference on initialization.

Member Function Documentation

void Consume ( IAPProduct  product,
string  itemInstanceID,
int  amount 
)

void FinishTransaction ( ProductDefinition  product,
string  transactionId 
)
virtual void FinishTransaction ( ProductDefinition  product,
string  transactionId 
)
virtual

Called by Unity Purchasing when a transaction has been recorded. Store systems should perform any housekeeping here, such as closing transactions or consuming consumables.

void Initialize ( IStoreCallback  callback)
virtual void Initialize ( IStoreCallback  callback)
virtual

Initialize the instance using the specified IStoreCallback.

Reimplemented in PlayFabPayPalStore, PlayFabSteamStore, and PlayFabFacebookStore.

void OnConsumeFailed ( PlayFabError  error)

Method we are calling for any failed consume results in the billing interaction.

void OnConsumeSucceeded ( IAPProduct  product,
int  amount 
)

Callback from the service provider when a consume action completes successfully.

void OnPurchaseFailed ( PlayFabError  error)

Method we are calling for any failed (real money) results in the billing interaction.

virtual void OnPurchaseResult ( PayForPurchaseResult  result)
virtual

Callback retrieved when the payment result is received from live servers. The purchase still needs to be acknowledged in this method.

Reimplemented in PlayFabPayPalStore, and PlayFabSteamStore.

virtual void OnPurchaseStarted ( StartPurchaseResult  result)
virtual

Callback retrieved when an (real money) order on live servers has been initiated. Here the payment request for the order is being sent off, triggering native overlays.

Reimplemented in PlayFabFacebookStore.

void OnPurchaseSucceeded ( ConfirmPurchaseResult  result)

Callback from the billing system when a (real money) purchase completes successfully.

void OnPurchaseSucceeded ( PurchaseItemResult  result)

Callback from the billing system when a (virtual) purchase completes successfully.

void OnSetupFailed ( PlayFabError  error)

Indicate that IAP is unavailable for a specific reason, such as IAP being disabled in device settings.

void OnVirtualPurchaseFailed ( PlayFabError  error)

Method we are calling for any failed (virtual) results in the billing interaction.

void Purchase ( ProductDefinition  product,
string  developerPayload 
)
virtual void Purchase ( ProductDefinition  productDefinition,
string  developerPayload 
)
virtual

Handle a purchase request from a user. Developer payload is provided for stores that define such a concept.

Reimplemented in PlayFabPayPalStore.

void Purchase ( IAPProduct  product)

Purchase overload for virtual products, as they differ in their workflow. Virtual currency funds should be checked locally before creating the request.

void RedeemCoupon ( string  code)

void RetrieveProducts ( ReadOnlyCollection< ProductDefinition >  products)
virtual void RetrieveProducts ( ReadOnlyCollection< ProductDefinition >  products)
virtual

Fetch the latest product metadata asynchronously with results returned via IStoreCallback.

Reimplemented in PlayFabPayPalStore.

Member Data Documentation

IStoreCallback callback

Callback for hooking into the native Unity IAP logic.

string orderId
static

Keeping track of the order that is currently being processed, so we can confirm and finish it later on.

Dictionary<string, ProductDescription> products

List of products which are declared and retrieved by the billing system.

string storeId = "StoreName"

Declaring the store name used in Unity IAP for product store identifiers.

Property Documentation

static PlayFabStore instance
staticget

Reference to this store class, since the user needs to confirm the purchase transaction manually in-game, thus calling the confirm method of this script.


The documentation for this class was generated from the following file: