WalletItem Class

Definition

Namespace:

Windows.ApplicationModel.Wallet

Caution

The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace.

Represents an item (data) that is stored in the wallet.

public ref class WalletItem sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Activatable(Windows.ApplicationModel.Wallet.IWalletItemFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Deprecated("WalletItem is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 917504, "Windows.Foundation.UniversalApiContract")]
class WalletItem final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.ApplicationModel.Wallet.IWalletItemFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Deprecated("WalletItem is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 917504, "Windows.Foundation.UniversalApiContract")]
public sealed class WalletItem

function WalletItem(kind, displayName)

Public NotInheritable Class WalletItem

Inheritance

Object Platform::Object IInspectable WalletItem

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute DeprecatedAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Use the WalletItem constructor if you're defining a new item to insert into the wallet. Use methods of WalletItemStore such as GetWalletItemAsync or GetItemsAsync if you're retrieving existing items from the wallet.

If you modify/set any of the properties in an existing WalletItem (including the WalletItemCustomProperty values in DisplayProperties), call WalletItemStore.UpdateAsync to commit these changes to the backing store. You can see example code for this in Quickstart: Using the APIs.

Constructors

WalletItem(WalletItemKind, String)

Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Initializes a new instance of the WalletItem class.

Properties

Barcode	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the barcode that's representative of the wallet item.
BodyBackgroundImage	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the background image of the body of the wallet item (uses a stream).
BodyColor	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the body color of the wallet item.
BodyFontColor	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the body font color of the wallet item.
DisplayMessage	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets a string that appears next to the app name in About info.
DisplayName	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the name or title to be displayed to the user.
DisplayProperties	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets the collection of WalletItemCustomProperty objects associated with the wallet item.
ExpirationDate	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the expiration date of the wallet item.
HeaderBackgroundImage	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the header background image of the wallet item.
HeaderColor	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the header color of the wallet item.
HeaderFontColor	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the header font color of the wallet item.
Id	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets the unique identifier of the wallet item.
IsAcknowledged	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets whether this item is acknowledged by the app.
IsDisplayMessageLaunchable	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets whether to launch your app when the user taps on the DisplayMessage.
IsMoreTransactionHistoryLaunchable	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets whether your app should be launched when the user taps "see more transaction history".
IssuerDisplayName	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the issuer name of the wallet item.
Kind	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets the type of the wallet item.
LastUpdated	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the date and time the data for this item was last updated.
Logo159x159	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the medium (159 x 159) logo image of the wallet item.
Logo336x336	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the large (336 x 336) logo image of the wallet item.
Logo99x99	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the small (99 x 99) logo image of the wallet item.
LogoImage	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the logo image of the wallet item. Use this property for a logo that doesn't have a specified size.
LogoText	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the logo text of the wallet item.
PromotionalImage	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the promotional image of the wallet item.
RelevantDate	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the date on which the item is valid.
RelevantDateDisplayMessage	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets or sets the description of the relevant date of the wallet item.
RelevantLocations	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets a collection of all relevant locations for the wallet item.
TransactionHistory	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets the transaction history collection of the wallet item.
Verbs	Caution The ApplicationModel.Wallet namespace is no longer supported, and will soon be deprecated. Developers are encouraged to avoid using this namespace. Gets the collection of WalletVerb objects associated with the wallet item.

See also

• WalletItemStore
• WalletManager
• Quickstart: Using the APIs