CurrentAppSimulator CurrentAppSimulator CurrentAppSimulator CurrentAppSimulator Class

Gets a simulated app ID. Since CurrentAppSimulator is intended only for testing during app development, the returned CurrentAppSimulator.AppId will contain only 0's.

Once your app is listed on the Windows Store, CurrentApp.AppId will get the GUID generated during app on-boarding and used to list your app within the Windows Store catalog.

public : static PlatForm::Guid AppId { get; }public static Guid AppId { get; }Public Static ReadOnly Property AppId As Guid// You can use this property in JavaScript.

Remarks

Uses the AppId element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more information, see Using the WindowsStoreProxy.xml file with CurrentAppSimulator.

Gets the simulated license metadata for the current app as provided by the simulation.

public : static LicenseInformation LicenseInformation { get; }public static LicenseInformation LicenseInformation { get; }Public Static ReadOnly Property LicenseInformation As LicenseInformation// You can use this property in JavaScript.

Remarks

Uses the LicenseInformation element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more information, see Using the WindowsStoreProxy.xml file with CurrentAppSimulator.

This API does not require a network connection.

Gets the simulated Uniform Resource Identifier (URI) that represents a Windows Store listing page for the current app.

public : static Uri LinkUri { get; }public static Uri LinkUri { get; }Public Static ReadOnly Property LinkUri As Uri// You can use this property in JavaScript.

Remarks

Gets the value of the LinkUri element in the WindowsStoreProxy.xml file. For more information, see Using the WindowsStoreProxy.xml file with CurrentAppSimulator.

Retrieves the promotion campaign ID for the current app.

public : static IAsyncOperation<PlatForm::String> GetAppPurchaseCampaignIdAsync()public static IAsyncOperation<string> GetAppPurchaseCampaignIdAsync()Public Static Function GetAppPurchaseCampaignIdAsync() As IAsyncOperation( Of string )// You can use this method in JavaScript.

Remarks

Starting in Windows 10, you can seed the installation URL for your app with an ID that represents a custom promotion campaign. This enables you to publicize the installation URL in different locations and use the campaign ID to determine which location the customer clicked on the installation URL. Use the GetAppPurchaseCampaignIdAsync method to retrieve the campaign ID for the current app. For more information about custom app promotion campaigns, see Create a custom app promotion campaign.

See Also

Create a custom app promotion campaign

Creates the async operation that the user can use to simulate requesting all receipts for this app and any in-app product purchases. For examples of how receipt information can be used, see Using receipts to verify product purchases.

public : static IAsyncOperation<PlatForm::String> GetAppReceiptAsync()public static IAsyncOperation<string> GetAppReceiptAsync()Public Static Function GetAppReceiptAsync() As IAsyncOperation( Of string )// You can use this method in JavaScript.

Remarks

For more information about the contents of the receipt, see Using receipts to verify product purchases.

Creates the async operation that the user can use to simulate requesting the receipt for the specified product ID. For examples of how receipt information can be used, see Using receipts to verify product purchases.

public : static IAsyncOperation<PlatForm::String> GetProductReceiptAsync(PlatForm::String productId)public static IAsyncOperation<string> GetProductReceiptAsync(String productId)Public Static Function GetProductReceiptAsync(productId As String) As IAsyncOperation( Of string )// You can use this method in JavaScript.

Remarks

For more information about the contents of the receipt, see Using receipts to verify product purchases.

Returns a list of purchased consumable in-app products that have not been fulfilled locally.

public : static IAsyncOperation<IVectorView<UnfulfilledConsumable>> GetUnfulfilledConsumablesAsync()public static IAsyncOperation<IReadOnlyList<UnfulfilledConsumable>> GetUnfulfilledConsumablesAsync()Public Static Function GetUnfulfilledConsumablesAsync() As IAsyncOperation( Of IReadOnlyListUnfulfilledConsumable )// You can use this method in JavaScript.

