AutoplayHandler element

Article
07/20/2015

Specifies a Windows Store device app that should appear as the recommended AutoPlay action when the device is connected and no default action is set. The AutoPlay event is raised whenever the device transitions from a disconnected state to a connected state, such as when the user plugs in the device.

Usage

<AutoplayHandler>
  child elements
</AutoplayHandler>

Attributes

There are no attributes.

Child elements

Element	Description
Application	Optional. Specifies the application ID for the application.
AutoplayType	Optional. Specifies whether the AutoPlay event is a device event or a content event. AutoPlay determines the type of device and raises either a Device event for non-volume devices, or a Content event for volume devices.
PackageIdentity	Optional. Specifies the package identity (name and publisher) for the application.
Verb	Optional. Specifies the verb that the application registers. For more info about how the Verb value is used by the app, see Quickstart: How to register an application for AutoPlay.

Child element sequence

PackageIdentityApplicationVerbAutoplayType

Parent elements

Element
WindowsInfo

XSD

  <!-- Autoplay Handler Type Definition-->
  <xs:complexType name="AutoplayHandlerType">
    <xs:sequence>
      <xs:element name="PackageIdentity" type="tns:PackageIdentityType" />
      <xs:element name="Application" type="tns:ApplicationType" />
      <xs:element name="Verb" type="tns:VerbType" />
      <xs:element name="AutoplayType" type="tns:AutoplayTypeType" />
      <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
    </xs:sequence>
  </xs:complexType>

Remarks

The structure for the Package Identity and Application element are identical with the Application Manifest structure, so copy the elements from the application's manifest.
In addition to including the AutoplayHandler element in the device metadata, the specified Windows Store device app must also register for the AutoPlay event by adding a Declaration in its application manifest for the event. AutoPlay recognizes the declaration for the app and then includes it in the list of possible actions that a user can take to respond to that event. For an example, see Quickstart: How to register an application for AutoPlay.
Only the package listed in the DeviceCompanionApplications value in the SoftwareInfo.xml file will be downloaded as part of the device installation. If the LaunchApplicationOnDeviceConnect element value is from a different package, Windows does not know whether it will actually be on the user’s machine. If the recommended application is not on the user’s machine, users will not be presented with the choice.
Even if the application is the same as the DeviceCompanionApplications entry, it may not always appear in the AutoPlay list. If the user is not connected to the Internet or otherwise fails to download the companion application, it will not appear in the list. However, when the user gets the application, they will be presented with a “New Option Available” AutoPlay dialog box the next time they connect their device.

See Auto-launching with AutoPlay (Windows Store style apps using JavaScript and HTML) for more info on using AutoPlay in Windows Store device apps.

Element information

Minimum supported system	Windows 8
Can be empty	No