uap4:DevicePortalProvider

Article
10/30/2023

Defines a Device Portal provider for deployment. See Write a custom plugin for Device Portal for more details on implementation.

Element hierarchy

<uap4:Extension>

<uap4:DevicePortalProvider>

Syntax

<uap4:DevicePortalProvider
  DisplayName = 'A string with a value between 1 and 256 characters in length. This string is localizable.'
  AppServiceName = 'A string with a value between 2 and 39 characters in length that consists of alphanumeric characters, periods (except for the first character), and dashes only.'
  ContentRoute = 'An optional string with a value between 1 and 32767 characters in length with a non-whitespace character at its beginning and end.'
  HandlerRoute = 'An optional string with a value between 1 and 32767 characters in length with a non-whitespace character at its beginning and end.' />

Key

? optional (zero or one)

Attributes and elements

Attributes

Attribute	Description	Data type	Required
DisplayName	A friendly display name for the device portal provider.	A string with a value between 1 and 256 characters in length. This string is localizable.	Yes
AppServiceName	The name of the app service used to launch the device portal provider.	A string with a value between 2 and 39 characters in length that consists of alphanumeric, period (except for the first character), and dash characters only.	Yes
ContentRoute	A route that's used to declare HTTP content (JavaScript, HTML, and CSS), e.g., /foo	An optional string with a value between 1 and 32767 characters in length with a non-whitespace character at its beginning and end.	No
HandlerRoute	The API namespace requested by the provider, e.g., /foo/bar. Any successful HTTP requests will be sent to the provider for handling.	An optional string with a value between 1 and 32767 characters in length with a non-whitespace character at its beginning and end.	No

Child elements

None.

Parent elements

Parent element	Description
uap4:Extension	Declares an extensibility point for the app.

Remarks

This extension requires the devicePortalProvider restricted capability and either the privateNetworkClientServer or internetClientServer capability.

Note

ContentRoute and HandlerRoute do not need to be provided together.

Requirements

Item	Value
Namespace	`http://schemas.microsoft.com/appx/manifest/uap/windows10/4`
Minimum OS Version	Windows 10 version 1703 (Build 15063)

Share via