WebUIContactMapActivatedEventArgs Class

Reference

Definition

Namespace:: Windows.UI.WebUI

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

public ref class WebUIContactMapActivatedEventArgs sealed : IActivatedEventArgs, IContactMapActivatedEventArgs, IActivatedEventArgsDeferral

/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Activation.ContactActivatedEventsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class WebUIContactMapActivatedEventArgs final : IActivatedEventArgs, IContactMapActivatedEventArgs, IActivatedEventArgsDeferral

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Activation.ContactActivatedEventsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class WebUIContactMapActivatedEventArgs : IActivatedEventArgs, IContactMapActivatedEventArgs, IActivatedEventArgsDeferral

Public NotInheritable Class WebUIContactMapActivatedEventArgs
Implements IActivatedEventArgs, IActivatedEventArgsDeferral, IContactMapActivatedEventArgs

Inheritance: Object Platform::Object IInspectable WebUIContactMapActivatedEventArgs

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Implements: IActivatedEventArgs IContactActivatedEventArgs IContactMapActivatedEventArgs IActivatedEventArgsDeferral

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.10240.0)
API contract	Windows.ApplicationModel.Activation.ContactActivatedEventsContract (introduced in v1.0)

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	Gets the app activated operation.
Address	Gets the address of a contact for the mapping operation.
Contact	Gets the contact for the mapping operation.
Kind	Gets the activation type.
PreviousExecutionState	Gets the execution state of the app before it was activated.
SplashScreen	Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.
Verb	Gets the action to be performed.

Applies to

Dela via