This topic has not yet been rated - Rate this topic

WalletAgent Class

April 12, 2014

An implementation of a BackgroundAgent specifically designed to enable a wallet app to be notified about wallet operations related to wallet items specific to that app.

System.Object
  Microsoft.Phone.BackgroundAgent
    Microsoft.Phone.Wallet.WalletAgent

Namespace:  Microsoft.Phone.Wallet
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)
public abstract class WalletAgent : BackgroundAgent

The WalletAgent type exposes the following members.

  NameDescription
Protected methodWalletAgentInitializes a new instance of the WalletAgent class.
Top
  NameDescription
Protected methodAbortInforms the operating system that the agent is unable to perform its intended task and that it should not be launched again until the foreground application mitigates the blocking issue and reenables the agent. (Inherited from BackgroundAgent.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodNotifyCompleteInforms the operating system that the agent has completed its intended task for the current invocation of the agent. (Inherited from BackgroundAgent.)
Protected methodNotifyCompleteWithResultInforms the operating system that the agent has completed its intended task for the current invocation of the agent. Call this method after successfully handling an invocation with a result. (Inherited from BackgroundAgent.)
Protected methodOnCancelCalled by the operating system to alert a background agent that it is going to be put into a dormant state or terminated. (Inherited from BackgroundAgent.)
Protected methodOnRefreshDataWhen overridden in a derived class, represents the method that handles the notification to refresh data for the given wallet items.
Protected methodOnSecureElementItemActionWhen overridden in a derived class, represents the method that will handle the OnSecureElementItemAction event, requesting that the agent perform an operation on the given wallet item.
Protected methodOnUserActionWhen overridden in a derived class, represents the method that will handle the notification that an action has been performed on a wallet item.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Capabilities

If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.

ID_CAP_WALLET

Windows Phone 8

For more info, see App capabilities and hardware requirements for Windows Phone 8.

Caution noteCaution:

This API is not supported for Silverlight 8.1 apps.

Windows Phone OS

Supported in: 8.1, 8.0
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.