ContactMapActivatedEventArgs class

Applies to Windows only

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

JavaScript:  This type appears as WebUIContactMapActivatedEventArgs.

Syntax


public sealed class ContactMapActivatedEventArgs : IContactMapActivatedEventArgs,
    IContactActivatedEventArgs,
    IActivatedEventArgs

Attributes

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

Members

The ContactMapActivatedEventArgs class has these types of members:

Properties

The ContactMapActivatedEventArgs class has these properties.

PropertyAccess typeDescription

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

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.

For info about how to handle app activation through contact actions, see Quickstart: Handling contact actions (XAML) and Quickstart: Handling contact actions (HTML).

Examples

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


protected override void OnActivated(IActivatedEventArgs args)
{
    if (args.Kind == ActivationKind.Contact)
    {
        var contactArgs = args as IContactActivatedEventArgs;
        if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Map)
        { 
            IContactMapActivatedEventArgs mapArgs = contactArgs as IContactMapActivatedEventArgs;

     //get contact display info
     var contactName = mapArgs.Contact.DisplayName;
            var contactThumbnail = mapArgs.Contact.Thumbnail;

            var address = mapArgs.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.ApplicationModel.Activation
Windows::ApplicationModel::Activation [C++]

Metadata

Windows.winmd

See also

Object
IContactMapActivatedEventArgs
IContactActivatedEventArgs
IActivatedEventArgs
Handling Contact Actions sample

 

 

Show:
© 2014 Microsoft