ContactCallActivatedEventArgs class

Applies to Windows only

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

JavaScript:  This type appears as WebUIContactCallActivatedEventArgs.

Syntax


public sealed class ContactCallActivatedEventArgs : IContactCallActivatedEventArgs,
    IContactActivatedEventArgs,
    IActivatedEventArgs

Attributes

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

Members

The ContactCallActivatedEventArgs class has these types of members:

Properties

The ContactCallActivatedEventArgs class has these properties.

PropertyAccess typeDescription

Contact

Read-onlyGets the contact for the call.

Kind

Read-onlyGets the activation type.

PreviousExecutionState

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

ServiceId

Read-onlyGets the identifier of the service used for the call.

ServiceUserId

Read-onlyGets the user identifier of the service used for the call.

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 call their contacts from the Contact Card or Windows Search experience. By implementing the contact call activation contract, Windows can launch your app to make calls for the user.

To receive call 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 "call." You can then specify the "ServiceId" element to specify the type of calling you support. For example, if your app handles standard PSTN calls, you can specify a "ServiceId" of "telephone." If your app handles calling over a web based service, like Skype, you can specify the domain name of that service, for example "skype.com."

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

Note  To enable a user to set your app as their default calling app for PSTN numbers, your app must also support the “tel” URI scheme.

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="call" DesiredView="useLess">
        <m2:ServiceId>telephone</m2:ServiceId>
        <m2:ServiceId>skype.com</m2:ServiceId>
      </m2:LaunchAction>
    </m2:ContactLaunchActions>
  </m2:Contact>
</m2:Extension>


After you register in your manifest, your app can be activated for the contact call contract. When your app is activated, you can use the event information to identify the call activation and extract the parameters that help you complete the call 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 call activations for PSTN numbers and Skype Ids:


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

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

            if (callArgs.ServiceId == "telephone")
            {
                var phoneNumber = callArgs.ServiceUserId;
                //add calling logic for PSTN numbers
            }
            else if (callArgs.ServiceId == "skype.com")
            {
                var userId = callArgs.ServiceUserId;
                //add calling logic for Skype Ids
            }
        }
                
    }
}


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
IContactCallActivatedEventArgs
IContactActivatedEventArgs
IActivatedEventArgs
Handling Contact Actions sample

 

 

Show:
© 2014 Microsoft