Loads the simulated app listing information asynchronously.

The returned ListingInformation object contains listing information (e.g. name, price, age rating) specific to the market the user currently resides in. Additionally, listing information for products available via in-app products is also provided.

public : static IAsyncOperation<ListingInformation> LoadListingInformationAsync()public static IAsyncOperation<ListingInformation> LoadListingInformationAsync()Public Static Function LoadListingInformationAsync() As IAsyncOperation( Of ListingInformation )// You can use this method in JavaScript.

Remarks

Calling this method requires an internet connection.

Loads the simulated app listing information asynchronously, returning in-app products in the ProductListings collection that match all supplied keywords.

public : static IAsyncOperation<ListingInformation> LoadListingInformationByKeywordsAsync(IIterable<PlatForm::String> keywords)public static IAsyncOperation<ListingInformation> LoadListingInformationByKeywordsAsync(IEnumerable<String> keywords)Public Static Function LoadListingInformationByKeywordsAsync(keywords As IEnumerable<String>) As IAsyncOperation( Of ListingInformation )// You can use this method in JavaScript.

Remarks

Uses the ListingInformation element in the WindowsStoreProxy.xml file as the data source for the members of the returned objects. For more information, see Using the WindowsStoreProxy.xml file with CurrentAppSimulator.

Calling this method requires an internet connection.

Loads the simulated app listing information asynchronously, returning available in-app products in the ProductListings collection that match any of the given products IDs.

public : static IAsyncOperation<ListingInformation> LoadListingInformationByProductIdsAsync(IIterable<PlatForm::String> productIds)public static IAsyncOperation<ListingInformation> LoadListingInformationByProductIdsAsync(IEnumerable<String> productIds)Public Static Function LoadListingInformationByProductIdsAsync(productIds As IEnumerable<String>) As IAsyncOperation( Of ListingInformation )// You can use this method in JavaScript.

Remarks

Uses the ListingInformation element in the WindowsStoreProxy.xml file as the data source for the members of the returned objects. For more information, see Using the WindowsStoreProxy.xml file with CurrentAppSimulator.

Calling this method requires an internet connection.

Reloads the simulator using a StorageFile containing the WindowsStoreProxy.xml file.

If you do not call this method to load your own file, the simulator will create/load (but not overwrite) a WindowsStoreProxy.xml file containing a set of default values.

public : static IAsyncAction ReloadSimulatorAsync(StorageFile simulatorSettingsFile)public static IAsyncAction ReloadSimulatorAsync(StorageFile simulatorSettingsFile)Public Static Function ReloadSimulatorAsync(simulatorSettingsFile As StorageFile) As IAsyncAction// You can use this method in JavaScript.

Remarks

For more information about using this method, see Using the WindowsStoreProxy.xml file with CurrentAppSimulator.

Simulates notifying the Windows Store that the purchase of a consumable add-on (also called an in-app product or IAP) is fulfilled and that the user has the right to access the content.

public : static IAsyncOperation<FulfillmentResult> ReportConsumableFulfillmentAsync(PlatForm::String productId, PlatForm::Guid transactionId)public static IAsyncOperation<FulfillmentResult> ReportConsumableFulfillmentAsync(String productId, Guid transactionId)Public Static Function ReportConsumableFulfillmentAsync(productId As String, transactionId As Guid) As IAsyncOperation( Of FulfillmentResult )// You can use this method in JavaScript.

Remarks

The product ID is the string that the app uses to identify the add-on. You enter the product ID when submitting your add-on in the Windows Dev Center dashboard, where it is associated with the description, price tier and lifetime. For more information, see How to use product IDs for add-ons in your code.

A unique transaction ID is required for each instance of a consumable product that has been purchased more than once.

Creates the async operation that simulates a user request to buy a full license for the current app.

