StoreQueueItem StoreQueueItem StoreQueueItem StoreQueueItem StoreQueueItem Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents info about a new or updated package that is in the download and installation queue for the current app.

public : sealed class StoreQueueItem : IStoreQueueItem
struct winrt::Windows::Services::Store::StoreQueueItem : IStoreQueueItem
public sealed class StoreQueueItem : IStoreQueueItem
Public NotInheritable Class StoreQueueItem Implements IStoreQueueItem
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 Insider Preview (introduced v10.0.17095.0)
API contract
Windows.Services.Store.StoreContract (introduced v3)

Properties

InstallKind InstallKind InstallKind InstallKind InstallKind

Prerelease. Gets a value that describes the operation being performed for the current package in the download and installation queue.

public : StoreQueueItemKind InstallKind { get; }
StoreQueueItemKind InstallKind();
public StoreQueueItemKind InstallKind { get; }
Public ReadOnly Property InstallKind As StoreQueueItemKind
var storeQueueItemKind = storeQueueItem.installKind;
Value
StoreQueueItemKind StoreQueueItemKind StoreQueueItemKind

A value that describes the operation being performed for the current package in the download and installation queue.

PackageFamilyName PackageFamilyName PackageFamilyName PackageFamilyName PackageFamilyName

Prerelease. Gets the package family name of the current package in the queue.

public : Platform::String PackageFamilyName { get; }
winrt::hstring PackageFamilyName();
public string PackageFamilyName { get; }
Public ReadOnly Property PackageFamilyName As string
var string = storeQueueItem.packageFamilyName;
Value
string string string

The package family name of the current package in the queue.

See Also

ProductId ProductId ProductId ProductId ProductId

Prerelease. Gets the add-on product ID of the current package in the queue, if the package corresponds to an add-on.

public : Platform::String ProductId { get; }
winrt::hstring ProductId();
public string ProductId { get; }
Public ReadOnly Property ProductId As string
var string = storeQueueItem.productId;
Value
string string string

The add-on product ID of the current package in the queue.

See Also

Methods

GetCurrentStatus() GetCurrentStatus() GetCurrentStatus() GetCurrentStatus() GetCurrentStatus()

Prerelease. Returns the status of the current package in the queue.

public : StoreQueueItemStatus GetCurrentStatus()
StoreQueueItemStatus GetCurrentStatus() const;
public StoreQueueItemStatus GetCurrentStatus()
Public Function GetCurrentStatus() As StoreQueueItemStatus
var storeQueueItemStatus = storeQueueItem.getCurrentStatus();
Returns

An object that represents the status of the current package in the queue.

Events

Completed Completed Completed Completed Completed

Prerelease. Raised when the download and installation of the current package in the queue is completed.

public : event TypedEventHandler Completed<StoreQueueItem, StoreQueueItemCompletedEventArgs>
// Register
event_token Completed(TypedEventHandler<StoreQueueItem, StoreQueueItemCompletedEventArgs> const& handler) const;

// Revoke with event_token
void Completed(event_token const& cookie) const;

// Revoke with event_revoker
Completed_revoker Completed(auto_revoker_t, TypedEventHandler<StoreQueueItem, StoreQueueItemCompletedEventArgs> const& handler) const;
public event TypedEventHandler Completed<StoreQueueItem, StoreQueueItemCompletedEventArgs>
Public Event TypedEventHandler Completed( Of ( Of StoreQueueItem ), ( Of StoreQueueItemCompletedEventArgs ))
function onCompleted(eventArgs){/* Your code */}


storeQueueItem.addEventListener("completed", onCompleted);
storeQueueItem.removeEventListener("completed", onCompleted);

StatusChanged StatusChanged StatusChanged StatusChanged StatusChanged

Prerelease. Raised when the status of the current package in the queue changes.

public : event TypedEventHandler StatusChanged<StoreQueueItem, object>
// Register
event_token StatusChanged(TypedEventHandler<StoreQueueItem, object> const& handler) const;

// Revoke with event_token
void StatusChanged(event_token const& cookie) const;

// Revoke with event_revoker
StatusChanged_revoker StatusChanged(auto_revoker_t, TypedEventHandler<StoreQueueItem, object> const& handler) const;
public event TypedEventHandler StatusChanged<StoreQueueItem, object>
Public Event TypedEventHandler StatusChanged( Of ( Of StoreQueueItem ), ( Of object ))
function onStatusChanged(eventArgs){/* Your code */}


storeQueueItem.addEventListener("statusChanged", onStatusChanged);
storeQueueItem.removeEventListener("statusChanged", onStatusChanged);