ProductListing class

ProductListing class

Provides localized information that details an in-app product.

Syntax


/* For information about creating or accessing this object, see Remarks. */

Members

The ProductListing class has these types of members:

Properties

The ProductListing class has these properties.

PropertyAccess typeDescription

CurrencyCode

Read-only

Gets the currency code associated with the user's market, such as USD or CAD.

Description

Read-only

Gets the description for the in-app product.

FormattedBasePrice

Read-only

Gets the base price for the in-app product with the appropriate formatting for the current market.

FormattedPrice

Read-only

Gets the purchase price for the in-app product with the appropriate formatting for the current market.

ImageUri

Read-only

Gets the URI of the image associated with the in-app product.

IsOnSale

Read-only

Gets a value that indicates whether the in-app product is on sale.

Keywords

Read-only

Gets the list of keywords associated with the in-app product. These keywords are useful for filtering product lists by keyword, for example, when calling LoadListingInformationByKeywordsAsync.

Name

Read-only

Gets the descriptive name of the in-app product that is displayed customers in the current market.

ProductId

Read-only

Gets the in-app product ID.

ProductType

Read-only

Gets the type of this in-app product. Possible values are defined by ProductType.

SaleEndDate

Read-only

Gets the end date of the sale period for the in-app product.

Tag

Read-only

Gets the tag string that contains custom information about an in-app product (IAP). This string corresponds to the value of the Tag field in the properties page for the IAP in the Windows Dev Center dashboard.

 

Remarks

You access this object by picking an element of the collection that the ProductListings property of the ListingInformation object returns as this code example shows.


// get current app object using the simulator interface
currentApp = Windows.ApplicationModel.Store.CurrentAppSimulator;

// get the listing information for the products this app supports
currentApp.loadListingInformationAsync().then(
    function (listing) {
        // loadListingInformationAsync returns the ListingInformation object in listing.
        // get the product listing collection from the ProductListings property.
        thisAppsProducts = listing.productListings;
        // now get a specific product.
        thisProduct = thisAppsProducts.lookup("product1");
    }
);


Examples

The code example here shows how to get the ListingInformation from simulated app data and then get the ProductListing object an in-app product.


// get current app object using the simulator interface
currentApp = Windows.ApplicationModel.Store.CurrentAppSimulator;

// get the listing information for the products this app supports
currentApp.loadListingInformationAsync().then(
    function (listing) {
        // loadListingInformationAsync returns the ListingInformation object in listing.
        // now get info about a specific product and write it to the screen.
        thisProduct = listing.productListings.lookup("product1");
        id("purchasePrice").innerText = "You can buy " + thisProduct.name +
            " for: " + thisProduct.formattedPrice + ".";
    }
);


Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.ApplicationModel.Store
Windows::ApplicationModel::Store [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8

Namespace

Windows.ApplicationModel.Store
Windows::ApplicationModel::Store [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]

See also

Object
ListingInformation
ProductListings

 

 

Show:
© 2016 Microsoft