public : static IAsyncOperation<PlatForm::String> RequestAppPurchaseAsync(bool includeReceipt)public static IAsyncOperation<string> RequestAppPurchaseAsync(Boolean includeReceipt)Public Static Function RequestAppPurchaseAsync(includeReceipt As Boolean) As IAsyncOperation( Of string )// You can use this method in JavaScript.

Remarks

This method returns a success value even if:

• No network connection is available.
• The user cancels out of the dialog.
• The user's authentication fails. You should treat a success result as indicating the async process completed without errors. To ensure that the transaction itself was successful, check the LicenseInformation element in the returned receipt.

For more information about the contents of the receipt, see Using receipts to verify product purchases.

Creates the async operation that displays the UI that is used to simulate the purchase of an add-on (also called an in-app product or IAP) from the Windows Store.

public : static IAsyncOperation<PurchaseResults> RequestProductPurchaseAsync(PlatForm::String productId)public static IAsyncOperation<PurchaseResults> RequestProductPurchaseAsync(String productId)Public Static Function RequestProductPurchaseAsync(productId As String) As IAsyncOperation( Of PurchaseResults )// You can use this method in JavaScript.

Remarks

Uses the CurrentApp/ListingInformation/Product element in the WindowsStoreProxy.xml file with the ProductId attribute that matches ProductId as the data source for the members of the returned object. If the purchase succeeds, the license state is updated only in memory. The contents of WindowsStoreProxy.xml are not changed. For more information, see Using the WindowsStoreProxy.xml file with CurrentAppSimulator.

You can see an example of how to use this method in our code sample.

See Also

RequestProductPurchaseAsync(String, Boolean)RequestProductPurchaseAsync(String, Boolean)RequestProductPurchaseAsync(String, Boolean)RequestProductPurchaseAsync(String, Boolean)

Creates the async operation that displays the UI that is used to simulate the purchase of an add-on (also called an in-app product or IAP) from the Windows Store.

public : static IAsyncOperation<PlatForm::String> RequestProductPurchaseAsync(PlatForm::String productId, bool includeReceipt)public static IAsyncOperation<string> RequestProductPurchaseAsync(String productId, Boolean includeReceipt)Public Static Function RequestProductPurchaseAsync(productId As String, includeReceipt As Boolean) As IAsyncOperation( Of string )// You can use this method in JavaScript.

Remarks

The remarks for RequestProductPurchaseAsync(String) also apply to this overload.

To confirm whether the product license is active after a successful call to this overload, use the LicenseInformation.IsActive property.

You can see an example of how to use this method in our code sample.

See Also

RequestProductPurchaseAsync(String)RequestProductPurchaseAsync(String)RequestProductPurchaseAsync(String)RequestProductPurchaseAsync(String)

Creates the async operation that displays the UI that is used to simulate the purchase of an add-on (also called an in-app product or IAP) from the Windows Store. This overload includes parameters you can use to display details for a specific offer within a large catalog of in-app purchases that is represented by a single product entry in the Store.

public : static IAsyncOperation<PurchaseResults> RequestProductPurchaseAsync(PlatForm::String productId, PlatForm::String offerId, ProductPurchaseDisplayProperties displayProperties)public static IAsyncOperation<PurchaseResults> RequestProductPurchaseAsync(String productId, String offerId, ProductPurchaseDisplayProperties displayProperties)Public Static Function RequestProductPurchaseAsync(productId As String, offerId As String, displayProperties As ProductPurchaseDisplayProperties) As IAsyncOperation( Of PurchaseResults )// You can use this method in JavaScript.

Remarks

The remarks for RequestProductPurchaseAsync(String) also apply to this overload.

See Also

RequestProductPurchaseAsync(String)RequestProductPurchaseAsync(String)RequestProductPurchaseAsync(String)RequestProductPurchaseAsync(String)

RequestProductPurchaseAsync(String, Boolean)RequestProductPurchaseAsync(String, Boolean)RequestProductPurchaseAsync(String, Boolean)RequestProductPurchaseAsync(String, Boolean)