CurrentAppSimulator Class

Defines methods and properties used to instantiate an object that you can use to get simulated license info during testing.

Syntax

public ref class CurrentAppSimulator abstract sealed  

Remarks

Until the app has been listed in the Microsoft Store, the CurrentApp object won’t work in the app. Use the CurrentAppSimulator to test your app’s licensing and in-app purchases while you develop your app. After you test your app and before you submit it to the Microsoft Store, replace the instances of CurrentAppSimulator with CurrentApp. Your app will fail certification if it uses CurrentAppSimulator.

Note

When using the simulation, the initial licensing state of the app is described in WindowsStoreProxy.xml. CurrentAppSimulator method that alter the license state, for example by buying a license or handling an in-app purchase, only update the license state of the object in memory. The contents of WindowsStoreProxy.xml are not changed. When the app starts again, the license state reverts to what is described in WindowsStoreProxy.xml.

The CurrentAppSimulator object gets its data from the WindowsStoreProxy.xml file. You must configure this file for the scenario that you want to simulate in the CurrentAppSimulator properties.

The contents of this file are defined by the SimulatedCurrentApp.xsd file included as an example later in this topic, and they reflect the organization of the objects and properties of the Windows.ApplicationModel.Store namespace.

The elements of this file are included in the CurrentApp root node and include:

• ListingInformation
  Represents data that would normal be found in the app’s listing and includes these elements:
  
  • App
    Represents data about the app and contains these elements:
    
    • AppId
      The GUID that identifies the app in the store. This can be any GUID for testing.
      
    • LinkUri
      The URI of the listing page in the store. This can be any valid URI for testing.
      
    • AgeRating
      An integer that represents the minimum age rating of the app. This is the same value you would specify in the Dashboard when you submit the app. The values used by the Microsoft Store are: 3, 7, 12, and 16.
      
    • CurrentMarket
      This is the customer’s country/region.
      For each country/region in which the app is listed, there must be a MarketData element.
      
      • MarketData
        Info about the app for this country/region.
        Requires the xml:lang attribute, which specifies the country/region for which this info applies.
        
      • Name
        The name of the app in this country/region.
        
      • Description
        The description of the app for this country/region.
        
      • Price
        The price of the app in this country/region.
        
      • CurrencySymbol
        The currency symbol used in this country/region.
        

      
      

    
    

  • Product
    Describes a product or a feature in this app that is enabled when the customer makes an in-app purchase.
    Requires the ProductId attribute, which contains the string used by the app to identify the product or feature.
    Requires the LicenseDuration attribute, which contains the number of days the license will be valid after the purchase. The expiration date of the new license created by a product purchase is the purchase date plus the license duration.
    
    • MarketData
      Info about the product or feature for this country/region.
      Requires the xml:lang attribute, which specifies the country/region for which this information applies.
      
    • Name
      The name of the product or feature in this country/region.
      
    • Price
      The price of the product or feature in this country/region.
      
    • CurrencySymbol
      The currency symbol used in this country/region.
      
    • CurrencyCode
      The currency code used in this country/region.
      

    
    

  
  

• LicenseInformation
  Represents data that describes the licenses available for this app and includes the following elements:
  
  • App
    Describes the app’s license:
    
    • IsActive
      Describes the current license state of this app.
      true indicates the license is valid. Normally this value is true, whether the app has a trial mode or not.
      false indicates an invalid license. Set this value to false to test how your app behaves when it has an invalid license.
      
    • IsTrial
      Describes the current trial state of this app.
      true indicates the app is being used during the trial period.
      false indicates the app is not in a trial, either because the app has been purchased or the trial period has expired.
      
    • ExpirationDate
      The date the trial period for this app expires. The date must be express as: yyyy-mm-ddThh:mm:ss.ssZ. For example, 05:00 on January 19, 2012 would be specified as 2012-01-19T05:00:00.00Z.
      If this element is required when IsTrial is true. Otherwise, it is not required.
      
    • DefaultResponse
      Describes the default error code returned by a given method. The MethodName attribute allows you to specify one of these methods:
      • RequestAppPurchaseAsync_GetResult
      • RequestProductPurchaseAsync_GetResult
      • LoadListingInformationAsync_GetResult

      The HResult attribute allows you to specify the error code. SimulatedCurrentApp.xsd contains the list of typical error codes you can use.
      

    
    

  • Product
    Describes the license status of a product or feature in the app:
    
    • IsActive
      Describes the current license state of this product or feature.
      true indicates the product or feature can be used.
      false indicates the product or feature cannot be used or has not been purchased.
      
    • ExpirationDate
      The date the product or feature expires. The date must be express as: yyyy-mm-ddThh:mm:ss.ssZ. For example, 05:00 on January 19, 2012 would be specified as 2012-01-19T05:00:00.00Z.
      If this element is present, the product or feature has an expiration date.
      If this element is not present, the product or feature does not expire.
      

    
    

  
  

• Simulation
  Describes how various method calls work. When the SimulationMode attribute is set to Automatic, the methods will automatically return the specified HRESULT error codes. This can be used when running automated test cases.
  

Requirements

Namespace: Windows.ApplicationModel.Store

Metadata: windows.winmd

See also

Reference

CurrentAppSimulator Members

Windows.ApplicationModel.Store Namespace