StoreContext.GetAppAndOptionalStorePackageUpdatesAsync Method

public:
 virtual IAsyncOperation<IVectorView<StorePackageUpdate ^> ^> ^ GetAppAndOptionalStorePackageUpdatesAsync() = GetAppAndOptionalStorePackageUpdatesAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<StorePackageUpdate>> GetAppAndOptionalStorePackageUpdatesAsync();

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<StorePackageUpdate>> GetAppAndOptionalStorePackageUpdatesAsync();

function getAppAndOptionalStorePackageUpdatesAsync()

Public Function GetAppAndOptionalStorePackageUpdatesAsync () As IAsyncOperation(Of IReadOnlyList(Of StorePackageUpdate))

Returns

An asynchronous operation that, on successful completion, returns a collection of StorePackageUpdate objects that represent the packages that have updates available.

Attributes

RemoteAsyncAttribute

Exceptions

Remarks

For more information about using this method, including a code example, see Download and install package updates for your app.

After you call GetAppAndOptionalStorePackageUpdatesAsync to determine which packages have updates available, you can call RequestDownloadStorePackageUpdatesAsync to download the updated packages or you can call RequestDownloadAndInstallStorePackageUpdatesAsync to download and install the updated packages.

Prerequisites and Environment Requirements

For this method to work correctly, the following conditions must be met:

• Microsoft Store app: The Microsoft Store app must be installed and functional on the system.
• Microsoft account: While a signed-in Microsoft account is not strictly required to check for updates, certain scenarios may require authentication.
• Store services: The Microsoft Store licensing and update services must be running and accessible.
• Network connectivity: An active internet connection is required to communicate with the Microsoft Store service.

Assigned Access Mode Compatibility

This method can be used in Assigned Access (kiosk) mode, but the following considerations apply:

• The assigned access account must have permission to access Microsoft Store services.
• Network access must be configured to allow communication with Microsoft Store endpoints.
• Some Store UI elements may be restricted depending on the assigned access configuration.

Error Handling Recommendations

When calling this method, it's recommended to implement proper error handling:

try
{
    var updates = await storeContext.GetAppAndOptionalStorePackageUpdatesAsync();
    // Process updates
}
catch (System.Runtime.InteropServices.COMException ex)
{
    // Handle COM-related errors (e.g., threading issues)
}
catch (System.Exception ex)
{
    // Handle Store service errors (e.g., service unavailable)
    // Log the error and implement appropriate retry logic
}

Update availability

After you publish an app update in Partner Center, there can be a short delay between when the package passes certification and when the GetAppAndOptionalStorePackageUpdatesAsync method recognizes that the update is available. Most updates become available within a couple hours, but some publishing and distribution steps may take longer to finish in certain cases.

Detection frequency

This API limits how often it checks for new updates. When an app calls the method more frequently than the allowed rate, the method returns the last known status instead of performing a new check.

The current limits are:

• No more than one check every 30 minutes.
• No more than ten checks within any 24-hour period.

If an app exceeds these limits, the method continues returning the previous status until the applicable time window passes.

See also

• Download and install package updates for your app
• Optional packages and related set authoring