WebUIContactMapActivatedEventArgs WebUIContactMapActivatedEventArgs WebUIContactMapActivatedEventArgs WebUIContactMapActivatedEventArgs Class

Definition

Provides data when an app is activated to map a contact.

public : sealed class WebUIContactMapActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactMapActivatedEventArgs, IActivatedEventArgsDeferral
public sealed class WebUIContactMapActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactMapActivatedEventArgs, IActivatedEventArgsDeferral
Public NotInheritable Class WebUIContactMapActivatedEventArgs Implements IActivatedEventArgs, IContactActivatedEventArgs, IContactMapActivatedEventArgs, IActivatedEventArgsDeferral
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.ApplicationModel.Activation.ContactActivatedEventsContract (introduced v1)

Examples

JavaScript

function activated(eventObject) {
    if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.contact) {
        if (eventObject.detail.verb === Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.map) {

     //get contact display info
            var contactName = eventObject.detail.contact.displayName;
            var contactThumbnail = eventObject.detail.contact.thumbnail;

            var address = eventObject.detail.address;
     //add mapping logic
        }
    }
}

Remarks

This object is accessed when you implement an event handler for the WinJS.Application.Onactivated or the Windows.UI.WebUI.WebUIApplication.activated events when ActivationKind is contact.

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).

Windows 8.1 allows users to map their contacts' locations from the Contact Card or Windows Search experience. By implementing the contact map activation contract, Windows can launch your app to map locations for the user.

To receive map activations, your app must register for the "windows.contact" extension category in its manifest. Under this extension, you must include a "LaunchAction" element with the "Verb" attribute equal to "map."

If multiple apps have registered for this contract, the user can choose one of them as their default for handling mapping.

Here is an example for manifest registration:


<m2:Extension Category="windows.contact" xmlns:m2="http://schemas.microsoft.com/appx/2013/manifest">
  <m2:Contact>
    <m2:ContactLaunchActions>
      <m2:LaunchAction Verb="map" DesiredView="useHalf"/>
    </m2:ContactLaunchActions>
  </m2:Contact>
</m2:Extension>

After you register in your manifest, your app can be activated for the contact map contract. When your app is activated, you can use the event information to identify the map activation and extract the parameters that help you complete the mapping scenario for the user.

Here is an example of the code you need to handle contact map activations:

Properties

ActivatedOperation ActivatedOperation ActivatedOperation ActivatedOperation

Gets the app activated operation.

public : ActivatedOperation ActivatedOperation { get; }
public ActivatedOperation ActivatedOperation { get; }
Public ReadOnly Property ActivatedOperation As ActivatedOperation
var activatedOperation = webuiContactMapActivatedEventArgs.activatedOperation;

Address Address Address Address

Gets the address of a contact for the mapping operation.

public : ContactAddress Address { get; }
public ContactAddress Address { get; }
Public ReadOnly Property Address As ContactAddress
var contactAddress = webuiContactMapActivatedEventArgs.address;
Value
ContactAddress ContactAddress ContactAddress ContactAddress

The address of a contact for the mapping operation.

Contact Contact Contact Contact

Gets the contact for the mapping operation.

public : Contact Contact { get; }
public Contact Contact { get; }
Public ReadOnly Property Contact As Contact
var contact = webuiContactMapActivatedEventArgs.contact;
Value
Contact Contact Contact Contact

The contact for the mapping operation.

Remarks

Use the Contact property to collect additional info about the contact that is being mapped. The contact can have a name and thumbnail that can be used to represent it in your app's UI. Or, the contact can have alternative addresses that can be used.

Here are possible Contact properties that can be populated during a map activation:

Kind Kind Kind Kind

Gets the activation type.

public : ActivationKind Kind { get; }
public ActivationKind Kind { get; }
Public ReadOnly Property Kind As ActivationKind
var activationKind = webuiContactMapActivatedEventArgs.kind;

PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState

Gets the execution state of the app before it was activated.

public : ApplicationExecutionState PreviousExecutionState { get; }
public ApplicationExecutionState PreviousExecutionState { get; }
Public ReadOnly Property PreviousExecutionState As ApplicationExecutionState
var applicationExecutionState = webuiContactMapActivatedEventArgs.previousExecutionState;

SplashScreen SplashScreen SplashScreen SplashScreen

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

public : SplashScreen SplashScreen { get; }
public SplashScreen SplashScreen { get; }
Public ReadOnly Property SplashScreen As SplashScreen
var splashScreen = webuiContactMapActivatedEventArgs.splashScreen;
Value
SplashScreen SplashScreen SplashScreen SplashScreen

The object that provides splash screen information.

Verb Verb Verb Verb

Gets the action to be performed.

public : Platform::String Verb { get; }
public string Verb { get; }
Public ReadOnly Property Verb As string
var string = webuiContactMapActivatedEventArgs.verb;
Value
Platform::String string string string

The action to be performed.

Remarks

Use the Verb property to determine the action to perform when your app is activated with ActivationKind.Contact. For map activations, the Verb property is set to the value of Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map.

See Also