WebUIContactCallActivatedEventArgs WebUIContactCallActivatedEventArgs WebUIContactCallActivatedEventArgs WebUIContactCallActivatedEventArgs WebUIContactCallActivatedEventArgs Class

Definition

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

public : sealed class WebUIContactCallActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactCallActivatedEventArgs, IActivatedEventArgsDeferral
struct winrt::Windows::UI::WebUI::WebUIContactCallActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactCallActivatedEventArgs, IActivatedEventArgsDeferral
public sealed class WebUIContactCallActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactCallActivatedEventArgs, IActivatedEventArgsDeferral
Public NotInheritable Class WebUIContactCallActivatedEventArgs Implements IActivatedEventArgs, IContactActivatedEventArgs, IContactCallActivatedEventArgs, 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.call) {

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

            if (eventObject.detail.serviceId === "telephone") {
                var phoneNumber = eventObject.detail.serviceUserId;
  //add calling logic for PSTN numbers
            }
     else if (eventObject.detail.serviceId === "skype.com") {
                var userId = eventObject.detail.serviceUserId;
  //add calling logic for Skype Ids
            }
        }
    }
}

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

Here is an example of the code you need to handle contact call activations for PSTN numbers and Skype Ids:

Properties

ActivatedOperation ActivatedOperation ActivatedOperation ActivatedOperation ActivatedOperation

Gets the app activated operation.

Contact Contact Contact Contact Contact

Gets the contact for the call.

Kind Kind Kind Kind Kind

Gets the activation type.

PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState

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

ServiceId ServiceId ServiceId ServiceId ServiceId

Gets the identifier of the service used for the call.

ServiceUserId ServiceUserId ServiceUserId ServiceUserId ServiceUserId

Gets the user identifier of the service used for the call.

SplashScreen SplashScreen SplashScreen SplashScreen SplashScreen

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

Verb Verb Verb Verb Verb

Gets the action to be performed.

See also