Web​UI​Contact​Call​Activated​Event​Args Web​UI​Contact​Call​Activated​Event​Args Web​UI​Contact​Call​Activated​Event​Args Class

Definition

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

public : sealed class WebUIContactCallActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactCallActivatedEventArgs, IActivatedEventArgsDeferralpublic sealed class WebUIContactCallActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactCallActivatedEventArgs, IActivatedEventArgsDeferralPublic NotInheritable Class WebUIContactCallActivatedEventArgs Implements IActivatedEventArgs, IContactActivatedEventArgs, IContactCallActivatedEventArgs, IActivatedEventArgsDeferral
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

Gets the app activated operation.

public : ActivatedOperation ActivatedOperation { get; }public ActivatedOperation ActivatedOperation { get; }Public ReadOnly Property ActivatedOperation As ActivatedOperation
Value
ActivatedOperation ActivatedOperation ActivatedOperation

The activation operation.

Attributes

Contact Contact Contact

Gets the contact for the call.

public : Contact Contact { get; }public Contact Contact { get; }Public ReadOnly Property Contact As Contact
Value
Contact Contact Contact

The contact for the call.

Attributes

Remarks

Use the Contact property to collect additional info about the contact that is being called. The contact can have a name and thumbnail that can be used to represent it in your app’s UI. Or, the contact can have alternative user ids that can be used in case the primary user id is unavailable. The ConnectedServiceAccounts property contains a list of all services available for the contact. You can use the ContactConnectedServiceAccount.ServiceName and ContactConnectedServiceAccount.Id properties on each service to retrieve alternative services and user ids respectively.

Here are possible Contact properties that can be populated during a call activation:

Kind Kind Kind

Gets the activation type.

public : ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind
Attributes

PreviousExecutionState PreviousExecutionState PreviousExecutionState

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

public : ApplicationExecutionState PreviousExecutionState { get; }public ApplicationExecutionState PreviousExecutionState { get; }Public ReadOnly Property PreviousExecutionState As ApplicationExecutionState
Attributes

ServiceId ServiceId ServiceId

Gets the identifier of the service used for the call.

public : PlatForm::String ServiceId { get; }public string ServiceId { get; }Public ReadOnly Property ServiceId As string
Value
PlatForm::String string string

The identifier of the service used for the call.

Attributes

Remarks

For PSTN calls, the ServiceId property is set to "telephone." For web-based services, the ServiceId property is set to the domain name of the service to be used for calling, for example “skype.com”. Your app will only receive call activations for ServiceIds that match the "ServiceId" elements that your app has registered in its manifest.

ServiceUserId ServiceUserId ServiceUserId

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

public : PlatForm::String ServiceUserId { get; }public string ServiceUserId { get; }Public ReadOnly Property ServiceUserId As string
Value
PlatForm::String string string

The user identifier of the service used for the call.

Attributes

Remarks

For PSTN calls, the ServiceUserId property is set to the PSTN number for the contact. For web-based services, the ServiceUserId property is set to the contact’s user id for that particular service.

SplashScreen SplashScreen SplashScreen

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

public : SplashScreen SplashScreen { get; }public SplashScreen SplashScreen { get; }Public ReadOnly Property SplashScreen As SplashScreen
Value
SplashScreen SplashScreen SplashScreen

The object that provides splash screen information.

Attributes

Verb Verb Verb

Gets the action to be performed.

public : PlatForm::String Verb { get; }public string Verb { get; }Public ReadOnly Property Verb As string
Value
PlatForm::String string string

The action to be performed.

Attributes

Remarks

Use the Verb property to determine the action to perform when your app is activated with ActivationKind.Contact. For call activations, the Verb property is set to the value of Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Call.

See Also