WalletItem
WalletItem
WalletItem
WalletItem
Class
Definition
Represents an item (data) that is stored in the wallet.
public : sealed class WalletItem : IWalletItempublic sealed class WalletItem : IWalletItemPublic NotInheritable Class WalletItem Implements IWalletItem// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
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) WalletItem(WalletItemKind, String) WalletItem(WalletItemKind, String) WalletItem(WalletItemKind, String)
Initializes a new instance of the WalletItem class.
public : WalletItem(WalletItemKind kind, PlatForm::String displayName)public WalletItem(WalletItemKind kind, String displayName)Public Sub New(kind As WalletItemKind, displayName As String)// You can use this method in JavaScript.
The type of wallet item.
- displayName
- PlatForm::String String String String
The display name of the item.
Properties
Barcode Barcode Barcode Barcode
Gets or sets the barcode that's representative of the wallet item.
public : WalletBarcode Barcode { get; set; }public WalletBarcode Barcode { get; set; }Public ReadWrite Property Barcode As WalletBarcode// You can use this property in JavaScript.
The barcode of the item.
- See Also
BodyBackgroundImage BodyBackgroundImage BodyBackgroundImage BodyBackgroundImage
Gets or sets the background image of the body of the wallet item (uses a stream).
public : IRandomAccessStreamReference BodyBackgroundImage { get; set; }public IRandomAccessStreamReference BodyBackgroundImage { get; set; }Public ReadWrite Property BodyBackgroundImage As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The background image of the body of the wallet item. This is a stream that contains the bitmap image.
- See Also
BodyFontColor BodyFontColor BodyFontColor BodyFontColor
Gets or sets the body font color of the wallet item.
public : Color BodyFontColor { get; set; }public Color BodyFontColor { get; set; }Public ReadWrite Property BodyFontColor As Color// You can use this property in JavaScript.
- See Also
DisplayMessage DisplayMessage DisplayMessage DisplayMessage
Gets or sets a string that appears next to the app name in About info.
public : PlatForm::String DisplayMessage { get; set; }public string DisplayMessage { get; set; }Public ReadWrite Property DisplayMessage As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A string that appears next to the app name in the About info associated with a wallet item.
DisplayName DisplayName DisplayName DisplayName
Gets or sets the name or title to be displayed to the user.
public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The display name of the wallet item.
DisplayProperties DisplayProperties DisplayProperties DisplayProperties
Gets the collection of WalletItemCustomProperty objects associated with the wallet item.
public : IMap<string, WalletItemCustomProperty> DisplayProperties { get; }public IDictionary<string, WalletItemCustomProperty> DisplayProperties { get; }Public ReadOnly Property DisplayProperties As IDictionary<string, WalletItemCustomProperty>// You can use this property in JavaScript.
- Value
- IMap<PlatForm::String, WalletItemCustomProperty> IDictionary<string, WalletItemCustomProperty> IDictionary<string, WalletItemCustomProperty> IDictionary<string, WalletItemCustomProperty>
The collection of WalletItemCustomProperty objects associated with the wallet item.
Remarks
The key for the DisplayProperties map is typically not used for the user UI. It's a programming identifier that you use to distinguish the individual custom properties. That identifier isn't part of the construction of a WalletItemCustomProperty; you choose it when you add one of the custom properties to the DisplayProperties collection.
ExpirationDate ExpirationDate ExpirationDate ExpirationDate
Gets or sets the expiration date of the wallet item.
public : IReference<DateTime> ExpirationDate { get; set; }public Nullable<DateTimeOffset> ExpirationDate { get; set; }Public ReadWrite Property ExpirationDate As Nullable<DateTimeOffset>// You can use this property in JavaScript.
- Value
- IReference<DateTime> Nullable<DateTimeOffset> Nullable<DateTimeOffset> Nullable<DateTimeOffset>
The expiration date of the item. Can be null (the default).
HeaderBackgroundImage HeaderBackgroundImage HeaderBackgroundImage HeaderBackgroundImage
Gets or sets the header background image of the wallet item.
public : IRandomAccessStreamReference HeaderBackgroundImage { get; set; }public IRandomAccessStreamReference HeaderBackgroundImage { get; set; }Public ReadWrite Property HeaderBackgroundImage As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The header background image of the item.
- See Also
HeaderColor HeaderColor HeaderColor HeaderColor
Gets or sets the header color of the wallet item.
public : Color HeaderColor { get; set; }public Color HeaderColor { get; set; }Public ReadWrite Property HeaderColor As Color// You can use this property in JavaScript.
- See Also
HeaderFontColor HeaderFontColor HeaderFontColor HeaderFontColor
Gets or sets the header font color of the wallet item.
public : Color HeaderFontColor { get; set; }public Color HeaderFontColor { get; set; }Public ReadWrite Property HeaderFontColor As Color// You can use this property in JavaScript.
- See Also
Id Id Id Id
Gets the unique identifier of the wallet item.
public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.
IsAcknowledged IsAcknowledged IsAcknowledged IsAcknowledged
Gets or sets whether this item is acknowledged by the app.
public : PlatForm::Boolean IsAcknowledged { get; set; }public bool IsAcknowledged { get; set; }Public ReadWrite Property IsAcknowledged As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
false if the item is new to the app (the default); Otherwise, true.
IsDisplayMessageLaunchable IsDisplayMessageLaunchable IsDisplayMessageLaunchable IsDisplayMessageLaunchable
Gets or sets whether to launch your app when the user taps on the DisplayMessage.
public : PlatForm::Boolean IsDisplayMessageLaunchable { get; set; }public bool IsDisplayMessageLaunchable { get; set; }Public ReadWrite Property IsDisplayMessageLaunchable As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if your app should launch when the users taps on the display message; Otherwise, false;
- See Also
IsMoreTransactionHistoryLaunchable IsMoreTransactionHistoryLaunchable IsMoreTransactionHistoryLaunchable IsMoreTransactionHistoryLaunchable
Gets or sets whether your app should be launched when the user taps "see more transaction history".
public : PlatForm::Boolean IsMoreTransactionHistoryLaunchable { get; set; }public bool IsMoreTransactionHistoryLaunchable { get; set; }Public ReadWrite Property IsMoreTransactionHistoryLaunchable As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if your app should be launched when the user taps on "see more transaction history", Otherwise, false.
Remarks
For more info on using Wallet activation, see the "Handling app activation by Wallet " section of Quickstart: Using the APIs.
- See Also
IssuerDisplayName IssuerDisplayName IssuerDisplayName IssuerDisplayName
Gets or sets the issuer name of the wallet item.
public : PlatForm::String IssuerDisplayName { get; set; }public string IssuerDisplayName { get; set; }Public ReadWrite Property IssuerDisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The issuer name of the wallet item.
Kind Kind Kind Kind
Gets the type of the wallet item.
public : WalletItemKind Kind { get; }public WalletItemKind Kind { get; }Public ReadOnly Property Kind As WalletItemKind// You can use this property in JavaScript.
The type of the item, as a value of the enumeration.
- See Also
LastUpdated LastUpdated LastUpdated LastUpdated
Gets or sets the date and time the data for this item was last updated.
public : IReference<DateTime> LastUpdated { get; set; }public Nullable<DateTimeOffset> LastUpdated { get; set; }Public ReadWrite Property LastUpdated As Nullable<DateTimeOffset>// You can use this property in JavaScript.
- Value
- IReference<DateTime> Nullable<DateTimeOffset> Nullable<DateTimeOffset> Nullable<DateTimeOffset>
The date and time the data for this item was last updated. Can be null (the default).
Logo159x159 Logo159x159 Logo159x159 Logo159x159
Gets or sets the medium (159 x 159) logo image of the wallet item.
public : IRandomAccessStreamReference Logo159x159 { get; set; }public IRandomAccessStreamReference Logo159x159 { get; set; }Public ReadWrite Property Logo159x159 As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The medium logo of the item, represented as a stream.
- See Also
Logo336x336 Logo336x336 Logo336x336 Logo336x336
Gets or sets the large (336 x 336) logo image of the wallet item.
public : IRandomAccessStreamReference Logo336x336 { get; set; }public IRandomAccessStreamReference Logo336x336 { get; set; }Public ReadWrite Property Logo336x336 As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The large logo of the item, represented as a stream.
- See Also
Logo99x99 Logo99x99 Logo99x99 Logo99x99
Gets or sets the small (99 x 99) logo image of the wallet item.
public : IRandomAccessStreamReference Logo99x99 { get; set; }public IRandomAccessStreamReference Logo99x99 { get; set; }Public ReadWrite Property Logo99x99 As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The small logo image of the item, represented as a stream.
- See Also
LogoImage LogoImage LogoImage LogoImage
Gets or sets the logo image of the wallet item. Use this property for a logo that doesn't have a specified size.
public : IRandomAccessStreamReference LogoImage { get; set; }public IRandomAccessStreamReference LogoImage { get; set; }Public ReadWrite Property LogoImage As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The logo image of the wallet item, represented as a stream.
- See Also
LogoText LogoText LogoText LogoText
Gets or sets the logo text of the wallet item.
public : PlatForm::String LogoText { get; set; }public string LogoText { get; set; }Public ReadWrite Property LogoText As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The logo text of the item.
PromotionalImage PromotionalImage PromotionalImage PromotionalImage
Gets or sets the promotional image of the wallet item.
public : IRandomAccessStreamReference PromotionalImage { get; set; }public IRandomAccessStreamReference PromotionalImage { get; set; }Public ReadWrite Property PromotionalImage As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The promotional image of the wallet item that will be displayed on back of the card, as a stream.
- See Also
RelevantDate RelevantDate RelevantDate RelevantDate
Gets or sets the date on which the item is valid.
public : IReference<DateTime> RelevantDate { get; set; }public Nullable<DateTimeOffset> RelevantDate { get; set; }Public ReadWrite Property RelevantDate As Nullable<DateTimeOffset>// You can use this property in JavaScript.
- Value
- IReference<DateTime> Nullable<DateTimeOffset> Nullable<DateTimeOffset> Nullable<DateTimeOffset>
The date on which the item is valid. Can be null (the default).
RelevantDateDisplayMessage RelevantDateDisplayMessage RelevantDateDisplayMessage RelevantDateDisplayMessage
Gets or sets the description of the relevant date of the wallet item.
public : PlatForm::String RelevantDateDisplayMessage { get; set; }public string RelevantDateDisplayMessage { get; set; }Public ReadWrite Property RelevantDateDisplayMessage As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The description of the relevant date of the wallet item.
RelevantLocations RelevantLocations RelevantLocations RelevantLocations
Gets a collection of all relevant locations for the wallet item.
public : IMap<string, WalletRelevantLocation> RelevantLocations { get; }public IDictionary<string, WalletRelevantLocation> RelevantLocations { get; }Public ReadOnly Property RelevantLocations As IDictionary<string, WalletRelevantLocation>// You can use this property in JavaScript.
- Value
- IMap<PlatForm::String, WalletRelevantLocation> IDictionary<string, WalletRelevantLocation> IDictionary<string, WalletRelevantLocation> IDictionary<string, WalletRelevantLocation>
A collection of all relevant locations for the wallet item
Remarks
The string key for items in this collection is usually a programmatic identifier that isn't intended for user UI. Data within a WalletRelevantLocation value is sometimes intended for UI.
Each WalletRelevantLocation value has a Position property to capture a BasicGeoposition value, and associates each position with a position-specific display message. You can see example code for this in Quickstart: Using the APIs.
TransactionHistory TransactionHistory TransactionHistory TransactionHistory
Gets the transaction history collection of the wallet item.
public : IMap<string, WalletTransaction> TransactionHistory { get; }public IDictionary<string, WalletTransaction> TransactionHistory { get; }Public ReadOnly Property TransactionHistory As IDictionary<string, WalletTransaction>// You can use this property in JavaScript.
- Value
- IMap<PlatForm::String, WalletTransaction> IDictionary<string, WalletTransaction> IDictionary<string, WalletTransaction> IDictionary<string, WalletTransaction>
The transaction history collection of the item. This is a keyed map of WalletTransaction items.
Verbs Verbs Verbs Verbs
Gets the collection of WalletVerb objects associated with the wallet item.
public : IMap<string, WalletVerb> Verbs { get; }public IDictionary<string, WalletVerb> Verbs { get; }Public ReadOnly Property Verbs As IDictionary<string, WalletVerb>// You can use this property in JavaScript.
- Value
- IMap<PlatForm::String, WalletVerb> IDictionary<string, WalletVerb> IDictionary<string, WalletVerb> IDictionary<string, WalletVerb>
The collection of WalletVerb objects associated with the wallet item.