CurrentApp.GetCustomerCollectionsIdAsync(String, String) Method

Definition

Retrieves a Microsoft Store ID key that can be used to query for product entitlements or to consume product entitlements that are owned by the current user.

public:
 static IAsyncOperation<Platform::String ^> ^ GetCustomerCollectionsIdAsync(Platform::String ^ serviceTicket, Platform::String ^ publisherUserId);
/// [Windows.Foundation.Metadata.RemoteAsync]
 static IAsyncOperation<winrt::hstring> GetCustomerCollectionsIdAsync(winrt::hstring const& serviceTicket, winrt::hstring const& publisherUserId);
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<string> GetCustomerCollectionsIdAsync(string serviceTicket, string publisherUserId);
function getCustomerCollectionsIdAsync(serviceTicket, publisherUserId)
Public Shared Function GetCustomerCollectionsIdAsync (serviceTicket As String, publisherUserId As String) As IAsyncOperation(Of String)

Parameters

serviceTicket
String

Platform::String

winrt::hstring

An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see Manage product entitlements from a service.

publisherUserId
String

Platform::String

winrt::hstring

An anonymous ID that identifies the current user in the context of services that you manage as the publisher of the current app. If you maintain user IDs in the context of your services, you can use this parameter to associate your ID for the current user with the new Microsoft Store ID key (the user ID will be embedded in the key). Otherwise, if you don't need to associate a user ID with the Microsoft Store ID key, you can pass any string value.

Returns

IAsyncOperation<String>

IAsyncOperation<Platform::String>

IAsyncOperation<winrt::hstring>

The collections ID key for the current user. This key is valid for 30 days.

Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v2.0)

Remarks

Publishers with catalogs of in-app purchases can use the Microsoft Store ID key in service-to-service calls to the Windows Store collections API to query for product entitlements or to consume product entitlements that are owned by the current user. An entitlement represents the customer's right to use an app or in-app product (IAP) that is published through the Windows Store. For more information, see Manage product entitlements from a service.

Applies to

See also