This topic has not yet been rated - Rate this topic

WebUIContactMapActivatedEventArgs class

Applies to Windows only

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

Syntax


/* For information about creating or accessing this object, see Remarks. */

Attributes

[MarshalingBehavior(Standard)]
[Version(0x06030000)]

Members

The WebUIContactMapActivatedEventArgs class has these types of members:

Methods

The WebUIContactMapActivatedEventArgs class inherits methods from the Object class (C#/VB/C++).

Properties

The WebUIContactMapActivatedEventArgs class has these properties.

PropertyAccess typeDescription

ActivatedOperation

Read-onlyGets the app activated operation.

Address

Read-onlyGets the address of a contact for the mapping operation.

Contact

Read-onlyGets the contact for the mapping operation.

Kind

Read-onlyGets the activation type.

PreviousExecutionState

Read-onlyGets the execution state of the app before it was activated.

SplashScreen

Read-onlyGets the splash screen object, which provides information about the transition from the splash screen to the activated app.

Verb

Read-onlyGets the action to be performed.

 

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:

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
        }
    }
}


Requirements

Minimum supported client

Windows 8.1 [Windows Store apps only]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

Windows.UI.WebUI

Metadata

Windows.winmd

See also

Object
IContactMapActivatedEventArgs
IContactActivatedEventArgs
IActivatedEventArgs
IActivatedEventArgsDeferral
Handling Contact Actions sample

 

 

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