diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md b/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md index 6b686ec5b3..6ea1f4256e 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_findallasync_326280522.md @@ -10,13 +10,16 @@ public Windows.Foundation.IAsyncOperation ## -returns -The list of extensions. +The list of extensions in the catalog. Note that this method returns a list of [AppExtensions](appextension.md), not [Packages](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.package). You can get the **Package** for each **AppExtension** with [AppExtension.Package](appextension_package.md). ## -remarks +Extensions are scoped by the `` defined in the extension's Package.appxmanifest file. This method returns the list of extensions installed on the machine that match the `` defined in the host's Package.appxmanifest file. + +You typically call this method when your app launches or resumes from suspension. Then use the events on this class to listen for updates to the extensions in the catalog. ## -examples diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md b/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md index 2659ef889f..361cb39108 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_open_1320339374.md @@ -10,17 +10,21 @@ public Windows.ApplicationModel.AppExtensions.AppExtensionCatalog Open(System.St # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.Open ## -description -Opens an app package that contains one or more extensions. +Opens a catalog of extensions. ## -parameters ### -param appExtensionName -The name of the extension. - +The extension namespace name. ## -returns -Information about the various extensions within an extension group. +A catalog containing the extensions declared with the specified extension namespace name. ## -remarks +Extensions are scoped by the `` defined in the extension's Package.appxmanifest file. Only extensions that match the `` defined in the host's Package.appxmanifest file appear in the catalog. + +If you have multiple `` declarations in your host app, you need to open a separate catalog for each one. + +An instance of the **PackageCatalog** is required to handle the events so keep a reference to it as long as you need to manage your app extensions. ## -examples diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md b/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md index 230b6a0e02..0463f32867 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packageinstalled.md @@ -13,7 +13,23 @@ public event Windows.Foundation.TypedEventHandler PackageInstalled` defined in the extension's Package.appxmanifest file. Only extensions that match the `` defined in the host's Package.appxmanifest file, are in the list of extensions. + +An event handler for this event is a good place to examine each app extension for correctness and to provide the user the option to use it. + +The unit of deployment for an [AppExtension](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.appextensions.appextension) is the [Package](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.package). That's why this is a **Package** install event and not an **AppExtension** install event. + +Typically there will only be one extension in a package. However, be prepared to handle the case where there are multiple extensions in the package. + +Use [AppExtension.Id](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.appextensions.appextension) to distinguish between extensions in the same package. To uniquely identify an extension in your app, consider concatenating [AppInfo.AppUserModelId](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.appinfo) and [AppExtension.Id](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.appinfo): + +```cs +_uniqueId = yourAppExtention.AppInfo.AppUserModelId + "!" + yourAppExtention.Id; +``` + +This guarantees that each **AppExtension** has a unique name that you can use to track it with in your app. We recommend using this as a key for your **AppExtensions** so that you can efficiently and correctly identify if a given **AppExtension** is one that you already know about. ## -examples diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md b/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md index fb149d99f7..dd802ba512 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packagestatuschanged.md @@ -10,9 +10,19 @@ public event Windows.Foundation.TypedEventHandler PackageStatusChanged` defined in the extension's Package.appxmanifest file. Only extensions that match the `` defined in the host's Package.appxmanifest file are in the list. + +The updated package may include new [AppExtensions](appextension.md), and may no longer contain **AppExtensions** that were there previously. If you are maintaining a list of loaded extensions, the handler for this event is a good place to compare the list of **AppExtensions** in the new package against your list and then update your list accordingly. + +**AppExtension** properties may have changed during the update. If you cached any of them, this is a good time to check for updates. + +Generally the best way to handle this event is to treat it as you do the [PackageInstalled](appextensioncatalog_packageinstalled.md) event, but update your tracking list of **AppExtensions** instead of creating a new tracking list. ## -examples diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md b/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md index cc96ad5aaa..bc3ada9ef3 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_packageupdating.md @@ -13,6 +13,13 @@ public event Windows.Foundation.TypedEventHandler PackageUpdating`. It doesn't contain the list of extensions. + +When you handle the **PackageUpdating** event, match the package that is being updated against any extensions that you have loaded from that package so that you can keep track of which extensions are now available. This is why you should keep track of the [AppExtensions](appextension.md) that you have loaded, the packages to which they belong, and a unique identifier for them that you can use as a key as described in the remarks for **AppExtensionCatalog.Open**. ## -examples diff --git a/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md b/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md index 86e0932d39..45600cfab9 100644 --- a/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md +++ b/windows.applicationmodel.appextensions/appextensioncatalog_requestremovepackageasync_996140883.md @@ -10,18 +10,24 @@ public Windows.Foundation.IAsyncOperation RequestRemovePackageAsync(System # Windows.ApplicationModel.AppExtensions.AppExtensionCatalog.RequestRemovePackageAsync ## -description -Removes the specified extension package. +Attempts to remove the specified extension package from the machine. ## -parameters ### -param packageFullName -The name of the package to remove. - +The name of the package to remove, which you can get from [AppExtension.Package.Id.FullName](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.packageid). ## -returns -Returns **true** if the package was successfully removed; otherwise, **false**. +Returns **true** if the request to the user to remove the package was made; otherwise, **false**. +This function will return **false** if you try to use a **Package** name that is not associated with an extension in the **AppExtensionCatalog** instance. The return value doesn't reflect whether the package was actually removed or not. If the user accepts the prompt to remove the package, you will get a [PackageUninstalling](appextensioncatalog_packageuninstalling.md) event. ## -remarks -The user is prompted to allow or deny the removal of the package. +The user is prompted to allow or deny the package removal. You can only remove packages that contain extensions found in the **AppExtensionCatalog** instance you make the call from. + +The unit of deployment for [AppExtensions](appextension.md) is the [Package](https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.package). You cannot remove **AppExtensions**; you can only remove **Packages**. **Packages** may contain multiple **AppExtensions**. + +The user may not understand the relationship between **AppExtensions** and **Packages**, or between an **AppExtension** and an app on the machine (because an app may be designed to also serve as an extension). The user may accept the request to remove a package thinking that they are only removing an extension but then find that one of their favorite apps is now gone. Only use this method if you are certain that the **AppExtension** is the only thing in the package. + +Avoid using this method if you do not control the ecosystem of extensions involved. This method is intended for convenience in a closed ecosystem of extensions, such as in an enterprise environment. [Desktop Bridge](https://developer.microsoft.com/en-us/windows/bridges/desktop) app extension hosts cannot use this method directly. Desktop Bridge app extension hosts should use their Universal Windows Platform component to manage app extensions. diff --git a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md index bf2436bced..751b9d4db1 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md +++ b/windows.applicationmodel.appextensions/appextensionpackageinstalledeventargs_extensions.md @@ -10,10 +10,13 @@ public Windows.Foundation.Collections.IVectorView` defined in the extension's Package.appxmanifest file. Only extensions that match the `` defined in the host's Package.appxmanifest file are returned. + ## -remarks diff --git a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md index 57cf49d70b..634f157775 100644 --- a/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md +++ b/windows.applicationmodel.appextensions/appextensionpackageupdatedeventargs_extensions.md @@ -16,6 +16,7 @@ Provides a list of extensions that are in the extension package that was updated A list of extensions within the updated extension package. ## -remarks +Extensions are scoped by the `` in the extension's Package.appxmanifest file. Only extensions that match the `` defined in the host's Package.appxmanifest file are returned. ## -examples diff --git a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md index 97deaca7a9..3705f7cf51 100644 --- a/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md +++ b/windows.applicationmodel.appointments.dataprovider/appointmentcalendarcancelmeetingrequest_appointmentcalendarlocalid.md @@ -10,7 +10,7 @@ public string AppointmentCalendarLocalId { get; } # Windows.ApplicationModel.Appointments.DataProvider.AppointmentCalendarCancelMeetingRequest.AppointmentCalendarLocalId ## -description -Gets a string that uniquely identifies the calendar associated with the appointment on the local device. + ## -property-value A string that uniquely identifies the calendar on the local device. diff --git a/windows.applicationmodel.appservice/appserviceconnectionstatus.md b/windows.applicationmodel.appservice/appserviceconnectionstatus.md index cfac278626..14b56f0706 100644 --- a/windows.applicationmodel.appservice/appserviceconnectionstatus.md +++ b/windows.applicationmodel.appservice/appserviceconnectionstatus.md @@ -32,7 +32,7 @@ An unknown error occurred. The device to which a connection was attempted is not available. ### -field RemoteSystemNotSupportedByApp:6 -The app does not support remote connections to the device you attempted to connect with. +The app on the remote device does not support remote connections. It needs to specify SupportsRemoteSystems="true" on the appService extension in its AppXManifest to accept remote connections. ### -field NotAuthorized:7 The user for your app is not authorized to connect to the service. @@ -45,4 +45,4 @@ The user for your app is not authorized to connect to the service. ## -examples ## -see-also -[AppServiceConnection.OpenAsync](appserviceconnection_openasync.md) \ No newline at end of file +[AppServiceConnection.OpenAsync](appserviceconnection_openasync.md) diff --git a/windows.applicationmodel.background/applicationtrigger.md b/windows.applicationmodel.background/applicationtrigger.md index 2a09543e0b..a749185b08 100644 --- a/windows.applicationmodel.background/applicationtrigger.md +++ b/windows.applicationmodel.background/applicationtrigger.md @@ -14,7 +14,10 @@ This allows you to programmatically trigger a background tasks from within your ## -remarks +> [!IMPORTANT] +> An app can only register one **ApplicationTrigger** with the [BackgroundTaskBuilder](https://docs.microsoft.com/en-us/uwp/api/Windows.ApplicationModel.Background.BackgroundTaskBuilder) at any given time. + ## -examples ## -see-also -[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file +[IBackgroundTrigger](ibackgroundtrigger.md) diff --git a/windows.applicationmodel.background/backgroundtaskbuilder.md b/windows.applicationmodel.background/backgroundtaskbuilder.md index 3db1309307..6b1560080d 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder.md @@ -17,8 +17,8 @@ Represents a background task to be registered with the system. ## -remarks > [!NOTE] -> : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see [Threading and Marshaling (C++/CX)](http://go.microsoft.com/fwlink/p/?linkid=258275) and [Using Windows Runtime objects in a multithreaded environment (.NET)](http://go.microsoft.com/fwlink/p/?linkid=258277). +> This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see [Threading and Marshaling (C++/CX)](http://go.microsoft.com/fwlink/p/?linkid=258275) and [Using Windows Runtime objects in a multithreaded environment (.NET)](http://go.microsoft.com/fwlink/p/?linkid=258277). ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md b/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md index 14df5e30cf..5e20b8b612 100644 --- a/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md +++ b/windows.applicationmodel.background/backgroundtaskbuilder_register_292201929.md @@ -18,9 +18,7 @@ An instance of a [BackgroundTaskRegistration](backgroundtaskregistration.md) obj ## -remarks The task must have an event trigger and a task entry point for the [Register](backgroundtaskbuilder_register.md) method to succeed. The system schedules the background task when its trigger event occurs and all of its conditions have been met. -### Background task parameter validatio -n - +### Background task parameter validation > **Windows 8** > Windows 8 does not validate the parameters set on the [BackgroundTaskBuilder](backgroundtaskbuilder.md) object until the system tries to run the background task. If the parameters aren't valid, the background task can't start and an event log entry is created. @@ -29,5 +27,6 @@ n > Starting in Windows 8.1, the parameters used to register the background task are validated at the time of registration. An error is returned if the background task registration fails, allowing the app to determine whether or not the background task is valid. For C# and Visual Basic, task registration errors typically result in specific .NET exceptions being thrown. These exceptions are thrown as first-chance exceptions and should be corrected while you're still developing your code.Existing Windows 8 apps running on Windows 8.1 are subject to this new system behavior, which can cause the app to crash if it can't handle a failed background task registration. (An event log entry will still be generated for the failed background task registration.) As a result, Windows 8 apps that register invalid background tasks should be rewritten to register background tasks correctly and to handle failed background task registration as a caught exception. ## -examples +[BackgroundTask sample](https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/BackgroundTask/cs/BackgroundTask ) ## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md b/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md index 8e7c90357a..4ed17bd0b3 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md @@ -10,7 +10,7 @@ public Windows.Foundation.Collections.IMapView **Windows 8Windows Server 2012Windows 8.1Windows Server 2012 R2Windows Phone 8.1** +> **Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows Phone 8.1** > An app must be placed on the lock screen before it can successfully register background tasks using this trigger type. -> **Windows 10Windows Server 2016Windows 10 Mobile** +> **Windows 10, Windows Server 2016, Windows 10 Mobile** > You do not need to place an app on the lock screen before the app can successfully register background tasks using this trigger type. ### -field UserAway:3 The background task is triggered when the user becomes absent. -> **Windows 8Windows Server 2012Windows 8.1Windows Server 2012 R2Windows Phone 8.1** +> **Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows Phone 8.1** > An app must be placed on the lock screen before it can successfully register background tasks using this trigger type. -> **Windows 10Windows Server 2016Windows 10 Mobile** +> **Windows 10, Windows Server 2016, Windows 10 Mobile** > You do not need to place an app on the lock screen before the app can successfully register background tasks using this trigger type. ### -field NetworkStateChange:4 @@ -52,12 +52,12 @@ The background task is triggered when a control channel is reset. -> **Windows 8Windows Server 2012Windows 8.1Windows Server 2012 R2Windows Phone 8.1** +> **Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows Phone 8.1** > An app must be placed on the lock screen before it can successfully register background tasks using this trigger type. -> **Windows 10Windows Server 2016Windows 10 Mobile** +> **Windows 10, Windows Server 2016, Windows 10 Mobile** > You do not need to place an app on the lock screen before the app can successfully register background tasks using this trigger type. ### -field InternetAvailable:6 @@ -66,12 +66,12 @@ The background task is triggered when the Internet becomes available. ### -field SessionConnected:7 The background task is triggered when the session is connected. -> **Windows 8Windows Server 2012Windows 8.1Windows Server 2012 R2Windows Phone 8.1** +> **Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows Phone 8.1** > An app must be placed on the lock screen before it can successfully register background tasks using this trigger type. -> **Windows 10Windows Server 2016Windows 10 Mobile** +> **Windows 10, Windows Server 2016, Windows 10 Mobile** > You do not need to place an app on the lock screen before the app can successfully register background tasks using this trigger type. ### -field ServicingComplete:8 @@ -95,12 +95,12 @@ The background task is triggered when the Microsoft account connected to the acc ### -field BackgroundWorkCostChange:13 The background task is triggered when the cost of background work changes. -> **Windows 8Windows Server 2012Windows 8.1Windows Server 2012 R2Windows Phone 8.1** +> **Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows Phone 8.1** > An app must be placed on the lock screen before it can successfully register background tasks using this trigger type. -> **Windows 10Windows Server 2016Windows 10 Mobile** +> **Windows 10, Windows Server 2016, Windows 10 Mobile** > You do not need to place an app on the lock screen before the app can successfully register background tasks using this trigger type. ### -field PowerStateChange:14 @@ -121,4 +121,4 @@ The background task is triggered when the default sign-in account changes. ## -examples ## -see-also -[SystemTrigger.TriggerType](systemtrigger_triggertype.md) \ No newline at end of file +[SystemTrigger.TriggerType](systemtrigger_triggertype.md) diff --git a/windows.applicationmodel.background/timetrigger_freshnesstime.md b/windows.applicationmodel.background/timetrigger_freshnesstime.md index f83b764afc..eae47a27f0 100644 --- a/windows.applicationmodel.background/timetrigger_freshnesstime.md +++ b/windows.applicationmodel.background/timetrigger_freshnesstime.md @@ -13,15 +13,14 @@ public uint FreshnessTime { get; } Gets the interval of a time event trigger. ## -property-value -Specifies the number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after [FreshnessTime](timetrigger_freshnesstime.md) elapses. +Specifies the number of minutes to wait before scheduling the background task. The minimum value for **FreshnessTime** is 15 minutes. The system schedules the task within 15 minutes after **FreshnessTime** elapses. ## -remarks -The system uses a 15-minute tick frequency for timer requests. A time-triggered background task is scheduled on the next tick after [FreshnessTime](timetrigger_freshnesstime.md) elapses. If the [OneShot](timetrigger_oneshot.md) property is false, [FreshnessTime](timetrigger_freshnesstime.md) specifies the interval for a recurring task. - +The system uses a 15-minute tick frequency for timer requests. A time-triggered background task is scheduled on the next tick after **FreshnessTime** elapses. If the [OneShot](timetrigger_oneshot.md) property is false, **FreshnessTime** specifies the interval for a recurring task. > [!NOTE] -> If *FreshnessTime* is set to less than 15 minutes, an exception is thrown when attempting to register the background task. +> To understand the timeframe within which the time trigger may fire, consider a **FreshnessTime** set to 15 minutes. Because the system schedules the task within 15 minutes after *FreshnessTime* elapses, it may be up to 30 minutes before the time trigger fires. ## -examples diff --git a/windows.applicationmodel.chat/chatcapabilities.md b/windows.applicationmodel.chat/chatcapabilities.md index bbfba1a74a..8bd7c5f166 100644 --- a/windows.applicationmodel.chat/chatcapabilities.md +++ b/windows.applicationmodel.chat/chatcapabilities.md @@ -1,6 +1,7 @@ --- -api-id: T:Windows.ApplicationModel.Chat.ChatCapabilities -api-type: winrt class +-api-device-family-note: xbox --- + +# Windows.ApplicationModel.Store.Preview.WebAuthenticationCoreManagerHelper + +## -description +Provides the ability to host a custom UI to request an authentication token. + +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/webauthenticationcoremanagerhelper_requesttokenwithuielementhostingasync_109263148.md b/windows.applicationmodel.store.preview/webauthenticationcoremanagerhelper_requesttokenwithuielementhostingasync_109263148.md new file mode 100644 index 0000000000..1f8087e808 --- /dev/null +++ b/windows.applicationmodel.store.preview/webauthenticationcoremanagerhelper_requesttokenwithuielementhostingasync_109263148.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.WebAuthenticationCoreManagerHelper.RequestTokenWithUIElementHostingAsync(Windows.Security.Authentication.Web.Core.WebTokenRequest,Windows.UI.Xaml.UIElement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.WebAuthenticationCoreManagerHelper.RequestTokenWithUIElementHostingAsync + +## -description +Requests an authentication token using the specified custom UI. + +## -params + +## -param request +An object that represents the request to an online identity provider for an authentication token. + +## -param uiElement +The custom UI that is shown to the user to retrieve information needed for the authentication token (such as a user ID or password). + +## -returns +An asynchronous operation that, on successful completion, returns a [WebTokenRequestResult](../windows.security.authentication.web.core/webtokenrequestresult.md) object that represents the results of the web token request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/webauthenticationcoremanagerhelper_requesttokenwithuielementhostingasync_684513420.md b/windows.applicationmodel.store.preview/webauthenticationcoremanagerhelper_requesttokenwithuielementhostingasync_684513420.md new file mode 100644 index 0000000000..d11927817d --- /dev/null +++ b/windows.applicationmodel.store.preview/webauthenticationcoremanagerhelper_requesttokenwithuielementhostingasync_684513420.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.WebAuthenticationCoreManagerHelper.RequestTokenWithUIElementHostingAsync(Windows.Security.Authentication.Web.Core.WebTokenRequest,Windows.Security.Credentials.WebAccount,Windows.UI.Xaml.UIElement) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.WebAuthenticationCoreManagerHelper.RequestTokenWithUIElementHostingAsync + +## -description +Requests an authentication token for the specified account using the specified custom UI. + +## -params + +## -param request +An object that represents the request to an online identity provider for an authentication token. + +## -param webAccount +An object that identifies the account for which to request the authentication token. + +## -param uiElement +The custom UI that is shown to the user to retrieve information needed for the authentication token (such as a user ID or password). + +## -returns +An asynchronous operation that, on successful completion, returns a [WebTokenRequestResult](../windows.security.authentication.web.core/webtokenrequestresult.md) object that represents the results of the web token request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportcompletedasync_1011424265.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportcompletedasync_1011424265.md index 5de6f4cdb5..21fcbf7f3b 100644 --- a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportcompletedasync_1011424265.md +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportcompletedasync_1011424265.md @@ -20,7 +20,7 @@ The ID of the task that was processed. ## -returns An asynchronous operation. -# -remarks +## -remarks ## -see-also diff --git a/windows.applicationmodel.userdatatasks/userdatataskmanager_user.md b/windows.applicationmodel.userdatatasks/userdatataskmanager_user.md index 17a0b26d16..59b7151bed 100644 --- a/windows.applicationmodel.userdatatasks/userdatataskmanager_user.md +++ b/windows.applicationmodel.userdatatasks/userdatataskmanager_user.md @@ -15,7 +15,7 @@ Gets the user associated with this [UserDataTaskManager](userdatataskmanager.md) ## -property-value The user associated with this [UserDataTaskManager](userdatataskmanager.md). -# -remarks +## -remarks ## -see-also diff --git a/windows.applicationmodel.voicecommands/voicecommand.md b/windows.applicationmodel.voicecommands/voicecommand.md index 7b1c9bc6a0..d8041a4c9f 100644 --- a/windows.applicationmodel.voicecommands/voicecommand.md +++ b/windows.applicationmodel.voicecommands/voicecommand.md @@ -21,4 +21,4 @@ Access [VoiceCommand](voicecommand.md) objects by calling [GetVoiceCommandAsync] ## -examples ## -see-also -[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommand_commandname.md b/windows.applicationmodel.voicecommands/voicecommand_commandname.md index cb397b21f2..562e7694ad 100644 --- a/windows.applicationmodel.voicecommands/voicecommand_commandname.md +++ b/windows.applicationmodel.voicecommands/voicecommand_commandname.md @@ -20,4 +20,4 @@ The command name. ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommand_properties.md b/windows.applicationmodel.voicecommands/voicecommand_properties.md index 8ab8195331..ef99ad3cbf 100644 --- a/windows.applicationmodel.voicecommands/voicecommand_properties.md +++ b/windows.applicationmodel.voicecommands/voicecommand_properties.md @@ -20,4 +20,4 @@ The semantic properties recognized in the voice command. ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md b/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md index 7da479d1f6..f4df4b26e0 100644 --- a/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md +++ b/windows.applicationmodel.voicecommands/voicecommand_speechrecognitionresult.md @@ -20,4 +20,4 @@ The result of a speech recognition session. ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs.md b/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs.md index 2b66a3167a..23dbd7b773 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs.md +++ b/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs.md @@ -18,4 +18,4 @@ Contains event data for the [VoiceCommandCompleted](voicecommandserviceconnectio ## -examples ## -see-also -[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md b/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md index 65f288269f..3dedc52cd2 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md +++ b/windows.applicationmodel.voicecommands/voicecommandcompletedeventargs_reason.md @@ -20,4 +20,4 @@ The reason the voice command completed. ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcompletionreason.md b/windows.applicationmodel.voicecommands/voicecommandcompletionreason.md index c5c482bb75..844b696c2e 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcompletionreason.md +++ b/windows.applicationmodel.voicecommands/voicecommandcompletionreason.md @@ -40,4 +40,4 @@ The background app service completed the interaction by calling [ReportSuccessAs ## -examples ## -see-also -[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [VoiceCommandCompletedEventArgs.Reason](voicecommandcompletedeventargs_reason.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [VoiceCommandCompletedEventArgs.Reason](voicecommandcompletedeventargs_reason.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandconfirmationresult.md b/windows.applicationmodel.voicecommands/voicecommandconfirmationresult.md index 264f6d44cf..0523c01eba 100644 --- a/windows.applicationmodel.voicecommands/voicecommandconfirmationresult.md +++ b/windows.applicationmodel.voicecommands/voicecommandconfirmationresult.md @@ -18,4 +18,4 @@ Access the [VoiceCommandConfirmationResult](voicecommandconfirmationresult.md) o ## -examples ## -see-also -[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md b/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md index 966ec7b0e8..7a44d6de4c 100644 --- a/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md +++ b/windows.applicationmodel.voicecommands/voicecommandconfirmationresult_confirmed.md @@ -20,4 +20,4 @@ Gets the response to the question specified by the background app and shown on t ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile.md index 563b621929..869bedc9fa 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile.md @@ -20,4 +20,4 @@ The maximum number of tiles that can be displayed depends on the feedback screen ## -examples ## -see-also -[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[Windows.ApplicationModel.VoiceCommands](windows_applicationmodel_voicecommands.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md index 2bc4ef0315..d6690de535 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_appcontext.md @@ -20,4 +20,4 @@ Supplementary information associated with the content tile. ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md index 92a11c9efd..c03765a569 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_applaunchargument.md @@ -25,4 +25,4 @@ An app is launched to the foreground through Uniform Resource Identifier (URI) a ## -examples ## -see-also -[Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[Deep link from Cortana to a background app](http://msdn.microsoft.com/library/be811a87-8821-476a-90e4-2e20d37e4043), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md index 5f7cf06bd3..ffedcb6f34 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_contenttiletype.md @@ -23,4 +23,4 @@ The content tile template. ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md index a8e8c39911..59ec82bbf1 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_image.md @@ -22,4 +22,4 @@ The image associated with the content tile. ## -examples ## -see-also -[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md index 21a277cbea..02be6faf7a 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline1.md @@ -22,4 +22,4 @@ The first line of text associated with the content tile. ## -examples ## -see-also -[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md index e633661e88..4f6b8c7f33 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline2.md @@ -22,4 +22,4 @@ The second line of text associated with the content tile. ## -examples ## -see-also -[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md index 8d7f94128f..d933866c7d 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_textline3.md @@ -22,4 +22,4 @@ The third line of text associated with the content tile. ## -examples ## -see-also -[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md index 92b76b402e..6a6e426001 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_title.md @@ -22,4 +22,4 @@ The title associated with the content tile. ## -examples ## -see-also -[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ContentTileType](voicecommandcontenttile_contenttiletype.md), [ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md b/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md index 9af23e6645..cf2299eda6 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttile_voicecommandcontenttile_1221375020.md @@ -17,4 +17,4 @@ Creates an instance of the [VoiceCommandContentTile](voicecommandcontenttile.md) ## -examples ## -see-also -[ elements and attributes v1.2](voice_command_elements_and_attributes_1_2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file +[ elements and attributes v1.2](https://docs.microsoft.com/en-us/uwp/schemas/voicecommands/voice-command-elements-and-attributes-1-2.md), [Cortana interactions](http://msdn.microsoft.com/library/4c11a7cf-da26-4ca1-a9b9-fe52670101f5), [Cortana design guidelines](http://msdn.microsoft.com/library/a92c084b-9913-4718-9a04-569d51ace55d), [Cortana voice command sample](http://go.microsoft.com/fwlink/p/?LinkID=619899) \ No newline at end of file diff --git a/windows.applicationmodel.voicecommands/voicecommandcontenttiletype.md b/windows.applicationmodel.voicecommands/voicecommandcontenttiletype.md index 04e6e1767e..d6d7ba282f 100644 --- a/windows.applicationmodel.voicecommands/voicecommandcontenttiletype.md +++ b/windows.applicationmodel.voicecommands/voicecommandcontenttiletype.md @@ -48,4 +48,4 @@ Item title, up to two lines of text, and wide image. [!IMPORTANT] -> Although [Package](package.md) is supported in desktop apps, this member is supported only in Windows Store app. To access a package object from a desktop app, use [Windows.Management.Deployment.PackageManager](../windows.management.deployment/packagemanager.md). +> Although [Package](package.md) is supported in desktop apps, this member is supported only in Windows Store apps. To access a package object from a desktop app, use [Windows.Management.Deployment.PackageManager](../windows.management.deployment/packagemanager.md). ## -examples ## -see-also -[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) \ No newline at end of file +[App package information sample](http://code.msdn.microsoft.com/windowsapps/Package-sample-46e239fa) diff --git a/windows.applicationmodel/package_setinuseasync_1792768214.md b/windows.applicationmodel/package_setinuseasync_1792768214.md index ddc01c54eb..370396cc7c 100644 --- a/windows.applicationmodel/package_setinuseasync_1792768214.md +++ b/windows.applicationmodel/package_setinuseasync_1792768214.md @@ -21,7 +21,7 @@ Sets whether the package is in use or not. **True** indicates that the operation was successful; **false** otherwise. ## -remarks -This API provides a way to indicate whether the app is using an optional package. With this information the system can determine whether servicing the optional package requires shutting down the app or not. This provides a better user experience because the app can mitigate when it is shut down for optional package updates or removals. +This API specifies whether the app is using an optional package. With this information the system can determine whether servicing the optional package will require shutting down the app. This provides a better user experience because the app can manage when it is shut down for optional package updates or removals. By default, all optional packages are in use. Servicing an optional package causes the app to shut down. To avoid shutting down the app when an optional package that is not being used is updated or removed, call this API with **inUse** set to **false**. diff --git a/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md b/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md index 2f0b870aee..2bf036022c 100644 --- a/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md +++ b/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md @@ -21,6 +21,7 @@ The package family of the optional package to add to the catalog. The result of adding the package. ## -remarks +This method only works for optional packages in a related set. ## -see-also diff --git a/windows.applicationmodel/packagecatalog_packagecontentgroupstaging.md b/windows.applicationmodel/packagecatalog_packagecontentgroupstaging.md index fe977de13a..1249bd6897 100644 --- a/windows.applicationmodel/packagecatalog_packagecontentgroupstaging.md +++ b/windows.applicationmodel/packagecatalog_packagecontentgroupstaging.md @@ -10,7 +10,7 @@ public event TypedEventHandler PackageContentGroupStaging precedingWords, Windows.Foundation.Collections.IIterable words) diff --git a/windows.data.text/selectablewordssegmenter.md b/windows.data.text/selectablewordssegmenter.md index 19495df17f..40f0845514 100644 --- a/windows.data.text/selectablewordssegmenter.md +++ b/windows.data.text/selectablewordssegmenter.md @@ -1,6 +1,7 @@ --- -api-id: T:Windows.Data.Text.SelectableWordsSegmenter -api-type: winrt class +-api-device-family-note: xbox --- # Windows.Devices.Bluetooth.Background.BluetoothEventTriggeringMode ## -description -This enumeration represents a Bluetooth backgorund event triggering mode. +This enumeration represents a Bluetooth background event triggering mode. ## -enum-fields ### -field Serial:0 The triggering method is serial. @@ -19,11 +19,10 @@ The triggering method is serial. The triggering mode is keep latest. ### -field Batch:1 -The triggering mdoe is batch. +The triggering mode is batch. ## -remarks ## -see-also ## -examples - diff --git a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md index ec89c002a6..d091e581a1 100644 --- a/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md +++ b/windows.devices.bluetooth.background/bluetoothleadvertisementpublishertriggerdetails.md @@ -1,6 +1,7 @@ --- -api-id: T:Windows.Devices.Bluetooth.Background.BluetoothLEAdvertisementPublisherTriggerDetails -api-type: winrt class +-api-device-family-note: xbox --- -# Windows.Devices.PointOfService.BarcodeSymbologyAttributes - +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes + ## -description -The symbology attributes of a barcode scanner. +The attributes of a barcode scanner symbology. ## -remarks This object is created when a [ClaimedBarcodeScanner.GetSymbologyAttributesAsync](claimedbarcodescanner_getsymbologyattributesasync.md) method completes. diff --git a/windows.devices.pointofservice/barcodesymbologydecodelengthkind.md b/windows.devices.pointofservice/barcodesymbologydecodelengthkind.md index a249a1f1dc..91b2dea909 100644 --- a/windows.devices.pointofservice/barcodesymbologydecodelengthkind.md +++ b/windows.devices.pointofservice/barcodesymbologydecodelengthkind.md @@ -1,14 +1,14 @@ ---- --api-id: T:Windows.Devices.PointOfService.BarcodeSymbologyDecodeLengthKind --api-type: winrt enum ---- - +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeSymbologyDecodeLengthKind +-api-type: winrt enum +--- + -# Windows.Devices.PointOfService.BarcodeSymbologyDecodeLengthKind - +# Windows.Devices.PointOfService.BarcodeSymbologyDecodeLengthKind + ## -description The types of decode lengths that barcode symbologies can support. @@ -20,7 +20,7 @@ Decode lengths between [DecodeLength1](barcodesymbologyattributes_decodelength1. Decode lengths of either [DecodeLength1](barcodesymbologyattributes_decodelength1.md) or [DecodeLength2](barcodesymbologyattributes_decodelength2.md) single-byte characters. ### -field AnyLength:0 -Decode lengths of any number of single-byte characters. +Decode lengths of any number. ## -remarks diff --git a/windows.devices.pointofservice/cashdrawer.md b/windows.devices.pointofservice/cashdrawer.md index 38c97c76ba..9ba7bc16f8 100644 --- a/windows.devices.pointofservice/cashdrawer.md +++ b/windows.devices.pointofservice/cashdrawer.md @@ -1,6 +1,7 @@ --- -api-id: T:Windows.Devices.PointOfService.CashDrawer -api-type: winrt class +-api-device-family-note: xbox --- \ No newline at end of file +``` \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_trygetbatteryreport_340082979.md b/windows.gaming.input/arcadestick_trygetbatteryreport_340082979.md index 0bb6134836..db69459e01 100644 --- a/windows.gaming.input/arcadestick_trygetbatteryreport_340082979.md +++ b/windows.gaming.input/arcadestick_trygetbatteryreport_340082979.md @@ -24,17 +24,3 @@ Information about the arcade stick's current battery state. * [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) ## -examples - - \ No newline at end of file diff --git a/windows.gaming.input/flightstick.md b/windows.gaming.input/flightstick.md index 2f9164267d..51719c8eb7 100644 --- a/windows.gaming.input/flightstick.md +++ b/windows.gaming.input/flightstick.md @@ -21,13 +21,19 @@ Represents a flight stick. * A hat switch for camera view and/or target selection. * Axis data for pitch, roll, yaw, and throttle position. +Instances of the **FlightStick** class cannot be created directly; instead, instances of the class are retrieved through the [FlightStick.FlightSticks](flightstick_flightsticks.md) property listing all connected flight sticks or through the [FlightStick.FlightStickAdded](flightstick_flightstickadded.md) event. + +See [Flight stick](https://docs.microsoft.com/windows/uwp/gaming/flight-stick) for more information about how to use the **FlightStick** class. + ### Supported Devices -`FlightStick` supports any Xbox One certified or Xbox 360 compatible flight stick. +**FlightStick** supports any Xbox One-certified or Xbox 360-compatible flight stick. ## -see-also -* [IGameController](igamecontroller.md) -* [IGameControllerBatteryInfo](igamecontrollerbatteryinfo.md) +* [Flight stick](https://docs.microsoft.com/windows/uwp/gaming/flight-stick) +* [Windows.Gaming.Input.IGameController interface](igamecontroller.md) +* [Windows.Gaming.Input.IGameControllerBatteryInfo interface](igamecontrollerbatteryinfo.md) ## -examples + diff --git a/windows.gaming.input/flightstick_flightstickadded.md b/windows.gaming.input/flightstick_flightstickadded.md index 97981ce5a5..f9ac5a2a23 100644 --- a/windows.gaming.input/flightstick_flightstickadded.md +++ b/windows.gaming.input/flightstick_flightstickadded.md @@ -15,8 +15,19 @@ Signals when a new flight stick is connected. ## -remarks -To identify flight sticks that have already been added, you query the list of connected flight sticks using [FlightStick.FlightSticks](flightstick_flightsticks.md). +To identify flight sticks that have already been added, you query the list of connected flight sticks using [FlightStick.FlightSticks](flightstick_flightsticks.md). However, because you might only be interested in some of the connected flight sticks, we recommend that you maintain your own collection instead of accessing them through **FlightSticks**. ## -see-also ## -examples + +The following example starts tracking a flight stick that's been added. `myFlightSticks` is a `Vector` that contains the flight sticks that your game is tracking. + +```cpp +FlightStick::FlightStickAdded += + ref new EventHandler([] (Platform::Object^, FlightStick^ args) +{ + // This code assumes that you're interested in all new flight sticks. + myFlightSticks->Append(args); +}); +``` \ No newline at end of file diff --git a/windows.gaming.input/flightstick_flightstickremoved.md b/windows.gaming.input/flightstick_flightstickremoved.md index 7c631b272c..0557b2f4c1 100644 --- a/windows.gaming.input/flightstick_flightstickremoved.md +++ b/windows.gaming.input/flightstick_flightstickremoved.md @@ -15,6 +15,21 @@ Signals when a flight stick is disconnected. ## -remarks +The following example stops tracking a flight stick that's been removed. `myFlightSticks` is a `Vector` that contains the flight sticks that your game is tracking. + +```cpp +FlightStick::FlightStickRemoved += + ref new EventHandler([] (Platform::Object^, FlightStick^ args) +{ + unsigned int indexRemoved; + + if (myFlightSticks->IndexOf(args, &indexRemoved)) + { + myFlightSticks->RemoveAt(indexRemoved); + } +}); +``` + ## -see-also ## -examples diff --git a/windows.gaming.input/flightstick_flightsticks.md b/windows.gaming.input/flightstick_flightsticks.md index 05d8882399..b6852012c5 100644 --- a/windows.gaming.input/flightstick_flightsticks.md +++ b/windows.gaming.input/flightstick_flightsticks.md @@ -19,6 +19,20 @@ The list of all connected flight sticks. ## -remarks +**FlightStick** objects are managed by the system, therefore you don't have to create or initialize them. Instead, you can access connected flight sticks through this property. Because you might only be interested in some of the connected flight sticks, we recommend that you maintain your own collection. + ## -see-also ## -examples + +The following example copies all connected flight sticks into a new collection: + +```cpp +auto myFlightSticks = ref new Vector(); + +for (auto flightStick : FlightStick::FlightSticks) +{ + // This code assumes that you're interested in all flight sticks. + myFlightSticks->Append(flightStick); +} +``` \ No newline at end of file diff --git a/windows.gaming.input/flightstick_fromgamecontroller_421915006.md b/windows.gaming.input/flightstick_fromgamecontroller_421915006.md index bffbe458ce..b6c7078ffd 100644 --- a/windows.gaming.input/flightstick_fromgamecontroller_421915006.md +++ b/windows.gaming.input/flightstick_fromgamecontroller_421915006.md @@ -25,25 +25,29 @@ The flight stick that was returned from the given game controller. ## -remarks +This method checks if the provided game controller has a flight stick implementation, and if so, it returns that implementation. You might use this method if you want to first get the controller as a [RawGameController](rawgamecontroller.md), and then see if it can be used as a **FlightStick**—if so, you can use a default control scheme for flight sticks, otherwise you can let the player do their own input mapping. + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) ## -examples - \ No newline at end of file +``` \ No newline at end of file diff --git a/windows.gaming.input/flightstick_getbuttonlabel_2119068015.md b/windows.gaming.input/flightstick_getbuttonlabel_2119068015.md index ab64667768..f7896c3376 100644 --- a/windows.gaming.input/flightstick_getbuttonlabel_2119068015.md +++ b/windows.gaming.input/flightstick_getbuttonlabel_2119068015.md @@ -21,30 +21,32 @@ The button for which to retrieve the label. ## -returns -Returns the label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned. +The label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned. ## -remarks +The following example gets the label on the **FirePrimary** button on the flight stick, and shows an icon based on the label: + +```cpp +void ShowFlightStickFirePrimaryButtonIcon(FlightStick flightStick) +{ + GameControllerButtonLabel label = + flightStick.GetButtonLabel(FlightStickButtons::FirePrimary); + + switch (label) + { + case (GameControllerButtonLabel::RightTrigger): + { + // Show the right trigger icon. + } + // ... + } +} +``` + ## -see-also * [Windows.Gaming.Input.GameControllerButtonLabel](gamecontrollerbuttonlabel.md) * [Windows.Gaming.Input.FlightStickButtons](flightstickbuttons.md) ## -examples - - \ No newline at end of file diff --git a/windows.gaming.input/flightstick_getcurrentreading_1416488181.md b/windows.gaming.input/flightstick_getcurrentreading_1416488181.md index 8d55c7dbeb..4d2d4b4737 100644 --- a/windows.gaming.input/flightstick_getcurrentreading_1416488181.md +++ b/windows.gaming.input/flightstick_getcurrentreading_1416488181.md @@ -21,8 +21,10 @@ The current state of the flight stick. ## -remarks +To gather input from a flight stick, you must *poll* the flight stick using this method. The method returns a **FlightStickReading** that has information about which buttons are being pressed, the joystick's roll, pitch, and yaw, and so on. See [Reading the flight stick](https://docs.microsoft.com/windows/uwp/gaming/flight-stick#reading-the-flight-stick) for more information about how to read input from a flight stick. + ## -see-also * [Windows.Gaming.Input.FlightStickReading](flightstickreading.md) -## -examples +## -examples \ No newline at end of file diff --git a/windows.gaming.input/flightstick_hatswitchkind.md b/windows.gaming.input/flightstick_hatswitchkind.md index 52314a8ec1..65349147cf 100644 --- a/windows.gaming.input/flightstick_hatswitchkind.md +++ b/windows.gaming.input/flightstick_hatswitchkind.md @@ -26,3 +26,4 @@ A hat switch is a control often used for camera view and/or target selection. It * [Windows.Gaming.Input.GameControllerSwitchKind](gamecontrollerswitchkind.md) ## -examples + diff --git a/windows.gaming.input/flightstick_headset.md b/windows.gaming.input/flightstick_headset.md index 8de733cac3..dccfc88662 100644 --- a/windows.gaming.input/flightstick_headset.md +++ b/windows.gaming.input/flightstick_headset.md @@ -19,6 +19,8 @@ The audio headset attached to the flight stick. ## -remarks +See [Headset](https://docs.microsoft.com/windows/uwp/gaming/headset) for information about programming for headsets. + ## -see-also * [Windows.Gaming.Input.Headset](headset.md) diff --git a/windows.gaming.input/flightstick_headsetconnected.md b/windows.gaming.input/flightstick_headsetconnected.md index 004929db6b..71afe3b48a 100644 --- a/windows.gaming.input/flightstick_headsetconnected.md +++ b/windows.gaming.input/flightstick_headsetconnected.md @@ -15,9 +15,21 @@ Signals when a headset is attached to the flight stick. ## -remarks +For more information on detecting, tracking, and using headsets, see [Headset](https://docs.microsoft.com/windows/uwp/gaming/headset). + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) * [Windows.Gaming.Input.Headset](headset.md) ## -examples + +The following example shows how to register a handler for this event. `flightStick` is a **FlightStick** that's connected to the device. + +```cpp +flightStick.HeadsetConnected += ref new TypedEventHandler( + [] (IGameController^ device, Headset^ headset) +{ + // Enable headset capture and playback on this device. +}); +``` \ No newline at end of file diff --git a/windows.gaming.input/flightstick_headsetdisconnected.md b/windows.gaming.input/flightstick_headsetdisconnected.md index d096988954..50574dadf6 100644 --- a/windows.gaming.input/flightstick_headsetdisconnected.md +++ b/windows.gaming.input/flightstick_headsetdisconnected.md @@ -15,9 +15,21 @@ Signals when a headset is disconnected from the flight stick. ## -remarks +For more information on detecting, tracking, and using headsets, see [Headset](https://docs.microsoft.com/windows/uwp/gaming/headset). + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) * [Windows.Gaming.Input.Headset](headset.md) ## -examples + +The following example shows how to register a handler for this event. `flightStick` is a **FlightStick** that's connected to the device. + +```cpp +flightStick.HeadsetDisconnected += ref new TypedEventHandler( + [] (IGameController^ device, Headset^ headset) +{ + // Enable headset capture and playback on this device. +}); +``` \ No newline at end of file diff --git a/windows.gaming.input/flightstick_user.md b/windows.gaming.input/flightstick_user.md index a6b8018b09..98643f8060 100644 --- a/windows.gaming.input/flightstick_user.md +++ b/windows.gaming.input/flightstick_user.md @@ -19,6 +19,8 @@ The user associated with the flight stick. ## -remarks +See [Tracking users and their devices](https://docs.microsoft.com/windows/uwp/gaming/input-practices-for-games#tracking-users-and-their-devices) for information about how to keep track of users. + ## -see-also [Windows.System.User](../windows.system/user.md) diff --git a/windows.gaming.input/flightstick_userchanged.md b/windows.gaming.input/flightstick_userchanged.md index 6745b77b86..3efcd9b826 100644 --- a/windows.gaming.input/flightstick_userchanged.md +++ b/windows.gaming.input/flightstick_userchanged.md @@ -15,6 +15,8 @@ Signals when the user associated with the flight stick has changed. ## -remarks +See [Tracking users and their devices](https://docs.microsoft.com/windows/uwp/gaming/input-practices-for-games#tracking-users-and-their-devices) for more information about how to keep track of users. + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) diff --git a/windows.gaming.input/flightstickreading.md b/windows.gaming.input/flightstickreading.md index f8363daeca..6c59bfb31c 100644 --- a/windows.gaming.input/flightstickreading.md +++ b/windows.gaming.input/flightstickreading.md @@ -53,6 +53,8 @@ The amount of yaw (rotation around the Y-axis; usually read from twisting the jo ## -remarks +For information about how to process the information provided in this structure, see [Flight stick](https://docs.microsoft.com/windows/uwp/gaming/flight-stick). + ## -see-also * [Windows.Gaming.Input.FlightStickButtons](flightstickbuttons.md) diff --git a/windows.gaming.input/gamepad_fromgamecontroller_421915006.md b/windows.gaming.input/gamepad_fromgamecontroller_421915006.md index b6202b7dae..a3a7dfa2e5 100644 --- a/windows.gaming.input/gamepad_fromgamecontroller_421915006.md +++ b/windows.gaming.input/gamepad_fromgamecontroller_421915006.md @@ -25,8 +25,27 @@ The gamepad that was returned from the given game controller. ## -remarks +This method checks if the provided game controller has a gamepad implementation, and if so, it returns that implementation. You might use this method if you want to first get the controller as a [RawGameController](rawgamecontroller.md), and then see if it can be used as a **Gamepad**—if so, you can use a default control scheme for gamepads, otherwise you can let the player do their own input mapping. + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) ## -examples + +In the following example, the app gets the first available [RawGameController](rawgamecontroller.md) object, and tries to access this game controller via the **Gamepad** class: + +```cpp +Gamepad^ gamepad; + +if (RawGameController::RawGameControllers->Size > 0) +{ + RawGameController^ rawGameController = RawGameController::RawGameControllers->GetAt(0); + gamepad = Gamepad::FromGameController(rawGameController); +} + +if (gamepad != nullptr) +{ + // Assign a standard button mapping to this controller. +} +``` \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_fromgamecontroller_421915006.md b/windows.gaming.input/racingwheel_fromgamecontroller_421915006.md index 88c000010c..c31ccc6e78 100644 --- a/windows.gaming.input/racingwheel_fromgamecontroller_421915006.md +++ b/windows.gaming.input/racingwheel_fromgamecontroller_421915006.md @@ -25,8 +25,29 @@ The racing wheel that was returned from the given game controller. ## -remarks +This method checks if the provided game controller has a racing wheel implementation, and if so, it returns that implementation. You might use this method if you want to first get the controller as a [RawGameController](rawgamecontroller.md), and then see if it can be used as a **RacingWheel**—if so, you can use a default control scheme for racing wheels, otherwise you can let the player do their own input mapping. + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) ## -examples + +In the following example, the app gets the first available [RawGameController](rawgamecontroller.md) object, and tries to access this game controller via the **RacingWheel** class: + +```cpp +RacingWheel^ racingWheel; + +if (RawGameController::RawGameControllers->Size > 0) +{ + RawGameController^ rawGameController = + RawGameController::RawGameControllers->GetAt(0); + + racingWheel = RacingWheel::FromGameController(rawGameController); +} + +if (racingWheel != nullptr) +{ + // Assign a standard button mapping to this controller. +} +``` \ No newline at end of file diff --git a/windows.gaming.input/rawgamecontroller.md b/windows.gaming.input/rawgamecontroller.md index d84e1ddf32..f175f8f70e 100644 --- a/windows.gaming.input/rawgamecontroller.md +++ b/windows.gaming.input/rawgamecontroller.md @@ -21,9 +21,11 @@ All inputs available on a **RawGameController** are exposed as simple arrays of You'll need to create these arrays yourself, and then populate them using [RawGameController.GetCurrentReading](rawgamecontroller_getcurrentreading.md) to determine the states of the buttons, switches, and axes. See that function's documentation for more information. +See [Raw game controller](https://docs.microsoft.com/en-us/windows/uwp/gaming/raw-game-controller) for information about how to use the **RawGameController** class. + ## -see-also -* [Windows.Gaming.Input.IGameController](igamecontroller.md) -* [Windows.Gaming.Input.IGameControllerBatteryInfo](igamecontrollerbatteryinfo.md) +* [Windows.Gaming.Input.IGameController interface](igamecontroller.md) +* [Windows.Gaming.Input.IGameControllerBatteryInfo interface](igamecontrollerbatteryinfo.md) ## -examples diff --git a/windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md b/windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md index 65c9d28cfb..153ddf318f 100644 --- a/windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md +++ b/windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md @@ -25,6 +25,8 @@ The raw game controller that was returned from the given game controller. ## -remarks +This method checks if the provided game controller has a raw game controller implementation, and if so, it returns that implementation. You might use this method if you want to first get the controller as a [RawGameController](rawgamecontroller.md), and then see if it can be used as another type of controller, such as a [Gamepad](gamepad.md)—if so, you can use a default control scheme for that controller type, otherwise you can let the player do their own input mapping. + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) diff --git a/windows.gaming.input/rawgamecontroller_getbuttonlabel_214310582.md b/windows.gaming.input/rawgamecontroller_getbuttonlabel_214310582.md index 689752c5e6..821f0d0993 100644 --- a/windows.gaming.input/rawgamecontroller_getbuttonlabel_214310582.md +++ b/windows.gaming.input/rawgamecontroller_getbuttonlabel_214310582.md @@ -21,13 +21,13 @@ The button for which to retrieve the label. ## -returns -Returns the label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned. +The label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned. ## -remarks Unlike the **GetButtonLabel** member functions of other classes, such as [ArcadeStick.GetButtonLabel](arcadestick_getbuttonlabel.md), this function takes an integer, rather than an [ArcadeStickButtons](arcadestickbuttons.md) or other enumeration value. This integer is an index into the buttons array for the raw game controller. -You can create your own buttons array and then populate it with values representing each button's state using [RawGameController.GetCurrentReading](rawgamecontroller_getcurrentreading.md). See that function's documentation for more information. +You can create your own buttons array and then populate it with values representing each button's state using [RawGameController.GetCurrentReading](rawgamecontroller_getcurrentreading.md). See [Raw game controller](https://docs.microsoft.com/windows/uwp/gaming/raw-game-controller) for more information. ## -see-also diff --git a/windows.gaming.input/rawgamecontroller_getcurrentreading_123740519.md b/windows.gaming.input/rawgamecontroller_getcurrentreading_123740519.md index df1dc3ec7b..7173f09667 100644 --- a/windows.gaming.input/rawgamecontroller_getcurrentreading_123740519.md +++ b/windows.gaming.input/rawgamecontroller_getcurrentreading_123740519.md @@ -37,6 +37,8 @@ Unlike the **GetCurrentReading** member functions of other classes, such as [Arc **RawGameController.GetCurrentReading** populates each of these arrays with the current states of each input. The button array is an array of Booleans, where **true** means the button is pressed and **false** means it is not. The switch array is an array of [GameControllerSwitchPosition](gamecontrollerswitchposition.md), where the value at each index represents that switch's current position. Finally, the axis array is an array of doubles, where the value at each index (between 0.0 and 1.0) represents the position of that axis. +See [Raw game controller](https://docs.microsoft.com/windows/uwp/gaming/raw-game-controller) for more information about how to read input from a raw game controller. + ## -see-also * [Windows.Gaming.Input.GameControllerSwitchPosition](gamecontrollerswitchposition.md) diff --git a/windows.gaming.input/rawgamecontroller_getswitchkind_1074485771.md b/windows.gaming.input/rawgamecontroller_getswitchkind_1074485771.md index 818684dfff..f5f7fd7f6d 100644 --- a/windows.gaming.input/rawgamecontroller_getswitchkind_1074485771.md +++ b/windows.gaming.input/rawgamecontroller_getswitchkind_1074485771.md @@ -25,7 +25,7 @@ The type of the given switch on the raw game controller. ## -remarks -This function takes an integer, which is the index of the raw game controller's switch array that points to the switch you want to query. You can create your own switch array and then populate it with values representing each switch's state using [RawGameController.GetCurrentReading](rawgamecontroller_getcurrentreading.md). See that function's documentation for more information. +This function takes an integer, which is the index in the raw game controller's switch array that points to the switch you want to query. You can create your own switch array and then populate it with values representing each switch's state using [RawGameController.GetCurrentReading](rawgamecontroller_getcurrentreading.md). See [Raw game controller](https://docs.microsoft.com/windows/uwp/gaming/raw-game-controller) for more information. ## -see-also diff --git a/windows.gaming.input/rawgamecontroller_hardwareproductid.md b/windows.gaming.input/rawgamecontroller_hardwareproductid.md index 397fae3c97..c4f99b6e7e 100644 --- a/windows.gaming.input/rawgamecontroller_hardwareproductid.md +++ b/windows.gaming.input/rawgamecontroller_hardwareproductid.md @@ -19,6 +19,22 @@ The hardware product ID of the raw game controller. ## -remarks +If you have a specific controller that you want to support, you can get this value and [RawGameController.HardwareVendorId](https://docs.microsoft.com/uwp/api/windows.gaming.input.rawgamecontroller#Windows_Gaming_Input_RawGameController_HardwareVendorId) and check that they match the controller. The position of each input in each array that you get from [RawGameController.GetCurrentReading](https://docs.microsoft.com/uwp/api/windows.gaming.input.rawgamecontroller#Windows_Gaming_Input_RawGameController_GetCurrentReading_System_Boolean___Windows_Gaming_Input_GameControllerSwitchPosition___System_Double___) is the same for every controller with the same **HardwareProductId** and **HardwareVendorId**, so you don't have to worry about your logic potentially being inconsistent among different controllers of the same type. + ## -see-also ## -examples + +The following example checks if the given raw game controller's PID and VID (Product ID and Vendor ID, respectively) match the given PID and VID. + +```cpp +void CheckIfMatch(RawGameController rawGameController, unsigned short pid, unsigned short vid) +{ + if ((rawGameController.HardwareProductId == pid) && + (rawGameController.HardwareVendorId == vid)) + { + /* This controller is the type that we're checking for, so we can assign a + specific input mapping. */ + } +} +``` \ No newline at end of file diff --git a/windows.gaming.input/rawgamecontroller_hardwarevendorid.md b/windows.gaming.input/rawgamecontroller_hardwarevendorid.md index a29d321c98..03f5f0a53c 100644 --- a/windows.gaming.input/rawgamecontroller_hardwarevendorid.md +++ b/windows.gaming.input/rawgamecontroller_hardwarevendorid.md @@ -19,6 +19,8 @@ The hardware vendor ID of the raw game controller. ## -remarks +See [RawGameController.HardwareProductId](rawgamecontroller_hardwareproductid.md) for information about how to use this value to support specific types of controllers. + ## -see-also ## -examples diff --git a/windows.gaming.input/rawgamecontroller_headset.md b/windows.gaming.input/rawgamecontroller_headset.md index bb8c1e4cbd..a34858b4d6 100644 --- a/windows.gaming.input/rawgamecontroller_headset.md +++ b/windows.gaming.input/rawgamecontroller_headset.md @@ -19,6 +19,8 @@ The audio headset attached to the raw game controller. ## -remarks +See [Headset](https://docs.microsoft.com/windows/uwp/gaming/headset) for information about programming for headsets. + ## -see-also * [Windows.Gaming.Input.Headset](headset.md) diff --git a/windows.gaming.input/rawgamecontroller_headsetconnected.md b/windows.gaming.input/rawgamecontroller_headsetconnected.md index b973d04fbe..277a6f20eb 100644 --- a/windows.gaming.input/rawgamecontroller_headsetconnected.md +++ b/windows.gaming.input/rawgamecontroller_headsetconnected.md @@ -15,9 +15,21 @@ Signals when a headset is attached to the raw game controller. ## -remarks +For more information on detecting, tracking, and using headsets, see [Headset](https://docs.microsoft.com/windows/uwp/gaming/headset). + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) * [Windows.Gaming.Input.Headset](headset.md) ## -examples + +The following example shows how to register a handler for this event. `rawGameController` is a **RawGameController** that's connected to the device. + +```cpp +rawGameController.HeadsetConnected += ref new TypedEventHandler( + [] (IGameController^ device, Headset^ headset) +{ + // Enable headset capture and playback on this device. +}); +``` \ No newline at end of file diff --git a/windows.gaming.input/rawgamecontroller_headsetdisconnected.md b/windows.gaming.input/rawgamecontroller_headsetdisconnected.md index 3d44f2688d..c8060aa810 100644 --- a/windows.gaming.input/rawgamecontroller_headsetdisconnected.md +++ b/windows.gaming.input/rawgamecontroller_headsetdisconnected.md @@ -15,9 +15,21 @@ Signals when a headset is disconnected from the raw game controller. ## -remarks +For more information on detecting, tracking, and using headsets, see [Headset](https://docs.microsoft.com/windows/uwp/gaming/headset). + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) * [Windows.Gaming.Input.Headset](headset.md) ## -examples + +The following example shows how to register a handler for this event. `rawGameController` is a **RawGameController** that's connected to the device. + +```cpp +rawGameController.HeadsetDisconnected += ref new TypedEventHandler( + [] (IGameController^ device, Headset^ headset) +{ + // Enable headset capture and playback on this device. +}); +``` \ No newline at end of file diff --git a/windows.gaming.input/rawgamecontroller_rawgamecontrolleradded.md b/windows.gaming.input/rawgamecontroller_rawgamecontrolleradded.md index 2b63d013d7..3574e330d3 100644 --- a/windows.gaming.input/rawgamecontroller_rawgamecontrolleradded.md +++ b/windows.gaming.input/rawgamecontroller_rawgamecontrolleradded.md @@ -15,8 +15,19 @@ Signals when a new raw game controller is connected. ## -remarks -To identify controllers that have already been added, you query the list of connected controllers using [RawGameController.RawGameControllers](rawgamecontroller_rawgamecontrollers.md). +To identify controllers that have already been added, you query the list of connected controllers using [RawGameController.RawGameControllers](rawgamecontroller_rawgamecontrollers.md). However, because you might only be interested in some of the connected raw game controllers, we recommend that you maintain your own collection instead of accessing them through **RawGameControllers**. ## -see-also ## -examples + +The following example starts tracking a raw game controller that's been added. `myRawGameControllers` is a `Vector` that contains the raw game controllers that your game is tracking. + +```cpp +RawGameController::RawGameControllerAdded += ref new EventHandler( + [] (Platform::Object^, RawGameController^ args) +{ + // This code assumes that you're interested in all new raw game controllers. + myRawGameControllers->Append(args); +}); +``` \ No newline at end of file diff --git a/windows.gaming.input/rawgamecontroller_rawgamecontrollerremoved.md b/windows.gaming.input/rawgamecontroller_rawgamecontrollerremoved.md index 135327d6df..c4471e8f17 100644 --- a/windows.gaming.input/rawgamecontroller_rawgamecontrollerremoved.md +++ b/windows.gaming.input/rawgamecontroller_rawgamecontrollerremoved.md @@ -15,6 +15,22 @@ Signals when a raw game controller is disconnected. ## -remarks +The following example stops tracking a raw game controller that's been removed. `myRawGameControllers` is a `Vector` that contains the raw game controllers that your game is tracking. + +```cpp +RawGameController::RawGameControllerRemoved += + ref new EventHandler( + [] (Platform::Object^, RawGameController^ args) +{ + unsigned int indexRemoved; + + if (myRawGameControllers->IndexOf(args, &indexRemoved)) + { + myRawGameControllers->RemoveAt(indexRemoved); + } +}); +``` + ## -see-also ## -examples diff --git a/windows.gaming.input/rawgamecontroller_rawgamecontrollers.md b/windows.gaming.input/rawgamecontroller_rawgamecontrollers.md index 92a9c8ec35..ac2069aec9 100644 --- a/windows.gaming.input/rawgamecontroller_rawgamecontrollers.md +++ b/windows.gaming.input/rawgamecontroller_rawgamecontrollers.md @@ -19,6 +19,20 @@ The list of all connected raw game controllers. ## -remarks +**RawGameController** objects are managed by the system, therefore you don't have to create or initialize them. Instead, you can access connected raw game controllers through this property. Because you might only be interested in some of the connected raw game controllers, we recommend that you maintain your own collection. + ## -see-also ## -examples + +The following example copies all connected raw game controllers into a new collection: + +```cpp +auto myRawGameControllers = ref new Vector(); + +for (auto rawGameController : RawGameController::RawGameControllers) +{ + // This code assumes that you're interested in all raw game controllers. + myRawGameControllers->Append(rawGameController); +} +``` \ No newline at end of file diff --git a/windows.gaming.input/rawgamecontroller_user.md b/windows.gaming.input/rawgamecontroller_user.md index bbaf5b14ee..64836314ac 100644 --- a/windows.gaming.input/rawgamecontroller_user.md +++ b/windows.gaming.input/rawgamecontroller_user.md @@ -19,6 +19,8 @@ The user associated with the raw game controller. ## -remarks +See [Tracking users and their devices](https://docs.microsoft.com/windows/uwp/gaming/input-practices-for-games#tracking-users-and-their-devices) for information about how to keep track of users. + ## -see-also * [Windows.System.User](../windows.system/user.md) diff --git a/windows.gaming.input/rawgamecontroller_userchanged.md b/windows.gaming.input/rawgamecontroller_userchanged.md index ff1fc8248f..0e255b7048 100644 --- a/windows.gaming.input/rawgamecontroller_userchanged.md +++ b/windows.gaming.input/rawgamecontroller_userchanged.md @@ -15,6 +15,8 @@ Signals when the user associated with the raw game controller has changed. ## -remarks +See [Tracking users and their devices](https://docs.microsoft.com/windows/uwp/gaming/input-practices-for-games#tracking-users-and-their-devices) for more information about how to keep track of users. + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) diff --git a/windows.gaming.input/uinavigationcontroller_fromgamecontroller_421915006.md b/windows.gaming.input/uinavigationcontroller_fromgamecontroller_421915006.md index e0c528cc3a..e86681ee72 100644 --- a/windows.gaming.input/uinavigationcontroller_fromgamecontroller_421915006.md +++ b/windows.gaming.input/uinavigationcontroller_fromgamecontroller_421915006.md @@ -25,8 +25,30 @@ The UI navigation controller that was returned from the given game controller. ## -remarks +This method checks if the provided game controller has a UI navigation controller implementation, and if so, it returns that implementation. You might use this method if you want to first get the controller as a [RawGameController](rawgamecontroller.md), and then see if it can be used as a **UINavigationController**—if so, you can use a default control scheme for UI navigation controllers, otherwise you can let the player do their own input mapping. + ## -see-also * [Windows.Gaming.Input.IGameController](igamecontroller.md) ## -examples + +In the following example, the app gets the first available [RawGameController](rawgamecontroller.md) object, and tries to access this game controller via the **UINavigationController** class: + +```cpp +UINavigationController^ uiNavigationController; + +if (RawGameController::RawGameControllers->Size > 0) +{ + RawGameController^ rawGameController = + RawGameController::RawGameControllers->GetAt(0); + + uiNavigationController = + UINavigationController::FromGameController(rawGameController); +} + +if (uiNavigationController != nullptr) +{ + // Assign a standard button mapping to this controller. +} +``` \ No newline at end of file diff --git a/windows.graphics.display/brightnessoverride.md b/windows.graphics.display/brightnessoverride.md index 10bcaf489f..1a0d057b07 100644 --- a/windows.graphics.display/brightnessoverride.md +++ b/windows.graphics.display/brightnessoverride.md @@ -17,4 +17,4 @@ Use the [BrightnessOverride](brightnessoverride.md) object to override the user' ## -see-also -## -examples +## -examples \ No newline at end of file diff --git a/windows.graphics.display/brightnessoverride_getdefaultforsystem_1452001692.md b/windows.graphics.display/brightnessoverride_getdefaultforsystem_1452001692.md index 7d1ee4fe9b..79d3a29fc5 100644 --- a/windows.graphics.display/brightnessoverride_getdefaultforsystem_1452001692.md +++ b/windows.graphics.display/brightnessoverride_getdefaultforsystem_1452001692.md @@ -16,9 +16,24 @@ Returns a brightness override object. This method does not require [CoreWindow]( The brightness override object. ## -remarks -Requires the Embedded Mode capability to be declared and enabled. +Requires the __systemManagement__ capability to be declared in your app's package manifest. This capability allows apps to have basic system administration privileges. If it isn’t declared, this method throws an access is denied exception. For more info, see [App capability declarations](https://docs.microsoft.com/windows/uwp/packaging/app-capability-declarations#general-use-capabilities). ## -see-also ## -examples +This example overrides the device's brightness at full brightness, but is used by apps that run in the background and do not have a [CoreWindow](../windows.ui.core/corewindow.md). + +```csharp +private void Set_Full_Brightness_AppsInBackground() +{ + //Create BrightnessOverride object + BrightnessOverride bo = BrightnessOverride.GetDefaultForSystem(); + + //Set override brightness to full brightness even when battery is low + bo.SetBrightnessScenario(DisplayBrightnessScenario.FullBrightness, DisplayBrightnessOverrideOptions.None); + + //Request to start the overriding process + bo.StartOverride(); +} +``` \ No newline at end of file diff --git a/windows.graphics.display/brightnessoverride_getforcurrentview_1363600702.md b/windows.graphics.display/brightnessoverride_getforcurrentview_1363600702.md index 754c8f29e5..68adf484d0 100644 --- a/windows.graphics.display/brightnessoverride_getforcurrentview_1363600702.md +++ b/windows.graphics.display/brightnessoverride_getforcurrentview_1363600702.md @@ -16,9 +16,24 @@ Returns a brightness override object. This method requires [CoreWindow](../windo The brightness override object. ## -remarks -This method fails if there is no [CoreWindow](../windows.ui.core/corewindow.md) on the calling thread. +This method throws an access is denied exception if there is no [CoreWindow](../windows.ui.core/corewindow.md) on the calling thread. ## -see-also ## -examples +This example shows how apps that run in a window can override the device's brightness at full brightness. To stop the overriding process, use [StopOverride()](brightnessoverride_stopoverride_1207260318.md). + +```csharp +private void Set_Full_Brightness() +{ + //Create BrightnessOverride object + BrightnessOverride bo = BrightnessOverride.GetForCurrentView(); + + //Set override brightness to full brightness even when battery is low + bo.SetBrightnessScenario(DisplayBrightnessScenario.FullBrightness, DisplayBrightnessOverrideOptions.None); + + //Request to start the overriding process + bo.StartOverride(); +} +``` \ No newline at end of file diff --git a/windows.graphics.display/brightnessoverride_isoverrideactivechanged.md b/windows.graphics.display/brightnessoverride_isoverrideactivechanged.md index 4bc0b47734..d7cd562e29 100644 --- a/windows.graphics.display/brightnessoverride_isoverrideactivechanged.md +++ b/windows.graphics.display/brightnessoverride_isoverrideactivechanged.md @@ -18,3 +18,13 @@ Occurs when the screen brightness level either starts to match or stops to match ## -examples +This example shows how to use the [IsOverrideActiveChanged](brightnessoverride_isoverrideactivechanged.md) event and the __OnIsOverrideActiveChanged__ event handler to notify the user whether or not the brightness override object is in fact controlling the screen brightness. + +```csharp +bo.IsOverrideActiveChanged += OnIsOverrideActiveChanged; +... +private void OnIsOverrideActiveChanged(BrightnessOverride sender, object e) +{ + rootPage.NotifyUser("Brightness override is " + (sender.IsOverrideActive ? "active" : "not active"), NotifyType.StatusMessage); +} +``` diff --git a/windows.graphics.display/brightnessoverride_issupported.md b/windows.graphics.display/brightnessoverride_issupported.md index 45f9f0d27f..e62ba63cf2 100644 --- a/windows.graphics.display/brightnessoverride_issupported.md +++ b/windows.graphics.display/brightnessoverride_issupported.md @@ -10,7 +10,7 @@ public bool IsSupported { get; } # Windows.Graphics.Display.BrightnessOverride.IsSupported ## -description -Indicates whether the device is able to support brightness override. If TRUE, the device currently has at least one brightness controllable display. +Indicates whether the device currently has at least one brightness controllable display. If TRUE, the device has at least one brightness controllable display that supports brightness override. ## -property-value diff --git a/windows.graphics.display/brightnessoverride_saveforsystemasync_723572109.md b/windows.graphics.display/brightnessoverride_saveforsystemasync_723572109.md index 24da7a1f24..a0572e3247 100644 --- a/windows.graphics.display/brightnessoverride_saveforsystemasync_723572109.md +++ b/windows.graphics.display/brightnessoverride_saveforsystemasync_723572109.md @@ -21,7 +21,7 @@ The brightness override object. BOOLEAN value to indicate if the operation is successful or not. ## -remarks -Requires the Embedded Mode capability to be declared and enabled. +Requires the __systemManagement__ capability to be declared in your app's package manifest. This capability allows apps to have basic system administration privileges. If it isn’t declared, this method throws an access is denied exception. For more info, see [App capability declarations](https://docs.microsoft.com/windows/uwp/packaging/app-capability-declarations#general-use-capabilities). ## -see-also diff --git a/windows.graphics.display/brightnessoverride_setbrightnesslevel_519170707.md b/windows.graphics.display/brightnessoverride_setbrightnesslevel_519170707.md index c7329488a9..44ddadf43c 100644 --- a/windows.graphics.display/brightnessoverride_setbrightnesslevel_519170707.md +++ b/windows.graphics.display/brightnessoverride_setbrightnesslevel_519170707.md @@ -10,7 +10,7 @@ public void BrightnessOverride.SetBrightnessLevel(Double brightnessLevel, Displa # Windows.Graphics.Display.BrightnessOverride.SetBrightnessLevel ## -description -Sets the brightness level and the override options. +Sets the brightness level and the override options. When your app is ready to change the current brightness with what you want to override it with, call [StartOverride()](brightnessoverride_startoverride_1290413150.md). ## -parameters @@ -26,3 +26,8 @@ Options that modify the brightness level of the screen during the brightness ove ## -examples +```csharp +/* Set display to 80% brightness and if the device is on low battery during overriding, allow the display to dim*/ + +bo.SetBrightnessLevel(0.80, DisplayBrightnessOverrideOptions.UseDimmedPolicyWhenBatteryIsLow); +``` diff --git a/windows.graphics.display/brightnessoverride_setbrightnessscenario_1995700297.md b/windows.graphics.display/brightnessoverride_setbrightnessscenario_1995700297.md index 338b7a81c3..7e2979e8d1 100644 --- a/windows.graphics.display/brightnessoverride_setbrightnessscenario_1995700297.md +++ b/windows.graphics.display/brightnessoverride_setbrightnessscenario_1995700297.md @@ -26,3 +26,8 @@ Options that modify the brightness level of the screen during the brightness ove ## -examples +```csharp +/* Set the display brightness to a level that is optimum for reading barcodes. If the device is on low battery during overriding, allow the display to dim*/ + +bo.SetBrightnessScenario(DisplayBrightnessScenario.BarcodeReadingBrightness, DisplayBrightnessOverrideOptions.UseDimmedPolicyWhenBatteryIsLow); +``` diff --git a/windows.graphics.display/brightnessoverride_startoverride_1290413150.md b/windows.graphics.display/brightnessoverride_startoverride_1290413150.md index 8796962962..3b0648731a 100644 --- a/windows.graphics.display/brightnessoverride_startoverride_1290413150.md +++ b/windows.graphics.display/brightnessoverride_startoverride_1290413150.md @@ -10,7 +10,7 @@ public void BrightnessOverride.StartOverride() # Windows.Graphics.Display.BrightnessOverride.StartOverride ## -description -Request to start overriding the screen brightness level. The request to start overriding does not mean that the screen brightness level always changes to match the specified override brightness level. It's still up to the system to decide whether or not to honor this override request. +Request to start overriding the screen brightness level. The request to start overriding does not mean that the screen brightness level always changes to match the specified override brightness level. It's still up to the system to decide whether or not to honor this override request. Use [IsOverrideActive](brightnessoverride_isoverrideactive.md) and [IsOverrideActiveChanged](brightnessoverride_isoverrideactivechanged.md) properties to determine if the system has honored the override request. ## -remarks diff --git a/windows.graphics.display/displayorientations.md b/windows.graphics.display/displayorientations.md index d294306f7f..6dc16c7f0d 100644 --- a/windows.graphics.display/displayorientations.md +++ b/windows.graphics.display/displayorientations.md @@ -48,9 +48,9 @@ A device that is first oriented in portrait mode has the following angles of rot + **Landscape** = 270 degrees -The [Scaling according to DPI sample](http://go.microsoft.com/fwlink/p/?linkid=231577) shows how to use the [DisplayOrientations](displayorientations.md) enumeration. +The [Scaling according to DPI sample](http://go.microsoft.com/fwlink/p/?LinkId=624042) shows how to use the [DisplayOrientations](displayorientations.md) enumeration. -The [DisplayOrientations](displayorientations.md) values describe the orientation of the display or monitor and not necessarily the orientation of your app. To determine the orientation of your app for layout purposes, use the [ApplicationView.Value](../windows.ui.viewmanagement/applicationview_value.md) property. +The [DisplayOrientations](displayorientations.md) values describe the orientation of the display or monitor and not necessarily the orientation of your app. To determine the orientation of your app for layout purposes, use the [ApplicationView.Orientation](../windows.ui.viewmanagement/applicationview_orientation.md) property. ## -examples diff --git a/windows.graphics.holographic/holographicadapterid.md b/windows.graphics.holographic/holographicadapterid.md index 5865f92af0..ae8adb676b 100644 --- a/windows.graphics.holographic/holographicadapterid.md +++ b/windows.graphics.holographic/holographicadapterid.md @@ -1,6 +1,7 @@ --- -api-id: T:Windows.Graphics.Holographic.HolographicAdapterId -api-type: winrt struct +-api-device-family-note: xbox --- -An app that contains media elements has Play To enabled by default. If a user invokes the **Devices** charm while running the app and selects a target device to stream media to, Play To will stream the media from the first audio, video, or image element on the current page. You can disable this default behavior by setting the **DefaultSourceSelection** property to **false**.```javascript +An app that contains media elements has Play To enabled by default. If a user invokes the **Devices** charm while running the app and selects a target device to stream media to, Play To will stream the media from the first audio, video, or image element on the current page. You can disable this default behavior by setting the **DefaultSourceSelection** property to **false**. +```javascript var ptm = Windows.Media.PlayTo.PlayToManager.getForCurrentView(); ptm.defaultSourceSelection = false; @@ -25,7 +26,8 @@ ptm.defaultSourceSelection = false; -You can exclude individual HTML elements from the default Play To behavior by adding the **-ms-playToDisabled** attribute in your HTML markup.```javascript +You can exclude individual HTML elements from the default Play To behavior by adding the **-ms-playToDisabled** attribute in your HTML markup. +```javascript