ContactVideoCallActivatedEventArgs class

Applies to Windows only

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

JavaScript:  This type appears as WebUIContactVideoCallActivatedEventArgs.

Syntax


public sealed class ContactVideoCallActivatedEventArgs : IContactVideoCallActivatedEventArgs,
    IContactActivatedEventArgs,
    IActivatedEventArgs

Attributes

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

Members

The ContactVideoCallActivatedEventArgs class has these types of members:

Properties

The ContactVideoCallActivatedEventArgs class has these properties.

PropertyAccess typeDescription

Contact

Read-onlyGets the contact for the video 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 video call.

ServiceUserId

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

To receive video 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 "videoCall." You can then specify the "ServiceId" element to specify the domain name of the service that your app can video call over, for example "skype.com."

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

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="videoCall" DesiredView="useHalf">
        <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 video call contract. When your app is activated, you can use the event information to identify the video call activation and extract the parameters that help you complete the video call for the user.

Examples

Here is an example of the code you need to handle contact video call activations for 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.VideoCall)
        { 
            IContactVideoCallActivatedEventArgs videoCallArgs = contactArgs as IContactVideoCallActivatedEventArgs;

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

            if (videoCallArgs.ServiceId == "skype.com")
            {
                var userId = videoCallArgs.ServiceUserId;
                //add video 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
IContactVideoCallActivatedEventArgs
IContactActivatedEventArgs
IActivatedEventArgs
Handling Contact Actions sample

 

 

Show:
© 2014 Microsoft