WebUIContactMessageActivatedEventArgs WebUIContactMessageActivatedEventArgs WebUIContactMessageActivatedEventArgs WebUIContactMessageActivatedEventArgs Class

Definition

public : sealed class WebUIContactMessageActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactMessageActivatedEventArgs, IActivatedEventArgsDeferralpublic sealed class WebUIContactMessageActivatedEventArgs : IActivatedEventArgs, IContactActivatedEventArgs, IContactMessageActivatedEventArgs, IActivatedEventArgsDeferralPublic NotInheritable Class WebUIContactMessageActivatedEventArgs Implements IActivatedEventArgs, IContactActivatedEventArgs, IContactMessageActivatedEventArgs, IActivatedEventArgsDeferral// You can use this class in JavaScript.

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Examples

JavaScript

function activated(eventObject) {
    if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.contact) {
        if (eventObject.detail.verb === Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.message) {

     //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 messaging logic for PSTN numbers
            }
     else if (eventObject.detail.serviceId === "skype.com") {
                var userId = eventObject.detail.serviceUserId;
  //add messaging 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.

Windows 8.1 allows users to message their contacts from the Contact Card or Windows Search experience. By implementing the contact message activation contract, Windows can launch your app to send messages for the user.

To receive message 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 "message." You can then specify the "ServiceId" element to specify the type of messaging you support. For example, if your app handles standard text messages, you can specify a "ServiceId" of "telephone." If your app handles messaging 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 messages.

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="message" DesiredView="useLess">
        <m2:ServiceId>telephone</m2:ServiceId>
      </m2:LaunchAction>
      <m2:LaunchAction Verb="message" DesiredView="useLess">
        <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 message contract. When your app is activated, you can use the event information to identify the message activation and extract the parameters that help you complete the messaging scenario for the user.

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

public : ActivatedOperation ActivatedOperation { get; }public ActivatedOperation ActivatedOperation { get; }Public ReadOnly Property ActivatedOperation As ActivatedOperation// You can use this property in JavaScript.

public : Contact Contact { get; }public Contact Contact { get; }Public ReadOnly Property Contact As Contact// You can use this property in JavaScript.

public : ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind// You can use this property in JavaScript.

public : ApplicationExecutionState PreviousExecutionState { get; }public ApplicationExecutionState PreviousExecutionState { get; }Public ReadOnly Property PreviousExecutionState As ApplicationExecutionState// You can use this property in JavaScript.

public : PlatForm::String ServiceId { get; }public string ServiceId { get; }Public ReadOnly Property ServiceId As string// You can use this property in JavaScript.

public : PlatForm::String ServiceUserId { get; }public string ServiceUserId { get; }Public ReadOnly Property ServiceUserId As string// You can use this property in JavaScript.

public : SplashScreen SplashScreen { get; }public SplashScreen SplashScreen { get; }Public ReadOnly Property SplashScreen As SplashScreen// You can use this property in JavaScript.

public : PlatForm::String Verb { get; }public string Verb { get; }Public ReadOnly Property Verb As string// You can use this property in JavaScript.

See Also

• Handling Contact Actions sample