uap:Protocol

  • Article

Declares an app extensibility point of type windows.protocol. A URI association indicates that the app is registered to handle URIs with the specified scheme.

Element hierarchy

Syntax

<Protocol Name           = A string between 2 and 39 characters in length that contains numbers, lowercased letters, dots ('.'), pluses('+'), or hyphens ('-'). The string can't start with a dot ('.').

              DesiredView?   = "default" | "useLess" | "useHalf" | "useMore" | "useMinimum"
              ReturnResults? = "none" | "always" | "optional" >

  <!-- Child elements -->
  ( uap:Logo?
  & uap:DisplayName?
  )

</uap:Protocol>

Key

?   optional (zero or one)

&   interleave connector (may occur in any order)

Attributes and Elements

Attributes

Attribute Description Data type Required Default value
DesiredView

The desired amount of screen space to use when the app launches. See Remarks.

This attribute can have one of the following values:

  • default
  • useLess
  • useHalf
  • useMore
  • useMinimum
 No
Name

The name of the URI scheme, such as "mailto". This name must be unique for the package.

 A string between 2 and 39 characters in length that contains numbers, lowercased letters, dots ('.'), pluses('+'), or hyphens ('-'). The string can't start with a dot ('.'). Yes
ReturnResults

TBD

This attribute can have one of the following values:

  • none
  • always
  • optional
 No

 

Child Elements

Child Element Description
uap:DisplayName

A friendly name that can be displayed to users. This string is localizable. For more info, see Localizing the package manifest.
uap:Logo

A path to a file that contains an image.

 

Parent Elements

Parent Element Description
uap:Extension

Declares an extensibility point for the app.

 

Remarks

For more info, see ViewSizePreference and DesiredRemainingView.

See also

Tasks

How to handle URI activation

Concepts

App contracts and extensions

Requirements

Namespace

https://schemas.microsoft.com/appx/manifest/uap/windows10