diff --git a/windows.applicationmodel.activation/activationkind.md b/windows.applicationmodel.activation/activationkind.md index b7134ed341..3345ab9b2f 100644 --- a/windows.applicationmodel.activation/activationkind.md +++ b/windows.applicationmodel.activation/activationkind.md @@ -118,9 +118,20 @@ Introduced in Windows 10, version 1607. Reserved for system use. Introduced in Windows 10, version 1607. +### -field ContactPanel:1017 + + +### -field LockScreenComponent:1016 + + +### -field PrintWorkflowForegroundTask:1018 + + ## -remarks ## -examples ## -see-also -[CachedFileUpdaterActivatedEventArgs.Kind](cachedfileupdateractivatedeventargs_kind.md), [CameraSettingsActivatedEventArgs.Kind](camerasettingsactivatedeventargs_kind.md), [ContactPickerActivatedEventArgs.Kind](contactpickeractivatedeventargs_kind.md), [DeviceActivatedEventArgs.Kind](deviceactivatedeventargs_kind.md), [FileActivatedEventArgs.Kind](fileactivatedeventargs_kind.md), [FileOpenPickerActivatedEventArgs.Kind](fileopenpickeractivatedeventargs_kind.md), [FileSavePickerActivatedEventArgs.Kind](filesavepickeractivatedeventargs_kind.md), [LaunchActivatedEventArgs.Kind](launchactivatedeventargs_kind.md), [LockScreenActivatedEventsArg.Kind](lockscreenactivatedeventargs_kind.md), [PrintTaskSettingsActivatedEventArgs.Kind](printtasksettingsactivatedeventargs_kind.md), [ProtocolActivatedEventArgs.Kind](protocolactivatedeventargs_kind.md), [SearchActivatedEventArgs.Kind](searchactivatedeventargs_kind.md), [ShareTargetActivatedEventArgs.Kind](sharetargetactivatedeventargs_kind.md), [WebUICachedFileUpdaterActivatedEventArgs.kind](../windows.ui.webui/webuicachedfileupdateractivatedeventargs_kind.md), [WebUICameraSettingsActivatedEventArgs.kind](../windows.ui.webui/webuicamerasettingsactivatedeventargs_kind.md), [WebUIContactPickerActivatedEventArgs.kind](../windows.ui.webui/webuicontactpickeractivatedeventargs_kind.md), [WebUIDeviceActivatedEventArgs.kind](../windows.ui.webui/webuideviceactivatedeventargs_kind.md), [WebUIFileActivatedEventArgs.kind](../windows.ui.webui/webuifileactivatedeventargs_kind.md), [WebUIFileOpenPickerActivatedEventArgs.kind](../windows.ui.webui/webuifileopenpickeractivatedeventargs_kind.md), [WebUIFileSavePickerActivatedEventArgs.kind](../windows.ui.webui/webuifilesavepickeractivatedeventargs_kind.md), [WebUILaunchActivatedEventArgs.kind](../windows.ui.webui/webuilaunchactivatedeventargs_kind.md), [WebUIPrintTaskSettingsActivatedEventArgs.kind](../windows.ui.webui/webuiprinttasksettingsactivatedeventargs_kind.md), [WebUIProtocolActivatedEventArgs.kind](../windows.ui.webui/webuiprotocolactivatedeventargs_kind.md), [WebUISearchActivatedEventArgs.kind](../windows.ui.webui/webuisearchactivatedeventargs_kind.md), [WebUIShareTargetActivatedEventArgs.kind](../windows.ui.webui/webuisharetargetactivatedeventargs_kind.md) \ No newline at end of file +[CachedFileUpdaterActivatedEventArgs.Kind](cachedfileupdateractivatedeventargs_kind.md), [CameraSettingsActivatedEventArgs.Kind](camerasettingsactivatedeventargs_kind.md), [ContactPickerActivatedEventArgs.Kind](contactpickeractivatedeventargs_kind.md), [DeviceActivatedEventArgs.Kind](deviceactivatedeventargs_kind.md), [FileActivatedEventArgs.Kind](fileactivatedeventargs_kind.md), [FileOpenPickerActivatedEventArgs.Kind](fileopenpickeractivatedeventargs_kind.md), [FileSavePickerActivatedEventArgs.Kind](filesavepickeractivatedeventargs_kind.md), [LaunchActivatedEventArgs.Kind](launchactivatedeventargs_kind.md), [LockScreenActivatedEventsArg.Kind](lockscreenactivatedeventargs_kind.md), [PrintTaskSettingsActivatedEventArgs.Kind](printtasksettingsactivatedeventargs_kind.md), [ProtocolActivatedEventArgs.Kind](protocolactivatedeventargs_kind.md), [SearchActivatedEventArgs.Kind](searchactivatedeventargs_kind.md), [ShareTargetActivatedEventArgs.Kind](sharetargetactivatedeventargs_kind.md), [WebUICachedFileUpdaterActivatedEventArgs.kind](../windows.ui.webui/webuicachedfileupdateractivatedeventargs_kind.md), [WebUICameraSettingsActivatedEventArgs.kind](../windows.ui.webui/webuicamerasettingsactivatedeventargs_kind.md), [WebUIContactPickerActivatedEventArgs.kind](../windows.ui.webui/webuicontactpickeractivatedeventargs_kind.md), [WebUIDeviceActivatedEventArgs.kind](../windows.ui.webui/webuideviceactivatedeventargs_kind.md), [WebUIFileActivatedEventArgs.kind](../windows.ui.webui/webuifileactivatedeventargs_kind.md), [WebUIFileOpenPickerActivatedEventArgs.kind](../windows.ui.webui/webuifileopenpickeractivatedeventargs_kind.md), [WebUIFileSavePickerActivatedEventArgs.kind](../windows.ui.webui/webuifilesavepickeractivatedeventargs_kind.md), [WebUILaunchActivatedEventArgs.kind](../windows.ui.webui/webuilaunchactivatedeventargs_kind.md), [WebUIPrintTaskSettingsActivatedEventArgs.kind](../windows.ui.webui/webuiprinttasksettingsactivatedeventargs_kind.md), [WebUIProtocolActivatedEventArgs.kind](../windows.ui.webui/webuiprotocolactivatedeventargs_kind.md), [WebUISearchActivatedEventArgs.kind](../windows.ui.webui/webuisearchactivatedeventargs_kind.md), [WebUIShareTargetActivatedEventArgs.kind](../windows.ui.webui/webuisharetargetactivatedeventargs_kind.md) + + diff --git a/windows.applicationmodel.activation/contactpanelactivatedeventargs.md b/windows.applicationmodel.activation/contactpanelactivatedeventargs.md new file mode 100644 index 0000000000..3feb0eb5fb --- /dev/null +++ b/windows.applicationmodel.activation/contactpanelactivatedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs + +## -description + +Provides data when an app is activated because it uses the Contact Panel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/contactpanelactivatedeventargs_contact.md b/windows.applicationmodel.activation/contactpanelactivatedeventargs_contact.md new file mode 100644 index 0000000000..cdc8bfcb0b --- /dev/null +++ b/windows.applicationmodel.activation/contactpanelactivatedeventargs_contact.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.Contact + +## -description + +Gets the selected contact from the Contact Panel. + +## -property-value + +The selected contact. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/contactpanelactivatedeventargs_contactpanel.md b/windows.applicationmodel.activation/contactpanelactivatedeventargs_contactpanel.md new file mode 100644 index 0000000000..7d8244a529 --- /dev/null +++ b/windows.applicationmodel.activation/contactpanelactivatedeventargs_contactpanel.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.ContactPanel +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.ContactPanel + +## -description + +Gets the contact panel. + +## -property-value + +The contact panel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/contactpanelactivatedeventargs_kind.md b/windows.applicationmodel.activation/contactpanelactivatedeventargs_kind.md new file mode 100644 index 0000000000..8486ec252a --- /dev/null +++ b/windows.applicationmodel.activation/contactpanelactivatedeventargs_kind.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.Kind + +## -description + +Gets the activation type. + +## -property-value + +The [ActivationKind.Contact](activationkind.md) enumeration value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/contactpanelactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/contactpanelactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..699dfaace2 --- /dev/null +++ b/windows.applicationmodel.activation/contactpanelactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.PreviousExecutionState + +## -description + +Gets the execution state of the app before it was activated. + +## -property-value + +A [ApplicationExecutionState](applicationexecutionstate.md)-typed value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/contactpanelactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/contactpanelactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..36f1c6ee8a --- /dev/null +++ b/windows.applicationmodel.activation/contactpanelactivatedeventargs_splashscreen.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.SplashScreen + +## -description + +Gets the splash screen object, which provides information about the transition from the splash screen to the activated app. + +## -property-value + +The object that provides splash screen information. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/contactpanelactivatedeventargs_user.md b/windows.applicationmodel.activation/contactpanelactivatedeventargs_user.md new file mode 100644 index 0000000000..27ec933d03 --- /dev/null +++ b/windows.applicationmodel.activation/contactpanelactivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ContactPanelActivatedEventArgs.User + +## -description + +Gets the user the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/devicepairingactivatedeventargs_user.md b/windows.applicationmodel.activation/devicepairingactivatedeventargs_user.md new file mode 100644 index 0000000000..68cf139db8 --- /dev/null +++ b/windows.applicationmodel.activation/devicepairingactivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DevicePairingActivatedEventArgs.User + +## -description + +Gets the user the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/dialreceiveractivatedeventargs_user.md b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_user.md new file mode 100644 index 0000000000..d5560cbdf1 --- /dev/null +++ b/windows.applicationmodel.activation/dialreceiveractivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.DialReceiverActivatedEventArgs.User + +## -description + +Gets the user the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/icontactpanelactivatedeventargs.md b/windows.applicationmodel.activation/icontactpanelactivatedeventargs.md new file mode 100644 index 0000000000..8ad2584084 --- /dev/null +++ b/windows.applicationmodel.activation/icontactpanelactivatedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.IContactPanelActivatedEventArgs +-api-type: winrt interface +--- + + + +# Windows.ApplicationModel.Activation.IContactPanelActivatedEventArgs + +## -description + +Provides data when an app is activated by the contact panel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/icontactpanelactivatedeventargs_contact.md b/windows.applicationmodel.activation/icontactpanelactivatedeventargs_contact.md new file mode 100644 index 0000000000..d82916dca3 --- /dev/null +++ b/windows.applicationmodel.activation/icontactpanelactivatedeventargs_contact.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactPanelActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactPanelActivatedEventArgs.Contact + +## -description + +Gets the contact. + +## -property-value + +The contact. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/icontactpanelactivatedeventargs_contactpanel.md b/windows.applicationmodel.activation/icontactpanelactivatedeventargs_contactpanel.md new file mode 100644 index 0000000000..64d90fdf30 --- /dev/null +++ b/windows.applicationmodel.activation/icontactpanelactivatedeventargs_contactpanel.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.IContactPanelActivatedEventArgs.ContactPanel +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.IContactPanelActivatedEventArgs.ContactPanel + +## -description + +Gets the contact panel. + +## -property-value + +The contact panel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/lockscreenactivatedeventargs_user.md b/windows.applicationmodel.activation/lockscreenactivatedeventargs_user.md new file mode 100644 index 0000000000..1117618454 --- /dev/null +++ b/windows.applicationmodel.activation/lockscreenactivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenActivatedEventArgs.User + +## -description + +Gets the user the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs.md b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs.md new file mode 100644 index 0000000000..0f663b7df2 --- /dev/null +++ b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs + +## -description + +Provides data when an app is activated as part of a lock screen component. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_kind.md b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_kind.md new file mode 100644 index 0000000000..471a0dbce0 --- /dev/null +++ b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_kind.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs.Kind + +## -description + +Gets the activation type. + +## -property-value + +The activation type. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..537832a4a2 --- /dev/null +++ b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs.PreviousExecutionState + +## -description + +Gets the execution state of the app before it was activated. + +## -property-value + +The execution state of the app before it was activated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..7737fb6a21 --- /dev/null +++ b/windows.applicationmodel.activation/lockscreencomponentactivatedeventargs_splashscreen.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.LockScreenComponentActivatedEventArgs.SplashScreen + +## -description + +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value + +The splash screen object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs.md b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs.md new file mode 100644 index 0000000000..26ba77d2dd --- /dev/null +++ b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs + +## -description + +Provides data when an app is launched as part of a print workflow. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_kind.md b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_kind.md new file mode 100644 index 0000000000..a662256f77 --- /dev/null +++ b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_kind.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.Kind + +## -description + +Gets the activation type. + +## -property-value + +The activation type. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_previousexecutionstate.md b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..9c3da2636a --- /dev/null +++ b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.PreviousExecutionState + +## -description + +Gets the execution state of the app before it was activated. + +## -property-value + +The execution state of the app before it was activated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_printworkflowsession.md b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_printworkflowsession.md new file mode 100644 index 0000000000..b068616196 --- /dev/null +++ b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_printworkflowsession.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.PrintWorkflowSession +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.PrintWorkflowSession + +## -description + +Gets the print workflow session that caused the activation. + +## -property-value + +The print workflow session that caused the activation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_splashscreen.md b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..37bcd3b2ed --- /dev/null +++ b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_splashscreen.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.SplashScreen + +## -description + +Gets the splash screen object that provides information about the transition from the splash screen to the activated app. + +## -property-value + +The object that provides splash screen information. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_user.md b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_user.md new file mode 100644 index 0000000000..f67411ffd9 --- /dev/null +++ b/windows.applicationmodel.activation/printworkflowforegroundtaskactivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.PrintWorkflowForegroundTaskActivatedEventArgs.User + +## -description + +Gets the user that the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_user.md b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_user.md new file mode 100644 index 0000000000..30cb57ff08 --- /dev/null +++ b/windows.applicationmodel.activation/protocolforresultsactivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ProtocolForResultsActivatedEventArgs.User + +## -description + +Gets the user the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md b/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md index 0b24b7b596..d1062fbea2 100644 --- a/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md +++ b/windows.applicationmodel.activation/sharetargetactivatedeventargs_shareoperation.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation - -## -description -Gets information about data included in a share operation. - -## -property-value -An object that includes the data included in a send operation. - -## -remarks -You can use the [ShareOperation](XREF:TODO:w_appmod_dataxfer_share.shareoperation) object to get the data that a user wants to send. It also contains methods your app can use to track the progress of the operation. - -## -examples - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ShareTargetActivatedEventArgs.ShareOperation + +## -description +Gets information about data included in a share operation. + +## -property-value +An object that includes the data included in a send operation. + +## -remarks +You can use the [ShareOperation](http://msdn.microsoft.com/library/0794ca7c-8c1f-467d-b3c7-a005d09f4a6f) object to get the data that a user wants to send. It also contains methods your app can use to track the progress of the operation. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.activation/splashscreen.md b/windows.applicationmodel.activation/splashscreen.md index 789e45e5a3..bed4026a8b 100644 --- a/windows.applicationmodel.activation/splashscreen.md +++ b/windows.applicationmodel.activation/splashscreen.md @@ -27,7 +27,7 @@ Additionally, if you use fragment loading to load an extended splash screen page Respond to [Activated](../windows.applicationmodel.core/coreapplicationview_activated.md) events by overloading the corresponding activated event handler method. For example, use [OnLaunched](../windows.ui.xaml/application_onlaunched.md) to respond to [ActivationKind.Launch](activationkind.md) activation events. To learn how to respond to activated events, see [App lifecycle](http://msdn.microsoft.com/library/6c469e77-f1e3-4859-a27b-c326f9616d10). -If you notice a flicker during the transition to your extended splash screen, see the [Troubleshooting](XREF:TODO:m_ui_splash.guidelines_and_checklist_for_splash_screens) section in [Guidelines and checklist for splash screens](XREF:TODO:m_ui_splash.guidelines_and_checklist_for_splash_screens) for help. +If you notice a flicker during the transition to your extended splash screen, see the [Troubleshooting](http://msdn.microsoft.com/library/10e04ab1-000d-4b2c-92c5-8378b92fc001) section in [Guidelines and checklist for splash screens](http://msdn.microsoft.com/library/10e04ab1-000d-4b2c-92c5-8378b92fc001) for help. The [SplashScreen](iactivatedeventargs_splashscreen.md) property is available on all [Windows.ApplicationModel.Activation](windows_applicationmodel_activation_classes.md) classes. diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_currentlyshownapplicationviewid.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_currentlyshownapplicationviewid.md new file mode 100644 index 0000000000..fde6b7daea --- /dev/null +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_currentlyshownapplicationviewid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.CurrentlyShownApplicationViewId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.CurrentlyShownApplicationViewId + +## -description + +Gets the identifier for the currently shown app view. + +## -property-value + +The identifier for the currently shown app view. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/toastnotificationactivatedeventargs_user.md b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_user.md new file mode 100644 index 0000000000..aec37304bb --- /dev/null +++ b/windows.applicationmodel.activation/toastnotificationactivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.ToastNotificationActivatedEventArgs.User + +## -description + +Gets the user the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_user.md b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_user.md new file mode 100644 index 0000000000..4109179f97 --- /dev/null +++ b/windows.applicationmodel.activation/webaccountprovideractivatedeventargs_user.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Activation.WebAccountProviderActivatedEventArgs.User + +## -description + +Gets the user the app was activated for. + +## -property-value + +The user the app was activated for. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.background/activitysensortrigger_reportinterval.md b/windows.applicationmodel.background/activitysensortrigger_reportinterval.md index d16cca3eb0..e5395b765a 100644 --- a/windows.applicationmodel.background/activitysensortrigger_reportinterval.md +++ b/windows.applicationmodel.background/activitysensortrigger_reportinterval.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval - -## -description -Gets the report interval for the trigger. - -## -property-value -The current report interval for the trigger in milliseconds. - -## -remarks - -## -examples - -## -see-also \ No newline at end of file +--- +-api-id: P:Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.ActivitySensorTrigger.ReportInterval + +## -description +Gets the report interval for the trigger. + +## -property-value +The current report interval for the trigger in milliseconds. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/appbroadcasttrigger.md b/windows.applicationmodel.background/appbroadcasttrigger.md new file mode 100644 index 0000000000..e1b2de456a --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttrigger.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.AppBroadcastTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTrigger + +## -description +Represents an event that triggers a background task to run when an application starts gameplay broadcasting. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. + +The background task must be declared in the manifest before the registration can be successful. +An instance of this class is passed to the background task in its [Run](ibackgroundtask_run.md) method. diff --git a/windows.applicationmodel.background/appbroadcasttrigger_appbroadcasttrigger_290278668.md b/windows.applicationmodel.background/appbroadcasttrigger_appbroadcasttrigger_290278668.md new file mode 100644 index 0000000000..9ee6303070 --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttrigger_appbroadcasttrigger_290278668.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.AppBroadcastTrigger.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTrigger.AppBroadcastTrigger + +## -description +Constructs an AppBroadcastTrigger with the name of the provider that will be doing the gameplay broadcasting. + +## -parameters + +### -param providerKey +The name of the provider that is broadcasting gameplay. + +## -remarks + +## -see-also diff --git a/windows.applicationmodel.background/appbroadcasttrigger_providerinfo.md b/windows.applicationmodel.background/appbroadcasttrigger_providerinfo.md new file mode 100644 index 0000000000..fb83e09f01 --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttrigger_providerinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.AppBroadcastTrigger.ProviderInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTrigger.ProviderInfo + +## -description +Provides information about the application that is broadcasting gameplay. + +## -property-value +Information about the provider that is broadcasting gameplay, such as the maximum video bitrate, height and width of the video, etc. + +## -remarks + +## -see-also diff --git a/windows.applicationmodel.background/appbroadcasttriggerproviderinfo.md b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo.md new file mode 100644 index 0000000000..5473d0759a --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo.md @@ -0,0 +1,17 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo + +## -description +Provides information about the application that is broadcasting gameplay such as its logo, display name, and video characteristics. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. diff --git a/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_displaynameresource.md b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_displaynameresource.md new file mode 100644 index 0000000000..2344ce3a62 --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_displaynameresource.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.DisplayNameResource +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.DisplayNameResource + +## -description +Gets and sets the resource location for the UI friendly name of the provider that is broadcasting gameplay. + +## -property-value +The resource location of the display name. For example, "ms-resource://resources/DisplayName" + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. diff --git a/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_logoresource.md b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_logoresource.md new file mode 100644 index 0000000000..f14d5a55ba --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_logoresource.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.LogoResource +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.LogoResource + +## -description +Gets and sets the resource location of the logo of the provider that is broadcasting gameplay. + +## -property-value +The resource location of the logo. For example, "ms-resource://resources/Logo.png" + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. diff --git a/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideobitrate.md b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideobitrate.md new file mode 100644 index 0000000000..7a49327347 --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideobitrate.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.MaxVideoBitrate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.MaxVideoBitrate + +## -description +Gets and sets the maximum bitrate that the provider that is broadcasting gameplay can provide. + +## -property-value +The maximum bitrate in bits per second. For example, 2500000 = 2.5 mbps + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. diff --git a/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideoheight.md b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideoheight.md new file mode 100644 index 0000000000..9e31a5424a --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideoheight.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.MaxVideoHeight +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.MaxVideoHeight + +## -description +Gets and sets the maximum video height that the gameplay broadcast provider supports. + +## -property-value +Maximum video height in pixels. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. diff --git a/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideowidth.md b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideowidth.md new file mode 100644 index 0000000000..e14defc610 --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_maxvideowidth.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.MaxVideoWidth +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.MaxVideoWidth + +## -description +Gets and sets the maximum video width that the gameplay broadcast provider supports. + +## -property-value +Maximum video width in pixels. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. diff --git a/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_videokeyframeinterval.md b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_videokeyframeinterval.md new file mode 100644 index 0000000000..0cbd306c2b --- /dev/null +++ b/windows.applicationmodel.background/appbroadcasttriggerproviderinfo_videokeyframeinterval.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.VideoKeyFrameInterval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.AppBroadcastTriggerProviderInfo.VideoKeyFrameInterval + +## -description +Gets and sets the amount of time between video key frames. + +## -property-value +The time span between key frames. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. diff --git a/windows.applicationmodel.background/applicationtriggerdetails.md b/windows.applicationmodel.background/applicationtriggerdetails.md index 0e85233005..a63484252b 100644 --- a/windows.applicationmodel.background/applicationtriggerdetails.md +++ b/windows.applicationmodel.background/applicationtriggerdetails.md @@ -1,22 +1,21 @@ ---- --api-id: T:Windows.ApplicationModel.Background.ApplicationTriggerDetails --api-type: winrt class ---- - - - -# Windows.ApplicationModel.Background.ApplicationTriggerDetails - -## -description -The details of an [ApplicationTrigger](applicationtrigger.md). - -## -remarks - -An instance of this class is passed to the background task in its [Run](ibackgroundtask_run.md) method. - -## -examples - -## -see-also - +--- +-api-id: T:Windows.ApplicationModel.Background.ApplicationTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.ApplicationTriggerDetails + +## -description +The details of an [ApplicationTrigger](applicationtrigger.md). + +## -remarks + +An instance of this class is passed to the background task in its [Run](ibackgroundtask_run.md) method. + +## -examples + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskbuilder_taskgroup.md b/windows.applicationmodel.background/backgroundtaskbuilder_taskgroup.md new file mode 100644 index 0000000000..596a3f87f4 --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskbuilder_taskgroup.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskGroup +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskGroup + +## -description +Gets and sets the group identifier. + +## -property-value +The group identifier. + +## -remarks +To reduce collisions with other group identifiers, consider including your domain name in the group identifier. For example: `"com.contoso.appname.tasks"`. Or use the string form of a GUID. + +## -see-also +[Launching, resuming, and background tasks](https://msdn.microsoft.com/windows/uwp/launch-resume/index) + + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistration_alltaskgroups.md b/windows.applicationmodel.background/backgroundtaskregistration_alltaskgroups.md new file mode 100644 index 0000000000..2605802309 --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistration_alltaskgroups.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTaskGroups +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTaskGroups + +## -description +Gets the background task groups. + +## -property-value +A dictionary of background task groups. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md b/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md index e9634cf4e9..8e7c90357a 100644 --- a/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md +++ b/windows.applicationmodel.background/backgroundtaskregistration_alltasks.md @@ -1,43 +1,41 @@ ---- --api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks --api-type: winrt property ---- - - - -# Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks - -## -description -Enumerates an application's registered background tasks. - -## -property-value -A view into a map of registered background tasks consisting of the task ID and an [IBackgroundTaskRegistration](ibackgroundtaskregistration.md) interface. - -## -remarks - -## -examples -The following example shows how to use the [AllTasks](backgroundtaskregistration_alltasks.md) property of the [BackgroundTaskRegistration](backgroundtaskregistration.md) class to retrieve the existing background task registration object for your app's background task (if the task is currently registered). - -```csharp -// The name of the background task for your app. -string name = "ExampleTaskName"; - -// Get a list of all background tasks. The list is returned as -// a dictionary of IBackgroundTaskRegistration objects. -foreach (var cur in BackgroundTaskRegistration.AllTasks) -{ - if (cur.Value.Name == name) - { - // Take some action based on finding the background task. - // - // For example, unregister the task: cur.Value.Unregister(true); - // Or, set a global variable indicating that the task is already registered - } -} -``` - - - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.AllTasks + +## -description +Enumerates an application's registered background tasks. + +## -property-value +A view into a map of registered background tasks consisting of the task ID and an [IBackgroundTaskRegistration](ibackgroundtaskregistration.md) interface. + +## -remarks + +## -examples +The following example shows how to use the [AllTasks](backgroundtaskregistration_alltasks.md) property of the [BackgroundTaskRegistration](backgroundtaskregistration.md) class to retrieve the existing background task registration object for your app's background task (if the task is currently registered). + +```csharp +// The name of the background task for your app. +string name = "ExampleTaskName"; + +// Get a list of all background tasks. The list is returned as +// a dictionary of IBackgroundTaskRegistration objects. +foreach (var cur in BackgroundTaskRegistration.AllTasks) +{ + if (cur.Value.Name == name) + { + // Take some action based on finding the background task. + // + // For example, unregister the task: cur.Value.Unregister(true); + // Or, set a global variable indicating that the task is already registered + } +} +``` + +## -see-also diff --git a/windows.applicationmodel.background/backgroundtaskregistration_gettaskgroup_816100593.md b/windows.applicationmodel.background/backgroundtaskregistration_gettaskgroup_816100593.md new file mode 100644 index 0000000000..685d229bed --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistration_gettaskgroup_816100593.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskRegistration.GetTaskGroup(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.GetTaskGroup + +## -description +Gets the task group object that is associated with the group identifier. + +## -params + +## -param groupId +The group identifier. + +## -returns +The task group object that is associated with the group identifier. + +## -remarks +If no group with the specified ID is found, `null` is returned. +To get all of the tasks associated with the group, call [BackgroundTaskRegistrationGroup.AllTasks()](backgroundtaskregistrationgroup_alltasks.md) + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistration_taskgroup.md b/windows.applicationmodel.background/backgroundtaskregistration_taskgroup.md new file mode 100644 index 0000000000..01b10fecac --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistration_taskgroup.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistration.TaskGroup +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistration.TaskGroup + +## -description +Gets the **BackgroundTaskRegistrationGroup** that this **BackgroundTaskRegistration** is a part of. + +## -property-value +The **BackgroundTaskRegistrationGroup** that this **BackgroundTaskRegistration** is a part of. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistrationgroup.md b/windows.applicationmodel.background/backgroundtaskregistrationgroup.md new file mode 100644 index 0000000000..c5dd64b19b --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistrationgroup.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup + +## -description +Provides grouping semantics so that background task registration can be maintained separately. + +## -remarks +Developers are encouraged to unregister, and then register, all background tasks used by the application when the app launches. However, in addition to unregistering the app's background tasks, this can also unregister background tasks registered by frameworks used by the app. + +Grouped background task registration provides roughly the equivalent of a namespace for background tasks. You can register/unregister background tasks that belong to a group that you define without disturbing the registration of other background tasks on the device. + +## -see-also +[Launching, resuming, and background tasks](https://msdn.microsoft.com/windows/uwp/launch-resume/index) + +## -examples +[Background activation sample](https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/BackgroundActivation) +[Background task sample](https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/BackgroundTask) diff --git a/windows.applicationmodel.background/backgroundtaskregistrationgroup_alltasks.md b/windows.applicationmodel.background/backgroundtaskregistrationgroup_alltasks.md new file mode 100644 index 0000000000..82a65d5c9d --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistrationgroup_alltasks.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.AllTasks +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.AllTasks + +## -description +Gets all of the background tasks that belong to the group. + +## -property-value +The background tasks that belong to the group. + +## -remarks +`Null` is returned if no tasks belong to the group. + +## -see-also +[Launching, resuming, and background tasks](https://msdn.microsoft.com/windows/uwp/launch-resume/index) + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundactivated.md b/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundactivated.md new file mode 100644 index 0000000000..136016aed5 --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundactivated.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.BackgroundActivated +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.BackgroundActivated + +## -description +This event is fired when a background task that belongs to a group starts. + +## -remarks +Background triggers associated with a group fire this event instead of having a task entry point. For single-process background tasks that don't define an entry point in their background task registration, this event is the entry point. Instead of calling the application's [OnBackgroundActivated](../windows.ui.xaml/application_onbackgroundactivated_431338129.md) method, the event attached to the group is called. + +## -see-also +[Launching, resuming, and background tasks](https://msdn.microsoft.com/windows/uwp/launch-resume/index) + +## -examples +[Background activation sample](https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/BackgroundActivation) diff --git a/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundtaskregistrationgroup_1571897524.md b/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundtaskregistrationgroup_1571897524.md new file mode 100644 index 0000000000..20c1d94135 --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundtaskregistrationgroup_1571897524.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.#ctor(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.BackgroundTaskRegistrationGroup + +## -description +Creates a **BackgroundTaskRegistrationGroup** with the specified group ID and + +## -params + +## -param id +The group ID. + +## -param name +The friendly name for this group. + +## -remarks +To reduce collisions with other group identifiers, consider including your domain name in the group ID. For example: `"com.contoso.appname.tasks"`. Or use the string form of a GUID. + +The friendly name can be useful for debugging purposes if your group IDs are difficult to distinguish. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundtaskregistrationgroup_290278668.md b/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundtaskregistrationgroup_290278668.md new file mode 100644 index 0000000000..2565b520fa --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistrationgroup_backgroundtaskregistrationgroup_290278668.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.BackgroundTaskRegistrationGroup + +## -description +Creates a **BackgroundTaskRegistrationGroup** with the specified group ID. + +## -params + +## -param id +The group ID. + +## -remarks +To reduce collisions with other group identifiers, consider including your domain name in the group identifier. For example: `"com.contoso.appname.tasks"`. Or use the string form of a GUID. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistrationgroup_id.md b/windows.applicationmodel.background/backgroundtaskregistrationgroup_id.md new file mode 100644 index 0000000000..6dbe4e972b --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistrationgroup_id.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.Id + +## -description +Gets the group ID. + +## -property-value +The group ID. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/backgroundtaskregistrationgroup_name.md b/windows.applicationmodel.background/backgroundtaskregistrationgroup_name.md new file mode 100644 index 0000000000..568efeeee2 --- /dev/null +++ b/windows.applicationmodel.background/backgroundtaskregistrationgroup_name.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.BackgroundTaskRegistrationGroup.Name + +## -description +Gets the friendly name of the group. + +## -property-value +The friendly name. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/gattcharacteristicnotificationtrigger.md b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger.md new file mode 100644 index 0000000000..fccb0bf8bb --- /dev/null +++ b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger + +## -description +Represents a trigger that launches a background task when an incoming change notification is received for a Bluetooth LE GATT characteristic. + +## -remarks + +## -examples + +## -see-also +[IBackgroundTrigger](ibackgroundtrigger.md) \ No newline at end of file diff --git a/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_eventtriggeringmode.md b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_eventtriggeringmode.md new file mode 100644 index 0000000000..74ea75127b --- /dev/null +++ b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_eventtriggeringmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.EventTriggeringMode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.EventTriggeringMode + +## -description +Gets the mode for the trigger. The mode specifies when the trigger is activated. + +## -property-value +The trigger mode. + +## -remarks + +## -see-also +[Windows.Devices.Bluetooth.Background.BluetoothEventTriggeringMode](bluetootheventtriggeringmode.md) + +## -examples diff --git a/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_gattcharacteristicnotificationtrigger_1956195080.md b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_gattcharacteristicnotificationtrigger_1956195080.md new file mode 100644 index 0000000000..e11d45de3f --- /dev/null +++ b/windows.applicationmodel.background/gattcharacteristicnotificationtrigger_gattcharacteristicnotificationtrigger_1956195080.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.#ctor(Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic,Windows.Devices.Bluetooth.Background.BluetoothEventTriggeringMode) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.GattCharacteristicNotificationTrigger.GattCharacteristicNotificationTrigger + +## -description +Initializes a new instance of the **GattCharacteristicNotificationTrigger** class with the specified characteristic and triggering mode. + +## -params + +## -param characteristic +The GATT characteristic that you want value change notifications for. + +## -param eventTriggeringMode +Specifies when the trigger is activated. diff --git a/windows.applicationmodel.background/gattserviceprovidertrigger.md b/windows.applicationmodel.background/gattserviceprovidertrigger.md new file mode 100644 index 0000000000..179a3bc282 --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertrigger.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.GattServiceProviderTrigger +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTrigger + +## -description +Constructs a Generic Attributes (GATT) service that can be persisted in the background. + +## -remarks +GATT defines a hierarchical data structure that is exposed to connected Bluetooth low energy (LE) devices. + +## -see-also +[Bluetooth GATT specification](https://www.bluetooth.com/specifications/generic-attributes-overview) + +## -examples diff --git a/windows.applicationmodel.background/gattserviceprovidertrigger_advertisingparameters.md b/windows.applicationmodel.background/gattserviceprovidertrigger_advertisingparameters.md new file mode 100644 index 0000000000..39a092c042 --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertrigger_advertisingparameters.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.GattServiceProviderTrigger.AdvertisingParameters +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTrigger.AdvertisingParameters + +## -description +Gets the advertising parameters which control whether the radio is connected/discoverable. + +## -property-value + +## -remarks +When the device is discoverable, the service is published to a database so that other devices can see what services are available without having to connect to the device. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/gattserviceprovidertrigger_createasync_776293710.md b/windows.applicationmodel.background/gattserviceprovidertrigger_createasync_776293710.md new file mode 100644 index 0000000000..28baebcb03 --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertrigger_createasync_776293710.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.ApplicationModel.Background.GattServiceProviderTrigger.CreateAsync(System.String,System.Guid) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTrigger.CreateAsync + +## -description +Creates a GATT provider service. + +## -params + +## -param triggerId +The identifier for the trigger. + +## -param serviceUuid +The universally unique identifier for the trigger. + +## -returns +Await the asynchronous operation to get the **GattServiceProviderTriggerResult**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/gattserviceprovidertrigger_service.md b/windows.applicationmodel.background/gattserviceprovidertrigger_service.md new file mode 100644 index 0000000000..b5e9ca0715 --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertrigger_service.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.GattServiceProviderTrigger.Service +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTrigger.Service + +## -description +Gets the service associated with this trigger. + +## -property-value +The service. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/gattserviceprovidertrigger_triggerid.md b/windows.applicationmodel.background/gattserviceprovidertrigger_triggerid.md new file mode 100644 index 0000000000..b6cb31a2e3 --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertrigger_triggerid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.GattServiceProviderTrigger.TriggerId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTrigger.TriggerId + +## -description +Gets the trigger identifier. + +## -property-value +The trigger ID. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/gattserviceprovidertriggerresult.md b/windows.applicationmodel.background/gattserviceprovidertriggerresult.md new file mode 100644 index 0000000000..49f7d58723 --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertriggerresult.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.GattServiceProviderTriggerResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTriggerResult + +## -description +This class contains the trigger created by [GattServiceProviderTrigger.CreateAsync()](gattserviceprovidertrigger_createasync_776293710.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/gattserviceprovidertriggerresult_error.md b/windows.applicationmodel.background/gattserviceprovidertriggerresult_error.md new file mode 100644 index 0000000000..cf3718973a --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertriggerresult_error.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.GattServiceProviderTriggerResult.Error +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTriggerResult.Error + +## -description +Get the status of creating the trigger. + +## -property-value +The error code. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/gattserviceprovidertriggerresult_trigger.md b/windows.applicationmodel.background/gattserviceprovidertriggerresult_trigger.md new file mode 100644 index 0000000000..6065a040e9 --- /dev/null +++ b/windows.applicationmodel.background/gattserviceprovidertriggerresult_trigger.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.GattServiceProviderTriggerResult.Trigger +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.GattServiceProviderTriggerResult.Trigger + +## -description +Gets the Trigger created by [GattServiceProviderTrigger.CreateAsync](gattserviceprovidertrigger_createasync_776293710.md) + +## -property-value +The trigger. + +## -remarks + +## -see-also +[GattServiceProviderTrigger.CreateAsync](gattserviceprovidertrigger_createasync_776293710.md) + +## -examples diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration3.md b/windows.applicationmodel.background/ibackgroundtaskregistration3.md new file mode 100644 index 0000000000..5bb5c5a306 --- /dev/null +++ b/windows.applicationmodel.background/ibackgroundtaskregistration3.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Background.IBackgroundTaskRegistration3 +-api-type: winrt interface +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration3 + +## -description +Represents a background task that has been registered as part of a group of related background tasks. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/ibackgroundtaskregistration3_taskgroup.md b/windows.applicationmodel.background/ibackgroundtaskregistration3_taskgroup.md new file mode 100644 index 0000000000..1ffc3fb05f --- /dev/null +++ b/windows.applicationmodel.background/ibackgroundtaskregistration3_taskgroup.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Background.IBackgroundTaskRegistration3.TaskGroup +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Background.IBackgroundTaskRegistration3.TaskGroup + +## -description +Gets the **BackgroundTaskRegistrationGroup** that this **BackgroundTaskRegistration** is a part of. + +## -property-value +The **BackgroundTaskRegistrationGroup** that this **BackgroundTaskRegistration** is a part of. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md b/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md index 71717b1f41..099fe4f1d1 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_inboundconnection.md @@ -10,10 +10,10 @@ public Windows.Devices.Bluetooth.Background.RfcommInboundConnectionInformation I # Windows.ApplicationModel.Background.RfcommConnectionTrigger.InboundConnection ## -description -Gets or sets the [RfcommInboundConnectionInformation](rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. +Gets or sets the [RfcommInboundConnectionInformation](../windows.devices.bluetooth.background/rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. ## -property-value -The [RfcommInboundConnectionInformation](rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. The default is null. +The [RfcommInboundConnectionInformation](../windows.devices.bluetooth.background/rfcomminboundconnectioninformation.md) object that describes how the system will advertise and listen for inbound connections on behalf of the app. The default is null. ## -remarks If this property is null, the system will not listen for incoming connections. diff --git a/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md b/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md index f0cae8f6bb..8f4db08f4c 100644 --- a/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md +++ b/windows.applicationmodel.background/rfcommconnectiontrigger_outboundconnection.md @@ -10,10 +10,10 @@ public Windows.Devices.Bluetooth.Background.RfcommOutboundConnectionInformation # Windows.ApplicationModel.Background.RfcommConnectionTrigger.OutboundConnection ## -description -Gets or sets the [RfcommOutboundConnectionInformation](rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. +Gets or sets the [RfcommOutboundConnectionInformation](../windows.devices.bluetooth.background/rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. ## -property-value -The [RfcommOutboundConnectionInformation](rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. The default is null. +The [RfcommOutboundConnectionInformation](../windows.devices.bluetooth.background/rfcommoutboundconnectioninformation.md) object that describes how the system will create outgoing connections on behalf of the app. The default is null. ## -remarks If this property is null, the system will not create outgoing connections. diff --git a/windows.applicationmodel.contacts/contactannotation_contactlistid.md b/windows.applicationmodel.contacts/contactannotation_contactlistid.md new file mode 100644 index 0000000000..76db09161f --- /dev/null +++ b/windows.applicationmodel.contacts/contactannotation_contactlistid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactAnnotation.ContactListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotation.ContactListId + +## -description +Gets or sets the [ContactList](contactlist.md) to which this [ContactAnnotation](contactannotation.md) applies. + +## -property-value +The ID for the [ContactList](contactlist.md) to which this [ContactAnnotation](contactannotation.md) applies. + +## -remarks + +## -see-also +[ContactList](contactlist.md) + +## -examples diff --git a/windows.applicationmodel.contacts/contactannotationstore_findannotationsforcontactlistasync_1688275499.md b/windows.applicationmodel.contacts/contactannotationstore_findannotationsforcontactlistasync_1688275499.md new file mode 100644 index 0000000000..db474459b2 --- /dev/null +++ b/windows.applicationmodel.contacts/contactannotationstore_findannotationsforcontactlistasync_1688275499.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationsForContactListAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactAnnotationStore.FindAnnotationsForContactListAsync + +## -description +Gets the annotations for the specified [ContactList](contactlist.md). +## -params + +## -param contactListId +The ID of the [ContactList](contactlist.md) for which to retrieve annotations. + +## -returns +The list of [ContactAnnotation](contactannotation.md) objects. + +## -remarks + +## -see-also + + +## -examples diff --git a/windows.applicationmodel.contacts/contactgroup.md b/windows.applicationmodel.contacts/contactgroup.md new file mode 100644 index 0000000000..f4c880483b --- /dev/null +++ b/windows.applicationmodel.contacts/contactgroup.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactGroup +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactGroup + +## -description +This API supports the product infrastructure and is not intended to be used directly from your code. + +Microsoft Internal Use Only. +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactmanager_includemiddlenameinsystemdisplayandsort.md b/windows.applicationmodel.contacts/contactmanager_includemiddlenameinsystemdisplayandsort.md new file mode 100644 index 0000000000..f30fe29eac --- /dev/null +++ b/windows.applicationmodel.contacts/contactmanager_includemiddlenameinsystemdisplayandsort.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactManager.IncludeMiddleNameInSystemDisplayAndSort +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.IncludeMiddleNameInSystemDisplayAndSort + +## -description +Gets or sets a Boolean that indicates whether the middle name of a contact is included in the [DisplayName](contact_displayname.md) and [SortName](contact_sortname.md) of a contact. + +## -property-value +A Boolean that indicates whether the middle name of a contact is included in the [DisplayName](contact_displayname.md) and [SortName](contact_sortname.md) of a contact. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactmanager_isshowfullcontactcardsupportedasync_1348898571.md b/windows.applicationmodel.contacts/contactmanager_isshowfullcontactcardsupportedasync_1348898571.md new file mode 100644 index 0000000000..72350e9245 --- /dev/null +++ b/windows.applicationmodel.contacts/contactmanager_isshowfullcontactcardsupportedasync_1348898571.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.IsShowFullContactCardSupportedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.IsShowFullContactCardSupportedAsync + +## -description +Gets a Boolean value indicating if the [ShowFullContactCard](contactmanagerforuser_showfullcontactcard_2012855989.md) method is supported on the current platform. +## -params + +## -returns +An asynchronous operation that returns **true** if the [ShowFullContactCard](contactmanagerforuser_showfullcontactcard_2012855989.md) method is supported on the current platform. +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactmanager_showfullcontactcard_2012855989.md b/windows.applicationmodel.contacts/contactmanager_showfullcontactcard_2012855989.md new file mode 100644 index 0000000000..8deca112c3 --- /dev/null +++ b/windows.applicationmodel.contacts/contactmanager_showfullcontactcard_2012855989.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManager.ShowFullContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.FullContactCardOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManager.ShowFullContactCard + +## -description +Queries the operating system for a user’s contact and shows the contact data in a full contact card. + +## -parameters +### -param contact +The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. + +If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. + +### -param fullContactCardOptions +Specifies how to display the full contact card. + +## -remarks + +## -examples + +## -see-also +[Contact cards sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624040) \ No newline at end of file diff --git a/windows.applicationmodel.contacts/contactmanagerforuser_showfullcontactcard_2012855989.md b/windows.applicationmodel.contacts/contactmanagerforuser_showfullcontactcard_2012855989.md new file mode 100644 index 0000000000..3c9fcca735 --- /dev/null +++ b/windows.applicationmodel.contacts/contactmanagerforuser_showfullcontactcard_2012855989.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactManagerForUser.ShowFullContactCard(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.FullContactCardOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactManagerForUser.ShowFullContactCard + +## -description +Queries the operating system for a user’s contact and shows the contact data in a full contact card. +## -params + +## -param contact +The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an [Id](contact_id.md), [Emails](contact_emails.md), or a phone number from a [Phones](contact_phones.md) list to query the user’s contact database to retrieve a matching contact to display. [Id](contact_id.md) has higher priority for querying. If an [Id](contact_id.md) matches, the rest of query parameters will be ignored for matching purposes. If an [Id](contact_id.md) does not find a match, the query uses the rest of query parameters. [Emails](contact_emails.md) and [Phones](contact_phones.md) have equal priority for matching. If multiple email addresses, or phone numbers, or both are provided, the query first performs an exact match, requiring all query parameters to match a system contact record. If this results in no matches, the query uses "best effort" match, in which a match of any query parameters is sufficient. + +If no matches occur, the data in the input contact displays in the contact card. If a match occurs, only system contact data displays, and the data in the input contact is discarded. +## -param fullContactCardOptions +Specifies how to display the full contact card. + +## -remarks +This method must be called from the main UI thread. +## -see-also +[ContactManager](contactmanager.md), [Contact cards sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624040) +## -examples diff --git a/windows.applicationmodel.contacts/contactpanel.md b/windows.applicationmodel.contacts/contactpanel.md new file mode 100644 index 0000000000..6e9d9c7206 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanel.md @@ -0,0 +1,18 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactPanel +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanel + +## -description +Represents a Contact Panel that appears when users click a contact that is pinned to the taskbar. +## -remarks +The Contact Panel appears when users click a contact that is pinned to the taskbar. +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactpanel_closepanel_1777562300.md b/windows.applicationmodel.contacts/contactpanel_closepanel_1777562300.md new file mode 100644 index 0000000000..9860d62182 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanel_closepanel_1777562300.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPanel.ClosePanel +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanel.ClosePanel + +## -description +Closes the Contact Panel. +## -params + +## -remarks +This method must be called from the main UI thread. +## -see-also +[Closing](contactpanel_closing.md) + +## -examples diff --git a/windows.applicationmodel.contacts/contactpanel_closing.md b/windows.applicationmodel.contacts/contactpanel_closing.md new file mode 100644 index 0000000000..9bd5f0d41e --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanel_closing.md @@ -0,0 +1,18 @@ +--- +-api-id: E:Windows.ApplicationModel.Contacts.ContactPanel.Closing +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanel.Closing + +## -description +Occurs when the Contact Panel is closing. +## -remarks + +## -see-also +[Close](contactpanel_closepanel_1777562300.md) +## -examples diff --git a/windows.applicationmodel.contacts/contactpanel_headercolor.md b/windows.applicationmodel.contacts/contactpanel_headercolor.md new file mode 100644 index 0000000000..74ba3576ba --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanel_headercolor.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPanel.HeaderColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanel.HeaderColor + +## -description +Specifies the color of the Contact Panel header. +## -property-value +A [Color](./windows.ui/color.md) that represents the desired color. +## -remarks +[Color](./windows.ui/color.md) takes effect only when the app is the active tab. If you don’t set this property, the system chooses the color. +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactpanel_launchfullapprequested.md b/windows.applicationmodel.contacts/contactpanel_launchfullapprequested.md new file mode 100644 index 0000000000..6b0422f905 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanel_launchfullapprequested.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.ApplicationModel.Contacts.ContactPanel.LaunchFullAppRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanel.LaunchFullAppRequested + +## -description +Occurs when the user clicks the **Launch Full App** button in the Contact Panel. +## -remarks +Handle this event to provide your users with a smoother experience. For example, your app could handle this event to ensure that the full app continues playing a video that users start in the Contact Panel, or open a message that users started reading in the Contact Panel. +If you don’t handle this event, or if you handle this event, but you don’t set the [Handled](contactpanellaunchfullapprequestedeventargs_handled.md) property of the [ContactPanelLaunchFullAppRequestedEventArgs](contactpanellaunchfullapprequestedeventargs.md) property to true, your app starts in it’s default state. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactpanelclosingeventargs.md b/windows.applicationmodel.contacts/contactpanelclosingeventargs.md new file mode 100644 index 0000000000..cc11cb425f --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanelclosingeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactPanelClosingEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanelClosingEventArgs + +## -description +Provides event information for the [Closing](contactpanel_closing.md) event. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactpanelclosingeventargs_getdeferral_254836512.md b/windows.applicationmodel.contacts/contactpanelclosingeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..13a029430a --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanelclosingeventargs_getdeferral_254836512.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPanelClosingEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanelClosingEventArgs.GetDeferral + +## -description +Gets the deferral object for the [Closing](contactpanel_closing.md) event. +## -params + +## -returns +The deferral object for the [Closing](contactpanel_closing.md) event. +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactpanellaunchfullapprequestedeventargs.md b/windows.applicationmodel.contacts/contactpanellaunchfullapprequestedeventargs.md new file mode 100644 index 0000000000..96a0b273b7 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanellaunchfullapprequestedeventargs.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.ContactPanelLaunchFullAppRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanelLaunchFullAppRequestedEventArgs + +## -description +Provides event information for the [LaunchFullAppRequested](contactpanel_launchfullapprequested.md) event. +## -remarks +First, check to see the [Handled](contactpanellaunchfullapprequestedeventargs_handled.md) property is **false**. Then, set the [Handled](contactpanellaunchfullapprequestedeventargs_handled.md) property to **true**, and start your app. Depending on what sort of experience you want to provide your users, consider closing the Contact Panel because they’ll be interacting directly with the full version of your app. +## -see-also + +## -examples +The following example illustrates the remarks in this topic. +```csharp +async void OnLaunchFullAppRequested(ContactPanel ContactPanel, + ContactPanelLaunchFullAppRequestedEventArgs e) +{ + if (!e.Handled) + { + e.Handled = true; + if (await TryLaunchFullAppFromCurrentStateAsync()) + { + // we've successfully started the full version of our app; close the hosted view. + ContactPanel.ClosePanel(); + } + } +} + +``` diff --git a/windows.applicationmodel.contacts/contactpanellaunchfullapprequestedeventargs_handled.md b/windows.applicationmodel.contacts/contactpanellaunchfullapprequestedeventargs_handled.md new file mode 100644 index 0000000000..7e176ce8b1 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpanellaunchfullapprequestedeventargs_handled.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPanelLaunchFullAppRequestedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPanelLaunchFullAppRequestedEventArgs.Handled + +## -description +Gets or sets a value that indicates the [LaunchFullAppRequested](contactpanel_launchfullapprequested.md) event has been handled. +## -property-value +**true** if the [LaunchFullAppRequested](contactpanel_launchfullapprequested.md) event is handled; **false** if the [LaunchFullAppRequested](contactpanel_launchfullapprequested.md) event is not yet handled. +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactpicker_createforuser_24112450.md b/windows.applicationmodel.contacts/contactpicker_createforuser_24112450.md new file mode 100644 index 0000000000..21a6b60d80 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpicker_createforuser_24112450.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.CreateForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.CreateForUser + +## -description +Creates a new [ContactPicker](contactpicker.md) for a specific [User](./windows.system/user.md). + +## -params + +## -param user +The [User](./windows.system/user.md) for which you want to create the [ContactPicker](contactpicker.md). + +## -returns +Returns a [ContactPicker](contactpicker.md) for the account specified by the *user* parameter. +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/contactpicker_issupportedasync_2134939103.md b/windows.applicationmodel.contacts/contactpicker_issupportedasync_2134939103.md new file mode 100644 index 0000000000..94299e2938 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpicker_issupportedasync_2134939103.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.ContactPicker.IsSupportedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.IsSupportedAsync + +## -description +Gets a Boolean value indicating if the contact picker is supported on the current platform. +## -params + +## -returns +A Boolean value indicating if the contact picker is supported on the current platform. +## -remarks + +## -see-also + + +## -examples diff --git a/windows.applicationmodel.contacts/contactpicker_user.md b/windows.applicationmodel.contacts/contactpicker_user.md new file mode 100644 index 0000000000..aa3628ee66 --- /dev/null +++ b/windows.applicationmodel.contacts/contactpicker_user.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.ContactPicker.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.ContactPicker.User + +## -description +Gets the [User](./windows.system/user.md) associated with the [ContactPicker](contactpicker.md). +## -property-value +The [User](./windows.system/user.md) associated with the [ContactPicker](contactpicker.md). +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactidsqueryresult.md b/windows.applicationmodel.contacts/pinnedcontactidsqueryresult.md new file mode 100644 index 0000000000..ca25b274ec --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactidsqueryresult.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.PinnedContactIdsQueryResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactIdsQueryResult + +## -description +Provides access to the results of a query that lists the IDs all contacts pinned to the taskbar or Start menu. + +## -remarks +You can use a [PinnedContactIdsQueryResult](pinnedcontactidsqueryresult.md) to enumerate through the IDs of pinned contacts. + +## -see-also +[ContactIds](pinnedcontactidsqueryresult_contactids.md), [GetPinnedContactIdsAsync](pinnedcontactmanager_getpinnedcontactidsasync_301892974.md) + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactidsqueryresult_contactids.md b/windows.applicationmodel.contacts/pinnedcontactidsqueryresult_contactids.md new file mode 100644 index 0000000000..3368ecbc92 --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactidsqueryresult_contactids.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.PinnedContactIdsQueryResult.ContactIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactIdsQueryResult.ContactIds + +## -description +Gets the list of contact IDs that are pinned to the taskbar or **Start** menu. + +## -property-value +The list of contact IDs that are pinned to the taskbar or **Start** menu. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager.md b/windows.applicationmodel.contacts/pinnedcontactmanager.md new file mode 100644 index 0000000000..c5edf834c5 --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.PinnedContactManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager + +## -description +Represents a service that source apps can call to pin and unpin contacts to and from the taskbar or **Start** menu. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_getdefault_846721868.md b/windows.applicationmodel.contacts/pinnedcontactmanager_getdefault_846721868.md new file mode 100644 index 0000000000..5aee1f60fa --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_getdefault_846721868.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.GetDefault + +## -description +Gets the default an instance of a [PinnedContactManager](pinnedcontactmanager.md). + +## -params + +## -returns +the default [PinnedContactManager](pinnedcontactmanager.md). + +## -remarks +This method must be called from the main UI thread. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_getforuser_2058550280.md b/windows.applicationmodel.contacts/pinnedcontactmanager_getforuser_2058550280.md new file mode 100644 index 0000000000..0415ffae8f --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_getforuser_2058550280.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.GetForUser + +## -description +Gets a [PinnedContactManager](pinnedcontactmanager.md) for the specified user. + +## -params + +## -param user +The user account to use to get the [PinnedContactManager](pinnedcontactmanager.md). + +## -returns +Returns the [PinnedContactManager](pinnedcontactmanager.md) for the account specified by the *user* parameter. + +## -remarks +This method must be called from the main UI thread. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_getpinnedcontactidsasync_301892974.md b/windows.applicationmodel.contacts/pinnedcontactmanager_getpinnedcontactidsasync_301892974.md new file mode 100644 index 0000000000..33ec608e5f --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_getpinnedcontactidsasync_301892974.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.GetPinnedContactIdsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.GetPinnedContactIdsAsync + +## -description +Gets the ID's of all contacts that are pinned to the taskbar or **Start** menu. + +## -params + +## -returns + +An asynchronous operation that returns a [PinnedContactIdsQueryResult](pinnedcontactmanageridsqueryresult.md) that you can use to get the ID's of all pinned contacts. +## -remarks + +This method raises an **AccessDeniedException** if you have not enabled the *contactPanel* capability in your app manifest. + +This method can be called from a background thread. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_iscontactpinned_1279172363.md b/windows.applicationmodel.contacts/pinnedcontactmanager_iscontactpinned_1279172363.md new file mode 100644 index 0000000000..f4c318a0d3 --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_iscontactpinned_1279172363.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.IsContactPinned(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.PinnedContactSurface) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.IsContactPinned + +## -description +Indicates whether the specified contact is pinned to the specified location in the Windows user interface. + +## -params + +## -param contact +A contact of interest. This property indicates whether that contact is pinned or not pinned. + +## -param surface +A [pinnedContactSurface](pinnedcontactsurface.md) value that specifies the location in the UI that you'd like to check for pinned contacts. + +## -returns +A Boolean value that specifies whether the specified contact is pinned to the specified location in the Windows user interface. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_ispinsurfacesupported_1483083550.md b/windows.applicationmodel.contacts/pinnedcontactmanager_ispinsurfacesupported_1483083550.md new file mode 100644 index 0000000000..47697e9bd9 --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_ispinsurfacesupported_1483083550.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.IsPinSurfaceSupported(Windows.ApplicationModel.Contacts.PinnedContactSurface) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.IsPinSurfaceSupported + +## -description +Indicates whether the specified location in the Windows UI supports contact pinning. + +## -params + +## -param surface +A [pinnedContactSurface](pinnedcontactsurface.md) value that specifies a pinning location in the Windows UI. This property determines whether pinning is supported in that location. + +## -returns +A Boolean value that indicates whether the location in the Windows UI supports contact pinning. + +## -remarks +This property can be useful if your app handles the [Window.SizeChanged](./windows.ui.xaml/window_sizechanged.md) event. That event is raised when the view changes between monitors. In the [WindowSizeChanged](./windows.ui.xaml/windowsizechangedeventhandler.md) event handler, your could use this property to determine whether the new monitor supports pinning. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_issupported_930300905.md b/windows.applicationmodel.contacts/pinnedcontactmanager_issupported_930300905.md new file mode 100644 index 0000000000..929a4c650f --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_issupported_930300905.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.IsSupported +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.IsSupported + +## -description +Indicates whether the Windows UI supports contact pinning. + +## -returns +A Boolean value that indicates whether the Windows UI supports contact pinning. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_requestpincontactasync_1854872090.md b/windows.applicationmodel.contacts/pinnedcontactmanager_requestpincontactasync_1854872090.md new file mode 100644 index 0000000000..7f78f196a2 --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_requestpincontactasync_1854872090.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.RequestPinContactAsync(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.PinnedContactSurface) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.RequestPinContactAsync + +## -description +Pins a contact to the taskbar or **Start** menu. + +## -params + +## -param contact +The contact to pin to the taskbar or **Start** menu. + +## -param surface +A [pinnedContactSurface](pinnedcontactsurface.md) value that specifies where in the Windows UI you would like to pin the contact. + +## -returns +An asynchronous operation that returns a Boolean value that indicates whether the contact was successfully pinned to the specified location. + +## -remarks +This method must be called from the main UI thread. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_requestpincontactsasync_869169164.md b/windows.applicationmodel.contacts/pinnedcontactmanager_requestpincontactsasync_869169164.md new file mode 100644 index 0000000000..98b63923de --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_requestpincontactsasync_869169164.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.RequestPinContactsAsync(Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Contacts.Contact},Windows.ApplicationModel.Contacts.PinnedContactSurface) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.RequestPinContactsAsync + +## -description +Pins a collection of contacts to the taskbar or **Start** menu. + +## -params + +## -param contacts +The collection of contacts to pin to the taskbar or **Start** menu. + +## -param surface +A [pinnedContactSurface](pinnedcontactsurface.md) value that specifies where in the Windows UI you would like to pin the contacts. + +## -returns +An asynchronous operation that returns a Boolean value that indicates whether the contacts were successfully pinned to the specified location. + +## -remarks +This method must be called from the main UI thread. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_requestunpincontactasync_311700484.md b/windows.applicationmodel.contacts/pinnedcontactmanager_requestunpincontactasync_311700484.md new file mode 100644 index 0000000000..51316565fe --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_requestunpincontactasync_311700484.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.RequestUnpinContactAsync(Windows.ApplicationModel.Contacts.Contact,Windows.ApplicationModel.Contacts.PinnedContactSurface) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.RequestUnpinContactAsync + +## -description +Unpins a contact from the taskbar or **Start** menu. + +## -params + +## -param contact +The contact to unpin from the taskbar or **Start** menu. + +## -param surface +A [pinnedContactSurface](pinnedcontactsurface.md) value that specifies from which area in the Windows UI you would like to unpin the contact. + +## -returns +An asynchronous operation that returns a Boolean value that indicates whether the contact was successfully unpinned from the specified location. + +## -remarks +This method must be called from the main UI thread. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_signalcontactactivity_423111902.md b/windows.applicationmodel.contacts/pinnedcontactmanager_signalcontactactivity_423111902.md new file mode 100644 index 0000000000..b6c8d47c1b --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_signalcontactactivity_423111902.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Contacts.PinnedContactManager.SignalContactActivity(Windows.ApplicationModel.Contacts.Contact) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.SignalContactActivity + +## -description +Indicates to Windows when activity that is related to a pinned contact occurs. + +## -params + +## -param contact +The contact that is exhibits activity. + +## -remarks +Activity could be any interesting event related to a contact that occurs in your app. For example, if your app receives a message or mail for a contact, your app could call the [SignalContactActivity](pinnedcontactmanager_signalcontactactivity_423111902.md) to report that event. +Windows indicates this reported activity to the user. Windows does not indicate anything to the user if the contact is not pinned. If you call this method for a contact that is not pinned, no error will occur. + +Your app can call this method from a background thread. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactmanager_user.md b/windows.applicationmodel.contacts/pinnedcontactmanager_user.md new file mode 100644 index 0000000000..cf0d8c0614 --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactmanager_user.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Contacts.PinnedContactManager.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactManager.User + +## -description +Gets the [User](./windows.system/user.md) associated with the [PinnedContactManager](pinnedcontactmanager.md). + +## -property-value +The [User](./windows.system/user.md) associated with the [PinnedContactManager](pinnedcontactmanager.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.contacts/pinnedcontactsurface.md b/windows.applicationmodel.contacts/pinnedcontactsurface.md new file mode 100644 index 0000000000..9eb154a24e --- /dev/null +++ b/windows.applicationmodel.contacts/pinnedcontactsurface.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.ApplicationModel.Contacts.PinnedContactSurface +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.Contacts.PinnedContactSurface + +## -description +Specifies the location in the Windows user interface to which a contact can be pinned. + +## -enum-fields + +## -field Taskbar:1 +The taskbar as a pinning location. + +## -field StartMenu:0 +The Windows **Start** menu as a pinning location. + +## -remarks + +## -see-also +[PinnedContactManager](pinnedcontactmanager.md) + +## -examples diff --git a/windows.applicationmodel.core/coreapplicationview_iscomponent.md b/windows.applicationmodel.core/coreapplicationview_iscomponent.md index 840f498871..012ce7a224 100644 --- a/windows.applicationmodel.core/coreapplicationview_iscomponent.md +++ b/windows.applicationmodel.core/coreapplicationview_iscomponent.md @@ -10,16 +10,15 @@ public bool IsComponent { get; } # Windows.ApplicationModel.Core.CoreApplicationView.IsComponent ## -description -Gets whether the app was launched as a component that is embedded in another app by calling the [LaunchAsync](restrictedappcontainer_launchasync.md) method. +Gets whether the app was launched as a component that is embedded in another app. This property is reserved for internal use and is not intended to be used in your code. ## -property-value -True if the app was launched as a component that is embedded in another app; false if the app was not launch as a component that is embedded in another app. +**True** if the app was launched as a component that is embedded in another app; **false** otherwise. ## -remarks ## -examples ## -see-also -[LaunchAsync](restrictedappcontainer_launchasync.md) \ No newline at end of file diff --git a/windows.applicationmodel.core/coreapplicationview_properties.md b/windows.applicationmodel.core/coreapplicationview_properties.md new file mode 100644 index 0000000000..a58923060f --- /dev/null +++ b/windows.applicationmodel.core/coreapplicationview_properties.md @@ -0,0 +1,19 @@ +--- +-api-id: P:Windows.ApplicationModel.Core.CoreApplicationView.Properties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Core.CoreApplicationView.Properties + +## -description +Gets properties that the app can associate with the view. + +## -property-value +The property bag. + +## -remarks +Properties stored here are guaranteed to have a lifetime equal to the **CoreApplicationView**. diff --git a/windows.applicationmodel.datatransfer/datapackage.md b/windows.applicationmodel.datatransfer/datapackage.md index 61a1eaac45..87e09ce280 100644 --- a/windows.applicationmodel.datatransfer/datapackage.md +++ b/windows.applicationmodel.datatransfer/datapackage.md @@ -32,3 +32,4 @@ This API is supported in native apps only. ## -see-also [Clipboard sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620520), [Sharing content source app sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620596) +soft.com/fwlink/p/?LinkId=620596) diff --git a/windows.applicationmodel.datatransfer/datapackage_resourcemap.md b/windows.applicationmodel.datatransfer/datapackage_resourcemap.md index fc313f92d3..2c3121f3df 100644 --- a/windows.applicationmodel.datatransfer/datapackage_resourcemap.md +++ b/windows.applicationmodel.datatransfer/datapackage_resourcemap.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap - -## -description -Maps a URI to a file. Used to ensure that referenced content (such as an image) in HTML content is added to the [DataPackage](datapackage.md). - -## -property-value -Specifies a name/value pair that specifies the an HTML path with a corresponding [StreamReference](../windows.storage.streams/randomaccessstreamreference.md) object. - -## -remarks -HTML content often contains references to other files. The most common example is an img tag that refers to a specific file. To ensure that the image is sent with the rest of the HTML content, you need to use `ResourceMap`, which maps the URI string to the actual data. You can learn more about this in [How to share HTML](http://msdn.microsoft.com/library/95a3d2a1-e188-4bd9-bace-d401d2d14ca2). - -## -examples - - -[!code-csharp[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml_CS)] - -[!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.ResourceMap + +## -description +Maps a URI to a file. Used to ensure that referenced content (such as an image) in HTML content is added to the [DataPackage](datapackage.md). + +## -property-value +Specifies a name/value pair that specifies the an HTML path with a corresponding [StreamReference](../windows.storage.streams/randomaccessstreamreference.md) object. + +## -remarks +HTML content often contains references to other files. The most common example is an img tag that refers to a specific file. To ensure that the image is sent with the rest of the HTML content, you need to use `ResourceMap`, which maps the URI string to the actual data. You can learn more about this in [How to share HTML](http://msdn.microsoft.com/library/95a3d2a1-e188-4bd9-bace-d401d2d14ca2). + +## -examples + + +[!code-csharp[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)] + +[!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md b/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md index 3fd9b272aa..ebcc0c541a 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md +++ b/windows.applicationmodel.datatransfer/datapackage_setbitmap_1002521000.md @@ -1,33 +1,33 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap(Windows.Storage.Streams.RandomAccessStreamReference) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap - -## -description -Sets the bitmap image contained in the [DataPackage](datapackage.md). - -## -parameters -### -param value -A stream that contains the bitmap image. - -## -remarks -This method sets the value for [StandardFormats.Bitmap](standarddataformats_bitmap.md). - -Bitmap is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. - -## -examples -The following example uses the **setBitmap** method to share an image with a target app. - - - -[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] - -[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap(Windows.Storage.Streams.RandomAccessStreamReference) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetBitmap + +## -description +Sets the bitmap image contained in the [DataPackage](datapackage.md). + +## -parameters +### -param value +A stream that contains the bitmap image. + +## -remarks +This method sets the value for [StandardFormats.Bitmap](standarddataformats_bitmap.md). + +Bitmap is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. + +## -examples +The following example uses the **setBitmap** method to share an image with a target app. + + + +[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] + +[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md b/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md index 49ae8f805d..8b441ee0da 100644 --- a/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md +++ b/windows.applicationmodel.datatransfer/datapackage_setdataprovider_375548563.md @@ -1,40 +1,41 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider(System.String,Windows.ApplicationModel.DataTransfer.DataProviderHandler) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider - -## -description -Sets a delegate to handle requests from the target app. - -## -parameters -### -param formatId -Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. - -### -param delayRenderer -A delegate that is responsible for processing requests from a target app. - -## -remarks -Use the **SetDataProvider** method when your app supports a specific format, but does not want to supply the data until the target app requests it. We encourage you to use this method if your app shares content that can require significant processing time; for example, sharing a selection of photos, videos, or files. - -When you use this method, you need to specify a format and a function. You can specify the format by using the [StandardDataFormats](standarddataformats.md) class, or you can use a string value for a custom format. The function must put data in the [DataPackage](datapackage.md) by using a method like [SetData](datapackage_setdata.md). - -You must specify the extension of the [StorageItems](standarddataformats_storageitems.md) being passed to the Share Target. - -The **SetDataProvider** method is different from the [GetDeferral](datarequest_getdeferral.md) method of the [DataRequest](datarequest.md) class. With [GetDeferral](datarequest_getdeferral.md), a source app can call a function that immediately puts the data in the [DataPackage](datapackage.md) object. The **SetDataProvider** method is for more complex share operations where packaging the data to be shared is more time-intensive or resource-intensive. - - - -## -examples - - -[!code-csharp[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles_CS)] - -[!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider(System.String,Windows.ApplicationModel.DataTransfer.DataProviderHandler) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetDataProvider + +## -description +Sets a delegate to handle requests from the target app. + +## -parameters +### -param formatId +Specifies the format of the data. We recommend that you set this value by using the [StandardDataFormats](standarddataformats.md) class. + +### -param delayRenderer +A delegate that is responsible for processing requests from a target app. + +## -remarks +Use the **SetDataProvider** method when your app supports a specific format, but does not want to supply the data until the target app requests it. We encourage you to use this method if your app shares content that can require significant processing time; for example, sharing a selection of photos, videos, or files. + +When you use this method, you need to specify a format and a function. You can specify the format by using the [StandardDataFormats](standarddataformats.md) class, or you can use a string value for a custom format. The function must put data in the [DataPackage](datapackage.md) by using a method like [SetData](datapackage_setdata.md). + +You must specify the extension of the [StorageItems](standarddataformats_storageitems.md) being passed to the Share Target. + +The **SetDataProvider** method is different from the [GetDeferral](datarequest_getdeferral.md) method of the [DataRequest](datarequest.md) class. With [GetDeferral](datarequest_getdeferral.md), a source app can call a function that immediately puts the data in the [DataPackage](datapackage.md) object. The **SetDataProvider** method is for more complex share operations where packaging the data to be shared is more time-intensive or resource-intensive. + + + +## -examples + + +[!code-csharp[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles)] + +[!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] + + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md b/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md index 1821123212..32d80265fa 100644 --- a/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md +++ b/windows.applicationmodel.datatransfer/datapackage_sethtmlformat_1162235403.md @@ -1,31 +1,32 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat(System.String) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat - -## -description -Adds HTML content to the [DataPackage](datapackage.md). - -## -parameters -### -param value -The HTML content. - -## -remarks -To ensure that a target app can process the HTML content, use [HtmlFormatHelper.CreateHtmlFormat](htmlformathelper_createhtmlformat.md). It adds the required headers and other information the string containing the HTML. - -If your app supports selection or copying/pasting of HTML content that contains [img](XREF:TODO:wwa.IMG_Element_IMG_Object) elements, be sure that the **src** attributes specify fully-qualified absolute paths to the images, not relative paths. - -## -examples - - -[!code-csharp[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml_CS)] - -[!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetHtmlFormat + +## -description +Adds HTML content to the [DataPackage](datapackage.md). + +## -parameters +### -param value +The HTML content. + +## -remarks +To ensure that a target app can process the HTML content, use [HtmlFormatHelper.CreateHtmlFormat](htmlformathelper_createhtmlformat.md). It adds the required headers and other information the string containing the HTML. + +If your app supports selection or copying/pasting of HTML content that contains [img](XREF:TODO:wwa.IMG_Element_IMG_Object) elements, be sure that the **src** attributes specify fully-qualified absolute paths to the images, not relative paths. + +## -examples + + +[!code-csharp[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)] + +[!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] + + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md b/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md index 132c0073b1..369122472a 100644 --- a/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md +++ b/windows.applicationmodel.datatransfer/datapackage_settext_908345632.md @@ -1,31 +1,32 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetText(System.String) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackage.SetText - -## -description -Sets the text that a [DataPackage](datapackage.md) contains. - -## -parameters -### -param value -The text. - -## -remarks -This method sets the text value for [StandardDataFormats.Text](standarddataformats_text.md). It's the equivalent of calling `dataPackage.setText(StandardDataFormats.Text)`. - -Text is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. - -## -examples - - -[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] - -[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackage.SetText(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.SetText + +## -description +Sets the text that a [DataPackage](datapackage.md) contains. + +## -parameters +### -param value +The text. + +## -remarks +This method sets the text value for [StandardDataFormats.Text](standarddataformats_text.md). It's the equivalent of calling `dataPackage.setText(StandardDataFormats.Text)`. + +Text is one of the data types that the [DataPackage](datapackage.md) object supports directly. See the [StandardDataFormats](standarddataformats.md) class for information on other supported data types. + +## -examples + + +[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] + +[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackage_sharecompleted.md b/windows.applicationmodel.datatransfer/datapackage_sharecompleted.md new file mode 100644 index 0000000000..1f5dac08e2 --- /dev/null +++ b/windows.applicationmodel.datatransfer/datapackage_sharecompleted.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DataPackage.ShareCompleted +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackage.ShareCompleted + +## -description +An event that is triggered when a share is completed. Shares can be sent to an app, a provider, or a contact. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md index 5cc571b319..39fd34b1d9 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_description.md @@ -1,30 +1,30 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description - -## -description -Gets or sets text that describes the contents of the [DataPackage](datapackage.md). - -## -property-value -Text that describes the contents of the [DataPackage](datapackage.md). - -## -remarks -We recommend adding a description to a [DataPackage](datapackage.md) object if you can. Target apps can use this description to help users identify what content they're sharing. - -## -examples -The following example shows how you can set the description for the content in a [DataPackage](datapackage.md). - - - -[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] - -[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Description + +## -description +Gets or sets text that describes the contents of the [DataPackage](datapackage.md). + +## -property-value +Text that describes the contents of the [DataPackage](datapackage.md). + +## -remarks +We recommend adding a description to a [DataPackage](datapackage.md) object if you can. Target apps can use this description to help users identify what content they're sharing. + +## -examples +The following example shows how you can set the description for the content in a [DataPackage](datapackage.md). + + + +[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] + +[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md index 78c2942bd9..84c6e2e6fb 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_thumbnail.md @@ -1,34 +1,34 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail - -## -description -Gets or sets a thumbnail image for the [DataPackage](datapackage.md). - -## -property-value -The [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) that represents the thumbnail image. - -## -remarks -We recommend that any time you create a [DataPackage](datapackage.md) that contains images, you also assign a thumbnail image. Doing so gives target apps the opportunity to display a visual representation of the images being shared to the user while the share operation completes. - -The minimum recommended size is 80x80. The maximum size is 240x160. These sizes are in device-independent pixels, so if the system plateau setting is other than 1.0, appropriate multiplier should be used. For example, minimum recommended size for 1.4 plateau would be 80*1.4x80*1.4=112x112 physical pixels. If you're writing a target app, remember that while we recommend a minimum and maximum size, there is no enforcement of these sizes. Your app should have code to handle thumbnails that are an unexpected size—such as to scale them up or down as needed. Take care, however, not to alter the aspect ratio of the image. - -You can use any data format (JPG, GIF, and so on) for a thumbnail. You also have the option of loading the thumbnail from the disk, or creating it on the fly. - -## -examples -This example shows how you can add a thumbnail image to a [DataPackage](datapackage.md) when sharing an image with a target app. - - - -[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] - -[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Thumbnail + +## -description +Gets or sets a thumbnail image for the [DataPackage](datapackage.md). + +## -property-value +The [IRandomAccessStreamReference](../windows.storage.streams/irandomaccessstreamreference.md) that represents the thumbnail image. + +## -remarks +We recommend that any time you create a [DataPackage](datapackage.md) that contains images, you also assign a thumbnail image. Doing so gives target apps the opportunity to display a visual representation of the images being shared to the user while the share operation completes. + +The minimum recommended size is 80x80. The maximum size is 240x160. These sizes are in device-independent pixels, so if the system plateau setting is other than 1.0, appropriate multiplier should be used. For example, minimum recommended size for 1.4 plateau would be 80*1.4x80*1.4=112x112 physical pixels. If you're writing a target app, remember that while we recommend a minimum and maximum size, there is no enforcement of these sizes. Your app should have code to handle thumbnails that are an unexpected size—such as to scale them up or down as needed. Take care, however, not to alter the aspect ratio of the image. + +You can use any data format (JPG, GIF, and so on) for a thumbnail. You also have the option of loading the thumbnail from the disk, or creating it on the fly. + +## -examples +This example shows how you can add a thumbnail image to a [DataPackage](datapackage.md) when sharing an image with a target app. + + + +[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] + +[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md b/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md index 400c862729..e2bebccdf6 100644 --- a/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md +++ b/windows.applicationmodel.datatransfer/datapackagepropertyset_title.md @@ -1,30 +1,30 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title - -## -description -Gets or sets the text that displays as a title for the contents of the [DataPackage](datapackage.md) object. - -## -property-value -The text that displays as a title for the contents of the [DataPackage](datapackage.md) object. - -## -remarks -Setting this property is mandatory. Without it, any share operations involving the [DataPackage](datapackage.md) will fail. - -## -examples -This example shows how you can set the title for the content in a [DataPackage.](datapackage.md) - - - -[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] - -[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackagePropertySet.Title + +## -description +Gets or sets the text that displays as a title for the contents of the [DataPackage](datapackage.md) object. + +## -property-value +The text that displays as a title for the contents of the [DataPackage](datapackage.md) object. + +## -remarks +Setting this property is mandatory. Without it, any share operations involving the [DataPackage](datapackage.md) will fail. + +## -examples +This example shows how you can set the title for the content in a [DataPackage.](datapackage.md) + + + +[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] + +[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md b/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md index 0db29c0bea..9cea9ec953 100644 --- a/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md +++ b/windows.applicationmodel.datatransfer/datapackageview_gettextasync_1343001388.md @@ -1,28 +1,29 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync - -## -description -Gets the text in the [DataPackageView](datapackageview.md) object. - -## -returns -The text. - -## -remarks - -## -examples - - -[!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)] - -[!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)] - -## -see-also -[GetTextAsync(String)](datapackageview_gettextasync_160262668.md) +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync + +## -description +Gets the text in the [DataPackageView](datapackageview.md) object. + +## -returns +The text. + +## -remarks + +## -examples + + +[!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)] + +[!code-js[HowToReceiveSharedText](../windows.applicationmodel.datatransfer.sharetarget/code/ShareTargetBeta/javascript/js/ReceivedShardText.js#SnippetHowToReceiveSharedText)] + +## -see-also +[GetTextAsync(String)](datapackageview_gettextasync_160262668.md) +geview_gettextasync_160262668.md) diff --git a/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md b/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md index 7a05c17300..f935c8bab2 100644 --- a/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md +++ b/windows.applicationmodel.datatransfer/dataproviderrequest_getdeferral_254836512.md @@ -1,3 +1,4 @@ +======= --- -api-id: M:Windows.ApplicationModel.DataTransfer.DataProviderRequest.GetDeferral -api-type: winrt method diff --git a/windows.applicationmodel.datatransfer/datarequest_data.md b/windows.applicationmodel.datatransfer/datarequest_data.md index f3b7fdcbbd..33b61b57f3 100644 --- a/windows.applicationmodel.datatransfer/datarequest_data.md +++ b/windows.applicationmodel.datatransfer/datarequest_data.md @@ -1,34 +1,34 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.DataRequest.Data --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.DataRequest.Data - -## -description -Sets or gets a [DataPackage](datapackage.md) object that contains the content a user wants to share. - -## -property-value -Contains the content a user wants to share. - -## -remarks -The [Data](datarequest_data.md) property enables your app to supply data to a target app. Your app must supply this data by using a [DataPackage](datapackage.md) object. - -Use this property when your app has the content immediately available that the user wants to share. If you need to call a function to generate the [DataPackage](datapackage.md), use the [GetDeferral](datarequest_getdeferral.md) method. - -When your app cannot supply a [DataPackage](datapackage.md) object, use the [FailWithDisplayText](datarequest_failwithdisplaytext.md) method to cancel the share and provide a message that the target app can display to the user. - -## -examples -The following code shows how to get a [DataPackage](datapackage.md) object from the [Data](datarequest_data.md) property as part of setting the data on a [DataPackage](datapackage.md) to share with another app. - - - -[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] - -[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.DataRequest.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequest.Data + +## -description +Sets or gets a [DataPackage](datapackage.md) object that contains the content a user wants to share. + +## -property-value +Contains the content a user wants to share. + +## -remarks +The [Data](datarequest_data.md) property enables your app to supply data to a target app. Your app must supply this data by using a [DataPackage](datapackage.md) object. + +Use this property when your app has the content immediately available that the user wants to share. If you need to call a function to generate the [DataPackage](datapackage.md), use the [GetDeferral](datarequest_getdeferral.md) method. + +When your app cannot supply a [DataPackage](datapackage.md) object, use the [FailWithDisplayText](datarequest_failwithdisplaytext.md) method to cancel the share and provide a message that the target app can display to the user. + +## -examples +The following code shows how to get a [DataPackage](datapackage.md) object from the [Data](datarequest_data.md) property as part of setting the data on a [DataPackage](datapackage.md) to share with another app. + + + +[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] + +[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md b/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md index cd29fc569f..6f2229a350 100644 --- a/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md +++ b/windows.applicationmodel.datatransfer/datarequest_getdeferral_254836512.md @@ -1,32 +1,32 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral - -## -description -Supports asynchronous sharing operations by creating and returning a [DataRequestDeferral](datarequestdeferral.md) object. - -## -returns -An object that allows you to share or send content asynchronously. - -## -remarks -The **GetDeferral** method allows your app to call a function during a share operation, so that your app can asynchronously generate the [DataPackage](datapackage.md) object for the target app. - -Use this method when you want to use an asynchronous function call to generate the [DataPackage](datapackage.md) during a share operation. This function must return a [DataPackage](datapackage.md) object within 200ms to prevent the operation from timing out. If your app shares content that takes more time to package, such as a collection of files or photos, don't use this method. Instead, use the [SetDataProvider](datapackage_setdataprovider.md) method to assign a delegate to a [DataPackage](datapackage.md) and return that [DataPackage](datapackage.md) to the target app. - -## -examples -The following sample shows how to get a [DataRequestDeferral](datarequestdeferral.md) object by using the **GetDeferral** method. - - - -[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] - -[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequest.GetDeferral + +## -description +Supports asynchronous sharing operations by creating and returning a [DataRequestDeferral](datarequestdeferral.md) object. + +## -returns +An object that allows you to share or send content asynchronously. + +## -remarks +The **GetDeferral** method allows your app to call a function during a share operation, so that your app can asynchronously generate the [DataPackage](datapackage.md) object for the target app. + +Use this method when you want to use an asynchronous function call to generate the [DataPackage](datapackage.md) during a share operation. This function must return a [DataPackage](datapackage.md) object within 200ms to prevent the operation from timing out. If your app shares content that takes more time to package, such as a collection of files or photos, don't use this method. Instead, use the [SetDataProvider](datapackage_setdataprovider.md) method to assign a delegate to a [DataPackage](datapackage.md) and return that [DataPackage](datapackage.md) to the target app. + +## -examples +The following sample shows how to get a [DataRequestDeferral](datarequestdeferral.md) object by using the **GetDeferral** method. + + + +[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] + +[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md b/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md index 818ac0291a..c6bbf57a28 100644 --- a/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md +++ b/windows.applicationmodel.datatransfer/datarequestdeferral_complete_1807836922.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete - -## -description -Indicates that the content for an asynchronous share is ready for a target app, or that an error in the sharing operation occurred. - -## -remarks -Your app must call the **complete** method when its finished adding data to a [DataPackage](datapackage.md). - -## -examples -This example shows how to call the **complete** method after getting a [DataRequestDeferral](datarequestdeferral.md) object. - - - -[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] - -[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataRequestDeferral.Complete + +## -description +Indicates that the content for an asynchronous share is ready for a target app, or that an error in the sharing operation occurred. + +## -remarks +Your app must call the **complete** method when its finished adding data to a [DataPackage](datapackage.md). + +## -examples +This example shows how to call the **complete** method after getting a [DataRequestDeferral](datarequestdeferral.md) object. + + + +[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] + +[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md b/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md index 10aab920ae..85a7e50d71 100644 --- a/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md +++ b/windows.applicationmodel.datatransfer/datatransfermanager_datarequested.md @@ -1,31 +1,31 @@ ---- --api-id: E:Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested --api-type: winrt event ---- - - - -# Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested - -## -description -Occurs when a share operation starts. - -## -remarks -This event is fired when a sharing operation starts— typically when the user taps the Share charm, although it is also fired if your app starts a share operation programmatically. To handle this event, you need to add an event listener to the [DataTransferManager](datatransfermanager.md) object for the active window. You can get this object through the [GetForCurrentView](datatransfermanager_getforcurrentview.md) method. - -When handling a **datarequested** event, the most important property you need to be aware of is its [request](datarequestedeventargs_request.md) property. This property contains a [DataRequest](datarequest.md) object. Your app uses this object to provide the data that the user wants to share with a selected target app. - - - -## -examples -This example uses an inline function to handle a **datarequested** event. - - - -[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] - -[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.DataRequested + +## -description +Occurs when a share operation starts. + +## -remarks +This event is fired when a sharing operation starts— typically when the user taps the Share charm, although it is also fired if your app starts a share operation programmatically. To handle this event, you need to add an event listener to the [DataTransferManager](datatransfermanager.md) object for the active window. You can get this object through the [GetForCurrentView](datatransfermanager_getforcurrentview.md) method. + +When handling a **datarequested** event, the most important property you need to be aware of is its [request](datarequestedeventargs_request.md) property. This property contains a [DataRequest](datarequest.md) object. Your app uses this object to provide the data that the user wants to share with a selected target app. + + + +## -examples +This example uses an inline function to handle a **datarequested** event. + + + +[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] + +[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md b/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md index 48ad844f35..23fe4648fd 100644 --- a/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md +++ b/windows.applicationmodel.datatransfer/datatransfermanager_getforcurrentview_1363600702.md @@ -1,30 +1,30 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView - -## -description -Returns the [DataTransferManager](datatransfermanager.md) object associated with the current window. - -## -returns -The [DataTransferManager](datatransfermanager.md) object associated with the current window. - -## -remarks -Each window has a [DataTransferManager](datatransfermanager.md) object associated with it. When sharing content, you use the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object that is associated with the active window. After you have the appropriate [DataTransferManager](datatransfermanager.md) object, you can add an event listener to it to handle the [DataRequested](datatransfermanager_datarequested.md) event, which the system fires when a share operation is initiated. Your app uses the [DataRequest](datarequest.md) object returned with this event to set the data that the user wants to share with a target app. - -## -examples -This example calls the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object associated with the active window for the app. - - - -[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] - -[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView + +## -description +Returns the [DataTransferManager](datatransfermanager.md) object associated with the current window. + +## -returns +The [DataTransferManager](datatransfermanager.md) object associated with the current window. + +## -remarks +Each window has a [DataTransferManager](datatransfermanager.md) object associated with it. When sharing content, you use the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object that is associated with the active window. After you have the appropriate [DataTransferManager](datatransfermanager.md) object, you can add an event listener to it to handle the [DataRequested](datatransfermanager_datarequested.md) event, which the system fires when a share operation is initiated. Your app uses the [DataRequest](datarequest.md) object returned with this event to set the data that the user wants to share with a target app. + +## -examples +This example calls the **GetForCurrentView** method to get the [DataTransferManager](datatransfermanager.md) object associated with the active window for the app. + + + +[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] + +[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_issupported_930300905.md b/windows.applicationmodel.datatransfer/datatransfermanager_issupported_930300905.md new file mode 100644 index 0000000000..04a624e029 --- /dev/null +++ b/windows.applicationmodel.datatransfer/datatransfermanager_issupported_930300905.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.DataTransferManager.IsSupported +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.IsSupported + +## -description +Returns true if the device supports sharing, false otherwise. + +## -parameters + +## -returns +True if the device supports sharing, false otherwise. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/datatransfermanager_shareprovidersrequested.md b/windows.applicationmodel.datatransfer/datatransfermanager_shareprovidersrequested.md new file mode 100644 index 0000000000..ab0010d9f1 --- /dev/null +++ b/windows.applicationmodel.datatransfer/datatransfermanager_shareprovidersrequested.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.ApplicationModel.DataTransfer.DataTransferManager.ShareProvidersRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.DataTransfer.DataTransferManager.ShareProvidersRequested + +## -description +An event that is triggered when the share providers are requested. This is used as a callback and providers are added by subscribing to this event and calling ShareProvidersRequestedEventArgs.Providers.Add() in the event handler. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md b/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md index 80eab23731..9e429c7965 100644 --- a/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md +++ b/windows.applicationmodel.datatransfer/htmlformathelper_createhtmlformat_180504809.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat(System.String) --api-type: winrt method ---- - - - -# Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat - -## -description -Takes a string that represents HTML content and adds the necessary headers to ensure it is formatted correctly for share and Clipboard operations. - -## -parameters -### -param htmlFragment -A string representing the HTML content. - -## -returns -A string representing the formatted HTML. - -## -remarks - -## -examples - - -[!code-csharp[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml_CS)] - -[!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.HtmlFormatHelper.CreateHtmlFormat + +## -description +Takes a string that represents HTML content and adds the necessary headers to ensure it is formatted correctly for share and Clipboard operations. + +## -parameters +### -param htmlFragment +A string representing the HTML content. + +## -returns +A string representing the formatted HTML. + +## -remarks + +## -examples + + +[!code-csharp[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareHTML.xaml.cs#SnippetHowToShareHtml)] + +[!code-js[HowToShareHtml](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareHtml.js#SnippetHowToShareHtml)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/sharecompletedeventargs.md b/windows.applicationmodel.datatransfer/sharecompletedeventargs.md new file mode 100644 index 0000000000..b5768058cc --- /dev/null +++ b/windows.applicationmodel.datatransfer/sharecompletedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareCompletedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareCompletedEventArgs + +## -description +This class contains the event args for [ShareCompleted](datapackage_sharecompleted.md). +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/sharecompletedeventargs_sharetarget.md b/windows.applicationmodel.datatransfer/sharecompletedeventargs_sharetarget.md new file mode 100644 index 0000000000..0fd17ea445 --- /dev/null +++ b/windows.applicationmodel.datatransfer/sharecompletedeventargs_sharetarget.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareCompletedEventArgs.ShareTarget +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareCompletedEventArgs.ShareTarget + +## -description +Gets the share target. + +## -property-value +The share target. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovider.md b/windows.applicationmodel.datatransfer/shareprovider.md new file mode 100644 index 0000000000..531751ea4e --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovider.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareProvider +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvider + +## -description +This class represents a custom provider which can be shared. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovider_backgroundcolor.md b/windows.applicationmodel.datatransfer/shareprovider_backgroundcolor.md new file mode 100644 index 0000000000..c6e99618a8 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovider_backgroundcolor.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProvider.BackgroundColor +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvider.BackgroundColor + +## -description +Gets the background color of the share provider. + +## -property-value +The background color of the share provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovider_displayicon.md b/windows.applicationmodel.datatransfer/shareprovider_displayicon.md new file mode 100644 index 0000000000..eb9cc98b19 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovider_displayicon.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProvider.DisplayIcon +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvider.DisplayIcon + +## -description +Gets the display icon of the share provider. + +## -property-value +The display icon of the share provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovider_shareprovider_944950296.md b/windows.applicationmodel.datatransfer/shareprovider_shareprovider_944950296.md new file mode 100644 index 0000000000..4f8227d731 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovider_shareprovider_944950296.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareProvider.#ctor(System.String,Windows.Storage.Streams.RandomAccessStreamReference,Windows.UI.Color,Windows.ApplicationModel.DataTransfer.ShareProviderHandler) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvider.ShareProvider + +## -description +Creates a new ShareProvider object. + +## -parameters + +### -param title +The title of the share provider. + +### -param displayIcon +The display icon of the share provider. + +### -param backgroundColor +The background color of the share provider. + +### -param handler +The handler of the share provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovider_tag.md b/windows.applicationmodel.datatransfer/shareprovider_tag.md new file mode 100644 index 0000000000..2c8279f5b9 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovider_tag.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProvider.Tag +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvider.Tag + +## -description +Gets or sets the tag of the share provider. + +## -property-value +The tag of the share provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovider_title.md b/windows.applicationmodel.datatransfer/shareprovider_title.md new file mode 100644 index 0000000000..edb927f69d --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovider_title.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProvider.Title +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvider.Title + +## -description +Gets the title of the share provider. + +## -property-value +The title of the share provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareproviderhandler.md b/windows.applicationmodel.datatransfer/shareproviderhandler.md new file mode 100644 index 0000000000..9515bbfdab --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareproviderhandler.md @@ -0,0 +1,14 @@ +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareProviderHandler +-api-type: winrt delegate +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProviderHandler + +## -description +A delegate that handles share providers. + diff --git a/windows.applicationmodel.datatransfer/shareprovideroperation.md b/windows.applicationmodel.datatransfer/shareprovideroperation.md new file mode 100644 index 0000000000..00bb138963 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovideroperation.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareProviderOperation +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProviderOperation + +## -description +This class represents a share provider operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovideroperation_data.md b/windows.applicationmodel.datatransfer/shareprovideroperation_data.md new file mode 100644 index 0000000000..6d2a85813e --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovideroperation_data.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProviderOperation.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProviderOperation.Data + +## -description +Gets the data of the operation. + +## -property-value +The data of the operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovideroperation_provider.md b/windows.applicationmodel.datatransfer/shareprovideroperation_provider.md new file mode 100644 index 0000000000..7e8ff65c27 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovideroperation_provider.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProviderOperation.Provider +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProviderOperation.Provider + +## -description +Gets the share provider. + +## -property-value +The share provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovideroperation_reportcompleted_1121471021.md b/windows.applicationmodel.datatransfer/shareprovideroperation_reportcompleted_1121471021.md new file mode 100644 index 0000000000..3328d9622c --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovideroperation_reportcompleted_1121471021.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareProviderOperation.ReportCompleted +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProviderOperation.ReportCompleted + +## -description +Completes the report. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs.md b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs.md new file mode 100644 index 0000000000..543725114c --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs + +## -description +The event args of [ShareProvidersRequested](datatransfermanager_shareprovidersrequested.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_data.md b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_data.md new file mode 100644 index 0000000000..fd054f2a87 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_data.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs.Data +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs.Data + +## -description +Gets the data. + +## -property-value +The data. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_getdeferral_254836512.md b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..b9c2784594 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_getdeferral_254836512.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs.GetDeferral + +## -description +Requests a deferral to complete actions on this object in an event handler. + +## -returns +The deferral. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_providers.md b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_providers.md new file mode 100644 index 0000000000..80782e10c3 --- /dev/null +++ b/windows.applicationmodel.datatransfer/shareprovidersrequestedeventargs_providers.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs.Providers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareProvidersRequestedEventArgs.Providers + +## -description +Gets the share providers. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/sharetargetinfo.md b/windows.applicationmodel.datatransfer/sharetargetinfo.md new file mode 100644 index 0000000000..7e5c082710 --- /dev/null +++ b/windows.applicationmodel.datatransfer/sharetargetinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.DataTransfer.ShareTargetInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTargetInfo + +## -description +This class contains information about a share target. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/sharetargetinfo_appusermodelid.md b/windows.applicationmodel.datatransfer/sharetargetinfo_appusermodelid.md new file mode 100644 index 0000000000..4189eb18ef --- /dev/null +++ b/windows.applicationmodel.datatransfer/sharetargetinfo_appusermodelid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTargetInfo.AppUserModelId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTargetInfo.AppUserModelId + +## -description +Gets the app user model ID. + +## -property-value +The app user model ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/sharetargetinfo_shareprovider.md b/windows.applicationmodel.datatransfer/sharetargetinfo_shareprovider.md new file mode 100644 index 0000000000..81ab169316 --- /dev/null +++ b/windows.applicationmodel.datatransfer/sharetargetinfo_shareprovider.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.ShareTargetInfo.ShareProvider +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.ShareTargetInfo.ShareProvider + +## -description +Gets the share provider. + +## -property-value +The share provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md b/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md index a4851e2cfd..885d89a756 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_bitmap.md @@ -1,29 +1,29 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap - -## -description -A read-only property that returns the format ID string value corresponding to the Bitmap format. - -## -property-value -The format ID string value corresponding to the Bitmap format. - -## -remarks - -## -examples -This example demonstrates the use of the **Bitmap** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] - -[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Bitmap + +## -description +A read-only property that returns the format ID string value corresponding to the Bitmap format. + +## -property-value +The format ID string value corresponding to the Bitmap format. + +## -remarks + +## -examples +This example demonstrates the use of the **Bitmap** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +[!code-csharp[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareImage.xaml.cs#SnippetHowToShareImage)] + +[!code-js[HowToShareImage](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareImage.js#SnippetHowToShareImage)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md b/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md index ef073dd52d..a345313c93 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_storageitems.md @@ -1,29 +1,29 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems - -## -description -A read-only property that returns the format ID string value corresponding to the StorageItem format. - -## -property-value -The format ID string value corresponding to the StorageItem format. - -## -remarks - -## -examples -This example demonstrates the use of the **StorageItems** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -[!code-csharp[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles_CS)] - -[!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.StorageItems + +## -description +A read-only property that returns the format ID string value corresponding to the StorageItem format. + +## -property-value +The format ID string value corresponding to the StorageItem format. + +## -remarks + +## -examples +This example demonstrates the use of the **StorageItems** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +[!code-csharp[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareFiles.xaml.cs#SnippetHowToShareFiles)] + +[!code-js[HowToShareFiles](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareFiles.js#SnippetHowToShareFiles)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/standarddataformats_text.md b/windows.applicationmodel.datatransfer/standarddataformats_text.md index fbb4eaad75..eed432b2e7 100644 --- a/windows.applicationmodel.datatransfer/standarddataformats_text.md +++ b/windows.applicationmodel.datatransfer/standarddataformats_text.md @@ -1,29 +1,29 @@ ---- --api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text --api-type: winrt property ---- - - - -# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text - -## -description -A read-only property that returns the format ID string value corresponding to the Text format. - -## -property-value -The format ID string value corresponding to the Text format. - -## -remarks - -## -examples -This example demonstrates the use of the **Text** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. - - - -[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] - -[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] - -## -see-also +--- +-api-id: P:Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text + +## -description +A read-only property that returns the format ID string value corresponding to the Text format. + +## -property-value +The format ID string value corresponding to the Text format. + +## -remarks + +## -examples +This example demonstrates the use of the **Text** property. To use the code in this example, add an event listener to your app to handle the [activated](../windows.applicationmodel.core/coreapplicationview_activated.md) event. Then put this code in the function that this event listener calls. + + + +[!code-csharp[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/cs/ShareText.xaml.cs#SnippetHowToShareTextBasic)] + +[!code-js[HowToShareTextBasic](../windows.applicationmodel.datatransfer/code/ShareMainBeta/javascript/js/ShareText.js#SnippetHowToShareTextBasic)] + +## -see-also diff --git a/windows.applicationmodel.datatransfer/windows_applicationmodel_datatransfer.md b/windows.applicationmodel.datatransfer/windows_applicationmodel_datatransfer.md index bdaebc9cc4..f83f8be728 100644 --- a/windows.applicationmodel.datatransfer/windows_applicationmodel_datatransfer.md +++ b/windows.applicationmodel.datatransfer/windows_applicationmodel_datatransfer.md @@ -13,4 +13,4 @@ Contains classes that are used to exchange data between a source app and a targe ## -examples ## -see-also -[Windows.ApplicationModel.DataTransfer.ShareTarget](XREF:TODO:w_appmod_dataxfer_share.windows_applicationmodel_datatransfer_sharetarget), [Share data](http://msdn.microsoft.com/library/32287f5e-eb86-4b98-97ff-8f6228d06782), [Quickstart: Sharing content ( apps using JavaScript and HTML)](http://msdn.microsoft.com/library/594cd09c-19d4-4f7e-996a-e8e2489170dd), [Sharing content target app sample](http://go.microsoft.com/fwlink/p/?LinkID=267177), [Clipboard sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620520), [Sharing content source app sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620596), [Sharing content target app sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620597), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file +[Windows.ApplicationModel.DataTransfer.ShareTarget](http://msdn.microsoft.com/library/e8b36c71-6914-4a44-a42c-86d6b2682768), [Share data](http://msdn.microsoft.com/library/32287f5e-eb86-4b98-97ff-8f6228d06782), [Quickstart: Sharing content ( apps using JavaScript and HTML)](http://msdn.microsoft.com/library/594cd09c-19d4-4f7e-996a-e8e2489170dd), [Sharing content target app sample](http://go.microsoft.com/fwlink/p/?LinkID=267177), [Clipboard sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620520), [Sharing content source app sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620596), [Sharing content target app sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620597), [App package information sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620581) \ No newline at end of file diff --git a/windows.applicationmodel.email/emailmessage_replyto.md b/windows.applicationmodel.email/emailmessage_replyto.md new file mode 100644 index 0000000000..51ee91c7ff --- /dev/null +++ b/windows.applicationmodel.email/emailmessage_replyto.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.ReplyTo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.ReplyTo + +## -description +Gets the recipients that are configured to receive a reply to the email message. + +## -property-value +The recipients that are configured to receive a reply to the email message. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.email/emailmessage_sentrepresenting.md b/windows.applicationmodel.email/emailmessage_sentrepresenting.md new file mode 100644 index 0000000000..f3f14a2b74 --- /dev/null +++ b/windows.applicationmodel.email/emailmessage_sentrepresenting.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Email.EmailMessage.SentRepresenting +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Email.EmailMessage.SentRepresenting + +## -description +Gets or sets an object that identifies the name and address of the person sending the message. + +## -property-value +An object that identifies the name and address of the person sending the message. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.payments.provider/paymentappmanager.md b/windows.applicationmodel.payments.provider/paymentappmanager.md new file mode 100644 index 0000000000..79168fa032 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymentappmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.Provider.PaymentAppManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentAppManager + +## -description +This class is used to register an app as a payment provider app so that it can start processing [PaymentTransactions](paymenttransaction.md) that were submitted through the Payment Request APIs ([Windows.ApplicationModel.Payments](windows_applicationmodel_payments_provider.md)). + +## -remarks + + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymentappmanager_current.md b/windows.applicationmodel.payments.provider/paymentappmanager_current.md new file mode 100644 index 0000000000..93688bd9dc --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymentappmanager_current.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.Provider.PaymentAppManager.Current +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentAppManager.Current + +## -description +The current PaymentAppManager object. + +## -property-value +Gets or sets the Current property. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymentappmanager_registerasync_1509496085.md b/windows.applicationmodel.payments.provider/paymentappmanager_registerasync_1509496085.md new file mode 100644 index 0000000000..66d739646c --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymentappmanager_registerasync_1509496085.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentAppManager.RegisterAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentAppManager.RegisterAsync + +## -description +Registers this app as a payment provider. + +## -parameters + +### -param supportedPaymentMethodIds +The supported payment method IDs. + +## -returns +Returns an asynchronous action. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments.provider/paymentappmanager_unregisterasync_1070650021.md b/windows.applicationmodel.payments.provider/paymentappmanager_unregisterasync_1070650021.md new file mode 100644 index 0000000000..0381c25f5f --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymentappmanager_unregisterasync_1070650021.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentAppManager.UnregisterAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentAppManager.UnregisterAsync + +## -description +Unregisters this app as a payment provider. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction.md b/windows.applicationmodel.payments.provider/paymenttransaction.md new file mode 100644 index 0000000000..80e3306b0e --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.Provider.PaymentTransaction +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction + +## -description +This class contains information about a payment transaction that was submitted through the [Windows.ApplicationModel.Payments](windows_applicationmodel_payments_provider.md) API. The payment provider app uses this class to accept that payment transaction or reject it after verifying the payment through the provider's infrastructure. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_acceptasync_1179121155.md b/windows.applicationmodel.payments.provider/paymenttransaction_acceptasync_1179121155.md new file mode 100644 index 0000000000..67341092dc --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_acceptasync_1179121155.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.AcceptAsync(Windows.ApplicationModel.Payments.PaymentToken) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.AcceptAsync + +## -description +Accepts the payment. + +## -parameters +### -param paymentToken +The payment token. + +## -returns +An asynchronous operation that completes with a [PaymentTransactionAcceptResult](paymenttransactionacceptresult.md). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_fromidasync_1322863552.md b/windows.applicationmodel.payments.provider/paymenttransaction_fromidasync_1322863552.md new file mode 100644 index 0000000000..bde73c00a9 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_fromidasync_1322863552.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.FromIdAsync + +## -description +Gets a [PaymentTransaction](paymenttransaction.md) object from an ID. + +## -parameters +### -param id +The ID. + +## -returns +An asynchronous operation that completes with an instance of [PaymentTransaction](paymenttransaction.md). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_payeremail.md b/windows.applicationmodel.payments.provider/paymenttransaction_payeremail.md new file mode 100644 index 0000000000..519b0820b5 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_payeremail.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PayerEmail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PayerEmail + +## -description +The payer email. + +## -property-value +Gets the PayerEmail. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_payername.md b/windows.applicationmodel.payments.provider/paymenttransaction_payername.md new file mode 100644 index 0000000000..4e23d4ce4f --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_payername.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PayerName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PayerName + +## -description +The payer name. + +## -property-value +Gets or sets the PayerName. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_payerphonenumber.md b/windows.applicationmodel.payments.provider/paymenttransaction_payerphonenumber.md new file mode 100644 index 0000000000..f4a3df5fcc --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_payerphonenumber.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PayerPhoneNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PayerPhoneNumber + +## -description +The payer phone number. + +## -property-value +Gets or sets the PayerPhoneNumber. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_paymentrequest.md b/windows.applicationmodel.payments.provider/paymenttransaction_paymentrequest.md new file mode 100644 index 0000000000..768021358f --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_paymentrequest.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PaymentRequest +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.PaymentRequest + +## -description +The payment request. + +## -property-value +Gets the PaymentRequest. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_reject_731021879.md b/windows.applicationmodel.payments.provider/paymenttransaction_reject_731021879.md new file mode 100644 index 0000000000..421922009f --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_reject_731021879.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.Reject +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.Reject + +## -description +Rejects the payment transation. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_updateselectedshippingoptionasync_1921874835.md b/windows.applicationmodel.payments.provider/paymenttransaction_updateselectedshippingoptionasync_1921874835.md new file mode 100644 index 0000000000..7debf1a737 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_updateselectedshippingoptionasync_1921874835.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.UpdateSelectedShippingOptionAsync(Windows.ApplicationModel.Payments.PaymentShippingOption) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.UpdateSelectedShippingOptionAsync + +## -description +Updates the selected shipping option. + +## -parameters +### -param selectedShippingOption +The selected shipping option. + +## -returns +An asynchronous operation that completes with a [PaymentRequestChangedResult](../windows.applicationmodel.payments/paymentrequestchangedresult.md). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransaction_updateshippingaddressasync_1897375006.md b/windows.applicationmodel.payments.provider/paymenttransaction_updateshippingaddressasync_1897375006.md new file mode 100644 index 0000000000..5908e5ab9e --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransaction_updateshippingaddressasync_1897375006.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.Provider.PaymentTransaction.UpdateShippingAddressAsync(Windows.ApplicationModel.Payments.PaymentAddress) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransaction.UpdateShippingAddressAsync + +## -description +Updates the shipping address. + +## -parameters +### -param shippingAddress +The shipping address. + +## -returns +Returns an asynchronous operation that completes with a [PaymentRequestChangedResult](../windows.applicationmodel.payments/paymentrequestchangedresult.md). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransactionacceptresult.md b/windows.applicationmodel.payments.provider/paymenttransactionacceptresult.md new file mode 100644 index 0000000000..6d6b1f8359 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransactionacceptresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.Provider.PaymentTransactionAcceptResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransactionAcceptResult + +## -description +This class contains the status of of a payment transaction after attempting to accept it. + +## -remarks +An object of this class type is created and retrieved through the [PaymentTransationc.AcceptAsync](paymenttransaction_acceptasync.md) method. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/paymenttransactionacceptresult_status.md b/windows.applicationmodel.payments.provider/paymenttransactionacceptresult_status.md new file mode 100644 index 0000000000..6abd237610 --- /dev/null +++ b/windows.applicationmodel.payments.provider/paymenttransactionacceptresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.Provider.PaymentTransactionAcceptResult.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.Provider.PaymentTransactionAcceptResult.Status + +## -description +The status of a payment transaction accept operation. + +## -property-value +Gets or sets the Status. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments.provider/windows_applicationmodel_payments_provider.md b/windows.applicationmodel.payments.provider/windows_applicationmodel_payments_provider.md new file mode 100644 index 0000000000..20d40a206c --- /dev/null +++ b/windows.applicationmodel.payments.provider/windows_applicationmodel_payments_provider.md @@ -0,0 +1,15 @@ +--- +-api-id: N:Windows.ApplicationModel.Payments.Provider +-api-type: winrt namespace +--- + +# Windows.ApplicationModel.Payments.Provider + +## -description +This namespace provides API that allow your app to facilitate payment transactions submitted by users. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress.md b/windows.applicationmodel.payments/paymentaddress.md new file mode 100644 index 0000000000..13724f2a4d --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentAddress +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress + +## -description +This class represents an address that is used in the Payment Request API. + +> [!NOTE] +> This class reflects the [W3C PaymentAddress interface](https://aka.ms/prapi#paymentaddress-interface). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_addresslines.md b/windows.applicationmodel.payments/paymentaddress_addresslines.md new file mode 100644 index 0000000000..943000a236 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_addresslines.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.AddressLines +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.AddressLines + +## -description +The address lines. + +## -property-value +Gets or sets the AddressLines. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_city.md b/windows.applicationmodel.payments/paymentaddress_city.md new file mode 100644 index 0000000000..d434bac1d6 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_city.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.City +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.City + +## -description +The city. + +## -property-value +Gets or sets the City. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_country.md b/windows.applicationmodel.payments/paymentaddress_country.md new file mode 100644 index 0000000000..c952557223 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_country.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.Country +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.Country + +## -description +The country. Values must be from the [CLDR](http://cldr.unicode.org/) standard. + +## -property-value +Gets or sets the Country. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_dependentlocality.md b/windows.applicationmodel.payments/paymentaddress_dependentlocality.md new file mode 100644 index 0000000000..639c140244 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_dependentlocality.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.DependentLocality +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.DependentLocality + +## -description +The dependent locality within a city. + +## -property-value +Gets or sets the DependentLocality. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_languagecode.md b/windows.applicationmodel.payments/paymentaddress_languagecode.md new file mode 100644 index 0000000000..fa5a19381f --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_languagecode.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.LanguageCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.LanguageCode + +## -description +Language code for the address. Values must be valid IETF language tags as specified by the BCP-47 standard. + +## -property-value +Gets or sets the LanguageCode. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_organization.md b/windows.applicationmodel.payments/paymentaddress_organization.md new file mode 100644 index 0000000000..dd2391e802 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_organization.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.Organization +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.Organization + +## -description +Organization in the address. + +## -property-value +Gets or sets the Organization. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_paymentaddress_1221375020.md b/windows.applicationmodel.payments/paymentaddress_paymentaddress_1221375020.md new file mode 100644 index 0000000000..1e6b7c56cb --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_paymentaddress_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentAddress.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.PaymentAddress + +## -description +Creates a new PaymentAddress object. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_phonenumber.md b/windows.applicationmodel.payments/paymentaddress_phonenumber.md new file mode 100644 index 0000000000..f6404d029e --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_phonenumber.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.PhoneNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.PhoneNumber + +## -description +The phone number of the recipient. + +## -property-value +Gets or sets the PhoneNumber. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_postalcode.md b/windows.applicationmodel.payments/paymentaddress_postalcode.md new file mode 100644 index 0000000000..e1c1d27779 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_postalcode.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.PostalCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.PostalCode + +## -description +The address postal code. + +## -property-value +Gets or sets the PostalCode. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_properties.md b/windows.applicationmodel.payments/paymentaddress_properties.md new file mode 100644 index 0000000000..b36871c031 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_properties.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.Properties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.Properties + +## -description +This field is used to allow extensions to the class. It is not present in the W3C definition. + +## -property-value +Gets or sets Properties. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_recipient.md b/windows.applicationmodel.payments/paymentaddress_recipient.md new file mode 100644 index 0000000000..d67a3a4607 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_recipient.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.Recipient +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.Recipient + +## -description +The name of the recipient. + +## -property-value +Gets or sets the Recipient. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_region.md b/windows.applicationmodel.payments/paymentaddress_region.md new file mode 100644 index 0000000000..d8b691367d --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_region.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.Region +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.Region + +## -description +The region of a country. + +## -property-value +Gets or sets the Region. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentaddress_sortingcode.md b/windows.applicationmodel.payments/paymentaddress_sortingcode.md new file mode 100644 index 0000000000..7a78737fc5 --- /dev/null +++ b/windows.applicationmodel.payments/paymentaddress_sortingcode.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentAddress.SortingCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentAddress.SortingCode + +## -description +The sorting code. + +## -property-value +Gets or sets the SortingCode. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentcurrencyamount.md b/windows.applicationmodel.payments/paymentcurrencyamount.md new file mode 100644 index 0000000000..24f1405751 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcurrencyamount.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentCurrencyAmount +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentCurrencyAmount + +## -description +This class describes a monetary value associated with a purchase. For example, charges or discounts. + +> [!NOTE] +> This class reflects the [W3C PaymentCurrencyAmount dictionary](https://aka.ms/prapi#paymentcurrencyamount-dictionary). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentcurrencyamount_currency.md b/windows.applicationmodel.payments/paymentcurrencyamount_currency.md new file mode 100644 index 0000000000..d6cb5e9592 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcurrencyamount_currency.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentCurrencyAmount.Currency +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentCurrencyAmount.Currency + +## -description +The currency identifier. + +## -property-value +Gets or sets the Currency. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentcurrencyamount_currencysystem.md b/windows.applicationmodel.payments/paymentcurrencyamount_currencysystem.md new file mode 100644 index 0000000000..69d9d611f7 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcurrencyamount_currencysystem.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentCurrencyAmount.CurrencySystem +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentCurrencyAmount.CurrencySystem + +## -description +The currency system. + +## -property-value +Gets or sets the CurrencySystem. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentcurrencyamount_paymentcurrencyamount_1001825332.md b/windows.applicationmodel.payments/paymentcurrencyamount_paymentcurrencyamount_1001825332.md new file mode 100644 index 0000000000..328f433747 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcurrencyamount_paymentcurrencyamount_1001825332.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentCurrencyAmount.#ctor(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentCurrencyAmount.PaymentCurrencyAmount + +## -description +Creates a new PaymentCurrencyAmount object. + +## -parameters +### -param value +The monetary value. An exception will be thrown if this value doesn't match the following regex pattern.``` +^-?[0-9]+(\.[0-9]+)?$ +``` + + + +### -param currency +The currency. Valid values are determined by *currencySystem*. For example, if *currencySystem* is urn:iso:std:iso:4217 then **USD** is a valid currency value. + +> [!IMPORTANT] +> Validity of currency values are not enforced. + +### -param currencySystem +The currency system. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentcurrencyamount_paymentcurrencyamount_1571897524.md b/windows.applicationmodel.payments/paymentcurrencyamount_paymentcurrencyamount_1571897524.md new file mode 100644 index 0000000000..dc62906954 --- /dev/null +++ b/windows.applicationmodel.payments/paymentcurrencyamount_paymentcurrencyamount_1571897524.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentCurrencyAmount.#ctor(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentCurrencyAmount.PaymentCurrencyAmount + +## -description +Creates a new [PaymentCurrencyAmount](paymentcurrencyamount.md) object + +## -parameters +### -param value +The monetary value. An exception will be thrown if this value doesn't match the following regex pattern.``` +^-?[0-9]+(\.[0-9]+)?$ +``` + + + +### -param currency +The currency identifier. The default **CurrencySystem** is urn:iso:std:iso:4217. + +> [!IMPORTANT] +> Validity of currency values are not enforced. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentcurrencyamount_value.md b/windows.applicationmodel.payments/paymentcurrencyamount_value.md new file mode 100644 index 0000000000..5b68d04a8e --- /dev/null +++ b/windows.applicationmodel.payments/paymentcurrencyamount_value.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentCurrencyAmount.Value +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentCurrencyAmount.Value + +## -description +The monetary value. + +## -property-value +Gets or sets the value. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetails.md b/windows.applicationmodel.payments/paymentdetails.md new file mode 100644 index 0000000000..7fc6413eb6 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails + +## -description +This class provides information about the requested transaction; it is passed to the [PaymentRequest](../windows.payments/paymentrequest.md) and [PaymentRequestChangedResult](paymentrequestchangedresult.md) constructors. + +> [!NOTE] +> This class reflects the [W3C PaymentDetails dictionary](https://aka.ms/prapi#paymentdetailsmodifier-dictionary). + +## -remarks +If this class is used to update the payment request in [PaymentRequestChangedResult](paymentrequestchangedresult.md), properties that are null indicate that property hasn't been changed and that the old property value should + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetails_displayitems.md b/windows.applicationmodel.payments/paymentdetails_displayitems.md new file mode 100644 index 0000000000..bd15e36da7 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails_displayitems.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetails.DisplayItems +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails.DisplayItems + +## -description +This is a collection of [PaymentItem](../windows.payments/paymentitem.md) classes items for a payment request. These represent the breakdown of items in the payment request. Some examples are shoes or taxes. + +## -property-value +Gets or sets the DisplayItems. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetails_modifiers.md b/windows.applicationmodel.payments/paymentdetails_modifiers.md new file mode 100644 index 0000000000..f25ee253a9 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails_modifiers.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetails.Modifiers +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails.Modifiers + +## -description +A collection of [PaymentDetailsModifier ](../windows.payments/paymentdetailsmodifier.md) classes for which provide the ability to change the transaction cost based on the payment method used. + +## -property-value +Gets or sets the Modifiers. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetails_paymentdetails_1221375020.md b/windows.applicationmodel.payments/paymentdetails_paymentdetails_1221375020.md new file mode 100644 index 0000000000..202c5ba2bd --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails_paymentdetails_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentDetails.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails.PaymentDetails + +## -description +Creates a [PaymentDetails](paymentdetails.md) object. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetails_paymentdetails_1488406651.md b/windows.applicationmodel.payments/paymentdetails_paymentdetails_1488406651.md new file mode 100644 index 0000000000..c9b8d2df82 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails_paymentdetails_1488406651.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentDetails.#ctor(Windows.ApplicationModel.Payments.PaymentItem) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails.PaymentDetails + +## -description +Creates a [PaymentDetails](paymentdetails.md) object. + +## -parameters +### -param total +The total. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetails_paymentdetails_1625290407.md b/windows.applicationmodel.payments/paymentdetails_paymentdetails_1625290407.md new file mode 100644 index 0000000000..478c189234 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails_paymentdetails_1625290407.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentDetails.#ctor(Windows.ApplicationModel.Payments.PaymentItem,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Payments.PaymentItem}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails.PaymentDetails + +## -description +Creates a [PaymentDetails](paymentdetails.md) object. + +## -parameters + +### -param total +The total. + +### -param displayItems +The display items. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentdetails_shippingoptions.md b/windows.applicationmodel.payments/paymentdetails_shippingoptions.md new file mode 100644 index 0000000000..61327a5b62 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails_shippingoptions.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetails.ShippingOptions +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails.ShippingOptions + +## -description +A collection of [PaymentShippingOption](paymentshippingoption.md) classes for a payment request. + +## -property-value +Gets or sets the ShippingOptions. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetails_total.md b/windows.applicationmodel.payments/paymentdetails_total.md new file mode 100644 index 0000000000..e337689ce7 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetails_total.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetails.Total +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetails.Total + +## -description +This is the total cost of the transaction. + +## -property-value +Gets or sets the Total. + +## -remarks +Apps should validate that this value matches the sum of the [DisplayItems](paymentdetails_displayitems.md) and the selected shipping option. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier.md b/windows.applicationmodel.payments/paymentdetailsmodifier.md new file mode 100644 index 0000000000..e71f2a5a87 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentDetailsModifier +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier + +## -description +This class is used when payment methods (see [PaymentRequest.MethodData](paymentrequest_methoddata.md)) have additional costs or discounts associated with them. + +> [!NOTE] +> This class reflects the [W3C PaymentDetailsModifier dictionary](https://aka.ms/prapi#paymentdetailsmodifier-dictionary). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier_additionaldisplayitems.md b/windows.applicationmodel.payments/paymentdetailsmodifier_additionaldisplayitems.md new file mode 100644 index 0000000000..8b41032666 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier_additionaldisplayitems.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetailsModifier.AdditionalDisplayItems +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier.AdditionalDisplayItems + +## -description +The additional display items. + +## -property-value +Gets or sets the AdditionalDisplayItems. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier_jsondata.md b/windows.applicationmodel.payments/paymentdetailsmodifier_jsondata.md new file mode 100644 index 0000000000..110ae8777f --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier_jsondata.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetailsModifier.JsonData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier.JsonData + +## -description +Optional information. + +## -property-value +Gets or sets the JsonData. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_1720006576.md b/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_1720006576.md new file mode 100644 index 0000000000..75ed4d447c --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_1720006576.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentDetailsModifier.#ctor(Windows.Foundation.Collections.IIterable{System.String},Windows.ApplicationModel.Payments.PaymentItem) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier.PaymentDetailsModifier + +## -description +Creates a [PaymentDetailsModifier](paymentdetailsmodifier.md) object. + +## -parameters + +### -param supportedMethodIds +The supported method IDs. + +### -param total +The total. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_374622732.md b/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_374622732.md new file mode 100644 index 0000000000..cb80ed5bee --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_374622732.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentDetailsModifier.#ctor(Windows.Foundation.Collections.IIterable{System.String},Windows.ApplicationModel.Payments.PaymentItem,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Payments.PaymentItem}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier.PaymentDetailsModifier + +## -description +Creates a [PaymentDetailsModifier](paymentdetailsmodifier.md) object. + +## -parameters + +### -param supportedMethodIds +The supported method IDs. + +### -param total +The total. + +### -param additionalDisplayItems +The additional display items. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_631536884.md b/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_631536884.md new file mode 100644 index 0000000000..f25e26a392 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier_paymentdetailsmodifier_631536884.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentDetailsModifier.#ctor(Windows.Foundation.Collections.IIterable{System.String},Windows.ApplicationModel.Payments.PaymentItem,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Payments.PaymentItem},System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier.PaymentDetailsModifier + +## -description +Creates a [PaymentDetailsModifier](paymentdetailsmodifier.md) object. + +## -parameters + +### -param supportedMethodIds +The supported method IDs. + +### -param total +The total. + +### -param additionalDisplayItems +The additioanl display items. + +### -param jsonData + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier_supportedmethodids.md b/windows.applicationmodel.payments/paymentdetailsmodifier_supportedmethodids.md new file mode 100644 index 0000000000..1cae692880 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier_supportedmethodids.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetailsModifier.SupportedMethodIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier.SupportedMethodIds + +## -description +A collection of payment method that this modifier applies to. + +## -property-value +Gets or sets the SupportedMethodIds. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentdetailsmodifier_total.md b/windows.applicationmodel.payments/paymentdetailsmodifier_total.md new file mode 100644 index 0000000000..b4e3d9bf48 --- /dev/null +++ b/windows.applicationmodel.payments/paymentdetailsmodifier_total.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentDetailsModifier.Total +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentDetailsModifier.Total + +## -description +This is the total of all [DisplayItems](../windows.payments/paymentdetails_displayitems.md). This value serves as a replacement for the [PaymentDetails.Total](paymentdetails_total.md) property when one of the payment methods in the [SupportedMethodIds](paymentdetailsmodifier_supportedmethodids.md) list is used. Therefore, this value needs to be the sum of [PaymentDetail.DisplayItems](paymentdetails_displayitems.md), the selected shipping option in the [PaymentDetails.ShippingOptions](paymentdetails_shippingoptions.md) collection (See [PaymentShippingOption.IsSelected](paymentshippingoption_isselected.md)), and [AdditionalDisplayItems](paymentdetailsmodifier_additionaldisplayitems.md). + +## -property-value +Gets or sets the Total. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentitem.md b/windows.applicationmodel.payments/paymentitem.md new file mode 100644 index 0000000000..72bae4da34 --- /dev/null +++ b/windows.applicationmodel.payments/paymentitem.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentItem +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentItem + +## -description +This class represents a payment item. + +> [!NOTE] +> This class reflects the [W3C PaymentItem dictionary](https://aka.ms/prapi#paymentitem-dictionary). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentitem_amount.md b/windows.applicationmodel.payments/paymentitem_amount.md new file mode 100644 index 0000000000..bf308b69da --- /dev/null +++ b/windows.applicationmodel.payments/paymentitem_amount.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentItem.Amount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentItem.Amount + +## -description +The amount. + +## -property-value +Gets or sets the amount. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentitem_label.md b/windows.applicationmodel.payments/paymentitem_label.md new file mode 100644 index 0000000000..e5c6ec2168 --- /dev/null +++ b/windows.applicationmodel.payments/paymentitem_label.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentItem.Label +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentItem.Label + +## -description +The label. + +## -property-value +Gets or sets the Label. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentitem_paymentitem_1050873564.md b/windows.applicationmodel.payments/paymentitem_paymentitem_1050873564.md new file mode 100644 index 0000000000..b2e190714c --- /dev/null +++ b/windows.applicationmodel.payments/paymentitem_paymentitem_1050873564.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentItem.#ctor(System.String,Windows.ApplicationModel.Payments.PaymentCurrencyAmount) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentItem.PaymentItem + +## -description +Creates a [PaymentItem](paymentitem.md) object. The [Pending](paymentitem_pending.md) property is set to false by default. + +## -parameters +### -param label +The label. + +### -param amount +The amount. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentitem_pending.md b/windows.applicationmodel.payments/paymentitem_pending.md new file mode 100644 index 0000000000..3385d0ae21 --- /dev/null +++ b/windows.applicationmodel.payments/paymentitem_pending.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentItem.Pending +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentItem.Pending + +## -description +Indicates that the item may not be finalized, yet. For example, a merchant may initially quote the total cost assuming they will be shipping locally. But this value could change if the user provides an overseas shipping address, which would require the merchant to increase the price to account for international shipping. + +## -property-value +Gets or sets the Pending status. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmediator.md b/windows.applicationmodel.payments/paymentmediator.md new file mode 100644 index 0000000000..c7823349c7 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmediator.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentMediator +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentMediator + +## -description +This class is used to submit payment requests. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmediator_getsupportedmethodidsasync_914072544.md b/windows.applicationmodel.payments/paymentmediator_getsupportedmethodidsasync_914072544.md new file mode 100644 index 0000000000..19e0895af8 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmediator_getsupportedmethodidsasync_914072544.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMediator.GetSupportedMethodIdsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMediator.GetSupportedMethodIdsAsync + +## -description +Gets the list of payment methods currently supported. + +## -returns +When the asynchronous operation completes, it returns a collection of the supported payment methods. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmediator_paymentmediator_1221375020.md b/windows.applicationmodel.payments/paymentmediator_paymentmediator_1221375020.md new file mode 100644 index 0000000000..ee4e479576 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmediator_paymentmediator_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMediator.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMediator.PaymentMediator + +## -description +Creates a new [PaymentMediator](paymentmediator.md) object. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmediator_submitpaymentrequestasync_16520403.md b/windows.applicationmodel.payments/paymentmediator_submitpaymentrequestasync_16520403.md new file mode 100644 index 0000000000..48733ed650 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmediator_submitpaymentrequestasync_16520403.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMediator.SubmitPaymentRequestAsync(Windows.ApplicationModel.Payments.PaymentRequest) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMediator.SubmitPaymentRequestAsync + +## -description +Submits a payment request. + +## -parameters +### -param paymentRequest +The payment request. + +## -returns +When the asynchronous operation completes, it returns a submission result. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmediator_submitpaymentrequestasync_176424041.md b/windows.applicationmodel.payments/paymentmediator_submitpaymentrequestasync_176424041.md new file mode 100644 index 0000000000..4b21978824 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmediator_submitpaymentrequestasync_176424041.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMediator.SubmitPaymentRequestAsync(Windows.ApplicationModel.Payments.PaymentRequest,Windows.ApplicationModel.Payments.PaymentRequestChangedHandler) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMediator.SubmitPaymentRequestAsync + +## -description +Submits a payment request. + +## -parameters +### -param paymentRequest +The payment request. + +### -param changeHandler +A handler for when the payment request changes. + +## -returns +When the asynchronous operation completes it returns submission results. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmerchantinfo.md b/windows.applicationmodel.payments/paymentmerchantinfo.md new file mode 100644 index 0000000000..c66485dea5 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmerchantinfo.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentMerchantInfo +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentMerchantInfo + +## -description +A class that contains information about a payment merchant. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmerchantinfo_packagefullname.md b/windows.applicationmodel.payments/paymentmerchantinfo_packagefullname.md new file mode 100644 index 0000000000..5bf9f3b7fe --- /dev/null +++ b/windows.applicationmodel.payments/paymentmerchantinfo_packagefullname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentMerchantInfo.PackageFullName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentMerchantInfo.PackageFullName + +## -description +The full name of the package. + +## -property-value +Gets or sets the PackageFullName. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmerchantinfo_paymentmerchantinfo_1221375020.md b/windows.applicationmodel.payments/paymentmerchantinfo_paymentmerchantinfo_1221375020.md new file mode 100644 index 0000000000..cdd26bd88c --- /dev/null +++ b/windows.applicationmodel.payments/paymentmerchantinfo_paymentmerchantinfo_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMerchantInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMerchantInfo.PaymentMerchantInfo + +## -description +Creates a new [PaymentMerchantInfo](paymentmerchantinfo.md) object. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmerchantinfo_paymentmerchantinfo_843413386.md b/windows.applicationmodel.payments/paymentmerchantinfo_paymentmerchantinfo_843413386.md new file mode 100644 index 0000000000..8c979ff12b --- /dev/null +++ b/windows.applicationmodel.payments/paymentmerchantinfo_paymentmerchantinfo_843413386.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMerchantInfo.#ctor(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMerchantInfo.PaymentMerchantInfo + +## -description +Creates a new [PaymentMerchantInfo](paymentmerchantinfo.md) object. + +## -parameters +### -param uri +The uri. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmerchantinfo_uri.md b/windows.applicationmodel.payments/paymentmerchantinfo_uri.md new file mode 100644 index 0000000000..0dcb2e06bf --- /dev/null +++ b/windows.applicationmodel.payments/paymentmerchantinfo_uri.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentMerchantInfo.Uri +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentMerchantInfo.Uri + +## -description +A read-only property containing the URI. + +## -property-value +Gets the Uri. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmethoddata.md b/windows.applicationmodel.payments/paymentmethoddata.md new file mode 100644 index 0000000000..97dc3f86f1 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmethoddata.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentMethodData +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentMethodData + +## -description +A class containing data about a payment method. + +> [!NOTE] +> This class reflects the [W3C PaymentMethodData dictionary](https://www.w3.org/TR/payment-request/#paymentitem-dictionary). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmethoddata_jsondata.md b/windows.applicationmodel.payments/paymentmethoddata_jsondata.md new file mode 100644 index 0000000000..12c5fad0bc --- /dev/null +++ b/windows.applicationmodel.payments/paymentmethoddata_jsondata.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentMethodData.JsonData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentMethodData.JsonData + +## -description +Data about the payment method. For example, if the [Basic Card Payment](http://www.w3.org/TR/payment-method-basic-card/) method is being used then this must contain data confirming to the [BasicCardRequest](http://www.w3.org/TR/payment-method-basic-card/#basiccardrequest) dictionary type. + +## -property-value +Gets the JsonData. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentmethoddata_paymentmethoddata_1181929246.md b/windows.applicationmodel.payments/paymentmethoddata_paymentmethoddata_1181929246.md new file mode 100644 index 0000000000..fa6a90ad69 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmethoddata_paymentmethoddata_1181929246.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMethodData.#ctor(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMethodData.PaymentMethodData + +## -description +Creates a [PaymentMethodData](paymentmethoddata.md) object. + +## -parameters + +### -param supportedMethodIds +The supported method IDs. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentmethoddata_paymentmethoddata_177128098.md b/windows.applicationmodel.payments/paymentmethoddata_paymentmethoddata_177128098.md new file mode 100644 index 0000000000..da18ce057f --- /dev/null +++ b/windows.applicationmodel.payments/paymentmethoddata_paymentmethoddata_177128098.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentMethodData.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentMethodData.PaymentMethodData + +## -description +Creates a [PaymentMethodData](paymentmethoddata.md) object. + +## -parameters + +### -param supportedMethodIds +The supported method IDs. + +### -param jsonData +The data associated with a payment method. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentmethoddata_supportedmethodids.md b/windows.applicationmodel.payments/paymentmethoddata_supportedmethodids.md new file mode 100644 index 0000000000..6354763336 --- /dev/null +++ b/windows.applicationmodel.payments/paymentmethoddata_supportedmethodids.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentMethodData.SupportedMethodIds +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentMethodData.SupportedMethodIds + +## -description +The supported method IDs. + +## -property-value +Gets the SupportedMethodIds. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptionpresence.md b/windows.applicationmodel.payments/paymentoptionpresence.md new file mode 100644 index 0000000000..b64dcbd03d --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptionpresence.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentOptionPresence +-api-type: winrt enum +--- + + + +# PaymentOptionPresence + +## -description +An enumeration that indicates whether the option is required or optional. + +## -enum-fields +### -field None:0 +Property is not needed or used by the merchant. + +### -field Optional:1 +Property is not needed by the merchant, but they will accept it if provided. For example, a merchant could optionally send you a receipt to your email address. + +### -field Required:2 +The merchant can't (or is unwilling to) process the transaction without this information. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptions.md b/windows.applicationmodel.payments/paymentoptions.md new file mode 100644 index 0000000000..4431493de8 --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptions.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentOptions + +## -description +A class containing payment options. + +> [!NOTE] +> This class reflects the [W3C PaymentOptions dictionary](https://www.w3.org/TR/payment-request/#paymentoptions-dictionary). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptions_paymentoptions_1221375020.md b/windows.applicationmodel.payments/paymentoptions_paymentoptions_1221375020.md new file mode 100644 index 0000000000..0b3e3cf3a5 --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptions_paymentoptions_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentOptions.PaymentOptions + +## -description +Creates a new [PaymentOptions](paymentoptions.md) object. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptions_requestpayeremail.md b/windows.applicationmodel.payments/paymentoptions_requestpayeremail.md new file mode 100644 index 0000000000..83ed2fdc70 --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptions_requestpayeremail.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentOptions.RequestPayerEmail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentOptions.RequestPayerEmail + +## -description +Indicates whether to request the payer email. + +## -property-value +Gets or sets the RequestPayerEmail option. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptions_requestpayername.md b/windows.applicationmodel.payments/paymentoptions_requestpayername.md new file mode 100644 index 0000000000..798a323676 --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptions_requestpayername.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentOptions.RequestPayerName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentOptions.RequestPayerName + +## -description +Indicates whether to request the payer name. + +## -property-value +Gets or sets the RequestPayerName. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptions_requestpayerphonenumber.md b/windows.applicationmodel.payments/paymentoptions_requestpayerphonenumber.md new file mode 100644 index 0000000000..695569ca00 --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptions_requestpayerphonenumber.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentOptions.RequestPayerPhoneNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentOptions.RequestPayerPhoneNumber + +## -description +Indicates whether to request the payer phone number. + +## -property-value +Gets or sets the RequestPayerPhoneNumer. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptions_requestshipping.md b/windows.applicationmodel.payments/paymentoptions_requestshipping.md new file mode 100644 index 0000000000..a0f8d408e1 --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptions_requestshipping.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentOptions.RequestShipping +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentOptions.RequestShipping + +## -description +Indicates whether to request shipping. If this value is set to true, then [PaymentDetails.ShippingOptions](paymentdetails_shippingoptions.md) must not be empty. + +## -property-value +Gets or sets RequestShipping. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentoptions_shippingtype.md b/windows.applicationmodel.payments/paymentoptions_shippingtype.md new file mode 100644 index 0000000000..f3ed89be8b --- /dev/null +++ b/windows.applicationmodel.payments/paymentoptions_shippingtype.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentOptions.ShippingType +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentOptions.ShippingType + +## -description +The shipping type. + +## -property-value +Gets or sets the ShippingType. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequest.md b/windows.applicationmodel.payments/paymentrequest.md new file mode 100644 index 0000000000..6b0b9b8833 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest + +## -description +A class that contains information about a payment request. + +> [!NOTE] +> This class is reflects the [W3C PaymentRequest interface](https://www.w3.org/TR/payment-request/#paymentrequest-interface). + +## -remarks + + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequest_details.md b/windows.applicationmodel.payments/paymentrequest_details.md new file mode 100644 index 0000000000..860f88f4cb --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_details.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequest.Details +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.Details + +## -description +The details + +## -property-value +Gets or sets the Details. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequest_merchantinfo.md b/windows.applicationmodel.payments/paymentrequest_merchantinfo.md new file mode 100644 index 0000000000..b58aa3a1cc --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_merchantinfo.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequest.MerchantInfo +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.MerchantInfo + +## -description +The merchant info. + +## -property-value +Gets or sets the MerchantInfo + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequest_methoddata.md b/windows.applicationmodel.payments/paymentrequest_methoddata.md new file mode 100644 index 0000000000..49866bd555 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_methoddata.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequest.MethodData +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.MethodData + +## -description +A collection of [PaymentMethodData](paymentmethoddata.md) classes. This collection represents the list of payment methods supported by the merchant. + +## -property-value +Gets the MethodData. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequest_options.md b/windows.applicationmodel.payments/paymentrequest_options.md new file mode 100644 index 0000000000..b78e4eae44 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_options.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequest.Options +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.Options + +## -description +The options. + +## -property-value +Gets or sets the Options. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequest_paymentrequest_1245284228.md b/windows.applicationmodel.payments/paymentrequest_paymentrequest_1245284228.md new file mode 100644 index 0000000000..7a90dbc47b --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_paymentrequest_1245284228.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentRequest.#ctor(Windows.ApplicationModel.Payments.PaymentDetails,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Payments.PaymentMethodData},Windows.ApplicationModel.Payments.PaymentMerchantInfo) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.PaymentRequest + +## -description +Creates a [PaymentRequest](paymentrequest.md) object. + +## -parameters + +### -param details +The details. + +### -param methodData +The method data. + +### -param merchantInfo +The merchant information. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentrequest_paymentrequest_1739145104.md b/windows.applicationmodel.payments/paymentrequest_paymentrequest_1739145104.md new file mode 100644 index 0000000000..7299bed4b5 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_paymentrequest_1739145104.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentRequest.#ctor(Windows.ApplicationModel.Payments.PaymentDetails,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Payments.PaymentMethodData}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.PaymentRequest + +## -description +Creates a [PaymentRequest](paymentrequest.md) object. + +## -parameters + +### -param details +The details. + +### -param methodData +The method data. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentrequest_paymentrequest_31055812.md b/windows.applicationmodel.payments/paymentrequest_paymentrequest_31055812.md new file mode 100644 index 0000000000..4648c0ca51 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequest_paymentrequest_31055812.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentRequest.#ctor(Windows.ApplicationModel.Payments.PaymentDetails,Windows.Foundation.Collections.IIterable{Windows.ApplicationModel.Payments.PaymentMethodData},Windows.ApplicationModel.Payments.PaymentMerchantInfo,Windows.ApplicationModel.Payments.PaymentOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequest.PaymentRequest + +## -description +Creates a [PaymentRequest](paymentrequest.md) object. + +## -parameters + +### -param details +The details. + +### -param methodData +The method data. + +### -param merchantInfo +The merchant information. + +### -param options +The options. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.payments/paymentrequestchangedargs.md b/windows.applicationmodel.payments/paymentrequestchangedargs.md new file mode 100644 index 0000000000..7b4a17bdc9 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequestChangedArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedArgs + +## -description +A class containing arguments from the [PaymentRequestChanged](paymentrequestchangedhandler.md) delegate. + +## -remarks +An object of this class is created and retrieved through the [PaymentRequestChangedHandler](paymentrequestchangedhandler.md) delegate. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedargs_acknowledge_1320366353.md b/windows.applicationmodel.payments/paymentrequestchangedargs_acknowledge_1320366353.md new file mode 100644 index 0000000000..3f554d6b24 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedargs_acknowledge_1320366353.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.Acknowledge(Windows.ApplicationModel.Payments.PaymentRequestChangedResult) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.Acknowledge + +## -description +This method is called by the merchant to confirm that it has received and processed the changes to the payment request. And it provides a way for the merchant to update the details of the request, if required. + +## -parameters +### -param changeResult +The change result. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedargs_changekind.md b/windows.applicationmodel.payments/paymentrequestchangedargs_changekind.md new file mode 100644 index 0000000000..c752942033 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedargs_changekind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.ChangeKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.ChangeKind + +## -description +The change kind. + +## -property-value +Gets the ChangeKind. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedargs_selectedshippingoption.md b/windows.applicationmodel.payments/paymentrequestchangedargs_selectedshippingoption.md new file mode 100644 index 0000000000..ca20e08fcb --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedargs_selectedshippingoption.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.SelectedShippingOption +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.SelectedShippingOption + +## -description +The selected shipping option. This will be non-null if [ChangeKind](paymentrequestchangedargs_changekind.md) is set to [PaymentRequestChangeKind.ShippingOption](paymentrequestchangekind.md). + +## -property-value +Gets the SelectedShippingOption. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedargs_shippingaddress.md b/windows.applicationmodel.payments/paymentrequestchangedargs_shippingaddress.md new file mode 100644 index 0000000000..58299f91a3 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedargs_shippingaddress.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.ShippingAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedArgs.ShippingAddress + +## -description +The shipping address. This will be non-null if [ChangeKind](paymentrequestchangedargs_changekind.md) is set to [PaymentRequestChangeKind.ShippingAddress](paymentrequestchangekind.md). + +## -property-value +Gets the ShippingAddress. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedhandler.md b/windows.applicationmodel.payments/paymentrequestchangedhandler.md new file mode 100644 index 0000000000..fb162da617 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedhandler.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequestChangedHandler +-api-type: winrt delegate +--- + +# Windows.ApplicationModel.Payments.PaymentRequestChangedHandler + +## -description +A handler that is triggered when a payment request has changed. + +## -parameters + +### -param paymentRequest +The payment request. + +### -param args +The args. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedresult.md b/windows.applicationmodel.payments/paymentrequestchangedresult.md new file mode 100644 index 0000000000..b3af214231 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedresult.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequestChangedResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedResult + +## -description +The result of the payment changed payment request. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedresult_changeacceptedbymerchant.md b/windows.applicationmodel.payments/paymentrequestchangedresult_changeacceptedbymerchant.md new file mode 100644 index 0000000000..4a288dc7dd --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedresult_changeacceptedbymerchant.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestChangedResult.ChangeAcceptedByMerchant +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedResult.ChangeAcceptedByMerchant + +## -description +Indicates whether the change was accepted by the merchant. For example, this might be set to false, if the user specified an overseas shipping address but the merchant is unwilling to ship internationally. + +## -property-value +Gets or sets the ChangeAcceptedByMerchant. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedresult_message.md b/windows.applicationmodel.payments/paymentrequestchangedresult_message.md new file mode 100644 index 0000000000..414f2cecb8 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedresult_message.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestChangedResult.Message +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedResult.Message + +## -description +The message. + +## -property-value +Gets or sets the Message. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedresult_paymentrequestchangedresult_1055010060.md b/windows.applicationmodel.payments/paymentrequestchangedresult_paymentrequestchangedresult_1055010060.md new file mode 100644 index 0000000000..e92ddbf6b7 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedresult_paymentrequestchangedresult_1055010060.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentRequestChangedResult.#ctor(System.Boolean,Windows.ApplicationModel.Payments.PaymentDetails) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedResult.PaymentRequestChangedResult + +## -description +Creates a new [PaymentRequestChangedResult](paymentrequestchangedresult.md) object. + +## -parameters +### -param changeAcceptedByMerchant +Whether the change is accepted by the merchant. + +### -param updatedPaymentDetails +The updated payment details. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedresult_paymentrequestchangedresult_1174655024.md b/windows.applicationmodel.payments/paymentrequestchangedresult_paymentrequestchangedresult_1174655024.md new file mode 100644 index 0000000000..8cfc5b606a --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedresult_paymentrequestchangedresult_1174655024.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentRequestChangedResult.#ctor(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedResult.PaymentRequestChangedResult + +## -description +Creates a new [PaymentRequestChangedResult](paymentrequestchangedresult.md) object. + +## -parameters +### -param changeAcceptedByMerchant +Whether the change was accepted by the merchant. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangedresult_updatedpaymentdetails.md b/windows.applicationmodel.payments/paymentrequestchangedresult_updatedpaymentdetails.md new file mode 100644 index 0000000000..948cce63d3 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangedresult_updatedpaymentdetails.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestChangedResult.UpdatedPaymentDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestChangedResult.UpdatedPaymentDetails + +## -description +The updated payment details. + +## -property-value +Gets or sets the UpdatedPaymentDetails. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestchangekind.md b/windows.applicationmodel.payments/paymentrequestchangekind.md new file mode 100644 index 0000000000..391fa7a618 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestchangekind.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequestChangeKind +-api-type: winrt enum +--- + + + +# PaymentRequestChangeKind + +## -description +An enumeration indicating what was changed in the payment request. + +## -enum-fields +### -field ShippingOption:0 +The shipping option was changed. + +### -field ShippingAddress:1 +The shipping address was changed. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestcompletionstatus.md b/windows.applicationmodel.payments/paymentrequestcompletionstatus.md new file mode 100644 index 0000000000..97d83e5856 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestcompletionstatus.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequestCompletionStatus +-api-type: winrt enum +--- + + + +# PaymentRequestCompletionStatus + +## -description +An enumeration that describes whether or not the transaction completed successfully. + +## -enum-fields +### -field Succeeded:0 +Payment was successfully processed by the merchant. + +### -field Failed:1 +Payment failed by the merchant. + +### -field Unknown:2 +Unknown status provided by the merchant. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequeststatus.md b/windows.applicationmodel.payments/paymentrequeststatus.md new file mode 100644 index 0000000000..08fd63fb36 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequeststatus.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequestStatus +-api-type: winrt enum +--- + + + +# PaymentRequestStatus + +## -description +An enumeration that describes whether the user successfully accepted the payment request. See [PaymentRequestSubmitResult](paymentrequestsubmitresult.md). + +## -enum-fields +### -field Succeeded:0 +The payment request succeeded. + +### -field Failed:1 +The payment request failed. + +### -field Canceled:2 +The user cancelled the payment request + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestsubmitresult.md b/windows.applicationmodel.payments/paymentrequestsubmitresult.md new file mode 100644 index 0000000000..d5fa73addf --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestsubmitresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentRequestSubmitResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestSubmitResult + +## -description +A class containing the payment request submission result. + +## -remarks +An object of this class is created and retrieved through the [PaymentMediator.SubmitPaymentRequestAsync](paymentmediator_submitpaymentrequestasync_16520403.md) method. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestsubmitresult_response.md b/windows.applicationmodel.payments/paymentrequestsubmitresult_response.md new file mode 100644 index 0000000000..2384052ee4 --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestsubmitresult_response.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestSubmitResult.Response +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestSubmitResult.Response + +## -description +The response from the payment request submission. This will be non-null if [Status](paymentrequestsubmitresult_status.md) is equal to [PaymentRequestStatus.Succeeded](paymentrequeststatus.md). + +## -property-value +Gets the Response. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentrequestsubmitresult_status.md b/windows.applicationmodel.payments/paymentrequestsubmitresult_status.md new file mode 100644 index 0000000000..e9aee495ac --- /dev/null +++ b/windows.applicationmodel.payments/paymentrequestsubmitresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentRequestSubmitResult.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentRequestSubmitResult.Status + +## -description +The status of the submission. + +## -property-value +Gets the Status. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse.md b/windows.applicationmodel.payments/paymentresponse.md new file mode 100644 index 0000000000..e04ed6d304 --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentResponse +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse + +## -description +A class that contains the payment response. + +> [!NOTE] +> This class reflects the [W3C PaymentResponse interface](https://www.w3.org/TR/payment-request/#paymentrequest-interface). + +## -remarks +An object of this class type is created and retrieved through the [PaymentRequestSubmitResult.Response](paymentrequestsubmitresult_response.md) property. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse_completeasync_449016086.md b/windows.applicationmodel.payments/paymentresponse_completeasync_449016086.md new file mode 100644 index 0000000000..e34d72b125 --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse_completeasync_449016086.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentResponse.CompleteAsync(Windows.ApplicationModel.Payments.PaymentRequestCompletionStatus) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse.CompleteAsync + +## -description +Completes a payment response. + +## -parameters +### -param status +The status. + +## -returns +An asynchronous action. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse_payeremail.md b/windows.applicationmodel.payments/paymentresponse_payeremail.md new file mode 100644 index 0000000000..a7ddc559e5 --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse_payeremail.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentResponse.PayerEmail +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse.PayerEmail + +## -description +The payer email. + +## -property-value +Gets the PayerEmail. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse_payername.md b/windows.applicationmodel.payments/paymentresponse_payername.md new file mode 100644 index 0000000000..d20d753364 --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse_payername.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentResponse.PayerName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse.PayerName + +## -description +The payer name. + +## -property-value +Gets the PayerName. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse_payerphonenumber.md b/windows.applicationmodel.payments/paymentresponse_payerphonenumber.md new file mode 100644 index 0000000000..a452db4799 --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse_payerphonenumber.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentResponse.PayerPhoneNumber +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse.PayerPhoneNumber + +## -description +The payer phone number. + +## -property-value +Gets the PayerPhoneNumber. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse_paymenttoken.md b/windows.applicationmodel.payments/paymentresponse_paymenttoken.md new file mode 100644 index 0000000000..72523ab93f --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse_paymenttoken.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentResponse.PaymentToken +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse.PaymentToken + +## -description +The payment token. + +## -property-value +Gets the PaymentToken. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse_shippingaddress.md b/windows.applicationmodel.payments/paymentresponse_shippingaddress.md new file mode 100644 index 0000000000..1ffbdf0659 --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse_shippingaddress.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentResponse.ShippingAddress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse.ShippingAddress + +## -description +The shipping address. + +## -property-value +Gets the ShippingAddress. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentresponse_shippingoption.md b/windows.applicationmodel.payments/paymentresponse_shippingoption.md new file mode 100644 index 0000000000..87e84be96c --- /dev/null +++ b/windows.applicationmodel.payments/paymentresponse_shippingoption.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentResponse.ShippingOption +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentResponse.ShippingOption + +## -description +The shipping option + +## -property-value +Gets the ShippingOption. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption.md b/windows.applicationmodel.payments/paymentshippingoption.md new file mode 100644 index 0000000000..c913649cd0 --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentShippingOption +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption + +## -description +A class that contains information about a shipping option. + +> [!NOTE] +> This class reflects the [W3C PaymentShippingOption dictionary](https://www.w3.org/TR/payment-request/#paymentrequest-interface). + +## -remarks + + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption_amount.md b/windows.applicationmodel.payments/paymentshippingoption_amount.md new file mode 100644 index 0000000000..cdeaf90d7c --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption_amount.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentShippingOption.Amount +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption.Amount + +## -description +The amount. + +## -property-value +Gets or sets the Amount. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption_isselected.md b/windows.applicationmodel.payments/paymentshippingoption_isselected.md new file mode 100644 index 0000000000..f99cd143ca --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption_isselected.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentShippingOption.IsSelected +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption.IsSelected + +## -description +Indicates whether this shipping option is selected. A merchant is required to check that only a single shipping option within a request is marked as selected. + +## -property-value +Gets or sets IsSelected. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption_label.md b/windows.applicationmodel.payments/paymentshippingoption_label.md new file mode 100644 index 0000000000..6766008e46 --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption_label.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentShippingOption.Label +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption.Label + +## -description +The label. + +## -property-value +Gets or sets the Label. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_1050873564.md b/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_1050873564.md new file mode 100644 index 0000000000..53f7731e36 --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_1050873564.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentShippingOption.#ctor(System.String,Windows.ApplicationModel.Payments.PaymentCurrencyAmount) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption.PaymentShippingOption + +## -description +Creates a new [PaymentShippingOption](paymentshippingoption.md) object. + +## -parameters +### -param label +The label. + +### -param amount +The amount. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_913221676.md b/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_913221676.md new file mode 100644 index 0000000000..20809bb351 --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_913221676.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentShippingOption.#ctor(System.String,Windows.ApplicationModel.Payments.PaymentCurrencyAmount,System.Boolean,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption.PaymentShippingOption + +## -description +Creates a new [PaymentShippingOption](paymentshippingoption.md) object. + +## -parameters +### -param label +The label. + +### -param amount +The amount. + +### -param selected +Whether this option is selected. + +### -param tag +The tag. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_94281428.md b/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_94281428.md new file mode 100644 index 0000000000..b5d306a5d1 --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption_paymentshippingoption_94281428.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentShippingOption.#ctor(System.String,Windows.ApplicationModel.Payments.PaymentCurrencyAmount,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption.PaymentShippingOption + +## -description +Creates a new [PaymentShippingOption](paymentshippingoption.md) object. + +## -parameters +### -param label +The label. + +### -param amount +The amount. + +### -param selected +Whether this option is selected. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingoption_tag.md b/windows.applicationmodel.payments/paymentshippingoption_tag.md new file mode 100644 index 0000000000..b68f876299 --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingoption_tag.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentShippingOption.Tag +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentShippingOption.Tag + +## -description +The tag. + +## -property-value +Gets or sets the tag. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymentshippingtype.md b/windows.applicationmodel.payments/paymentshippingtype.md new file mode 100644 index 0000000000..0d4f579d9c --- /dev/null +++ b/windows.applicationmodel.payments/paymentshippingtype.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentShippingType +-api-type: winrt enum +--- + + + +# PaymentShippingType + +## -description +An enumeration that describes the shipping type. + +## -enum-fields +### -field Shipping:0 +Shipping. + +### -field Delivery:1 +Delivery. + +### -field Pickup:2 +Pickup. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymenttoken.md b/windows.applicationmodel.payments/paymenttoken.md new file mode 100644 index 0000000000..12650377db --- /dev/null +++ b/windows.applicationmodel.payments/paymenttoken.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.Payments.PaymentToken +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Payments.PaymentToken + +## -description +A class containing details about a payment token. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymenttoken_jsondetails.md b/windows.applicationmodel.payments/paymenttoken_jsondetails.md new file mode 100644 index 0000000000..0ce5df352b --- /dev/null +++ b/windows.applicationmodel.payments/paymenttoken_jsondetails.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentToken.JsonDetails +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentToken.JsonDetails + +## -description +Details of the payment token. This contains the information that the merchant will use to process the payment. The format of the data will depend on the payment method used. For example, if the Basic Card Payment method is being used, then this must contain data conforming to the [BasicCardResponse dictionary](http://www.w3.org/TR/payment-method-basic-card/#basiccardresponse) type. + +## -property-value +Gets the JsonDetails. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymenttoken_paymentmethodid.md b/windows.applicationmodel.payments/paymenttoken_paymentmethodid.md new file mode 100644 index 0000000000..39c64ab689 --- /dev/null +++ b/windows.applicationmodel.payments/paymenttoken_paymentmethodid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Payments.PaymentToken.PaymentMethodId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Payments.PaymentToken.PaymentMethodId + +## -description +The payment method ID. + +## -property-value +Gets the PaymentMethodId. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymenttoken_paymenttoken_1571897524.md b/windows.applicationmodel.payments/paymenttoken_paymenttoken_1571897524.md new file mode 100644 index 0000000000..dc2f83e282 --- /dev/null +++ b/windows.applicationmodel.payments/paymenttoken_paymenttoken_1571897524.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentToken.#ctor(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentToken.PaymentToken + +## -description +Creates a [PaymentToken](paymenttoken.md) object. + +## -parameters +### -param paymentMethodId +The payment method ID. + +### -param jsonDetails +The JSON details. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/paymenttoken_paymenttoken_290278668.md b/windows.applicationmodel.payments/paymenttoken_paymenttoken_290278668.md new file mode 100644 index 0000000000..204e1cf102 --- /dev/null +++ b/windows.applicationmodel.payments/paymenttoken_paymenttoken_290278668.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Payments.PaymentToken.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Payments.PaymentToken.PaymentToken + +## -description +Creates a new [PaymentToken](paymenttoken.md) object. + +## -parameters +### -param paymentMethodId +The payment method ID. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.payments/windows_applicationmodel_payments.md b/windows.applicationmodel.payments/windows_applicationmodel_payments.md new file mode 100644 index 0000000000..d5fcb87280 --- /dev/null +++ b/windows.applicationmodel.payments/windows_applicationmodel_payments.md @@ -0,0 +1,17 @@ +--- +-api-id: N:Windows.ApplicationModel.Payments +-api-type: winrt namespace +--- + +# Windows.ApplicationModel.Payments + +## -description +This namespace provides payment functionality equivalent to the [W3C Payment Request API](https://aka.ms/prapi) specification for Universal Windows Platform (UWP) apps. The W3C Payment Request API allows websites to collect payment information in a way that is easy for both the merchant and the user. + +To use the Payment Request API, you will need to support one of the existing payment methods. The [W3C Basic Card Payment](https://www.w3.org/TR/payment-method-basic-card/) is a payment method which is available in Windows and is easy to integrate into existing payment infrastructure. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.applicationmodel.preview.holographic/holographicapplicationpreview.md b/windows.applicationmodel.preview.holographic/holographicapplicationpreview.md new file mode 100644 index 0000000000..25ceade7c5 --- /dev/null +++ b/windows.applicationmodel.preview.holographic/holographicapplicationpreview.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Preview.Holographic.HolographicApplicationPreview +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Preview.Holographic.HolographicApplicationPreview + +## -description +Provides preview functionality that let apps interact with the holographic shell, allowing the user to see content in the world around them. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.holographic/holographicapplicationpreview_iscurrentviewpresentedonholographicdisplay_800713985.md b/windows.applicationmodel.preview.holographic/holographicapplicationpreview_iscurrentviewpresentedonholographicdisplay_800713985.md new file mode 100644 index 0000000000..542a637354 --- /dev/null +++ b/windows.applicationmodel.preview.holographic/holographicapplicationpreview_iscurrentviewpresentedonholographicdisplay_800713985.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.Holographic.HolographicApplicationPreview.IsCurrentViewPresentedOnHolographicDisplay +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Holographic.HolographicApplicationPreview.IsCurrentViewPresentedOnHolographicDisplay + +## -description +Gets whether the current app view will display in a Mixed Reality headset. + +## -returns +Whether the current view will display in a headset. + +## -remarks +On a Desktop PC, users can launch apps in either the desktop or holographic shell. This method lets an app reason about whether the current thread's CoreApplicationView is displaying within a Mixed Reality headset, rather than on a monitor or other display. This method is most useful for 2D views, as holographic views (i.e. views for which HolographicSpace.CreateForCoreWindow has been called) will always return true. + +On HoloLens, all views are displayed within the headset, and so this will return true for all views. + +It is an error to call this method when the current thread is not the dispatcher thread for a CoreApplicationView. + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.holographic/holographicapplicationpreview_isholographicactivation_1412777260.md b/windows.applicationmodel.preview.holographic/holographicapplicationpreview_isholographicactivation_1412777260.md new file mode 100644 index 0000000000..ebfe147409 --- /dev/null +++ b/windows.applicationmodel.preview.holographic/holographicapplicationpreview_isholographicactivation_1412777260.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.Holographic.HolographicApplicationPreview.IsHolographicActivation(Windows.ApplicationModel.Activation.IActivatedEventArgs) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Holographic.HolographicApplicationPreview.IsHolographicActivation + +## -description +Gets whether a given app activation is targeted at the holographic shell. + +## -parameters + +### -param activatedEventArgs +The app activation to inspect. + +## -returns +Whether the activation is targeted at the holographic shell. + +## -remarks +On a Desktop PC, users can launch an app from either the desktop Start Menu or the holographic Start Menu if they have a Mixed Reality headset. Users can also activate applications through protocol activations in either the desktop or holographic shell, for example by clicking a link in another app currently located in that shell. This method lets an app reason about whether a given app activation is targeting the holographic shell or not, which may affect how the app chooses to inititalize its views. + +On HoloLens, this will return true for all activations. + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.holographic/windows_applicationmodel_preview_holographic.md b/windows.applicationmodel.preview.holographic/windows_applicationmodel_preview_holographic.md new file mode 100644 index 0000000000..d3ecbd2313 --- /dev/null +++ b/windows.applicationmodel.preview.holographic/windows_applicationmodel_preview_holographic.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.ApplicationModel.Preview.Holographic +-api-type: winrt namespace +--- + + + +# Windows.ApplicationModel.Preview.Holographic + +## -description +Contains classes that let apps interact with the holographic shell, allowing the user to see content in the world around them. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager.md b/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager.md new file mode 100644 index 0000000000..42fff32c5c --- /dev/null +++ b/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Preview.InkWorkspace.InkWorkspaceHostedAppManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Preview.InkWorkspace.InkWorkspaceHostedAppManager + +## -description +Represents the manager for apps hosted in the Windws Ink Workspace. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager_getforcurrentapp_783217000.md b/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager_getforcurrentapp_783217000.md new file mode 100644 index 0000000000..813d63188a --- /dev/null +++ b/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager_getforcurrentapp_783217000.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.InkWorkspace.InkWorkspaceHostedAppManager.GetForCurrentApp +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.InkWorkspace.InkWorkspaceHostedAppManager.GetForCurrentApp + +## -description +Retrieves a reference to the Ink Workspace manager for this app. + +## -returns +An Ink Workspace reference. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager_setthumbnailasync_119098200.md b/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager_setthumbnailasync_119098200.md new file mode 100644 index 0000000000..0f629268d3 --- /dev/null +++ b/windows.applicationmodel.preview.inkworkspace/inkworkspacehostedappmanager_setthumbnailasync_119098200.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.InkWorkspace.InkWorkspaceHostedAppManager.SetThumbnailAsync(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.InkWorkspace.InkWorkspaceHostedAppManager.SetThumbnailAsync + +## -description +Asynchronously sets the thumbnail image for the Ink Workspace app. + +## -parameters + +### -param bitmap +An uncompressed bitmap. + +## -returns +An asynchronous action that doesn't return anything. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.inkworkspace/windows_applicationmodel_preview_inkworkspace.md b/windows.applicationmodel.preview.inkworkspace/windows_applicationmodel_preview_inkworkspace.md new file mode 100644 index 0000000000..5c90d4ac9f --- /dev/null +++ b/windows.applicationmodel.preview.inkworkspace/windows_applicationmodel_preview_inkworkspace.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.ApplicationModel.Preview.InkWorkspace +-api-type: winrt namespace +--- + + + +# Windows.ApplicationModel.Preview.InkWorkspace + +## -description +Provides support for specifying inking apps in the Ink Workspace. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setfocustopreviousview_1766525007.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setfocustopreviousview_1766525007.md new file mode 100644 index 0000000000..d580c48d60 --- /dev/null +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setfocustopreviousview_1766525007.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetFocusToPreviousView +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetFocusToPreviousView + +## -description +Switches focus to the previous visible note view (window) or to the Windows Ink Workspace (see Remarks). The views are selected in a cyclic, system-determined order. + +## -params + + +## -remarks +When the notes app is loaded from the Windows Ink Workspace, this method also switches focus to the Windows Ink Workspace and then back to views within the notes app. + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setthumbnailimagefortaskswitcherasync_1116959628.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setthumbnailimagefortaskswitcherasync_1116959628.md new file mode 100644 index 0000000000..5e5fbc9254 --- /dev/null +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_setthumbnailimagefortaskswitcherasync_1116959628.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetThumbnailImageForTaskSwitcherAsync(Windows.Graphics.Imaging.SoftwareBitmap) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.SetThumbnailImageForTaskSwitcherAsync + +## -description +Asynchronously sets the thumbnail image for this application as it appears in the Alt+TAB task switcher. + +## -params + +## -param bitmap +A bitmap of the thumbnail image. + +## -returns +Returns an **IAsyncAction** that indicates when the action has completed. + +## -remarks + +## -see-also +[SetNotesThumbnailAsync](noteswindowmanagerpreview_setnotesthumbnailasync_281830069.md) + +## -examples + diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownoterelativeto_1143588326.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownoterelativeto_1143588326.md new file mode 100644 index 0000000000..4c7f523fb4 --- /dev/null +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownoterelativeto_1143588326.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteRelativeTo(System.Int32,System.Int32,Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteRelativeTo + +## -description +Makes a note visible and places it adjacent to a specified "anchor" view. + +## -params + +## -param noteViewId +The unique identifier of the note to be shown. + +## -param anchorNoteViewId +The Id of the "anchor" view. If this value is 0 (not assigned to any view), the note will appear at the center of the screen. + +## -param options +Options for showing the note specified by the *noteViewId* parameter. For example, show the note with focus. + +## -remarks + +## -examples + +## -see-also +[NotesWindowManagerPreviewShowNoteOptions](noteswindowmanagerpreviewshownoteoptions.md) \ No newline at end of file diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownotewithplacement_1227740817.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownotewithplacement_1227740817.md new file mode 100644 index 0000000000..0fc2f77387 --- /dev/null +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreview_shownotewithplacement_1227740817.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteWithPlacement(System.Int32,Windows.Storage.Streams.IBuffer,Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreview.ShowNoteWithPlacement + +## -description +Makes a note visible and sets its placement data (dimensions and location) as specified. + +## -params + +## -param noteViewId +The unique identifier of the note to be shown. + +## -param data +An array of bytes holding note placement data. + +## -param options +Options for showing the note specified by the *noteViewId* parameter. For example, show the note with focus. + +## -remarks +[GetNotePlacement](noteswindowmanagerpreview_getnoteplacement_639894587.md) and [ShowNoteWithPlacement](noteswindowmanagerpreview_shownotewithplacement_1227740817.md) can be used together to store the placement of a note (say, while the application is exiting) and then restore the note to its previous placement on the screen (when the application is opened again). + +## -see-also +[NotesWindowManagerPreviewShowNoteOptions](noteswindowmanagerpreviewshownoteoptions.md) + +## -examples + diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions.md new file mode 100644 index 0000000000..a63d2fa9ac --- /dev/null +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions + +## -description +Provides options for how to show a note. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions_noteswindowmanagerpreviewshownoteoptions_1221375020.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions_noteswindowmanagerpreviewshownoteoptions_1221375020.md new file mode 100644 index 0000000000..cefd3fca2e --- /dev/null +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions_noteswindowmanagerpreviewshownoteoptions_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions.NotesWindowManagerPreviewShowNoteOptions + +## -description +Creates a new instance of the [NotesWindowManagerPreviewShowNoteOptions](noteswindowmanagerpreviewshownoteoptions.md) class. + +## -params + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions_showwithfocus.md b/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions_showwithfocus.md new file mode 100644 index 0000000000..e9cf80331b --- /dev/null +++ b/windows.applicationmodel.preview.notes/noteswindowmanagerpreviewshownoteoptions_showwithfocus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions.ShowWithFocus +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Preview.Notes.NotesWindowManagerPreviewShowNoteOptions.ShowWithFocus + +## -description +Gets or sets a Boolean value that specifies if the note should be shown with focus. + +## -property-value +If **true**, the note is shown with focus, otherwise **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.applicationmodel.search/localcontentsuggestionsettings_locations.md b/windows.applicationmodel.search/localcontentsuggestionsettings_locations.md index 2d9e1df764..90214e3b2a 100644 --- a/windows.applicationmodel.search/localcontentsuggestionsettings_locations.md +++ b/windows.applicationmodel.search/localcontentsuggestionsettings_locations.md @@ -24,7 +24,7 @@ Suggestions are provided based on local, indexed files in a listed [storageFolde If local suggestions are disabled, this property has no effect. Set the [localContentSuggestionSettings.enabled](localcontentsuggestionsettings_enabled.md) property to true to display local suggestions in the search pane. -You can use this list to provide suggestions from libraries or folders for which your app hasn't declared capabilities, like folders that were accessed using the file picker. Learn more about capabilities in [Access to user resources using the Windows Runtime](XREF:TODO:m_win_runtime.protected_access_to_user_resources_using_the_windows_runtime). +You can use this list to provide suggestions from libraries or folders for which your app hasn't declared capabilities, like folders that were accessed using the file picker. Learn more about capabilities in [Access to user resources using the Windows Runtime](http://msdn.microsoft.com/library/7b4402ea-55f6-438d-b9d1-8e65d56c8f42). ## -examples The [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892) demonstrates how to append a location to the list: @@ -35,4 +35,4 @@ The [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892) de > If there is only one [storageFolder](../windows.storage/storagefolder.md) in the [locations](localcontentsuggestionsettings_locations.md) list, like the Music library in the example, the local files in that location only are used to provide suggestions in the search pane. ## -see-also -[Access to user resources using the Windows Runtime](XREF:TODO:m_win_runtime.protected_access_to_user_resources_using_the_windows_runtime), [Quickstart: Adding search](http://msdn.microsoft.com/library/d412c562-22d2-41c4-9f27-27503b89b9e9), [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [Object class](https://msdn.microsoft.com/library/system.object.aspx), [LocalContentSuggestionSettings class](localcontentsuggestionsettings.md), [LocalContentSuggestionSettings.Enabled property](localcontentsuggestionsettings_enabled.md), [SearchPane.SetLocalContentSuggestionSettings method](searchpane_setlocalcontentsuggestionsettings.md), [Windows.Storage.KnownFolders class](../windows.storage/knownfolders.md), [Windows.Storage.StorageFolder class](../windows.storage/storagefolder.md) +[Access to user resources using the Windows Runtime](http://msdn.microsoft.com/library/7b4402ea-55f6-438d-b9d1-8e65d56c8f42), [Quickstart: Adding search](http://msdn.microsoft.com/library/d412c562-22d2-41c4-9f27-27503b89b9e9), [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [Object class](https://msdn.microsoft.com/library/system.object.aspx), [LocalContentSuggestionSettings class](localcontentsuggestionsettings.md), [LocalContentSuggestionSettings.Enabled property](localcontentsuggestionsettings_enabled.md), [SearchPane.SetLocalContentSuggestionSettings method](searchpane_setlocalcontentsuggestionsettings.md), [Windows.Storage.KnownFolders class](../windows.storage/knownfolders.md), [Windows.Storage.StorageFolder class](../windows.storage/storagefolder.md) diff --git a/windows.applicationmodel.search/localcontentsuggestionsettings_propertiestomatch.md b/windows.applicationmodel.search/localcontentsuggestionsettings_propertiestomatch.md index 80d715433b..b4c8670f43 100644 --- a/windows.applicationmodel.search/localcontentsuggestionsettings_propertiestomatch.md +++ b/windows.applicationmodel.search/localcontentsuggestionsettings_propertiestomatch.md @@ -28,4 +28,4 @@ Adding properties to this list limits local suggestions to local, indexed files ## -examples ## -see-also -[Access to user resources using the Windows Runtime](XREF:TODO:m_win_runtime.protected_access_to_user_resources_using_the_windows_runtime), [Quickstart: Adding search](http://msdn.microsoft.com/library/d412c562-22d2-41c4-9f27-27503b89b9e9), [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [Object class](https://msdn.microsoft.com/library/system.object.aspx), [LocalContentSuggestionSettings class](localcontentsuggestionsettings.md), [LocalContentSuggestionSettings.Enabled](localcontentsuggestionsettings_enabled.md), [SearchPane.SetLocalContentSuggestionSettings](searchpane_setlocalcontentsuggestionsettings.md) \ No newline at end of file +[Access to user resources using the Windows Runtime](http://msdn.microsoft.com/library/7b4402ea-55f6-438d-b9d1-8e65d56c8f42), [Quickstart: Adding search](http://msdn.microsoft.com/library/d412c562-22d2-41c4-9f27-27503b89b9e9), [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [Object class](https://msdn.microsoft.com/library/system.object.aspx), [LocalContentSuggestionSettings class](localcontentsuggestionsettings.md), [LocalContentSuggestionSettings.Enabled](localcontentsuggestionsettings_enabled.md), [SearchPane.SetLocalContentSuggestionSettings](searchpane_setlocalcontentsuggestionsettings.md) \ No newline at end of file diff --git a/windows.applicationmodel.search/searchpane_suggestionsrequested.md b/windows.applicationmodel.search/searchpane_suggestionsrequested.md index da07d47b7c..6344e0abb2 100644 --- a/windows.applicationmodel.search/searchpane_suggestionsrequested.md +++ b/windows.applicationmodel.search/searchpane_suggestionsrequested.md @@ -90,4 +90,5 @@ protected override void OnWindowCreated(WindowCreatedEventArgs args) ## -see-also [Guidelines and checklist for search](http://msdn.microsoft.com/library/c328faa3-f6ae-4970-8372-b413f1290c39), [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [SearchPane class](searchpane.md), [SearchPane.ResultSuggestionChosen event](searchpane_resultsuggestionchosen.md), [SearchSuggestionCollection class](searchsuggestioncollection.md), [SearchPaneSuggestionsRequestedEventArgs class](searchpanesuggestionsrequestedeventargs.md), [SearchPaneSuggestionsRequest.SearchSuggestionCollection property](searchpanesuggestionsrequest_searchsuggestioncollection.md) -tionsrequestedeventargs.md), [SearchPaneSuggestionsRequest.SearchSuggestionCollection property](searchpanesuggestionsrequest_searchsuggestioncollection.md) \ No newline at end of file +tionsrequestedeventargs.md), [SearchPaneSuggestionsRequest.SearchSuggestionCollection property](searchpanesuggestionsrequest_searchsuggestioncollection.md) +st_searchsuggestioncollection.md) \ No newline at end of file diff --git a/windows.applicationmodel.search/searchpanequerylinguisticdetails.md b/windows.applicationmodel.search/searchpanequerylinguisticdetails.md index 7a6737bc47..98dc3e41a2 100644 --- a/windows.applicationmodel.search/searchpanequerylinguisticdetails.md +++ b/windows.applicationmodel.search/searchpanequerylinguisticdetails.md @@ -26,3 +26,4 @@ The [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892) de ## -see-also [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [SearchPane.QueryChanged event](searchpane_querychanged.md), [SearchPaneQueryChangedEventArgs class](searchpanequerychangedeventargs.md), [SearchPaneQueryChangedEventArgs.LinguisticDetails property](searchpanequerychangedeventargs_linguisticdetails.md), [SearchPane.SuggestionsRequested event](searchpane_suggestionsrequested.md), [SearchPaneSuggestionsRequestedEventArgs class](searchpanesuggestionsrequestedeventargs.md), [SearchPaneSuggestionsRequestedEventArgs.LinguisticDetails property](searchpanesuggestionsrequestedeventargs_linguisticdetails.md) +edeventargs_linguisticdetails.md) diff --git a/windows.applicationmodel.search/searchpanequerysubmittedeventargs.md b/windows.applicationmodel.search/searchpanequerysubmittedeventargs.md index 879ac30554..adebafbbce 100644 --- a/windows.applicationmodel.search/searchpanequerysubmittedeventargs.md +++ b/windows.applicationmodel.search/searchpanequerysubmittedeventargs.md @@ -29,3 +29,4 @@ The [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892) de ## -see-also [SearchPane.QuerySubmitted event](searchpane_querysubmitted.md), [SearchPaneQuerySubmittedEventArgs class](searchpanequerysubmittedeventargs.md) +chpanequerysubmittedeventargs.md) diff --git a/windows.applicationmodel.search/searchpaneresultsuggestionchoseneventargs.md b/windows.applicationmodel.search/searchpaneresultsuggestionchoseneventargs.md index 52872538ae..e9154a2194 100644 --- a/windows.applicationmodel.search/searchpaneresultsuggestionchoseneventargs.md +++ b/windows.applicationmodel.search/searchpaneresultsuggestionchoseneventargs.md @@ -29,3 +29,4 @@ The [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892) de ## -see-also [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [SearchPane class](searchpane.md), [SearchPane.ResultSuggestionChosen event](searchpane_resultsuggestionchosen.md), [SearchSuggestionCollection.AppendResultSuggestion method](searchsuggestioncollection_appendresultsuggestion.md) +ection_appendresultsuggestion.md) diff --git a/windows.applicationmodel.search/searchpanesuggestionsrequest.md b/windows.applicationmodel.search/searchpanesuggestionsrequest.md index 6866970dde..0d100df62f 100644 --- a/windows.applicationmodel.search/searchpanesuggestionsrequest.md +++ b/windows.applicationmodel.search/searchpanesuggestionsrequest.md @@ -28,3 +28,4 @@ The [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892) de ## -see-also [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892), [SearchPane.SuggestionsRequested event](searchpane_suggestionsrequested.md), [SearchPaneSuggestionsRequestedEventArgs class](searchpanesuggestionsrequestedeventargs.md), [SearchPaneSuggestionsRequestedEventArgs.Request property](searchpanesuggestionsrequestedeventargs_request.md) +onsrequestedeventargs_request.md) diff --git a/windows.applicationmodel.search/searchpanesuggestionsrequestdeferral.md b/windows.applicationmodel.search/searchpanesuggestionsrequestdeferral.md index 855c5acd5e..636afbf8a0 100644 --- a/windows.applicationmodel.search/searchpanesuggestionsrequestdeferral.md +++ b/windows.applicationmodel.search/searchpanesuggestionsrequestdeferral.md @@ -30,3 +30,4 @@ The [Search contract sample](http://go.microsoft.com/fwlink/p/?linkid=234892) de ## -see-also [SearchPane class](searchpane.md), [SearchPane.SuggestionsRequested event](searchpane_suggestionsrequested.md), [SearchPaneSuggestionsRequest class](searchpanesuggestionsrequest.md), [SearchPaneSuggestionsRequest.GetDeferral method](searchpanesuggestionsrequest_getdeferral.md), [SearchPaneSuggestionsRequestedEventArgs class](searchpanesuggestionsrequestedeventargs.md) +suggestionsrequestedeventargs.md) diff --git a/windows.applicationmodel.search/searchpanesuggestionsrequestedeventargs.md b/windows.applicationmodel.search/searchpanesuggestionsrequestedeventargs.md index d0d462b8d3..445e052230 100644 --- a/windows.applicationmodel.search/searchpanesuggestionsrequestedeventargs.md +++ b/windows.applicationmodel.search/searchpanesuggestionsrequestedeventargs.md @@ -47,3 +47,4 @@ searchPane.SuggestionsRequested += new TypedEventHandler # Windows.ApplicationModel.Store.LicenseManagement.LicenseManager @@ -14,6 +14,8 @@ Provides members for managing license info for apps. ## -remarks +> [!NOTE] +> This class requires the **storeLicenseManagement** [restricted capability](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). ## -examples @@ -21,4 +23,4 @@ Provides members for managing license info for apps. ## -capabilities -storeLicenseManagement \ No newline at end of file +storeLicenseManagement diff --git a/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md b/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md index 00f480876b..a072bd73c8 100644 --- a/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md +++ b/windows.applicationmodel.store.licensemanagement/licensemanager_addlicenseasync_1858928187.md @@ -12,9 +12,6 @@ public Windows.Foundation.IAsyncAction AddLicenseAsync(Windows.Storage.Streams.I ## -description Installs the specified app license. -> [!NOTE] -> This member requires the **storeLicenseManagement** restricted capability. For more information about restricted capabilities, see [App capability declarations](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). - ## -parameters ### -param license The contents of the license to install. diff --git a/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md b/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md index 135b26aab2..0ccd99a3bd 100644 --- a/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md +++ b/windows.applicationmodel.store.licensemanagement/licensemanager_getsatisfactioninfosasync_1186889928.md @@ -12,9 +12,6 @@ public Windows.Foundation.IAsyncOperation [!NOTE] -> This member requires the **storeLicenseManagement** restricted capability. For more information about restricted capabilities, see [App capability declarations](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). - ## -parameters ### -param contentIds The content IDs of the products for which to get license entitlement info. @@ -33,4 +30,4 @@ An asynchronous operation that, on successful completion, returns a [LicenseSati ## -capabilities -storeLicenseManagement \ No newline at end of file +storeLicenseManagement diff --git a/windows.applicationmodel.store.licensemanagement/licensemanager_refreshlicensesasync_1595883359.md b/windows.applicationmodel.store.licensemanagement/licensemanager_refreshlicensesasync_1595883359.md new file mode 100644 index 0000000000..7a2e425f2f --- /dev/null +++ b/windows.applicationmodel.store.licensemanagement/licensemanager_refreshlicensesasync_1595883359.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.RefreshLicensesAsync(Windows.ApplicationModel.Store.LicenseManagement.LicenseRefreshOption) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseManager.RefreshLicensesAsync + +## -description +Refreshes license info for app licenses on the current device. + +## -params + +## -param refreshOption +A [LicenseRefreshOption](licenserefreshoption.md) that indicates whether to refresh all app licenses on the device or only the licenses for currently running apps. + +## -returns +An object that represents the asynchronous operation. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +storeLicenseManagement diff --git a/windows.applicationmodel.store.licensemanagement/licenserefreshoption.md b/windows.applicationmodel.store.licensemanagement/licenserefreshoption.md new file mode 100644 index 0000000000..5c5e2ca1bf --- /dev/null +++ b/windows.applicationmodel.store.licensemanagement/licenserefreshoption.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.Store.LicenseManagement.LicenseRefreshOption +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.Store.LicenseManagement.LicenseRefreshOption + +## -description +Defines values that can be used with the [LicenseManager.RefreshLicensesAsync](licensemanager_refreshlicensesasync_1595883359.md) method to specify which app licenses to refresh on the current device. + +## -enum-fields + +## -field RunningLicenses:0 +Refreshes only the licenses for currently running apps. + +## -field AllLicenses:1 +Refreshes all app licenses on the device. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.licensemanagement/windows_applicationmodel_store_licensemanagement.md b/windows.applicationmodel.store.licensemanagement/windows_applicationmodel_store_licensemanagement.md index 36017d1d70..ca919fa941 100644 --- a/windows.applicationmodel.store.licensemanagement/windows_applicationmodel_store_licensemanagement.md +++ b/windows.applicationmodel.store.licensemanagement/windows_applicationmodel_store_licensemanagement.md @@ -6,10 +6,13 @@ # Windows.ApplicationModel.Store.LicenseManagement ## -description -Provides APIs for managing license info for apps. The APIs in this namespace require the **storeLicenseManagement** restricted capability. For more information about restricted capabilities, see [App capability declarations](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). +Provides APIs for managing license info for apps. + +> [!NOTE] +> The APIs in this namespace require the **storeLicenseManagement** [restricted capability](https://msdn.microsoft.com/windows/uwp/packaging/app-capability-declarations). ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md index 799be141f2..1f0f713121 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem.md @@ -12,12 +12,12 @@ public class AppInstallItem : Windows.ApplicationModel.Store.Preview.InstallCont ## -description Represents an app that is in the installation queue. -> [!IMPORTANT] -> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. - ## -remarks Use the [AppInstallManager.AppInstallItems](appinstallmanager_appinstallitems.md) property to retrieve a vector view of [AppInstallItem](appinstallitem.md) objects. +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + ## -examples ## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_children.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_children.md new file mode 100644 index 0000000000..5ef832aacf --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_children.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Children +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.Children + +## -description +Retrieves information about app installs that are children of the current app install. This property only returns a value if the current app install is the parent of other app installs that are part of a the same app bundle. + +## -property-value +A collection of [AppInstallItem](appinstallitem.md) objects that represent the children app installs of the current app install. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallitem_itemoperationsmightaffectotheritems.md b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_itemoperationsmightaffectotheritems.md new file mode 100644 index 0000000000..c476fa8a44 --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallitem_itemoperationsmightaffectotheritems.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.ItemOperationsMightAffectOtherItems +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallItem.ItemOperationsMightAffectOtherItems + +## -description +Indicates whether the current app install is part of an app bundle, and therefore pausing or canceling the app install might affect other items in the installation queue. + +## -property-value +True if the current app install is part of an app bundle, and therefore pausing or canceling the app install might affect other items in the installation queue; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md index ab499a207e..9e9431e4d9 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager.md @@ -12,11 +12,11 @@ public class AppInstallManager : Windows.ApplicationModel.Store.Preview.InstallC ## -description Provides members for programmatically installing apps, including the ability to start an app install and get a list of app installs currently in progress. +## -remarks + > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. -## -remarks - ## -examples ## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallitemswithgroupsupport.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallitemswithgroupsupport.md new file mode 100644 index 0000000000..146ab5ea58 --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_appinstallitemswithgroupsupport.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallItemsWithGroupSupport +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.AppInstallItemsWithGroupSupport + +## -description +Retrieves information about all the apps that are part of a single app bundle that is currently in the installation queue. + +## -property-value +A collection of [AppInstallItem](appinstallitem.md) objects that represent all the apps that are part of a single app bundle that is currently in the installation queue. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreedeviceentitlementasync_1427505322.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreedeviceentitlementasync_1427505322.md new file mode 100644 index 0000000000..062e0d3bda --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreedeviceentitlementasync_1427505322.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetFreeDeviceEntitlementAsync(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetFreeDeviceEntitlementAsync + +## -description +Grants a free entitlement for the specified app to all users on the current device. + +## -params + +## -param storeId +The Store ID of the app for which you want to grant the entitlement. + +## -param campaignId +The ID of the campaign that is associated with the entitlement. + +## -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns a [GetEntitlementResult](getentitlementresult.md) object that indicates the status of the entitlement grant. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreeuserentitlementasync_107347343.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreeuserentitlementasync_107347343.md new file mode 100644 index 0000000000..1a5365c45a --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreeuserentitlementasync_107347343.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetFreeUserEntitlementAsync(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetFreeUserEntitlementAsync + +## -description +Grants a free entitlement for the specified app to the current user. + +## -params + +## -param storeId +The Store ID of the app for which you want to grant the entitlement. + +## -param campaignId +The ID of the campaign that is associated with the entitlement. + +## -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns a [GetEntitlementResult](getentitlementresult.md) object that indicates the status of the entitlement grant. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreeuserentitlementforuserasync_376670896.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreeuserentitlementforuserasync_376670896.md new file mode 100644 index 0000000000..c7effce0b1 --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanager_getfreeuserentitlementforuserasync_376670896.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetFreeUserEntitlementForUserAsync(Windows.System.User,System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.AppInstallManager.GetFreeUserEntitlementForUserAsync + +## -description +Grants a free entitlement for the specified app to the specified user. + +## -params + +## -param user +A [Windows.System.User](../windows.system/user.md) object that represents the user to which you want to grant the entitlement. + +## -param storeId +The Store ID of the app for which you want to grant the entitlement. + +## -param campaignId +The ID of the campaign that is associated with the entitlement. + +## -param correlationVector +A correlation vector string that can be used to generate telemetry data. + +## -returns +An asynchronous operation that, on successful completion, returns a [GetEntitlementResult](getentitlementresult.md) object that indicates the status of the entitlement grant. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md b/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md index a23fe80d28..922a3af1bd 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallmanageritemeventargs.md @@ -12,12 +12,12 @@ public class AppInstallManagerItemEventArgs : Windows.ApplicationModel.Store.Pre ## -description Provides data for the [ItemCompleted](appinstallmanager_itemcompleted.md) and [ItemStatusChanged](appinstallmanager_itemstatuschanged.md) events. -> [!IMPORTANT] -> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. - ## -remarks An instance of this class is passed to the event handler that you implement for the [AppInstallManager.ItemCompleted](appinstallmanager_itemcompleted.md) and [AppInstallManager.ItemStatusChanged](appinstallmanager_itemstatuschanged.md) events. +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + ## -examples ## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md index 1799d64b4d..4d33fbab0a 100644 --- a/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md +++ b/windows.applicationmodel.store.preview.installcontrol/appinstallstatus.md @@ -12,12 +12,12 @@ public class AppInstallStatus : Windows.ApplicationModel.Store.Preview.InstallCo ## -description Describes the status of an app that is in the installation queue. -> [!IMPORTANT] -> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. - ## -remarks To retrieve an instance of this class, use the [GetCurrentStatus](appinstallitem_getcurrentstatus.md) method of the [AppInstallItem](appinstallitem.md) class. +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + ## -examples ## -see-also diff --git a/windows.applicationmodel.store.preview.installcontrol/getentitlementresult.md b/windows.applicationmodel.store.preview.installcontrol/getentitlementresult.md new file mode 100644 index 0000000000..0267c86b70 --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/getentitlementresult.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.GetEntitlementResult +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.GetEntitlementResult + +## -description +Provides access to the result of a request to grant a free entitlement. + +## -remarks + +An instance of this class is returned by the following methods: + +* [GetFreeDeviceEntitlementAsync](appinstallmanager_getfreedeviceentitlementasync_1427505322.md) +* [GetFreeUserEntitlementAsync](appinstallmanager_getfreeuserentitlementasync_107347343.md) +* [GetFreeUserEntitlementForUserAsync](appinstallmanager_getfreeuserentitlementforuserasync_376670896.md) + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/getentitlementresult_status.md b/windows.applicationmodel.store.preview.installcontrol/getentitlementresult_status.md new file mode 100644 index 0000000000..5fc0d58404 --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/getentitlementresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.Store.Preview.InstallControl.GetEntitlementResult.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.GetEntitlementResult.Status + +## -description +Indicates the result of a request to grant a free entitlement. + +## -property-value +A [GetEntitlementStatus](getentitlementstatus.md) value that indicates the result of a request to grant a free entitlement. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/getentitlementstatus.md b/windows.applicationmodel.store.preview.installcontrol/getentitlementstatus.md new file mode 100644 index 0000000000..7dd6cc1f9e --- /dev/null +++ b/windows.applicationmodel.store.preview.installcontrol/getentitlementstatus.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.ApplicationModel.Store.Preview.InstallControl.GetEntitlementStatus +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.Store.Preview.InstallControl.GetEntitlementStatus + +## -description +Defines the possible results of a request to grant a free entitlement by using the [GetFreeDeviceEntitlementAsync](appinstallmanager_getfreedeviceentitlementasync_1427505322.md), [GetFreeUserEntitlementAsync](appinstallmanager_getfreeuserentitlementasync_107347343.md), or [GetFreeUserEntitlementForUserAsync](appinstallmanager_getfreeuserentitlementforuserasync_376670896.md) methods. + +## -enum-fields + +## -field Succeeded:0 +The request succeeded. + +## -field ServerError:3 +The request was unsuccessful because of a server error. + +## -field NoStoreAccount:1 +The request was unsuccessful because the specified user does not have a Microsoft account that is associated with the Store on the current device. + +## -field NetworkError:2 +The request was unsuccessful because of a network connection error. + +## -remarks +The [GetEntitlementResult.Status](getentitlementresult_status.md) property returns one of the **GetEntitlementStatus** values. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview.installcontrol/windows_applicationmodel_store_preview_installcontrol.md b/windows.applicationmodel.store.preview.installcontrol/windows_applicationmodel_store_preview_installcontrol.md index cae11b36d1..8619f6b8ea 100644 --- a/windows.applicationmodel.store.preview.installcontrol/windows_applicationmodel_store_preview_installcontrol.md +++ b/windows.applicationmodel.store.preview.installcontrol/windows_applicationmodel_store_preview_installcontrol.md @@ -6,13 +6,13 @@ # Windows.ApplicationModel.Store.Preview.InstallControl ## -description -Provides an API for programmatically managing the installation of apps and app updates. This API is accessible through the [AppInstallManager](appinstallmanager.md) class. - -> [!IMPORTANT] -> This API is protected by a private capability that is available only to apps that are developed by Microsoft. +Provides APIs for programmatically managing the installation of apps and app updates. ## -remarks +> [!IMPORTANT] +> The APIs in this namespace are protected by a private capability that is available only to apps that are developed by Microsoft. + ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration.md b/windows.applicationmodel.store.preview/storeconfiguration.md index fc7d8c733e..5093e66ea4 100644 --- a/windows.applicationmodel.store.preview/storeconfiguration.md +++ b/windows.applicationmodel.store.preview/storeconfiguration.md @@ -4,7 +4,7 @@ --- # Windows.ApplicationModel.Store.Preview.StoreConfiguration @@ -12,11 +12,11 @@ public class StoreConfiguration ## -description Defines static methods and properties for accessing information about the device hardware and configuring information about the system, the mobile operator, and the active user account. These members are used in various Windows Store scenarios. +## -remarks + > [!IMPORTANT] > Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. -## -remarks - ## -examples ## -see-also diff --git a/windows.applicationmodel.store.preview/storeconfiguration_getenterprisestorewebaccountid_78987272.md b/windows.applicationmodel.store.preview/storeconfiguration_getenterprisestorewebaccountid_78987272.md new file mode 100644 index 0000000000..24c82a7d5c --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_getenterprisestorewebaccountid_78987272.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetEnterpriseStoreWebAccountId +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetEnterpriseStoreWebAccountId + +## -description +Gets the Store user account ID for the current Azure AD user who is signed in to the Store. + +## -returns +The Store user account ID for the current Azure AD user who is signed in to the Store. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storeconfiguration_getenterprisestorewebaccountidforuser_2083309763.md b/windows.applicationmodel.store.preview/storeconfiguration_getenterprisestorewebaccountidforuser_2083309763.md new file mode 100644 index 0000000000..8b21f82eef --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_getenterprisestorewebaccountidforuser_2083309763.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetEnterpriseStoreWebAccountIdForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetEnterpriseStoreWebAccountIdForUser + +## -description +Gets the Store user account ID for the specified Azure AD user who is signed in to the Store. + +## -params + +## -param user +A [Windows.System.User](../windows.system/user.md) object that identifies the Azure AD user for which you want to retrieve the user account ID. + +## -returns +The Store user account ID for the specified user. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storeconfiguration_getstorewebaccountid_1519714701.md b/windows.applicationmodel.store.preview/storeconfiguration_getstorewebaccountid_1519714701.md new file mode 100644 index 0000000000..67636ab6ae --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_getstorewebaccountid_1519714701.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreWebAccountId +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreWebAccountId + +## -description +Gets the Store user account ID for the current user who is signed in to the Store. + +## -returns +The Store user account ID for the current user who is signed in to the Store. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storeconfiguration_getstorewebaccountidforuser_1517651834.md b/windows.applicationmodel.store.preview/storeconfiguration_getstorewebaccountidforuser_1517651834.md new file mode 100644 index 0000000000..e3f0b35bd9 --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_getstorewebaccountidforuser_1517651834.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreWebAccountIdForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.GetStoreWebAccountIdForUser + +## -description +Gets the Store user account ID for the specified user who is signed in to the Store. + +## -params + +## -param user +A [Windows.System.User](../windows.system/user.md) object that identifies the user for which you want to retrieve the Store user account ID. + +## -returns +The Store user account ID for the specified user. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storeconfiguration_setenterprisestorewebaccountid_1214769435.md b/windows.applicationmodel.store.preview/storeconfiguration_setenterprisestorewebaccountid_1214769435.md new file mode 100644 index 0000000000..cd6c450c6a --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_setenterprisestorewebaccountid_1214769435.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetEnterpriseStoreWebAccountId(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetEnterpriseStoreWebAccountId + +## -description +Sets the Store user account ID for the current Azure AD user who is signed in to the Store so that other apps can query against this ID. + +## -params + +## -param webAccountId +The Store user account ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to set for the Azure AD user who is currently signed in to the Store. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storeconfiguration_setenterprisestorewebaccountidforuser_452896242.md b/windows.applicationmodel.store.preview/storeconfiguration_setenterprisestorewebaccountidforuser_452896242.md new file mode 100644 index 0000000000..3a858997d3 --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_setenterprisestorewebaccountidforuser_452896242.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetEnterpriseStoreWebAccountIdForUser(Windows.System.User,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.SetEnterpriseStoreWebAccountIdForUser + +## -description +Sets the Store user account ID for the specified Azure AD user so that other apps can query against this ID. + +## -params + +## -param user +A [Windows.System.User](../windows.system/user.md) object that identifies the Azure AD user whose Store user account ID you want to set. + +## -param webAccountId +The Store user account ID (typically obtained from the [WebAccount.Id](../windows.security.credentials/webaccount_id.md) property) to set for the specified Azure AD user. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storeconfiguration_shouldrestricttoenterprisestoreonly_248202522.md b/windows.applicationmodel.store.preview/storeconfiguration_shouldrestricttoenterprisestoreonly_248202522.md new file mode 100644 index 0000000000..fabe68f132 --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_shouldrestricttoenterprisestoreonly_248202522.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.ShouldRestrictToEnterpriseStoreOnly +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.ShouldRestrictToEnterpriseStoreOnly + +## -description +Determines whether the Windows Store for Business is enabled for the current user. + +## -returns +True if the Windows Store for Business is enabled for the current user; otherwise false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storeconfiguration_shouldrestricttoenterprisestoreonlyforuser_1400628730.md b/windows.applicationmodel.store.preview/storeconfiguration_shouldrestricttoenterprisestoreonlyforuser_1400628730.md new file mode 100644 index 0000000000..ac3f16b8ca --- /dev/null +++ b/windows.applicationmodel.store.preview/storeconfiguration_shouldrestricttoenterprisestoreonlyforuser_1400628730.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.Store.Preview.StoreConfiguration.ShouldRestrictToEnterpriseStoreOnlyForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Store.Preview.StoreConfiguration.ShouldRestrictToEnterpriseStoreOnlyForUser + +## -description +Determines whether the Windows Store for Business is enabled for the specified user. + +## -params + +## -param user +A [Windows.System.User](../windows.system/user.md) object that identifies the user for whom you want to determine whether the Windows Store for Business is enabled. + +## -returns +True if the Windows Store for Business is enabled for the specified user; otherwise false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md index 73c3da3494..9acc79044a 100644 --- a/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md +++ b/windows.applicationmodel.store.preview/storehardwaremanufacturerinfo.md @@ -12,12 +12,12 @@ public class StoreHardwareManufacturerInfo : Windows.ApplicationModel.Store.Prev ## -description Provides information about the manufacturer for the current device. -> [!IMPORTANT] -> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. - ## -remarks To retrieve an instance of this class, use the [HardwareManufacturerInfo](storeconfiguration_hardwaremanufacturerinfo.md) property of the [StoreConfiguration](storeconfiguration.md) class. +> [!IMPORTANT] +> Access to this API is protected by a private capability that is restricted to apps that are developed by Microsoft. + ## -examples ## -see-also diff --git a/windows.applicationmodel.store.preview/storepreview.md b/windows.applicationmodel.store.preview/storepreview.md index 9ef6893596..e971246c47 100644 --- a/windows.applicationmodel.store.preview/storepreview.md +++ b/windows.applicationmodel.store.preview/storepreview.md @@ -4,7 +4,7 @@ --- # Windows.ApplicationModel.Store.Preview.StorePreview @@ -17,3 +17,6 @@ Defines static methods for retrieving the in-app product SKUs available for the ## -examples ## -see-also + +## -capabilities +previewStore diff --git a/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md b/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md index deea2fdb6b..dd220562db 100644 --- a/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md +++ b/windows.applicationmodel.store.preview/storepreview_loadaddonproductinfosasync_1961632920.md @@ -20,3 +20,6 @@ An asynchronous operation that, on successful completion, returns the collection ## -examples ## -see-also + +## -capabilities +previewStore diff --git a/windows.applicationmodel.store.preview/windows_applicationmodel_store_preview.md b/windows.applicationmodel.store.preview/windows_applicationmodel_store_preview.md index 95b19afc6b..632b6d87c9 100644 --- a/windows.applicationmodel.store.preview/windows_applicationmodel_store_preview.md +++ b/windows.applicationmodel.store.preview/windows_applicationmodel_store_preview.md @@ -6,15 +6,13 @@ # Windows.ApplicationModel.Store.Preview ## -description -Provides the following APIs that are currently accessible only via restricted or private capabilities. - - -+ An API for retrieving and purchasing SKUs of in-app products on the Windows Store. Each SKU has its own ID, description, price, and other unique product details. This API is accessible through static methods of the [StorePreview](storepreview.md) class. -+ An API for accessing information about the device hardware and configuring information about the system, the mobile operator, and the active user account. This API is accessible through static members of the [StoreConfiguration](storeconfiguration.md) class, and it is protected by a private capability that is available only to apps that are developed by Microsoft. - +Provides preview APIs for various Windows Store-related scenarios. ## -remarks +> [!IMPORTANT] +> The APIs in this namespace are currently protected by restricted or private capabilities that are only available to apps that are developed by Microsoft. + ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.applicationmodel.store/currentapp.md b/windows.applicationmodel.store/currentapp.md index 41f1368936..79fe417374 100644 --- a/windows.applicationmodel.store/currentapp.md +++ b/windows.applicationmodel.store/currentapp.md @@ -10,15 +10,14 @@ public class CurrentApp # Windows.ApplicationModel.Store.CurrentApp ## -description -Defines methods and properties you can use to get license and listing info about the current app and perform in-app product purchases. This object obtains its data from the Windows Store, so you must have a developer account and the app must be published in the Windows Store. Before submitting to the Windows Store, you can test your code with a simulated version of this class (whose state is initialized from an xml file). See [CurrentAppSimulator](currentappsimulator.md). - -> [!NOTE] -> If your app targets Windows 10, version 1607 or later, we recommend that you use members of the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace instead of the [Windows.ApplicationModel.Store](windows_applicationmodel_store.md) namespace. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace supports the latest add-on types, such as Store-managed consumable add-ons, and is designed to be compatible with future types of products and features supported by Windows Dev Center and the Store. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace is also designed to have better performance. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). +Defines methods and properties you can use to get license and listing info about the current app and perform in-app product purchases. ## -remarks -This object obtains its information from the Windows Store. +This object obtains its data from the Windows Store, so you must have a developer account and the app must be published in the Windows Store. Before submitting to the Windows Store, you can test your code with a simulated version of this class (whose state is initialized from an XML file). See [CurrentAppSimulator](currentappsimulator.md). > [!NOTE] +> If your app targets Windows 10, version 1607 or later, we recommend that you use members of the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace instead of the [Windows.ApplicationModel.Store](windows_applicationmodel_store.md) namespace. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace supports the latest add-on types, such as Store-managed consumable add-ons, and is designed to be compatible with future types of products and features supported by Windows Dev Center and the Store. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace is also designed to have better performance. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). +> > The [CurrentApp](currentapp.md) class is not supported in Windows desktop applications that use the [Desktop Bridge](https://developer.microsoft.com/windows/bridges/desktop). These applications must use the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace to implement in-app purchases and trials. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). ## -examples diff --git a/windows.applicationmodel.store/currentappsimulator.md b/windows.applicationmodel.store/currentappsimulator.md index a81dcdbd8b..76c31c3b9e 100644 --- a/windows.applicationmodel.store/currentappsimulator.md +++ b/windows.applicationmodel.store/currentappsimulator.md @@ -4,16 +4,13 @@ --- # Windows.ApplicationModel.Store.CurrentAppSimulator ## -description -Defines methods and properties used to instantiate an object that you can use to get simulated license info during testing. You must replace the [CurrentAppSimulator](currentappsimulator.md) class with the [CurrentApp](currentapp.md) class before you submit the app to the Windows Store. Apps that use the [CurrentAppSimulator](currentappsimulator.md) will fail certification. For more information about using this class, see the remarks section. - -> [!NOTE] -> If your app targets Windows 10, version 1607 or later, we recommend that you use members of the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace instead of the [Windows.ApplicationModel.Store](windows_applicationmodel_store.md) namespace. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace supports the latest add-on types, such as Store-managed consumable add-ons, and is designed to be compatible with future types of products and features supported by Windows Dev Center and the Store. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace is also designed to have better performance. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). +Defines methods and properties used to instantiate an object that you can use to get simulated license info during testing. ## -remarks Until the app has been listed in the Windows Store, the [CurrentApp](currentapp.md) object won't work in the app. Use the [CurrentAppSimulator](currentappsimulator.md) to test your app's licensing and in-app products while you develop your app. After you test your app, and before you submit it to the Windows Store, you must replace the instances of [CurrentAppSimulator](currentappsimulator.md) with [CurrentApp](currentapp.md). Your app will fail certification if it uses [CurrentAppSimulator](currentappsimulator.md). @@ -22,7 +19,10 @@ When the [CurrentAppSimulator](currentappsimulator.md) is used, the initial lice For more information about the WindowsStoreProxy.xml file, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace#proxy). +> [!NOTE] +> If your app targets Windows 10, version 1607 or later, we recommend that you use members of the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace instead of the [Windows.ApplicationModel.Store](windows_applicationmodel_store.md) namespace. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace supports the latest add-on types, such as Store-managed consumable add-ons, and is designed to be compatible with future types of products and features supported by Windows Dev Center and the Store. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace is also designed to have better performance. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). + ## -examples ## -see-also -[Store sample ()](https://github.com/Microsoft/Windows-universal-samples/tree/win10-1507/Samples/Store), [Trial app and in-app purchase sample ()](http://go.microsoft.com/fwlink/p/?LinkID=144754) \ No newline at end of file +[Store sample ()](https://github.com/Microsoft/Windows-universal-samples/tree/win10-1507/Samples/Store), [Trial app and in-app purchase sample ()](http://go.microsoft.com/fwlink/p/?LinkID=144754) diff --git a/windows.applicationmodel.store/windows_applicationmodel_store.md b/windows.applicationmodel.store/windows_applicationmodel_store.md index c2d0cf10c5..81bfa21880 100644 --- a/windows.applicationmodel.store/windows_applicationmodel_store.md +++ b/windows.applicationmodel.store/windows_applicationmodel_store.md @@ -6,18 +6,20 @@ # Windows.ApplicationModel.Store ## -description -Provides types and members for interacting with the Windows Store. You can use the members of this class to check the license state of the app and determine if it's a trial version or an active license. You can also check in-app features and enable in-app product purchases. This class also allows you to simulate these functions before you submit the app to the Windows Store. +Provides types and members for interacting with the Windows Store to add in-app purchases and trial functionality to your Universal Windows Platform (UWP) app. -You need a valid Windows Store developer account to interact with the Windows Store. If you don't have a Windows Store developer account, you can use only the simulated functions. +## -remarks -> [!NOTE] -> If your app targets Windows 10, version 1607 or later, we recommend that you use members of the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace instead of the [Windows.ApplicationModel.Store](windows_applicationmodel_store.md) namespace. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace supports the latest add-on types, such as Store-managed consumable add-ons, and is designed to be compatible with future types of products and features supported by Windows Dev Center and the Store. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace is also designed to have better performance. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). +You can use members in this namespace to add in-app purchases and trial functionality to your Universal Windows Platform (UWP) app to help monetize your app. You can use members in this namespace to check the license state of your app and determine if it's a trial version or an active license. This namespace can be used by UWP apps that target any version of Windows 10. + +You need a valid Windows Store developer account to interact with the Windows Store by using the [CurrentApp](currentapp.md) class. If you don't have a Windows Store developer account, you can use only the simulated functions in the [CurrentAppSimulator](currentappsimulator.md) class. -## -remarks > [!NOTE] +> If your app targets Windows 10, version 1607 or later, we recommend that you use members of the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace instead of the [Windows.ApplicationModel.Store](windows_applicationmodel_store.md) namespace. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace supports the latest add-on types, such as Store-managed consumable add-ons, and is designed to be compatible with future types of products and features supported by Windows Dev Center and the Store. The [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace is also designed to have better performance. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). +> > The [Windows.ApplicationModel.Store](windows_applicationmodel_store.md) namespace is not supported in Windows desktop applications that use the [Desktop Bridge](https://developer.microsoft.com/windows/bridges/desktop). These applications must use the [Windows.Services.Store](../windows.services.store/windows_services_store.md) namespace to implement in-app purchases and trials. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). ## -examples ## -see-also -[Store sample ()](https://github.com/Microsoft/Windows-universal-samples/tree/win10-1507/Samples/Store), [Trial app and in-app purchase sample ()](http://go.microsoft.com/fwlink/p/?LinkID=144754) \ No newline at end of file +[Store sample ()](https://github.com/Microsoft/Windows-universal-samples/tree/win10-1507/Samples/Store), [Trial app and in-app purchase sample ()](http://go.microsoft.com/fwlink/p/?LinkID=144754) diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_canshowcreatecontactgroup.md b/windows.applicationmodel.userdataaccounts/userdataaccount_canshowcreatecontactgroup.md new file mode 100644 index 0000000000..0d16998a01 --- /dev/null +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_canshowcreatecontactgroup.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.CanShowCreateContactGroup +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.CanShowCreateContactGroup + +## -description +This API supports the product infrastructure and is not intended to be used directly from your code. + +Microsoft Internal Use Only. + +## -property-value +A [ContactGroup](../windows.applicationmodel.contacts/contactgroup.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactgroupsasync_1099258195.md b/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactgroupsasync_1099258195.md new file mode 100644 index 0000000000..a9741ea2bd --- /dev/null +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_findcontactgroupsasync_1099258195.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactGroupsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindContactGroupsAsync + +## -description +This API supports the product infrastructure and is not intended to be used directly from your code. + +Microsoft Internal Use Only. + +## -params + +## -returns +A collection of [ContactGroup](../windows.applicationmodel.contacts/contactgroup.md) instances. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_finduserdatatasklistsasync_1479449054.md b/windows.applicationmodel.userdataaccounts/userdataaccount_finduserdatatasklistsasync_1479449054.md new file mode 100644 index 0000000000..2ffbcf0d4c --- /dev/null +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_finduserdatatasklistsasync_1479449054.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindUserDataTaskListsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.FindUserDataTaskListsAsync + +## -description +Returns a collection of [UserDataTask](../windows.applicationmodel.userdatatasks.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -params + +## -returns +A collection of [UserDataTask](../windows.applicationmodel.userdatatasks.md) instances associated with the [UserDataAccount](userdataaccount.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_providerproperties.md b/windows.applicationmodel.userdataaccounts/userdataaccount_providerproperties.md new file mode 100644 index 0000000000..80862c1090 --- /dev/null +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_providerproperties.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.ProviderProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.ProviderProperties + +## -description +Provides a place to store data to be used by the app when interacting with a [UserDataAccount](userdataaccount.md) provider. + +## -property-value +Data to be used by the app when interacting with a [UserDataAccount](userdataaccount.md) provider. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdataaccounts/userdataaccount_tryshowcreatecontactgroupasync_829396710.md b/windows.applicationmodel.userdataaccounts/userdataaccount_tryshowcreatecontactgroupasync_829396710.md new file mode 100644 index 0000000000..9343028403 --- /dev/null +++ b/windows.applicationmodel.userdataaccounts/userdataaccount_tryshowcreatecontactgroupasync_829396710.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccount.TryShowCreateContactGroupAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccount.TryShowCreateContactGroupAsync + +## -description +This API supports the product infrastructure and is not intended to be used directly from your code. + +Microsoft Internal Use Only. +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_1584113492.md b/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_1584113492.md new file mode 100644 index 0000000000..629baf5016 --- /dev/null +++ b/windows.applicationmodel.userdataaccounts/userdataaccountstore_createaccountasync_1584113492.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync + +## -description +Asynchronously creates a user data account, specifying a displayable user name, a GUID that identifies the app in the Windows Store, and the enterprise identity associated with the user account. + +## -params + +## -param userDisplayName +A string containing the user name that is suitable for display. + +## -param packageRelativeAppId +The GUID that identifies the app in the Windows Store. + +## -param enterpriseId +The enterprise identity associated with the user data account. + +## -returns +Returns the newly created [UserDataAccount](userdataaccount.md). + +## -remarks + +## -see-also +[CreateAccountAsync(String)](userdataaccountstore_createaccountasync_1955614316.md), [CreateAccountAsync(String, String)](userdataaccountstore_findaccountsasync_2001360321.md) +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection.md new file mode 100644 index 0000000000..a45ac1abf9 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection + +## -description +Represents a connection to a data provider client. + +## -remarks +Use the instance of this class provided by the [Connection](userdatataskdataprovidertriggerdetails_connection.md) property of the [UserDataTaskDataProviderTriggerDetails](userdatataskdataprovidertriggerdetails.md) object passed to your background task on activation. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_completetaskrequested.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_completetaskrequested.md new file mode 100644 index 0000000000..16fd280338 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_completetaskrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.CompleteTaskRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.CompleteTaskRequested + +## -description +Raised when the client app attempts to mark a task as completed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_createorupdatetaskrequested.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_createorupdatetaskrequested.md new file mode 100644 index 0000000000..b07e91b7f3 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_createorupdatetaskrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.CreateOrUpdateTaskRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.CreateOrUpdateTaskRequested + +## -description +Raised when the client app attempts to create or update a task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_deletetaskrequested.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_deletetaskrequested.md new file mode 100644 index 0000000000..6e7a5e85ca --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_deletetaskrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.DeleteTaskRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.DeleteTaskRequested + +## -description +Raised when the client app attempts to delete a task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_skipoccurrencerequested.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_skipoccurrencerequested.md new file mode 100644 index 0000000000..6b3d41620d --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_skipoccurrencerequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.SkipOccurrenceRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.SkipOccurrenceRequested + +## -description +Raised when the client app attempts to skip the current instance of a reoccurring task and move to the next instance. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_start_1587696324.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_start_1587696324.md new file mode 100644 index 0000000000..50a877c2b3 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_start_1587696324.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.Start +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.Start + +## -description +Call this method to indicate that all event handlers have been set and the data provider is ready to start handling requests. + +## -params + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_syncrequested.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_syncrequested.md new file mode 100644 index 0000000000..9bb00d608f --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataproviderconnection_syncrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.SyncRequested +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderConnection.SyncRequested + +## -description +Raised when the client app attempts to sync all calendar appointments with the server. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataprovidertriggerdetails.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataprovidertriggerdetails.md new file mode 100644 index 0000000000..c647bb8db2 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataprovidertriggerdetails.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderTriggerDetails +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderTriggerDetails + +## -description +Represents trigger information about the background task in which data will be transferred between the app and its caller. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataprovidertriggerdetails_connection.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataprovidertriggerdetails_connection.md new file mode 100644 index 0000000000..f13ac79874 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatataskdataprovidertriggerdetails_connection.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderTriggerDetails.Connection +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskDataProviderTriggerDetails.Connection + +## -description +Gets the data connection over which task data can be transferred. + +## -property-value +Gets the data connection over which task data can be transferred. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest.md new file mode 100644 index 0000000000..27f979f3c8 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest + +## -description +Details of a request to mark at task as completed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportcompletedasync_1011424265.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportcompletedasync_1011424265.md new file mode 100644 index 0000000000..5de6f4cdb5 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportcompletedasync_1011424265.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.ReportCompletedAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -params + +## -param completedTaskId +The ID of the task that was processed. + +## -returns +An asynchronous operation. + +# -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportfailedasync_1210652737.md new file mode 100644 index 0000000000..6f4df946e4 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_reportfailedasync_1210652737.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -params + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_taskid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_taskid.md new file mode 100644 index 0000000000..24517f96d4 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_taskid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.TaskId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.TaskId + +## -description +Gets the task ID of the task to be marked as completed. + +## -property-value +The task ID of the task to be marked as completed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_tasklistid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_tasklistid.md new file mode 100644 index 0000000000..a092772e2b --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequest_tasklistid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.TaskListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequest.TaskListId + +## -description +Gets the ID of the task list that contains the task that is to be marked as completed. + +## -property-value +The task list that contains the task that is to be marked as completed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs.md new file mode 100644 index 0000000000..c889f86bec --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequestEventArgs + +## -description +Encapsulates information about a request to mark a task as completed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..0988765ccf --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs_getdeferral_254836512.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -params + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs_request.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs_request.md new file mode 100644 index 0000000000..b9c81786e9 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcompletetaskrequesteventargs_request.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCompleteTaskRequestEventArgs.Request + +## -description +Gets the [UserDataTaskListCompleteTaskRequest](userdatatasklistcompletetaskrequest.md) object associated with this request. + +## -property-value +A [UserDataTaskListCompleteTaskRequest](userdatatasklistcompletetaskrequest.md) object describing the request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest.md new file mode 100644 index 0000000000..64cf214301 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest + +## -description +Details of a request to create or update a task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_reportcompletedasync_1925783074.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_reportcompletedasync_1925783074.md new file mode 100644 index 0000000000..ac389a9fca --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_reportcompletedasync_1925783074.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.ReportCompletedAsync(Windows.ApplicationModel.UserDataTasks.UserDataTask) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -params + +## -param createdOrUpdatedUserDataTask +The [UserDataTask](../windows.applicationmodel.userdatatasks/userdatatask.md) of the task that was created or updated. + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_reportfailedasync_1210652737.md new file mode 100644 index 0000000000..06833ee40b --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_reportfailedasync_1210652737.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -params + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_task.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_task.md new file mode 100644 index 0000000000..ec1236ec77 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_task.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.Task +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.Task + +## -description +Gets the [UserDataTask](../windows.applicationmodel.userdatatasks/userdatatask.md) of the task to be created or updated. + +## -property-value +The [UserDataTask](../windows.applicationmodel.userdatatasks/userdatatask.md) of the task to be created or updated. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_tasklistid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_tasklistid.md new file mode 100644 index 0000000000..2f496d02df --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequest_tasklistid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.TaskListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequest.TaskListId + +## -description +Gets the ID of the task list that contains the task that is to created or updated. + +## -property-value +The ID of the task list that contains the task that is to created or updated. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs.md new file mode 100644 index 0000000000..4e6d6ba8d4 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequestEventArgs + +## -description +Encapsulates information about a request to create or update. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..0b66018617 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs_getdeferral_254836512.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -params + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs_request.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs_request.md new file mode 100644 index 0000000000..96f1bcffcd --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistcreateorupdatetaskrequesteventargs_request.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListCreateOrUpdateTaskRequestEventArgs.Request + +## -description +Gets the [UserDataTaskListCreateOrUpdateTaskRequest](userdatatasklistcreateorupdatetaskrequest.md) object associated with this request. + +## -property-value +A [UserDataTaskListCreateOrUpdateTaskRequest](userdatatasklistcreateorupdatetaskrequest.md) object describing the request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest.md new file mode 100644 index 0000000000..c244851fff --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest + +## -description +Details of a request to delete a task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_reportcompletedasync_1707664681.md new file mode 100644 index 0000000000..feb5bb0137 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_reportcompletedasync_1707664681.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -params + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_reportfailedasync_1210652737.md new file mode 100644 index 0000000000..4c885136ee --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_reportfailedasync_1210652737.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. + +## -params + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_taskid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_taskid.md new file mode 100644 index 0000000000..b94edbae73 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_taskid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.TaskId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.TaskId + +## -description +Gets the task ID of the task to be deleted. + +## -property-value +The task ID of the task to be deleted. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_tasklistid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_tasklistid.md new file mode 100644 index 0000000000..e4b43eaf50 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequest_tasklistid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.TaskListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequest.TaskListId + +## -description +Gets the ID of the task list that contains the task that is to be deleted. + +## -property-value +The task list that contains the task that is to be deleted. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs.md new file mode 100644 index 0000000000..7bf9eaed11 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequestEventArgs + +## -description +Encapsulates information about a request to delete a task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..de6270b805 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs_getdeferral_254836512.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -params + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs_request.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs_request.md new file mode 100644 index 0000000000..541bbcbc52 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistdeletetaskrequesteventargs_request.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListDeleteTaskRequestEventArgs.Request + +## -description +Gets the [UserDataTaskListDeleteTaskRequest](userdatatasklistdeletetaskrequest.md) object associated with this request. + +## -property-value +A [UserDataTaskListDeleteTaskRequest](userdatatasklistdeletetaskrequest.md) object describing the request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest.md new file mode 100644 index 0000000000..7b7b7e9015 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest + +## -description +Details of a request to skip the current instance of a reoccurring task and move to the next instance. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_reportcompletedasync_1707664681.md new file mode 100644 index 0000000000..1f3625dfbe --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_reportcompletedasync_1707664681.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. +## -parameters + +## -returns +An asynchronous operation. +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_reportfailedasync_1210652737.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_reportfailedasync_1210652737.md new file mode 100644 index 0000000000..c2d08c031c --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_reportfailedasync_1210652737.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. +## -params + +## -returns +An asynchronous operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_taskid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_taskid.md new file mode 100644 index 0000000000..9ae16afd53 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_taskid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.TaskId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.TaskId + +## -description +Gets the task ID of the task to be skipped. + +## -property-value +The task ID of the task to be skipped. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_tasklistid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_tasklistid.md new file mode 100644 index 0000000000..78d8d94770 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequest_tasklistid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.TaskListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequest.TaskListId + +## -description +Gets the ID of the task list that contains the task to be skipped. + +## -property-value +The ID of the task list that contains the task to be skipped. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs.md new file mode 100644 index 0000000000..1de2f92bb3 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequestEventArgs + +## -description +Encapsulates information about a request to skip a task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..8265ecb65b --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs_getdeferral_254836512.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -params + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs_request.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs_request.md new file mode 100644 index 0000000000..d8bdd83dea --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistskipoccurrencerequesteventargs_request.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSkipOccurrenceRequestEventArgs.Request + +## -description +Gets the [UserDataTaskListSkipOccurrenceRequest](userdatatasklistskipoccurrencerequest.md) object associated with this request. + +## -property-value +A [UserDataTaskListSkipOccurrenceRequest](userdatatasklistskipoccurrencerequest.md) object describing the request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest.md new file mode 100644 index 0000000000..78ae2431f1 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest + +## -description +Details of a request from a client to sync a task list. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_reportcompletedasync_1707664681.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_reportcompletedasync_1707664681.md new file mode 100644 index 0000000000..35f8257eb9 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_reportcompletedasync_1707664681.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest.ReportCompletedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest.ReportCompletedAsync + +## -description +Informs the client app that the request was processed successfully. + +## -params + +## -returns +An asynchronous sync operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_reportfailedasync_1210652737.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_reportfailedasync_1210652737.md new file mode 100644 index 0000000000..4409ef9433 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_reportfailedasync_1210652737.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest.ReportFailedAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest.ReportFailedAsync + +## -description +Informs the client that the request was not processed successfully. +## -params + +## -returns +An asynchronous sync operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_tasklistid.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_tasklistid.md new file mode 100644 index 0000000000..74563d1fc1 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequest_tasklistid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest.TaskListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequest.TaskListId + +## -description +Gets the ID of the task list to be synced. + +## -property-value +The ID of the task list to be synced. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs.md new file mode 100644 index 0000000000..a175f6354e --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequestEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequestEventArgs + +## -description +Encapsulates information about a request to sync a task list. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs_getdeferral_254836512.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..74335da665 --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs_getdeferral_254836512.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequestEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequestEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -params + +## -returns +A [Deferral](../windows.foundation/deferral.md) object that your code uses to signal when it has finished processing this request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs_request.md b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs_request.md new file mode 100644 index 0000000000..bc801302de --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/userdatatasklistsyncmanagersyncrequesteventargs_request.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequestEventArgs.Request +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider.UserDataTaskListSyncManagerSyncRequestEventArgs.Request + +## -description +Gets the [UserDataTaskListSyncManagerSyncRequest](userdatatasklistsyncmanagersyncrequest.md) object associated with this request. + +## -property-value +A [UserDataTaskListSyncManagerSyncRequest](userdatatasklistsyncmanagersyncrequest.md) object describing the request. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks.dataprovider/windows_applicationmodel_userdatatasks_dataprovider.md b/windows.applicationmodel.userdatatasks.dataprovider/windows_applicationmodel_userdatatasks_dataprovider.md new file mode 100644 index 0000000000..581617af9d --- /dev/null +++ b/windows.applicationmodel.userdatatasks.dataprovider/windows_applicationmodel_userdatatasks_dataprovider.md @@ -0,0 +1,19 @@ +--- +-api-id: N:Windows.ApplicationModel.UserDataTasks.DataProvider +-api-type: winrt namespace +--- + + + +# Windows.ApplicationModel.UserDataTasks.DataProvider + +## -description +This API is implemented by a server to provide contact information to client apps. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask.md b/windows.applicationmodel.userdatatasks/userdatatask.md new file mode 100644 index 0000000000..293f95f3fe --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTask +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask + +## -description +Represents a task. + +## -remarks +No matter how you store task information in your app, you must be able to put that information into a [UserDataTask](userdatatask.md) object. This way, other apps that allow users to select tasks can use your app and process the task information it provides. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_completeddate.md b/windows.applicationmodel.userdatatasks/userdatatask_completeddate.md new file mode 100644 index 0000000000..8bc289305b --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_completeddate.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.CompletedDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.CompletedDate + +## -description +Gets or sets the completion date and time of the task. + +## -property-value +The completion date and time of the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_details.md b/windows.applicationmodel.userdatatasks/userdatatask_details.md new file mode 100644 index 0000000000..2ee791e86f --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_details.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.Details +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.Details + +## -description +Gets or sets a string value. The string contains extended details that describe the task. Details is of type String and a maximum of 1,073,741,823 characters in length, which is the maximum length of a JET database string. + +## -property-value +The extended details that describe the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_detailskind.md b/windows.applicationmodel.userdatatasks/userdatatask_detailskind.md new file mode 100644 index 0000000000..33115caf8f --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_detailskind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.DetailsKind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.DetailsKind + +## -description +Gets or sets the type of task details, plain text or HTML. + +## -property-value +The type of task details. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_duedate.md b/windows.applicationmodel.userdatatasks/userdatatask_duedate.md new file mode 100644 index 0000000000..e02345f9c8 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_duedate.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.DueDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.DueDate + +## -description +Gets or sets the due date of the task. + +## -property-value +the due date of the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_id.md b/windows.applicationmodel.userdatatasks/userdatatask_id.md new file mode 100644 index 0000000000..3d7c9e374c --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_id.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.Id + +## -description +Gets the unique identifier of the task. + +## -property-value +The unique identifier of the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_kind.md b/windows.applicationmodel.userdatatasks/userdatatask_kind.md new file mode 100644 index 0000000000..2a6b535fd0 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_kind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.Kind + +## -description +Gets the kind of task (For example: Recurring etc.). + +## -property-value +The kind of task (For example: Recurring etc.). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_listid.md b/windows.applicationmodel.userdatatasks/userdatatask_listid.md new file mode 100644 index 0000000000..5fdcf0ee42 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_listid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.ListId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.ListId + +## -description +Gets the unique identifier for the task list associated with the task. + +## -property-value +The unique identifier for the task list associated with the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_priority.md b/windows.applicationmodel.userdatatasks/userdatatask_priority.md new file mode 100644 index 0000000000..93d7e081cc --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_priority.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.Priority +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.Priority + +## -description +Gets or sets the priority of the task. + +## -property-value +The priority of the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_recurrenceproperties.md b/windows.applicationmodel.userdatatasks/userdatatask_recurrenceproperties.md new file mode 100644 index 0000000000..de8187a88b --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_recurrenceproperties.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.RecurrenceProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.RecurrenceProperties + +## -description +Gets or sets an object that represents when and how often a task occurs. + +## -property-value +An object that represents when and how often a task occurs + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_regenerationproperties.md b/windows.applicationmodel.userdatatasks/userdatatask_regenerationproperties.md new file mode 100644 index 0000000000..05266ba27d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_regenerationproperties.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.RegenerationProperties +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.RegenerationProperties + +## -description +Gets or sets an object that represents how many times and at what interval the task is generated. + +## -property-value +An object that represents how many times and at what interval the task is generated. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_reminder.md b/windows.applicationmodel.userdatatasks/userdatatask_reminder.md new file mode 100644 index 0000000000..e9cd51df56 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_reminder.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.Reminder +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.Reminder + +## -description +Gets or sets a time span value. The value declares the amount of time to subtract from the [DueDate](userdatatask_duedate.md), and that time used as the issue time for a reminder for a task. A **null** value indicates that the task won't issue a reminder. [Reminder](userdatatask_reminder.md) is of type [IReference(TimeSpan)](../windows.foundation/ireference_1.md). + +## -property-value +A time span value, or **null** to issue no reminder. + +## -remarks +This property uses a time span value, which is represented differently depending on which language you are programming with. For more information about how to use a time span value, see the [Duration](../windows.applicationmodel.appointments/appointment_duration.md) property. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_remoteid.md b/windows.applicationmodel.userdatatasks/userdatatask_remoteid.md new file mode 100644 index 0000000000..f44ead666e --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_remoteid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.RemoteId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.RemoteId + +## -description +Gets or sets an ID that can be used by a service provider to access the [UserDataTask](userdatatask.md) in their remote system. + +## -property-value +An ID that can be used by a service provider to access the [UserDataTask](userdatatask.md) in their remote system. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_sensitivity.md b/windows.applicationmodel.userdatatasks/userdatatask_sensitivity.md new file mode 100644 index 0000000000..614693ddbf --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_sensitivity.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.Sensitivity +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.Sensitivity + +## -description +Gets or sets a [UserDataTaskSensitivity](userdatatasksensitivity.md)-typed value that indicates the sensitivity of the task. + +## -property-value +A [UserDataTaskSensitivity](userdatatasksensitivity.md)-typed value that indicates the sensitivity of the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_startdate.md b/windows.applicationmodel.userdatatasks/userdatatask_startdate.md new file mode 100644 index 0000000000..966f3ca9be --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_startdate.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.StartDate +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.StartDate + +## -description +Gets or sets the starting date and time for the task. + +## -property-value +The date and time to use as the starting time for the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_subject.md b/windows.applicationmodel.userdatatasks/userdatatask_subject.md new file mode 100644 index 0000000000..b32174b17b --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_subject.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTask.Subject +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.Subject + +## -description +Gets or sets a string that communicates the subject of the task. [Subject](userdatatask_subject.md) is of type [String](https://msdn.microsoft.com/library/system.string.aspx) and a maximum of 255 characters in length. + +## -property-value +The subject of the task. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatask_userdatatask_1221375020.md b/windows.applicationmodel.userdatatasks/userdatatask_userdatatask_1221375020.md new file mode 100644 index 0000000000..15cfd68c8b --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatask_userdatatask_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTask.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTask.UserDataTask + +## -description +Initializes a new instance of the [UserDataTask](userdatatask.md) class. + +## -params +This constructor has no parameters. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskbatch.md b/windows.applicationmodel.userdatatasks/userdatataskbatch.md new file mode 100644 index 0000000000..2bf4bca8d7 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskbatch.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskBatch +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskBatch + +## -description +Represents a group of [UserDataTask](userdatatask.md) objects. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskbatch_tasks.md b/windows.applicationmodel.userdatatasks/userdatataskbatch_tasks.md new file mode 100644 index 0000000000..28fa84a231 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskbatch_tasks.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskBatch.Tasks +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskBatch.Tasks + +## -description +Gets the list of [UserDataTask](userdatatask.md) objects returned by a search operation. + +## -property-value +The list of tasks returned by a search operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskdaysofweek.md b/windows.applicationmodel.userdatatasks/userdatataskdaysofweek.md new file mode 100644 index 0000000000..1d50be3d92 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskdaysofweek.md @@ -0,0 +1,53 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskDaysOfWeek +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskDaysOfWeek + +## -description +Specifies the days of the week on which an task occurs. +## -enum-fields + +## -field Wednesday:8 +The task occurs on Wednesday. + +## -field Tuesday:4 +The task occurs on Tuesday. + +## -field Thursday:16 +The task occurs on Thursday. + +## -field Sunday:1 +The task occurs on Sunday. + +## -field Saturday:64 +The task occurs on Saturday. + +## -field None:0 +The task doesn't occur on any days of the week. + +## -field Monday:2 +The task occurs on Monday. + +## -field Friday:32 +The task occurs on Friday. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskdetailskind.md b/windows.applicationmodel.userdatatasks/userdatataskdetailskind.md new file mode 100644 index 0000000000..7020daa1f8 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskdetailskind.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskDetailsKind +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskDetailsKind + +## -description +Defines the type of content in task details. + +## -enum-fields + +## -field PlainText:0 +Content is in plain text. + +## -field Html:1 +Content is in HTML markup. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskkind.md b/windows.applicationmodel.userdatatasks/userdatataskkind.md new file mode 100644 index 0000000000..4851435f95 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskkind.md @@ -0,0 +1,33 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskKind +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskKind + +## -description +Defines the type of task. +## -enum-fields + +## -field Single:0 +A task with no special conditions that cause it to reoccur. + +## -field Regenerating:2 +A task that reoccurs at some regular interval. + +## -field Recurring:1 +A task that reoccurs at specific date and at some regular interval. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist.md b/windows.applicationmodel.userdatatasks/userdatatasklist.md new file mode 100644 index 0000000000..d329d8c729 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskList +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList + +## -description +Represents a list of [UserDataTask](userdatatask.md) objects. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_deleteasync_1247887881.md b/windows.applicationmodel.userdatatasks/userdatatasklist_deleteasync_1247887881.md new file mode 100644 index 0000000000..24687a23f3 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_deleteasync_1247887881.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.DeleteAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.DeleteAsync + +## -description +Asynchronously deletes this [UserDataTaskList](userdatatasklist.md), including all [UserDataTask](userdatatask.md) objects in the [UserDataTaskStore](userdatataskstore.md). +## -params + +## -returns +An async action indicating that the method is complete. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_deletetaskasync_508509526.md b/windows.applicationmodel.userdatatasks/userdatatasklist_deletetaskasync_508509526.md new file mode 100644 index 0000000000..72fb00526d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_deletetaskasync_508509526.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.DeleteTaskAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.DeleteTaskAsync + +## -description +Asynchronously deletes and individual [UserDataTask](userdatatask.md) from this [UserDataTaskList](userdatatasklist.md) and the [UserDataTaskStore](userdatataskstore.md). +## -params + +## -param userDataTaskId +The [UserDataTask](userdatatask.md) to delete. + +## -returns +An async action indicating that the method is complete. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_displayname.md b/windows.applicationmodel.userdatatasks/userdatatasklist_displayname.md new file mode 100644 index 0000000000..7683eb0721 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_displayname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.DisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.DisplayName + +## -description +Gets or sets the name of the [UserDataTaskList](userdatatasklist.md), suitable for display in the user interface. + +## -property-value +The name of the [UserDataTaskList](userdatatasklist.md), suitable for display in the user interface. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskasync_518736339.md b/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskasync_518736339.md new file mode 100644 index 0000000000..be7d624d12 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskasync_518736339.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.GetTaskAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.GetTaskAsync + +## -description +Asynchronously retrieves the specified [UserDataTask](userdatatask.md) object from the [UserDataTaskList](userdatatasklist.md). +## -params + +## -param userDataTask +The string that identifies the [UserDataTask](userdatatask.md) to return. + +## -returns +The [UserDataTask](userdatatask.md) identified by the *UserDataTask* parameter. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskreader_1184494814.md b/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskreader_1184494814.md new file mode 100644 index 0000000000..eb95b11bd5 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskreader_1184494814.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.GetTaskReader +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.GetTaskReader + +## -description +Gets a [UserDataTaskReader](userdatataskreader.md) object associated with this [UserDataTaskList](userdatatasklist.md). +## -params + +## -returns +A [UserDataTaskReader](userdatataskreader.md) object associated with this [UserDataTaskList](userdatatasklist.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskreader_1451551250.md b/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskreader_1451551250.md new file mode 100644 index 0000000000..5656e46cc0 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_gettaskreader_1451551250.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.GetTaskReader(Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.GetTaskReader + +## -description +Gets a [UserDataTaskReader](userdatataskreader.md) object associated with this [UserDataTaskList](userdatatasklist.md) by using the specified [UserDataTaskQueryOptions](userdatataskqueryoptions.md). +## -params + +## -param options +The [UserDataTaskQueryOptions](userdatataskqueryoptions.md) to use when creating the [UserDataTaskReader](userdatataskreader.md). + +## -returns +A [UserDataTaskReader](userdatataskreader.md) object associated with this [UserDataTaskList](userdatatasklist.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_id.md b/windows.applicationmodel.userdatatasks/userdatatasklist_id.md new file mode 100644 index 0000000000..9fd96cd173 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_id.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.Id +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.Id + +## -description +Gets the locally unique identifier for this [UserDataTaskList](userdatatasklist.md). + +## -property-value +The locally unique identifier for this [UserDataTaskList](userdatatasklist.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_limitedwriteoperations.md b/windows.applicationmodel.userdatatasks/userdatatasklist_limitedwriteoperations.md new file mode 100644 index 0000000000..9fa59973f7 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_limitedwriteoperations.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.LimitedWriteOperations +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.LimitedWriteOperations + +## -description +Gets an object that provides operations that an app can perform on a task list that it has not created. + +## -property-value +An object that provides operations that an app can perform on a task list that it has not created. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_otherappreadaccess.md b/windows.applicationmodel.userdatatasks/userdatatasklist_otherappreadaccess.md new file mode 100644 index 0000000000..cd4d7477a9 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_otherappreadaccess.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.OtherAppReadAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.OtherAppReadAccess + +## -description +Gets or sets a value indicating the read access level to this [UserDataTaskList](userdatatasklist.md) for other apps on the system. + +## -property-value +A value indicating the read access level to this [UserDataTaskList](userdatatasklist.md) for other apps on the system. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_otherappwriteaccess.md b/windows.applicationmodel.userdatatasks/userdatatasklist_otherappwriteaccess.md new file mode 100644 index 0000000000..446b0c7bff --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_otherappwriteaccess.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.OtherAppWriteAccess +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.OtherAppWriteAccess + +## -description +Gets or sets a value indicating the write access level to this [UserDataTaskList](userdatatasklist.md) for other apps on the system. + +## -property-value +A value indicating the write access level to this [UserDataTaskList](userdatatasklist.md) for other apps on the system. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_registersyncmanagerasync_1214558325.md b/windows.applicationmodel.userdatatasks/userdatatasklist_registersyncmanagerasync_1214558325.md new file mode 100644 index 0000000000..f391ded5f0 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_registersyncmanagerasync_1214558325.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.RegisterSyncManagerAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.RegisterSyncManagerAsync + +## -description +Adds a [SyncManager](userdatatasklist_syncmanager.md) to the [UserDataTaskList](userdatatasklist.md). +## -params + +## -returns +An asynchronous registration operation that you can await. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_saveasync_2143735121.md b/windows.applicationmodel.userdatatasks/userdatatasklist_saveasync_2143735121.md new file mode 100644 index 0000000000..896e146875 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_saveasync_2143735121.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SaveAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SaveAsync + +## -description +Asynchronously saves this [UserDataTaskList](userdatatasklist.md). + +## -params + +## -returns +An async action indicating that the method has completed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_savetaskasync_2085756509.md b/windows.applicationmodel.userdatatasks/userdatatasklist_savetaskasync_2085756509.md new file mode 100644 index 0000000000..b709c649bd --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_savetaskasync_2085756509.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SaveTaskAsync(Windows.ApplicationModel.UserDataTasks.UserDataTask) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SaveTaskAsync + +## -description +Asynchronously saves the specified [UserDataTask](userdatatask.md) to the [UserDataTaskStore](userdatataskstore.md). + +## -params + +## -param userDataTask +The task to save. + +## -returns + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_sourcedisplayname.md b/windows.applicationmodel.userdatatasks/userdatatasklist_sourcedisplayname.md new file mode 100644 index 0000000000..68a9d6d94b --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_sourcedisplayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SourceDisplayName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SourceDisplayName + +## -description +Gets the name of the source of the [UserDataTaskList](userdatatasklist.md), suitable for display in the user interface. + +## -property-value +The name of the source of the [UserDataTaskList](userdatatasklist.md), suitable for display in the user interface. + +## -remarks +This is usually the name of the app or service from which the contacts originate. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_syncmanager.md b/windows.applicationmodel.userdatatasks/userdatatasklist_syncmanager.md new file mode 100644 index 0000000000..082b48a60d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_syncmanager.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SyncManager +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.SyncManager + +## -description +Gets the [UserDataTaskListSyncManager](userdatatasklistsyncstatus.md) used to communicate with the server. + +## -property-value +The [UserDataTaskListSyncManager](userdatatasklistsyncstatus.md) used to communicate with the server. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklist_userdataaccountid.md b/windows.applicationmodel.userdatatasks/userdatatasklist_userdataaccountid.md new file mode 100644 index 0000000000..81639ea215 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklist_userdataaccountid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskList.UserDataAccountId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskList.UserDataAccountId + +## -description +Gets a string that represents the ID of the user data account for this [UserDataTaskList](userdatatasklist.md). + +## -property-value +A string that represents the ID of the user data account for this [UserDataTaskList](userdatatasklist.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations.md b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations.md new file mode 100644 index 0000000000..8f3df36a65 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations + +## -description +Provides operations that an app can perform on a task list that it has not created. + +## -remarks +Get an instance of this class by using the [LimitedWriteOperations](userdatatasklist_limitedwriteoperations.md) property of a [UserDataTaskList](userdatatasklist.md). + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trycompletetaskasync_1024823532.md b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trycompletetaskasync_1024823532.md new file mode 100644 index 0000000000..6959ba4dca --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trycompletetaskasync_1024823532.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TryCompleteTaskAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TryCompleteTaskAsync + +## -description +Asynchronously attempts to mark a task as completed. + +## -params + +## -param userDataTaskId +The ID of the task to mark as completed. + +## -returns +The ID of the task marked as completed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trycreateorupdatetaskasync_1740290498.md b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trycreateorupdatetaskasync_1740290498.md new file mode 100644 index 0000000000..8ccdef2021 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trycreateorupdatetaskasync_1740290498.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TryCreateOrUpdateTaskAsync(Windows.ApplicationModel.UserDataTasks.UserDataTask) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TryCreateOrUpdateTaskAsync + +## -description +Asynchronously attempts to create or update a task. + +## -params + +## -param userDataTask +The task to create or update. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trydeletetaskasync_1180130444.md b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trydeletetaskasync_1180130444.md new file mode 100644 index 0000000000..056145e77f --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_trydeletetaskasync_1180130444.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TryDeleteTaskAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TryDeleteTaskAsync + +## -description +Asynchronously attempts to delete a meeting. +## -params + +## -param userDataTaskId +The ID of the task to delete. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_tryskipoccurrenceasync_2066396186.md b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_tryskipoccurrenceasync_2066396186.md new file mode 100644 index 0000000000..5f003d93d5 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistlimitedwriteoperations_tryskipoccurrenceasync_2066396186.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TrySkipOccurrenceAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListLimitedWriteOperations.TrySkipOccurrenceAsync + +## -description +Asynchronously attempts to skip the current instance of a reoccurring task and move to the next instance. + +## -params + +## -param userDataTaskId +The ID of the reoccurring task. + +## -returns +A Boolean value indicating if the operation was successful. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistotherappreadaccess.md b/windows.applicationmodel.userdatatasks/userdatatasklistotherappreadaccess.md new file mode 100644 index 0000000000..ca6ab40123 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistotherappreadaccess.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskListOtherAppReadAccess +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListOtherAppReadAccess + +## -description +Specifies the level of task read access granted to other apps. + +## -enum-fields + +## -field SystemOnly:1 +Other apps can only read system tasks. + +## -field None:2 +Other apps cannot access any tasks. + +## -field Full:0 +Other apps have read access to system and app tasks. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistotherappwriteaccess.md b/windows.applicationmodel.userdatatasks/userdatatasklistotherappwriteaccess.md new file mode 100644 index 0000000000..97c26e2d63 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistotherappwriteaccess.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskListOtherAppWriteAccess +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListOtherAppWriteAccess + +## -description +Specifies the level of task write access granted to other apps. + +## -enum-fields + +## -field None:1 +No write access is granted. + +## -field Limited:0 +Other apps can only write tasks for this app. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager.md new file mode 100644 index 0000000000..cfe5ed311c --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager + +## -description +Provides functionality for syncing task information with the server. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastattemptedsynctime.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastattemptedsynctime.md new file mode 100644 index 0000000000..692b5849bb --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastattemptedsynctime.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.LastAttemptedSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.LastAttemptedSyncTime + +## -description +Gets or sets the last time a sync was attempted with the server. + +## -property-value +The last time a sync was attempted with the server. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastsuccessfulsynctime.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastsuccessfulsynctime.md new file mode 100644 index 0000000000..43e3c50693 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_lastsuccessfulsynctime.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.LastSuccessfulSyncTime +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.LastSuccessfulSyncTime + +## -description + +## -property-value +The last time the [UserDataTaskList](userdatatasklist.md) was successfully synced with the server. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_status.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_status.md new file mode 100644 index 0000000000..3419bcdc92 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.Status +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.Status + +## -description +Gets or sets the [UserDataTaskListSyncStatus](userdatatasklistsyncstatus.md). + +## -property-value +The [UserDataTaskListSyncStatus](userdatatasklistsyncstatus.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_syncasync_2144191352.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_syncasync_2144191352.md new file mode 100644 index 0000000000..c360ebb652 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_syncasync_2144191352.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.SyncAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.SyncAsync + +## -description +Asynchronously attempts to sync with the tasks server. + +## -params + +## -returns +A Boolean value indicating if the sync was successful. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_syncstatuschanged.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_syncstatuschanged.md new file mode 100644 index 0000000000..d9aa6261a2 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncmanager_syncstatuschanged.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.SyncStatusChanged +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncManager.SyncStatusChanged + +## -description +Occurs when the sync status with the server has changed. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasklistsyncstatus.md b/windows.applicationmodel.userdatatasks/userdatatasklistsyncstatus.md new file mode 100644 index 0000000000..f98d169266 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasklistsyncstatus.md @@ -0,0 +1,46 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncStatus +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskListSyncStatus + +## -description +Defines the [UserDataTaskList](userdatatasklist.md) sync status. + +## -enum-fields + +## -field UpToDate:2 +The task list is up-to-date. + +## -field UnknownError:5 +An unknown error occurred. + +## -field Syncing:1 +Currently syncing. + +## -field PolicyError:4 +There was a policy error. + +## -field Idle:0 +Idle. + +## -field AuthenticationError:3 +There was an authentication error. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskmanager.md b/windows.applicationmodel.userdatatasks/userdatataskmanager.md new file mode 100644 index 0000000000..ff4a350575 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskmanager.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskManager +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskManager + +## -description +Represents a service that source apps can call to access task data. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskmanager_getdefault_846721868.md b/windows.applicationmodel.userdatatasks/userdatataskmanager_getdefault_846721868.md new file mode 100644 index 0000000000..e624756d0e --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskmanager_getdefault_846721868.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.GetDefault + +## -description +Gets the default [UserTaskManager](userdatataskmanager.md) object. + +## -returns +Gets the default [UserTaskManager](userdatataskmanager.md) object. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskmanager_getforuser_2058550280.md b/windows.applicationmodel.userdatatasks/userdatataskmanager_getforuser_2058550280.md new file mode 100644 index 0000000000..214fbe7076 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskmanager_getforuser_2058550280.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.GetForUser + +## -description +Gets the [UserTaskManager](userdatataskmanager.md) object for the specified user. + +## -params + +## -param user +The user account to use to get the [UserTaskManager](userdatataskmanager.md) object. + +## -returns +The [UserTaskManager](userdatataskmanager.md) object for the specified user. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskmanager_requeststoreasync_1330322877.md b/windows.applicationmodel.userdatatasks/userdatataskmanager_requeststoreasync_1330322877.md new file mode 100644 index 0000000000..82a0af7fe4 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskmanager_requeststoreasync_1330322877.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.RequestStoreAsync(Windows.ApplicationModel.UserDataTasks.UserDataTaskStoreAccessType) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.RequestStoreAsync + +## -description +Retrieves a [UserDataTaskStore](userdatataskstore.md) object that enables searching or retrieving contacts on the device. + +## -params + +## -param accessType +Specifies the type of read/write access requested. + +## -returns +An asynchronous operation that returns a [UserDataTaskStore](userdatataskstore.md) object on successful completion. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskmanager_user.md b/windows.applicationmodel.userdatatasks/userdatataskmanager_user.md new file mode 100644 index 0000000000..17a0b26d16 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskmanager_user.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.User +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskManager.User + +## -description +Gets the user associated with this [UserDataTaskManager](userdatataskmanager.md). + +## -property-value +The user associated with this [UserDataTaskManager](userdatataskmanager.md). + +# -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskpriority.md b/windows.applicationmodel.userdatatasks/userdatataskpriority.md new file mode 100644 index 0000000000..c1091964bf --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskpriority.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskPriority +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskPriority + +## -description +Specifies the priority of the task. + +## -enum-fields + +## -field Normal:0 +The task has the normal priority. + +## -field Low:-1 +The task is a low priority. + +## -field High:1 +The task is a high priority. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskquerykind.md b/windows.applicationmodel.userdatatasks/userdatataskquerykind.md new file mode 100644 index 0000000000..3bc07145f3 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskquerykind.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryKind +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryKind + +## -description +Defines the type of task query. + +## -enum-fields + +## -field Incomplete:1 +The query is for tasks that are not marked as completed. + +## -field Complete:2 +The query is for tasks that are marked as completed. + +## -field All:0 +The query is for all tasks. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskqueryoptions.md b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions.md new file mode 100644 index 0000000000..414547761e --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions + +## -description +Represents the options selected for task query. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_kind.md b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_kind.md new file mode 100644 index 0000000000..0c9e5e95ce --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_kind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions.Kind +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions.Kind + +## -description +Gets or sets the kind of tasks for which to query. + +## -property-value +The kind of emails for which to query. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_sortproperty.md b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_sortproperty.md new file mode 100644 index 0000000000..e7d1fd8eab --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_sortproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions.SortProperty +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions.SortProperty + +## -description +Gets or sets a Boolean value indicating whether the query results should be sorted. + +## -property-value +A Boolean value indicating whether the query results should be sorted. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_userdatataskqueryoptions_1221375020.md b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_userdatataskqueryoptions_1221375020.md new file mode 100644 index 0000000000..49819250bd --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskqueryoptions_userdatataskqueryoptions_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskQueryOptions.UserDataTaskQueryOptions + +## -description +Instantiates a new instance of the [UserDataTaskQueryOptions](userdatataskqueryoptions.md) class. + +## -params + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskquerysortproperty.md b/windows.applicationmodel.userdatatasks/userdatataskquerysortproperty.md new file mode 100644 index 0000000000..651e35bd7d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskquerysortproperty.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskQuerySortProperty +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskQuerySortProperty + +## -description +The property by which to sort. Currently limited to due date. + +## -enum-fields + +## -field DueDate:0 +Sort by due date. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskreader.md b/windows.applicationmodel.userdatatasks/userdatataskreader.md new file mode 100644 index 0000000000..0936075e2d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskreader.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskReader +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskReader + +## -description +Used to read [UserDataTask](userdatatask.md) objects in batches from the [UserDataTaskStore](userdatataskstore.md) which may be local or remotely located. + +## -remarks +Use [GetTaskReader](userdatatasklist_gettaskreader_1184494814.md) or [GetTaskReader(UserDataTaskQueryOptions)](userdatatasklist_gettaskreader_1451551250.md) to get an instance of this class. + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskreader_readbatchasync_888788553.md b/windows.applicationmodel.userdatatasks/userdatataskreader_readbatchasync_888788553.md new file mode 100644 index 0000000000..10a7ade076 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskreader_readbatchasync_888788553.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskReader.ReadBatchAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskReader.ReadBatchAsync + +## -description +Asynchronously reads a batch of [UserDataTask](userdatatask.md) objects from the [UserDataTaskStore](userdatataskstore.md). + +## -params + +## -returns +The batch of tasks read from the [UserDataTaskStore](userdatataskstore.md). +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties.md new file mode 100644 index 0000000000..1effd4df6b --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties + +## -description +Represents when and how often a task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_day.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_day.md new file mode 100644 index 0000000000..8c5e73c69f --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_day.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Day +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Day + +## -description +Gets or sets the day on which a task occurs. [Day](userdatataskrecurrenceproperties_day.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx), has a default value of 1, and can be a value from 1 to 31. + +## -property-value +The day on which an appointment occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_daysofweek.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_daysofweek.md new file mode 100644 index 0000000000..f8c0555651 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_daysofweek.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.DaysOfWeek +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.DaysOfWeek + +## -description +Gets or sets a combination of [UserDataTaskDaysOfWeek](userdatataskdaysofweek.md)-typed values for all the days of the week on which a task occurs. + +## -property-value +A combination of [UserDataTaskDaysOfWeek](userdatataskdaysofweek.md)-typed values that are combined by using a bitwise OR operation. The resulting value specifies all the days of the week on which a task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_interval.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_interval.md new file mode 100644 index 0000000000..5468921aed --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_interval.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Interval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Interval + +## -description +Gets or sets the interval between occurrences of a task. [Interval](userdatataskrecurrenceproperties_interval.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx) and has a default value of 1. For daily, the interval is the number of days in between, for weekly, the number of weeks, and so on. + +## -property-value +The interval on which a task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_month.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_month.md new file mode 100644 index 0000000000..65ee84edb5 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_month.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Month +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Month + +## -description +Gets or sets the month on which a task occurs. [Month](userdatataskrecurrenceproperties_month.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx), has a default value of 1, and can be a value from 1 to 12. + +## -property-value +The month on which a task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_occurrences.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_occurrences.md new file mode 100644 index 0000000000..2827fda304 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_occurrences.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Occurrences +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Occurrences + +## -description +Gets or sets the number of times a task recurs. [Occurrences](userdatataskrecurrenceproperties_occurrences.md) is of type [IReference(UInt32)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Occurrences](userdatataskrecurrenceproperties_occurrences.md) is mutually exclusive with [Until](userdatataskrecurrenceproperties_until.md). + +## -property-value +The number of times a task recurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_unit.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_unit.md new file mode 100644 index 0000000000..0d240b89e8 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_unit.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Unit +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Unit + +## -description +Gets or sets a [UserDataTaskRecurrenceUnit](userdatataskrecurrenceunit.md)-typed value that indicates the frequency for which the task occurs. + +## -property-value +A [UserDataTaskRecurrenceUnit](userdatataskrecurrenceunit.md)-typed value that indicates the frequency for which the task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_until.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_until.md new file mode 100644 index 0000000000..be4d28d88d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_until.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Until +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.Until + +## -description +Gets or sets the date and time until which a task is valid. [Until](userdatataskrecurrenceproperties_until.md) is of type [IReference(DateTime)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Until](userdatataskrecurrenceproperties_until.md) is mutually exclusive with [Occurrences](userdatataskrecurrenceproperties_occurrences.md). + +## -property-value +The date and time until which a task is valid. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_userdatataskrecurrenceproperties_1221375020.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_userdatataskrecurrenceproperties_1221375020.md new file mode 100644 index 0000000000..aaa067bede --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_userdatataskrecurrenceproperties_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.UserDataTaskRecurrenceProperties + +## -description +Initializes a new instance of the [UserDataTaskRecurrenceProperties](userdatataskrecurrenceproperties.md) class. + +## -params + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_weekofmonth.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_weekofmonth.md new file mode 100644 index 0000000000..91a2d4b1a2 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceproperties_weekofmonth.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.WeekOfMonth +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceProperties.WeekOfMonth + +## -description +Gets or sets a [UserDataTaskWeekOfMonth](userdatataskweekofmonth.md)-typed value that indicates the week of the month for which the task occurs. The first week is the default. + +## -property-value + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskrecurrenceunit.md b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceunit.md new file mode 100644 index 0000000000..629310c32e --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskrecurrenceunit.md @@ -0,0 +1,46 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceUnit +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRecurrenceUnit + +## -description +Specifies the frequency for which a task occurs. + +## -enum-fields + +## -field YearlyOnDay:5 +Task occurs yearly on a particular day of the year. + +## -field Yearly:4 +Task occurs yearly. + +## -field Weekly:1 +Task occurs weekly. + +## -field MonthlyOnDay:3 +Task occurs monthly on a particular day of the month. + +## -field Monthly:2 +Task occurs monthly. + +## -field Daily:0 +Task occurs daily. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties.md b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties.md new file mode 100644 index 0000000000..7010a402c7 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties + +## -description +Represents how often a task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_interval.md b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_interval.md new file mode 100644 index 0000000000..c95bdbaa54 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_interval.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Interval +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Interval + +## -description +Gets or sets the interval between occurrences of a task. [Interval](userdatataskregenerationproperties_interval.md) is of type [UInt32](https://msdn.microsoft.com/library/system.uint32.aspx) and has a default value of 1. For daily, the interval is the number of days in between, for weekly, the number of weeks, and so on. + +## -property-value +The interval on which a task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_occurrences.md b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_occurrences.md new file mode 100644 index 0000000000..496b85af5e --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_occurrences.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Occurrences +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Occurrences + +## -description +Gets or sets the number of times a task recurs. [Occurrences](userdatataskregenerationproperties_occurrences.md) is of type [IReference(UInt32)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Occurrences](userdatataskregenerationproperties_occurrences.md) is mutually exclusive with [Until](userdatataskregenerationproperties_until.md). + +## -property-value +The number of times a task recurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_unit.md b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_unit.md new file mode 100644 index 0000000000..7ccf4e8b5a --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_unit.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Unit +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Unit + +## -description +Gets or sets a [UserDataTaskRecurrenceUnit](userdatataskregenerationunit.md)-typed value that indicates the frequency for which the task occurs. + +## -property-value +A [UserDataTaskRecurrenceUnit](userdatataskregenerationunit.md)-typed value that indicates the frequency for which the task occurs. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_until.md b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_until.md new file mode 100644 index 0000000000..5bb6971d49 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_until.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Until +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.Until + +## -description +Gets or sets the date and time until which a task is valid. [Until](userdatataskregenerationproperties_until.md) is of type [IReference(DateTime)](../windows.foundation/ireference_1.md) and is **NULL** by default. [Until](userdatataskregenerationproperties_until.md) is mutually exclusive with [Occurrences](userdatataskregenerationproperties_occurrences.md). + +## -property-value +The date and time until which a task is valid. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_userdatataskregenerationproperties_1221375020.md b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_userdatataskregenerationproperties_1221375020.md new file mode 100644 index 0000000000..427a5559a7 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskregenerationproperties_userdatataskregenerationproperties_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.#ctor +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationProperties.UserDataTaskRegenerationProperties + +## -description +Initializes a new instance of the [UserDataTaskRegenerationProperties](userdatataskregenerationproperties.md) class. + +## -params + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskregenerationunit.md b/windows.applicationmodel.userdatatasks/userdatataskregenerationunit.md new file mode 100644 index 0000000000..45dbd8ecd8 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskregenerationunit.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationUnit +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskRegenerationUnit + +## -description +Specifies the frequency for which a task occurs. + +## -enum-fields + +## -field Yearly:4 +Task occurs yearly. + +## -field Weekly:1 +Task occurs weekly. + +## -field Monthly:2 +Task occurs monthly. + +## -field Daily:0 +Task occurs daily. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatatasksensitivity.md b/windows.applicationmodel.userdatatasks/userdatatasksensitivity.md new file mode 100644 index 0000000000..338c48176e --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatatasksensitivity.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskSensitivity +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskSensitivity + +## -description +Specifies the sensitivity of a task. + +## -enum-fields + +## -field Public:0 +The task is publicly available to view. + +## -field Private:1 +The task is private and can't be viewed publicly. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskstore.md b/windows.applicationmodel.userdatatasks/userdatataskstore.md new file mode 100644 index 0000000000..eeeb9df6a1 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskstore.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskStore +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskStore + +## -description +Represents a database that contains tasks. + +## -remarks +To get a [UserDataTaskStore](userdatataskstore.md) object, call the static utility method [UserDataTaskManager.RequestStoreAsync](userdatataskmanager_requeststoreasync_1330322877.md). + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskstore_createlistasync_1133122101.md b/windows.applicationmodel.userdatatasks/userdatataskstore_createlistasync_1133122101.md new file mode 100644 index 0000000000..b49ddde43d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskstore_createlistasync_1133122101.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.CreateListAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.CreateListAsync + +## -description +Asynchronously creates a [UserDataTaskList](userdatatasklist.md) with the specified name. + +## -params + +## -param name +A name for the new [UserDataTaskList](userdatatasklist.md). + +## -returns +The newly created [UserDataTaskList](userdatatasklist.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskstore_createlistasync_259399563.md b/windows.applicationmodel.userdatatasks/userdatataskstore_createlistasync_259399563.md new file mode 100644 index 0000000000..309196705c --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskstore_createlistasync_259399563.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.CreateListAsync(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.CreateListAsync + +## -description +Asynchronously creates a [UserDataTaskList](userdatatasklist.md) with the specified name. + +## -params + +## -param name +A name for the new [UserDataTaskList](userdatatasklist.md). + +## -param userDataAccountId +The ID for the [UserDataAccount](../windows.applicationmodel.userdataaccounts/userdataaccount.md) to use when creating the [UserDataTaskList](userdatatasklist.md). + +## -returns + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskstore_findlistsasync_611054552.md b/windows.applicationmodel.userdatatasks/userdatataskstore_findlistsasync_611054552.md new file mode 100644 index 0000000000..b7a36c8545 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskstore_findlistsasync_611054552.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.FindListsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.FindListsAsync + +## -description +Asynchronously returns the list of [UserDataTaskList](userdatatasklist.md) objects. + +## -params + +## -returns +The list of [UserDataTaskList](userdatatasklist.md) objects. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskstore_getlistasync_768709224.md b/windows.applicationmodel.userdatatasks/userdatataskstore_getlistasync_768709224.md new file mode 100644 index 0000000000..6032944630 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskstore_getlistasync_768709224.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.GetListAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskStore.GetListAsync + +## -description +Asynchronously gets the [UserDataTaskList](userdatatasklist.md) with the specified ID. + +## -params + +## -param taskListId +The ID of the [UserDataTaskList](userdatatasklist.md) to retrieve. + +## -returns +The [UserDataTaskList](userdatatasklist.md) with the specified ID or null if the list is not found. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskstoreaccesstype.md b/windows.applicationmodel.userdatatasks/userdatataskstoreaccesstype.md new file mode 100644 index 0000000000..9a05f1b00b --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskstoreaccesstype.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskStoreAccessType +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskStoreAccessType + +## -description +Defines the type of access the app has to the [UserDataTaskStore](userdatataskstore.md). + +## -enum-fields + +## -field AppTasksReadWrite:0 +Read and write tasks that belong to the app only. + +## -field AllTasksLimitedReadWrite:1 +Read and write access limited to operations available in the [UserDataTaskListLimitedWriteOperations](userdatatasklistlimitedwriteoperations.md) class. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/userdatataskweekofmonth.md b/windows.applicationmodel.userdatatasks/userdatataskweekofmonth.md new file mode 100644 index 0000000000..590e25b2d6 --- /dev/null +++ b/windows.applicationmodel.userdatatasks/userdatataskweekofmonth.md @@ -0,0 +1,42 @@ +--- +-api-id: T:Windows.ApplicationModel.UserDataTasks.UserDataTaskWeekOfMonth +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.UserDataTasks.UserDataTaskWeekOfMonth + +## -description +Specifies the week of the month for which the task occurs. + +## -enum-fields + +## -field Third:2 +The task occurs on the third week of the month. + +## -field Second:1 +The task occurs on the second week of the month. + +## -field Last:4 +The appointment occurs on the last week of the month. + +## -field Fourth:3 +The task occurs on the fourth week of the month. + +## -field First:0 +The task occurs on the first week of the month. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.userdatatasks/windows_applicationmodel_userdatatasks.md b/windows.applicationmodel.userdatatasks/windows_applicationmodel_userdatatasks.md new file mode 100644 index 0000000000..5f0f440d1d --- /dev/null +++ b/windows.applicationmodel.userdatatasks/windows_applicationmodel_userdatatasks.md @@ -0,0 +1,19 @@ +--- +-api-id: N:Windows.ApplicationModel.UserDataTasks +-api-type: winrt namespace +--- + + + +# Windows.ApplicationModel.UserDataTasks + +## -description +Enables apps to select and acquire info about tasks. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager.md b/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager.md index e0ad342f57..34fc399bc2 100644 --- a/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager.md +++ b/windows.applicationmodel.voicecommands/voicecommanddefinitionmanager.md @@ -10,10 +10,9 @@ public class VoiceCommandDefinitionManager # Windows.ApplicationModel.VoiceCommands.VoiceCommandDefinitionManager ## -description -A static class that enables installing command sets from a [](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) file, and getting installed command sets. +A static class that enables registering and using command sets from a [Voice Command Data (VCD)](../windows.media.speechrecognition/voice_command_elements_and_attributes.md) file. ## -remarks - ## -examples diff --git a/windows.applicationmodel/appdisplayinfo_description.md b/windows.applicationmodel/appdisplayinfo_description.md index 40611c4f9b..c94fbe7f03 100644 --- a/windows.applicationmodel/appdisplayinfo_description.md +++ b/windows.applicationmodel/appdisplayinfo_description.md @@ -13,7 +13,7 @@ public string Description { get; } Gets the application's description. ## -property-value -The description of the application as defined in the package manifest (Package.appxmanifest). +The description of the application as defined in the package manifest (Package.appxmanifest). ## -remarks diff --git a/windows.applicationmodel/package_getcontentgroupasync_706196995.md b/windows.applicationmodel/package_getcontentgroupasync_706196995.md new file mode 100644 index 0000000000..d8f36658e1 --- /dev/null +++ b/windows.applicationmodel/package_getcontentgroupasync_706196995.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.ApplicationModel.Package.GetContentGroupAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.GetContentGroupAsync + +## -description +Provides information about the package content group such as its state, name, whether it is required, and so on. + +## -params + +## -param name +The name of the content group to get. + +## -returns +A [PackageContentGroup](packagecontentgroup.md) that contains information such as whether the content group is required, its state, the package associated with the content group, and so on. +Returns **Null** if the named content group is not part of this package. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/package_getcontentgroupsasync_730031759.md b/windows.applicationmodel/package_getcontentgroupsasync_730031759.md new file mode 100644 index 0000000000..9cef789c9c --- /dev/null +++ b/windows.applicationmodel/package_getcontentgroupsasync_730031759.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.ApplicationModel.Package.GetContentGroupsAsync +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.GetContentGroupsAsync + +## -description +Provides information about all of the package content groups in the app and their state, name, whether they are required, and so on. + +## -returns +A list of package content group objects. + +## -remarks +The returned collection may be empty if the package does not contain any content groups. + +## -see-also + +## -examples diff --git a/windows.applicationmodel/package_getthumbnailtoken_1529848989.md b/windows.applicationmodel/package_getthumbnailtoken_1529848989.md index 68f1f4c175..4a4239076e 100644 --- a/windows.applicationmodel/package_getthumbnailtoken_1529848989.md +++ b/windows.applicationmodel/package_getthumbnailtoken_1529848989.md @@ -1,23 +1,23 @@ ---- --api-id: M:Windows.ApplicationModel.Package.GetThumbnailToken --api-type: winrt method ---- - - - -# Windows.ApplicationModel.Package.GetThumbnailToken - -## -description -Windows Phone only. Returns a token that can be used to retrieve the thumbnail image associated with this application package. - -## -returns -A token that can be used to retrieve the thumbnail image associated with this application package. - -## -remarks -Use the [GetSharedFileName](XREF:TODO:wp_storage_shared.sharedstorageaccessmanager_getsharedfilename) method passing the token returned by this method to retrieve the thumbnail image associated with this application package. - -## -examples - -## -see-also +--- +-api-id: M:Windows.ApplicationModel.Package.GetThumbnailToken +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.GetThumbnailToken + +## -description +Windows Phone only. Returns a token that can be used to retrieve the thumbnail image associated with this application package. + +## -returns +A token that can be used to retrieve the thumbnail image associated with this application package. + +## -remarks +Use the [GetSharedFileName](http://msdn.microsoft.com/library/24fdc8cf-ded4-49f5-b73a-b79731afafcd) method passing the token returned by this method to retrieve the thumbnail image associated with this application package. + +## -examples + +## -see-also diff --git a/windows.applicationmodel/package_setinuseasync_1792768214.md b/windows.applicationmodel/package_setinuseasync_1792768214.md new file mode 100644 index 0000000000..ddc01c54eb --- /dev/null +++ b/windows.applicationmodel/package_setinuseasync_1792768214.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.ApplicationModel.Package.SetInUseAsync(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.SetInUseAsync + +## -description +Sets whether the package is in use or not. + +## -params + +## -param inUse +**True** to specify that the package is in use; **false** otherwise. + +## -returns +**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. + +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**. + +## -see-also + +## -examples diff --git a/windows.applicationmodel/package_stagecontentgroupsasync_1686225474.md b/windows.applicationmodel/package_stagecontentgroupsasync_1686225474.md new file mode 100644 index 0000000000..9871c4e96f --- /dev/null +++ b/windows.applicationmodel/package_stagecontentgroupsasync_1686225474.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.ApplicationModel.Package.StageContentGroupsAsync(Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.StageContentGroupsAsync + +## -description +Put the packages in the specified content groups into the staging queue. + +## -params + +## -param names +The names of the content groups to stage. + +## -returns +A list of [PackageContentGroup](packagecontentgroup.md) objects for each content group specified by the _names_ parameter. + +## -remarks +This function completes when all requested groups are staged. The returned list may contain a null element if the named group in that position does not exist. Use [PackageCatalog.PackageContentGroupStaging](packagecatalog_packagecontentgroupstaging.md) to observe staging progress. + +Be sure to check [PackageContentGroup.State](packagecontentgroupstate.md) to verify that the group was successfully staged. Referencing files in a group that is not fully staged may result in unexpected application behavior. Content groups return to the **PackageContentGroupState.NotStaged** state if the staging operation cannot be completed. + +## -see-also + +## -examples diff --git a/windows.applicationmodel/package_stagecontentgroupsasync_2032077382.md b/windows.applicationmodel/package_stagecontentgroupsasync_2032077382.md new file mode 100644 index 0000000000..7df3f856eb --- /dev/null +++ b/windows.applicationmodel/package_stagecontentgroupsasync_2032077382.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.ApplicationModel.Package.StageContentGroupsAsync(Windows.Foundation.Collections.IIterable{System.String},System.Boolean) +-api-type: winrt method +--- + + + +# Windows.ApplicationModel.Package.StageContentGroupsAsync + +## -description +Put the packages in the specified content groups into the staging queue; optionally placing the content groups at the head of the queue. + +## -params + +## -param names +The names of the content groups to stage. + +## -param moveToHeadOfQueue +**True** to move the content group to the head of the staging queue; **false** otherwise. + +## -returns +A list of [PackageContentGroup](packagecontentgroup.md) objects for each content group specified by the _names_ parameter. + +## -remarks +This function completes when all requested groups are staged. The returned list may contain a null element if the named group in that position does not exist. Use [PackageCatalog.PackageContentGroupStaging](packagecatalog_packagecontentgroupstaging.md) to observe staging progress. + +Be sure to check [PackageContentGroup.State](packagecontentgroupstate.md) to verify that the group was successfully staged. Referencing files in a group that is not fully staged may result in unexpected application behavior. Content groups return to the **PackageContentGroupState.NotStaged** state if the staging operation cannot be completed. + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md b/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md index 456e7dd934..2f0b870aee 100644 --- a/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md +++ b/windows.applicationmodel/packagecatalog_addoptionalpackageasync_922156115.md @@ -7,26 +7,6 @@ public IAsyncOperation PackageCatalog.AddOptionalPackageAsync(String optionalPackageFamilyName) --> -<<<<<<< HEAD -# Windows.ApplicationModel.PackageCatalog.AddOptionalPackageAsync - -## -description -Adds an optional package to the package catalog. - -## -params - -## -param optionalPackageFamilyName -The package family of the optional package to add to the catalog. - -## -returns -The result of starting the async add optional package operation. - -## -remarks - -## -see-also - -## -examples -======= # Windows.ApplicationModel.PackageCatalog.AddOptionalPackageAsync ## -description @@ -45,4 +25,3 @@ The result of adding the package. ## -see-also ## -examples ->>>>>>> 31eb39f25bc6580626006acd888ad065ccab4aed diff --git a/windows.applicationmodel/packagecatalog_packagecontentgroupstaging.md b/windows.applicationmodel/packagecatalog_packagecontentgroupstaging.md new file mode 100644 index 0000000000..fe977de13a --- /dev/null +++ b/windows.applicationmodel/packagecatalog_packagecontentgroupstaging.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.ApplicationModel.PackageCatalog.PackageContentGroupStaging +-api-type: winrt event +--- + + + +# Windows.ApplicationModel.PackageCatalog.PackageContentGroupStaging + +## -description +Event that is fired when a package content group starts staging. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecatalogaddoptionalpackageresult.md b/windows.applicationmodel/packagecatalogaddoptionalpackageresult.md index 99b41d1a36..e921c7fb17 100644 --- a/windows.applicationmodel/packagecatalogaddoptionalpackageresult.md +++ b/windows.applicationmodel/packagecatalogaddoptionalpackageresult.md @@ -7,19 +7,6 @@ public class PackageCatalogAddOptionalPackageResult --> -<<<<<<< HEAD -# Windows.ApplicationModel.PackageCatalogAddOptionalPackageResult - -## -description -Provides information about the result of adding an optional package to the package catalog. - -## -remarks - -## -see-also -[PackageCatalog.AddOoptionalPackageAsync](packagecatalog_addoptionalpackageasync_922156115.md) - -## -examples -======= # Windows.ApplicationModel.PackageCatalogAddOptionalPackageResult ## -description @@ -31,4 +18,3 @@ Provides information about the result of adding an optional package to the packa [PackageCatalog.AddOoptionalPackageAsync()](packagecatalog_addoptionalpackageasync_922156115.md) ## -examples ->>>>>>> 31eb39f25bc6580626006acd888ad065ccab4aed diff --git a/windows.applicationmodel/packagecatalogaddoptionalpackageresult_extendederror.md b/windows.applicationmodel/packagecatalogaddoptionalpackageresult_extendederror.md new file mode 100644 index 0000000000..01e2670fb5 --- /dev/null +++ b/windows.applicationmodel/packagecatalogaddoptionalpackageresult_extendederror.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageCatalogAddOptionalPackageResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageCatalogAddOptionalPackageResult.ExtendedError + +## -description +Provides error information about the attempt to add an optional package to the catalog. + +## -property-value +The exception if one occurred while adding the optional package; **null** otherwise. + +## -remarks + +## -see-also +[PackageCatalog.AddOoptionalPackageAsync()](packagecatalog_addoptionalpackageasync_922156115.md) diff --git a/windows.applicationmodel/packagecatalogaddoptionalpackageresult_package.md b/windows.applicationmodel/packagecatalogaddoptionalpackageresult_package.md new file mode 100644 index 0000000000..a548253d25 --- /dev/null +++ b/windows.applicationmodel/packagecatalogaddoptionalpackageresult_package.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageCatalogAddOptionalPackageResult.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageCatalogAddOptionalPackageResult.Package + +## -description +Get the optional package that was added to the package catalog. + +## -property-value +The optional package or **null** if the package could not be added. + +## -remarks + +## -see-also +[PackageCatalog.AddOoptionalPackageAsync()](packagecatalog_addoptionalpackageasync_922156115.md) diff --git a/windows.applicationmodel/packagecontentgroup.md b/windows.applicationmodel/packagecontentgroup.md new file mode 100644 index 0000000000..910f6f7ca8 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroup.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.ApplicationModel.PackageContentGroup +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.PackageContentGroup + +## -description +Provides information about a package content group. + +## -remarks +A package content group allows you to segment a large app into different groups. A group may be automatic which means it can be downloaded in the background or on-demand. A group may be required which means that it will be downloaded during app install. + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroup_isrequired.md b/windows.applicationmodel/packagecontentgroup_isrequired.md new file mode 100644 index 0000000000..331b30a283 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroup_isrequired.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroup.IsRequired +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroup.IsRequired + +## -description +Indicates whether this package content group is required or automatic. + +## -property-value +**True** indicates that the content group is required; **false** otherwise. + +## -remarks +Required packages are downloaded during app install. Automatic packages are downloaded on demand. There can only be one required packaged content group per app. + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroup_name.md b/windows.applicationmodel/packagecontentgroup_name.md new file mode 100644 index 0000000000..50134e1375 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroup_name.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroup.Name +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroup.Name + +## -description +Gets the name of this package content group. + +## -property-value +The content group name. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroup_package.md b/windows.applicationmodel/packagecontentgroup_package.md new file mode 100644 index 0000000000..4e008ffcfa --- /dev/null +++ b/windows.applicationmodel/packagecontentgroup_package.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroup.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroup.Package + +## -description +Gets the package for this content group. + +## -property-value +The package for this content group. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroup_requiredgroupname.md b/windows.applicationmodel/packagecontentgroup_requiredgroupname.md new file mode 100644 index 0000000000..2e9eb0b957 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroup_requiredgroupname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroup.RequiredGroupName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroup.RequiredGroupName + +## -description +Gets the name of the required content group. + +## -property-value +The name of the required content group. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroup_state.md b/windows.applicationmodel/packagecontentgroup_state.md new file mode 100644 index 0000000000..82c55a6721 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroup_state.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroup.State +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroup.State + +## -description +Gets the state of the package content group. + +## -property-value +A value describing the package content group state. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs.md b/windows.applicationmodel/packagecontentgroupstagingeventargs.md new file mode 100644 index 0000000000..82db0082c7 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.ApplicationModel.PackageContentGroupStagingEventArgs +-api-type: winrt class +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs + +## -description +Provides information about the package content group that is being staged. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs_activityid.md b/windows.applicationmodel/packagecontentgroupstagingeventargs_activityid.md new file mode 100644 index 0000000000..23e96945c7 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs_activityid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroupStagingEventArgs.ActivityId +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs.ActivityId + +## -description +Gets the id of the content group staging operation. + +## -property-value +A unique value that an app can use to correlate events that relate to a particular content group staging operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs_contentgroupname.md b/windows.applicationmodel/packagecontentgroupstagingeventargs_contentgroupname.md new file mode 100644 index 0000000000..36bba7eacf --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs_contentgroupname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroupStagingEventArgs.ContentGroupName +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs.ContentGroupName + +## -description +Gets the name of the content group this is being staged. + +## -property-value +The name of the content group. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs_errorcode.md b/windows.applicationmodel/packagecontentgroupstagingeventargs_errorcode.md new file mode 100644 index 0000000000..15f9127109 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs_errorcode.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroupStagingEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs.ErrorCode + +## -description +Gets the result of the package content group staging operation. + +## -property-value +The result of the package content group staging operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs_iscomplete.md b/windows.applicationmodel/packagecontentgroupstagingeventargs_iscomplete.md new file mode 100644 index 0000000000..b7dcf0e9df --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs_iscomplete.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroupStagingEventArgs.IsComplete +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs.IsComplete + +## -description +Indicates whether the content group is done staging. + +## -property-value +**True** indicates that the content group is done staging; **false**, otherwise. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs_iscontentgrouprequired.md b/windows.applicationmodel/packagecontentgroupstagingeventargs_iscontentgrouprequired.md new file mode 100644 index 0000000000..e79b3795c4 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs_iscontentgrouprequired.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroupStagingEventArgs.IsContentGroupRequired +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs.IsContentGroupRequired + +## -description +Indicates whether the content group is required. + +## -property-value +**True** indicates that the package content group is required; **false**, otherwise. + +## -remarks +Required content groups contain core executable binaries and are downloaded during app install. + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs_package.md b/windows.applicationmodel/packagecontentgroupstagingeventargs_package.md new file mode 100644 index 0000000000..ccab2247ae --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs_package.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroupStagingEventArgs.Package +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs.Package + +## -description +Gets the package that is being staged. + +## -property-value +The package containing the content group being staged. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagecontentgroupstagingeventargs_progress.md b/windows.applicationmodel/packagecontentgroupstagingeventargs_progress.md new file mode 100644 index 0000000000..52006551b9 --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstagingeventargs_progress.md @@ -0,0 +1,16 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageContentGroupStagingEventArgs.Progress +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageContentGroupStagingEventArgs.Progress + +## -description +Gets an approximation of the package content group's staging progress. + +## -property-value +A value in the range of 0 through 100 which represents approximately how far along the content group is in the staging process. diff --git a/windows.applicationmodel/packagecontentgroupstate.md b/windows.applicationmodel/packagecontentgroupstate.md new file mode 100644 index 0000000000..18958cbbfe --- /dev/null +++ b/windows.applicationmodel/packagecontentgroupstate.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.ApplicationModel.PackageContentGroupState +-api-type: winrt enumeration +--- + + + +# Windows.ApplicationModel.PackageContentGroupState + +## -description +Describes the staging state of the package content group. + +## -enum-fields + +## -field Staging:2 +The package group is currently being staged. + +## -field Staged:3 +The package group has been staged. + +## -field NotStaged:0 +The package group has not been staged and is not in the staging queue. + +## -field Queued:1 +The package has not been staged but is in queue of packages to be staged. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.applicationmodel/packagestatus_ispartiallystaged.md b/windows.applicationmodel/packagestatus_ispartiallystaged.md new file mode 100644 index 0000000000..ce6dd42cc7 --- /dev/null +++ b/windows.applicationmodel/packagestatus_ispartiallystaged.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.ApplicationModel.PackageStatus.IsPartiallyStaged +-api-type: winrt property +--- + + + +# Windows.ApplicationModel.PackageStatus.IsPartiallyStaged + +## -description +Get whether the package is partially staged. + +## -property-value +**True** indicates that the package is partially staged; **false**, otherwise. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.alljoyn/alljoynauthenticationmechanism.md b/windows.devices.alljoyn/alljoynauthenticationmechanism.md index 4a47746916..94df986374 100644 --- a/windows.devices.alljoyn/alljoynauthenticationmechanism.md +++ b/windows.devices.alljoyn/alljoynauthenticationmechanism.md @@ -32,6 +32,9 @@ ECDHE_PSK has been deprecated and should no longer be used. ECDHE_ECDSA key exchange. +### -field EcdheSpeke:6 +ECDHE_SPEKE key exchange. + ## -remarks ## -examples @@ -41,3 +44,5 @@ ECDHE_ECDSA key exchange. ## -capabilities allJoyn + + diff --git a/windows.devices.alljoyn/alljoynbusattachment_acceptsessionjoinerrequested.md b/windows.devices.alljoyn/alljoynbusattachment_acceptsessionjoinerrequested.md new file mode 100644 index 0000000000..cb1d1fc7f7 --- /dev/null +++ b/windows.devices.alljoyn/alljoynbusattachment_acceptsessionjoinerrequested.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.AcceptSessionJoinerRequested +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.AcceptSessionJoinerRequested + +## -description +Occurs when a remote AllJoyn endpoint requests to join the bus attachement's session. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_getaboutdataasync_513025028.md b/windows.devices.alljoyn/alljoynbusattachment_getaboutdataasync_513025028.md new file mode 100644 index 0000000000..c512e0329f --- /dev/null +++ b/windows.devices.alljoyn/alljoynbusattachment_getaboutdataasync_513025028.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.GetAboutDataAsync(Windows.Devices.AllJoyn.AllJoynServiceInfo) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.GetAboutDataAsync + +## -description +Gets the About data for a specific AllJoyn endpoint. This method is intended to replace the less intuitive static [AllJoynAboutDataView.GetDataBySessionPortAsync()](alljoynaboutdataview_getdatabysessionportasync_660342083.md). + +## -parameters + +### -param serviceInfo +The AllJoyn endpoint from which to retrieve About data. + +## -returns + +## -remarks + +## -see-also +[GetAboutDataAsync(AllJoynServiceInfo serviceInfo, Language language)](alljoynbusattachment_getaboutdataasync_522145388.md) + +## -examples + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_getaboutdataasync_522145388.md b/windows.devices.alljoyn/alljoynbusattachment_getaboutdataasync_522145388.md new file mode 100644 index 0000000000..01afc0f43c --- /dev/null +++ b/windows.devices.alljoyn/alljoynbusattachment_getaboutdataasync_522145388.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Devices.AllJoyn.AllJoynBusAttachment.GetAboutDataAsync(Windows.Devices.AllJoyn.AllJoynServiceInfo,Windows.Globalization.Language) +-api-type: winrt method +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.GetAboutDataAsync + +## -description +Gets the About data for a specific AllJoyn endpoint in a specific language. This method is intended to replace the less intuitive static [AllJoynAboutDataView.GetDataBySessionPortAsync()](alljoynaboutdataview_getdatabysessionportasync_561097955.md). +## -parameters + +### -param serviceInfo +The AllJoyn endpoint from which to retrieve About data. + +### -param language +The language in which to request About data. If the requested language is not supported, the remote device's default language will be used. + +## -returns + +## -remarks + +## -see-also +[AllJoynBusAttachment.GetAboutDataAsync(AllJoynServiceInfo serviceInfo)](alljoynbusattachment_getaboutdataasync_513025028.md) + +## -examples + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynbusattachment_sessionjoined.md b/windows.devices.alljoyn/alljoynbusattachment_sessionjoined.md new file mode 100644 index 0000000000..e860764958 --- /dev/null +++ b/windows.devices.alljoyn/alljoynbusattachment_sessionjoined.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.Devices.AllJoyn.AllJoynBusAttachment.SessionJoined +-api-type: winrt event +--- + + + +# Windows.Devices.AllJoyn.AllJoynBusAttachment.SessionJoined + +## -description +Occurs when a remote AllJoyn endpoint joins the session of the bus attachment. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +allJoyn \ No newline at end of file diff --git a/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md b/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md index 4fc5cec89b..323f0b46af 100644 --- a/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md +++ b/windows.devices.alljoyn/alljoynserviceinfo_fromidasync_1322863552.md @@ -10,11 +10,11 @@ public Windows.Foundation.IAsyncOperation + +# Windows.Devices.Bluetooth.Background.BluetoothEventTriggeringMode + +## -description +This enumeration represents a Bluetooth backgorund event triggering mode. +## -enum-fields +### -field Serial:0 +The triggering method is serial. + +### -field KeepLatest:2 +The triggering mode is keep latest. + +### -field Batch:1 +The triggering mdoe is batch. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_error.md b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_error.md new file mode 100644 index 0000000000..ba8b37c1e2 --- /dev/null +++ b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_error.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.Error + +## -description +Gets the error status for the trigger. + +## -property-value +Gets the error status for the trigger. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_eventtriggeringmode.md b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_eventtriggeringmode.md new file mode 100644 index 0000000000..9868f4d555 --- /dev/null +++ b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_eventtriggeringmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.EventTriggeringMode +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.EventTriggeringMode + +## -description +Gets the event trigger mode. + +## -property-value +Gets the event trigger mode. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_valuechangedevents.md b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_valuechangedevents.md new file mode 100644 index 0000000000..d839d7695a --- /dev/null +++ b/windows.devices.bluetooth.background/gattcharacteristicnotificationtriggerdetails_valuechangedevents.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.ValueChangedEvents +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattCharacteristicNotificationTriggerDetails.ValueChangedEvents + +## -description +Gets the value changes events for this trigger. + +## -property-value +Gets the value changes events for this trigger. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattserviceproviderconnection.md b/windows.devices.bluetooth.background/gattserviceproviderconnection.md new file mode 100644 index 0000000000..a156c01563 --- /dev/null +++ b/windows.devices.bluetooth.background/gattserviceproviderconnection.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.Background.GattServiceProviderConnection +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.GattServiceProviderConnection + +## -description +This class represents a gatt service provider connection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattserviceproviderconnection_allservices.md b/windows.devices.bluetooth.background/gattserviceproviderconnection_allservices.md new file mode 100644 index 0000000000..58d661dd34 --- /dev/null +++ b/windows.devices.bluetooth.background/gattserviceproviderconnection_allservices.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.AllServices +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.AllServices + +## -description +Gets all the services. + +## -property-value +Gets all the services. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattserviceproviderconnection_service.md b/windows.devices.bluetooth.background/gattserviceproviderconnection_service.md new file mode 100644 index 0000000000..4042d8d50b --- /dev/null +++ b/windows.devices.bluetooth.background/gattserviceproviderconnection_service.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.Service +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.Service + +## -description +Gets the local GATT service. + +## -property-value +Gets the local GATT service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattserviceproviderconnection_start_1587696324.md b/windows.devices.bluetooth.background/gattserviceproviderconnection_start_1587696324.md new file mode 100644 index 0000000000..26e58010b1 --- /dev/null +++ b/windows.devices.bluetooth.background/gattserviceproviderconnection_start_1587696324.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.Start + +## -description +Starts a GATT service provider connection. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattserviceproviderconnection_triggerid.md b/windows.devices.bluetooth.background/gattserviceproviderconnection_triggerid.md new file mode 100644 index 0000000000..051836927f --- /dev/null +++ b/windows.devices.bluetooth.background/gattserviceproviderconnection_triggerid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.TriggerId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattServiceProviderConnection.TriggerId + +## -description +Gets GATT service connection trigger ID. + +## -property-value +Gets GATT service connection trigger ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattserviceprovidertriggerdetails.md b/windows.devices.bluetooth.background/gattserviceprovidertriggerdetails.md new file mode 100644 index 0000000000..edad2f9465 --- /dev/null +++ b/windows.devices.bluetooth.background/gattserviceprovidertriggerdetails.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.Background.GattServiceProviderTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.Background.GattServiceProviderTriggerDetails + +## -description +Provides information about the Bluetooth device that caused this trigger to fire. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.background/gattserviceprovidertriggerdetails_connection.md b/windows.devices.bluetooth.background/gattserviceprovidertriggerdetails_connection.md new file mode 100644 index 0000000000..bc845db410 --- /dev/null +++ b/windows.devices.bluetooth.background/gattserviceprovidertriggerdetails_connection.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.Background.GattServiceProviderTriggerDetails.Connection +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.Background.GattServiceProviderTriggerDetails.Connection + +## -description +Gets the connection that triggered the event. + +## -property-value +Gets the connection that triggered the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsasync_1141906880.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsasync_1141906880.md new file mode 100644 index 0000000000..de4f5d92d1 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsasync_1141906880.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsAsync + +## -description +Returns the descriptors with the specified cache mode for this GattCharacteristic instance. + +## -parameters + +### -param cacheMode +The cache mode. + +## -returns +An asynchronous operation that completes with the descriptors. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsasync_255188005.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsasync_255188005.md new file mode 100644 index 0000000000..c11f82332b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsasync_255188005.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsAsync + +## -description +Returns the descriptors for this GattCharacteristic instance. + +## -parameters + +## -returns +An asynchronous operation that completes with the descriptors for this GattCharacteristic instance. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsforuuidasync_1770331452.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsforuuidasync_1770331452.md new file mode 100644 index 0000000000..a81104e933 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsforuuidasync_1770331452.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsForUuidAsync(System.Guid,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsForUuidAsync + +## -description +Returns the descriptors whose UUIDs match descriptorUuid with the specified cacheMode. + +## -parameters + +### -param descriptorUuid +The UUID for the descriptors to be retrieved. + +### -param cacheMode +The cache mode. + +## -returns +Returns an asynchronous operation that completes with the descriptors for the descriptorUuid. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsforuuidasync_3236106.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsforuuidasync_3236106.md new file mode 100644 index 0000000000..62ad1d0dc3 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_getdescriptorsforuuidasync_3236106.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsForUuidAsync(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.GetDescriptorsForUuidAsync + +## -description +Returns the descriptors whose UUIDs match descriptorUuid. + +## -parameters + +### -param descriptorUuid +The UUID for the descriptors to be retrieved. + +## -returns +An asynchronous operation that completes with the descriptors whose UUIDs match descriptorUuid. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writeclientcharacteristicconfigurationdescriptorwithresultasync_2005787286.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writeclientcharacteristicconfigurationdescriptorwithresultasync_2005787286.md new file mode 100644 index 0000000000..4c0b44b844 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writeclientcharacteristicconfigurationdescriptorwithresultasync_2005787286.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteClientCharacteristicConfigurationDescriptorWithResultAsync(Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientCharacteristicConfigurationDescriptorValue) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteClientCharacteristicConfigurationDescriptorWithResultAsync + +## -description +Writes the ClientCharacteristicConfigurationDescriptor to the Bluetooth LE device, and if the value to be written represents an indication or a notification and a ValueChanged event handler is registered, enables receiving ValueChanged events from the device. + +## -parameters + +### -param clientCharacteristicConfigurationDescriptorValue +Specifies a new value for the ClientCharacteristicConfigurationDescriptor of this Characteristic object. + +## -returns +Returns an asynchronous operation that completes with a GattWriteResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevaluewithresultasync_2074671654.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevaluewithresultasync_2074671654.md new file mode 100644 index 0000000000..580616b89d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevaluewithresultasync_2074671654.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueWithResultAsync(Windows.Storage.Streams.IBuffer,Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteOption) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueWithResultAsync + +## -description +Performs a Characteristic Value write to a Bluetooth LE device. + +## -parameters +### -param value +A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. + +### -param writeOption +Specifies what type of GATT write should be performed. + +## -returns +An asynchronous operation that completes with a GattWriteResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevaluewithresultasync_525802224.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevaluewithresultasync_525802224.md new file mode 100644 index 0000000000..4cb5c5d5bd --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevaluewithresultasync_525802224.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueWithResultAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristic.WriteValueWithResultAsync + +## -description +Performs a Characteristic Value write to a Bluetooth LE device. + +## -parameters +### -param value +A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. + +## -returns +An asynchronous operation that completes with a GattWriteResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult.md new file mode 100644 index 0000000000..30f76239b3 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult + +## -description +Contains the result of [**GetCharacteristicsForUuidAsync**](../../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsforuuidasync_1022371095.md) and [**GetCharacteristicsAsync**](../../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsasync_652132649.md) + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_characteristics.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_characteristics.md new file mode 100644 index 0000000000..f2961c9cc7 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_characteristics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult.Characteristics +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult.Characteristics + +## -description +Gets the characterisitics. + +## -property-value +The characteristics. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_protocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_protocolerror.md new file mode 100644 index 0000000000..928cd14093 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_protocolerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult.ProtocolError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult.ProtocolError + +## -description +Gets the protocol error, if there is one. + +## -property-value +The protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_status.md b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_status.md new file mode 100644 index 0000000000..4e158a513e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattcharacteristicsresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattCharacteristicsResult.Status + +## -description +Gets the status. + +## -property-value +The status. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult.md b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult.md new file mode 100644 index 0000000000..cbeda20986 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult + +## -description +The result of [NotifyValueAsync](gattlocalcharacteristic_notifyvalueasync_483273373.md) + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_protocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_protocolerror.md new file mode 100644 index 0000000000..a90f07e8b5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_protocolerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.ProtocolError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.ProtocolError + +## -description +Gets the protocol error. + +## -property-value +The protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_status.md b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_status.md new file mode 100644 index 0000000000..9f18337b43 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.Status + +## -description +Gets the GATT communication status. + +## -property-value +The GATT communication status. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_subscribedclient.md b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_subscribedclient.md new file mode 100644 index 0000000000..c87eed2160 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattclientnotificationresult_subscribedclient.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.SubscribedClient +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattClientNotificationResult.SubscribedClient + +## -description +Gets the subscribed client. + +## -property-value +The subscribed client. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattcommunicationstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattcommunicationstatus.md index 1f7ee8fda8..5dda44ee40 100644 --- a/windows.devices.bluetooth.genericattributeprofile/gattcommunicationstatus.md +++ b/windows.devices.bluetooth.genericattributeprofile/gattcommunicationstatus.md @@ -21,9 +21,15 @@ The operation completed successfully. ### -field Unreachable:1 No communication can be performed with the device, at this time. +### -field AccessDenied:3 +Access is denied. + +### -field ProtocolError:2 +There was a GATT communication protocol error. ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_writevaluewithresultasync_525802224.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_writevaluewithresultasync_525802224.md new file mode 100644 index 0000000000..76ec3877bd --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptor_writevaluewithresultasync_525802224.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.WriteValueWithResultAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptor.WriteValueWithResultAsync + +## -description +Performs a Descriptor Value write to a Bluetooth LE device. + +## -parameters + +### -param value +A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. + +## -returns +An asynchronous operation that completes with the result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult.md new file mode 100644 index 0000000000..f4b61a50fa --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult + +## -description +The result of descriptor operations like [GattCharacteristic.GetDescriptorsAsync](gattdescriptor_writevaluewithresultasync_525802224.md) +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_descriptors.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_descriptors.md new file mode 100644 index 0000000000..2c19cf401a --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_descriptors.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult.Descriptors +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult.Descriptors + +## -description +Gets a vector of the GATT descriptors. + +## -property-value +A vector of the GATT descriptors. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_protocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_protocolerror.md new file mode 100644 index 0000000000..8fe8f20db9 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_protocolerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult.ProtocolError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult.ProtocolError + +## -description +Gets the GATT protocol error. + +## -property-value +The GATT protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_status.md b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_status.md new file mode 100644 index 0000000000..ed9e75fa77 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdescriptorsresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDescriptorsResult.Status + +## -description +Gets the status of the operation. + +## -property-value +The status of the operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_deviceaccessinformation.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_deviceaccessinformation.md new file mode 100644 index 0000000000..a7e02980fa --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_deviceaccessinformation.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.DeviceAccessInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.DeviceAccessInformation + +## -description +Gets the device access information associated with the current [GattDeviceService](gattdeviceservice.md) object. + +## -property-value +The device access information associated with the current [GattDeviceService](gattdeviceservice.md) object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_fromidasync_116749634.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_fromidasync_116749634.md new file mode 100644 index 0000000000..3c1828c0f5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_fromidasync_116749634.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.FromIdAsync(System.String,Windows.Devices.Bluetooth.GenericAttributeProfile.GattSharingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.FromIdAsync + +## -description +Instantiates a new GattDeviceService object from the device ID. + +## -parameters + +### -param deviceId +The GATT device ID. + +### -param sharingMode +The sharing mode of the GATT device. + +## -returns +An asynchronous operation that completes with a GattDeviceService object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsasync_1845166286.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsasync_1845166286.md new file mode 100644 index 0000000000..f6b4e733cc --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsasync_1845166286.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsAsync + +## -description +Gets the characterisitics that are part of this GattDeviceService instance. + +## -parameters + +### -param cacheMode +The cache mode. + +## -returns +An asynchronous operation that completes with a GattCharacteristicsResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsasync_652132649.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsasync_652132649.md new file mode 100644 index 0000000000..acc1c4040a --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsasync_652132649.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsAsync + +## -description +Gets the characterisitics that are part of this GattDeviceService instance. + +## -parameters + +## -returns +An asynchronous operation that completes with a GattCharacteristicsResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsforuuidasync_1022371095.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsforuuidasync_1022371095.md new file mode 100644 index 0000000000..53645d7b77 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsforuuidasync_1022371095.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsForUuidAsync(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsForUuidAsync + +## -description +Gets the characterisitics that are part of this GattDeviceService instance and associated with the characteristicUuid. + +## -parameters + +### -param characteristicUuid +The UUID for the characteristics to be retrieved. + +## -returns +An asynchronous operation that completes with a GattCharacteristicsResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsforuuidasync_1430542627.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsforuuidasync_1430542627.md new file mode 100644 index 0000000000..6aa544c1fb --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getcharacteristicsforuuidasync_1430542627.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsForUuidAsync(System.Guid,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetCharacteristicsForUuidAsync + +## -description +Gets the characterisitics that are part of this GattDeviceService instance and associated with the characteristicUuid. + +## -parameters + +### -param characteristicUuid +The UUID for the characteristics to be retrieved. + +### -param cacheMode +The cache mode. + +## -returns +An asynchronous operation that completes with a GattCharacteristicsResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceid_1553892458.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceid_1553892458.md new file mode 100644 index 0000000000..cf94f1a42e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceid_1553892458.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceId(Windows.Devices.Bluetooth.BluetoothDeviceId,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceId + +## -description +Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a BluetoothDeviceId. + +## -parameters + +### -param bluetoothDeviceId +The bluetooth device ID. + +### -param cacheMode +The cache mode. + +## -returns +A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceid_892008544.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceid_892008544.md new file mode 100644 index 0000000000..dce8436168 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceid_892008544.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceId(Windows.Devices.Bluetooth.BluetoothDeviceId) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceId + +## -description +Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a BluetoothDeviceId. + +## -parameters + +### -param bluetoothDeviceId +The bluetooth device ID. + +## -returns +A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceidanduuid_1515623822.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceidanduuid_1515623822.md new file mode 100644 index 0000000000..641756113b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceidanduuid_1515623822.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceIdAndUuid(Windows.Devices.Bluetooth.BluetoothDeviceId,System.Guid,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceIdAndUuid + +## -description +Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a BluetoothDeviceId and serviceUuid. + +## -parameters + +### -param bluetoothDeviceId +The bluetooth device ID. + +### -param serviceUuid +The GATT service ID. + +### -param cacheMode +The cache mode. + +## -returns +A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceidanduuid_1992397338.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceidanduuid_1992397338.md new file mode 100644 index 0000000000..e4ee7c699c --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getdeviceselectorforbluetoothdeviceidanduuid_1992397338.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceIdAndUuid(Windows.Devices.Bluetooth.BluetoothDeviceId,System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetDeviceSelectorForBluetoothDeviceIdAndUuid + +## -description +Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, from a BluetoothDeviceId and serviceUuid. + +## -parameters + +### -param bluetoothDeviceId +The bluetooth device ID. + +### -param serviceUuid +The GATT service ID. + +## -returns +A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesasync_1443434351.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesasync_1443434351.md new file mode 100644 index 0000000000..49325690a8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesasync_1443434351.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesAsync + +## -description +Gets the included services that are associated with this GattDeviceService instance. + +## -parameters + +### -param cacheMode +The cache mode. + +## -returns +An asynchronous operation that completes with a GattDeviceServicesResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesasync_489475724.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesasync_489475724.md new file mode 100644 index 0000000000..16d3de2793 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesasync_489475724.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesAsync + +## -description +Gets the included services that are associated with this GattDeviceService instance. + +## -parameters + +## -returns +An asynchronous operation that completes with a GattDeviceServicesResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_1171557063.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_1171557063.md new file mode 100644 index 0000000000..8126a16ed8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_1171557063.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesForUuidAsync(System.Guid,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesForUuidAsync + +## -description +Gets the included services from the serviceUuid that is associated with this GattDeviceService instance. + +## -parameters + +### -param serviceUuid +A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object. + +### -param cacheMode +The cache mode. + +## -returns +An asynchronous operation that completes with a GattDeviceServicesResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_744552179.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_744552179.md new file mode 100644 index 0000000000..1aa6c0620f --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_744552179.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesForUuidAsync(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.GetIncludedServicesForUuidAsync + +## -description +Gets the included services from the serviceUuid that is associated with this GattDeviceService instance. + +## -parameters + +### -param serviceUuid +A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object. + +## -returns +An asynchronous operation that completes with a GattDeviceServicesResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_openasync_1373379244.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_openasync_1373379244.md new file mode 100644 index 0000000000..0d34623807 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_openasync_1373379244.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.OpenAsync(Windows.Devices.Bluetooth.GenericAttributeProfile.GattSharingMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.OpenAsync + +## -description +Opens the GATT device service with the specified sharingMode. + +## -parameters + +### -param sharingMode +The sharing mode. + +## -returns +An asynchronous operation that completes with a GattOpenStatus object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_requestaccessasync_380675631.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_requestaccessasync_380675631.md new file mode 100644 index 0000000000..c559bfa45b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_requestaccessasync_380675631.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.RequestAccessAsync + +## -description +Requests access to the GattDeviceService. + +## -parameters + +## -returns +An asynchronous operation that completes with a DeviceAccessStatus object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_session.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_session.md new file mode 100644 index 0000000000..d55f96e697 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_session.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Session +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Session + +## -description +Gets the session for this GATT device service instance. + +## -property-value +The session for this GATT device service instance. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_sharingmode.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_sharingmode.md new file mode 100644 index 0000000000..e15cde52f8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_sharingmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.SharingMode +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.SharingMode + +## -description +Gets the sharing mode for this GATT device service instance. + +## -property-value +The sharing mode for this GATT device service instance. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult.md new file mode 100644 index 0000000000..83f0f27755 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult + +## -description +The status of [**GetIncludedServicesForUuidAsync**](../../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_744552179.md) and [**GetIncludedServicesForUuidAsync**](../../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_getincludedservicesforuuidasync_744552179.md) + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_protocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_protocolerror.md new file mode 100644 index 0000000000..d5dcacd9e1 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_protocolerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult.ProtocolError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult.ProtocolError + +## -description +Gets the protocol error. + +## -property-value +The protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_services.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_services.md new file mode 100644 index 0000000000..f597180d43 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_services.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult.Services +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult.Services + +## -description +Gets the services. + +## -property-value +The services. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_status.md b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_status.md new file mode 100644 index 0000000000..eb9e6d93e9 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattdeviceservicesresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceServicesResult.Status + +## -description +Gets the communication status of the operation. + +## -property-value +The communication status of the operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic.md new file mode 100644 index 0000000000..a749fd6fa4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic + +## -description +This class represents a local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_characteristicproperties.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_characteristicproperties.md new file mode 100644 index 0000000000..796f9d6ab7 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_characteristicproperties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.CharacteristicProperties +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.CharacteristicProperties + +## -description +Gets the local characteristic properties. + +## -property-value +The local characteristic properties. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_createdescriptorasync_490182673.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_createdescriptorasync_490182673.md new file mode 100644 index 0000000000..2f99eb7b6a --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_createdescriptorasync_490182673.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.CreateDescriptorAsync(System.Guid,Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.CreateDescriptorAsync + +## -description +Creates descriptor for this local characteristic. + +## -parameters + +### -param descriptorUuid +The descriptor UUID. + +### -param parameters +The parameters for the descriptor. + +## -returns +An asynchronous operation that completes with a GattLocalDescriptorResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_descriptors.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_descriptors.md new file mode 100644 index 0000000000..565a296aca --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_descriptors.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.Descriptors +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.Descriptors + +## -description +Gets a vector list of all the descriptors for this local characteristic. + +## -property-value +A vector list of all the descriptors for this local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_notifyvalueasync_483273373.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_notifyvalueasync_483273373.md new file mode 100644 index 0000000000..ea35d5309b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_notifyvalueasync_483273373.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.NotifyValueAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.NotifyValueAsync + +## -description +Send and notifies all subscribed clients a GattSubscribedClient of a value. + +## -parameters + +### -param value +The buffer that contains the value to send to the GattSubscribedClient. + +## -returns +An asynchronous operation that completes with a vector list of all the GattClientNotificationResult for each subscribed client. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_notifyvalueasync_839341023.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_notifyvalueasync_839341023.md new file mode 100644 index 0000000000..4dd803ef93 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_notifyvalueasync_839341023.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.NotifyValueAsync(Windows.Storage.Streams.IBuffer,Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.NotifyValueAsync + +## -description +Sends and notifies a GattSubscribedClient of a value. + +## -parameters + +### -param value +The buffer that contains the value to send to the GattSubscribedClient. + +### -param subscribedClient +The subscribed client notify the value. + +## -returns +An asynchronous operation that completes with a GattClientNotificationResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_presentationformats.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_presentationformats.md new file mode 100644 index 0000000000..a6e570502d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_presentationformats.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.PresentationFormats +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.PresentationFormats + +## -description +Gets the presentation formats for this local characteristic. + +## -property-value +The presentation formats for this local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_readprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_readprotectionlevel.md new file mode 100644 index 0000000000..678d9ef75e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_readprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.ReadProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.ReadProtectionLevel + +## -description +Gets the read protection level of this local characteristic. + +## -property-value +The read protection level of this local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_readrequested.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_readrequested.md new file mode 100644 index 0000000000..f615d0faac --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_readrequested.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.ReadRequested +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.ReadRequested + +## -description +An event that is triggered when a GATT client requests a read operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_staticvalue.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_staticvalue.md new file mode 100644 index 0000000000..a12ebdd050 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_staticvalue.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.StaticValue +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.StaticValue + +## -description +Gets the static value for this local GATT characteristic. + +## -property-value +The static value for this local GATT characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_subscribedclients.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_subscribedclients.md new file mode 100644 index 0000000000..24b631535c --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_subscribedclients.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.SubscribedClients +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.SubscribedClients + +## -description +Gets a vector list of all clients that are subscribed to this local characteristic. + +## -property-value +A vector list of all clients that are subscribed to this local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_subscribedclientschanged.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_subscribedclientschanged.md new file mode 100644 index 0000000000..7c40c1ad54 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_subscribedclientschanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.SubscribedClientsChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.SubscribedClientsChanged + +## -description +An event that triggers when the clients subscribed to this local characteristic changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_userdescription.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_userdescription.md new file mode 100644 index 0000000000..e8fab09ade --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_userdescription.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.UserDescription +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.UserDescription + +## -description +Gets the user-friendly description for this local characteristic. + +## -property-value +The user-friendly description for this local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_uuid.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_uuid.md new file mode 100644 index 0000000000..8655a6537f --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_uuid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.Uuid +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.Uuid + +## -description +Gets the BluetoothSIG-defined UUID for this local characteristic. + +## -property-value +The BluetoothSIG-defined UUID for this local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_writeprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_writeprotectionlevel.md new file mode 100644 index 0000000000..f680e72429 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_writeprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.WriteProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.WriteProtectionLevel + +## -description +Gets the write protection level of this local characteristic. + +## -property-value +The write protection level of this local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_writerequested.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_writerequested.md new file mode 100644 index 0000000000..2ab9ba9bec --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristic_writerequested.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.WriteRequested +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristic.WriteRequested + +## -description +This is an event that is triggered when a write was requested. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters.md new file mode 100644 index 0000000000..c83113523e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters + +## -description +This class contains the local characteristic descriptor parameters. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_characteristicproperties.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_characteristicproperties.md new file mode 100644 index 0000000000..56d4aad5f7 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_characteristicproperties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.CharacteristicProperties +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.CharacteristicProperties + +## -description +Gets the properties. + +## -property-value +The properties. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_gattlocalcharacteristicparameters_1221375020.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_gattlocalcharacteristicparameters_1221375020.md new file mode 100644 index 0000000000..9e453d7c5a --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_gattlocalcharacteristicparameters_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.GattLocalCharacteristicParameters + +## -description +Creates a new GattLocalCharacteristicParameters object. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_presentationformats.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_presentationformats.md new file mode 100644 index 0000000000..b6dbff8d89 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_presentationformats.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.PresentationFormats +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.PresentationFormats + +## -description +Gets or sets the presentation formats. + +## -property-value +The presentation formats. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_readprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_readprotectionlevel.md new file mode 100644 index 0000000000..fc65d92193 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_readprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.ReadProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.ReadProtectionLevel + +## -description +Gets or sets the read protection level. + +## -property-value +The read protection level. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_staticvalue.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_staticvalue.md new file mode 100644 index 0000000000..74184513ac --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_staticvalue.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.StaticValue +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.StaticValue + +## -description +Gets or sets the static value. + +## -property-value +The static value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_userdescription.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_userdescription.md new file mode 100644 index 0000000000..dc226b9f7d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_userdescription.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.UserDescription +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.UserDescription + +## -description +Gets or sets the user-friendly description. + +## -property-value +The user-friendly description. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_writeprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_writeprotectionlevel.md new file mode 100644 index 0000000000..64e7ac988c --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicparameters_writeprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.WriteProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters.WriteProtectionLevel + +## -description +Gets and sets the write protection level. + +## -property-value +The write protection level. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult.md new file mode 100644 index 0000000000..9ca40e851d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicResult + +## -description +A result of [CreateCharacteristicAsync](gattlocalservice_createcharacteristicasync_1504398290.md). +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult_characteristic.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult_characteristic.md new file mode 100644 index 0000000000..fdc9743c57 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult_characteristic.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicResult.Characteristic +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicResult.Characteristic + +## -description +Gets the characteristic of the GATT service. + +## -property-value +The characteristic of the GATT service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult_error.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult_error.md new file mode 100644 index 0000000000..4d1ec04d18 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalcharacteristicresult_error.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicResult.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicResult.Error + +## -description +Gets the error. + +## -property-value +The error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor.md new file mode 100644 index 0000000000..81200ed2ef --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor + +## -description +This class defines a descriptor of a local characteristic. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_readprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_readprotectionlevel.md new file mode 100644 index 0000000000..a9aa19d5e5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_readprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.ReadProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.ReadProtectionLevel + +## -description +Gets the read protection level of this local characteristic descriptor. + +## -property-value +The read protection level of this local characteristic descriptor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_readrequested.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_readrequested.md new file mode 100644 index 0000000000..bd202305c8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_readrequested.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.ReadRequested +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.ReadRequested + +## -description +An event that is triggered when a read has been requested. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_staticvalue.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_staticvalue.md new file mode 100644 index 0000000000..9d7d73e2fb --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_staticvalue.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.StaticValue +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.StaticValue + +## -description +Gets the static value for this local characteristic descriptor. + +## -property-value +The static value for this local characteristic descriptor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_uuid.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_uuid.md new file mode 100644 index 0000000000..747e7f2afd --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_uuid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.Uuid +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.Uuid + +## -description +Gets the Bluetooth SIG-defined UUID for this local characteristic descriptor. + +## -property-value +The Bluetooth SIG-defined UUID for this local characteristic descriptor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_writeprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_writeprotectionlevel.md new file mode 100644 index 0000000000..9725756fa4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_writeprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.WriteProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.WriteProtectionLevel + +## -description +Gets the write protection level. + +## -property-value +The write protection level. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_writerequested.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_writerequested.md new file mode 100644 index 0000000000..c0e4c8d93e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptor_writerequested.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.WriteRequested +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptor.WriteRequested + +## -description +An event that is triggered when a write has been requested. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters.md new file mode 100644 index 0000000000..213941c3ea --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters + +## -description +This class defines the parameters of a descriptor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_gattlocaldescriptorparameters_1221375020.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_gattlocaldescriptorparameters_1221375020.md new file mode 100644 index 0000000000..b78833c20b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_gattlocaldescriptorparameters_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.GattLocalDescriptorParameters + +## -description +Creates a new GattLocalDescriptorParameters object. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_readprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_readprotectionlevel.md new file mode 100644 index 0000000000..2d834e0aa4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_readprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.ReadProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.ReadProtectionLevel + +## -description +Gets or sets the read protection level. + +## -property-value +The read protection level. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_staticvalue.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_staticvalue.md new file mode 100644 index 0000000000..84679758b9 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_staticvalue.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.StaticValue +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.StaticValue + +## -description +Gets or sets the static value. + +## -property-value +The static value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_writeprotectionlevel.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_writeprotectionlevel.md new file mode 100644 index 0000000000..c6ae77d3fb --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorparameters_writeprotectionlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.WriteProtectionLevel +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorParameters.WriteProtectionLevel + +## -description +Gets or sets the write protection level. + +## -property-value +The write protection level. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult.md new file mode 100644 index 0000000000..97ae86e6f6 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorResult + +## -description +The result of local characteristic descriptor operations like [CreateDescriptorAsync](gattlocalcharacteristic_createdescriptorasync_490182673.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult_descriptor.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult_descriptor.md new file mode 100644 index 0000000000..4b01503abf --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult_descriptor.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorResult.Descriptor +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorResult.Descriptor + +## -description +Gets the descriptor. + +## -property-value +The descriptor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult_error.md b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult_error.md new file mode 100644 index 0000000000..d194f87fd2 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocaldescriptorresult_error.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorResult.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalDescriptorResult.Error + +## -description +Gets the error. + +## -property-value +The error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalservice.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice.md new file mode 100644 index 0000000000..d29beb29bc --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService + +## -description +This class represents a GATT local service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_characteristics.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_characteristics.md new file mode 100644 index 0000000000..53d4fc80d6 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_characteristics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService.Characteristics +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService.Characteristics + +## -description +Gets a vector list of the characteristics available for this local service. + +## -property-value +A vector list of the characteristics available for this local service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_createcharacteristicasync_1504398290.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_createcharacteristicasync_1504398290.md new file mode 100644 index 0000000000..4992cb209f --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_createcharacteristicasync_1504398290.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService.CreateCharacteristicAsync(System.Guid,Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalCharacteristicParameters) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService.CreateCharacteristicAsync + +## -description +Creates a characteristic for this local service. + +## -parameters + +### -param characteristicUuid +The characteristic UUID. + +### -param parameters +The characteristic parameters. + +## -returns +An asynchronous operation + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_uuid.md b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_uuid.md new file mode 100644 index 0000000000..3124fb3f93 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattlocalservice_uuid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService.Uuid +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattLocalService.Uuid + +## -description +Gets the local service UUID. + +## -property-value +The local service UUID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattopenstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattopenstatus.md new file mode 100644 index 0000000000..9f18b1c021 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattopenstatus.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattOpenStatus +-api-type: winrt enum +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattOpenStatus + +## -description +The status of [**GattDeviceService.OpenAsync**](../../windows.devices.bluetooth.genericattributeprofile/gattdeviceservice_openasync_1373379244.md). + +## -enum-fields +### -field SharingViolation:4 +There was a sharing violation. + +### -field NotFound:3 +The GATT device service was not found. + +### -field AlreadyOpened:2 +The GATT device service is already opened. + +### -field AccessDenied:5 +Access is denied. + +### -field Unspecified:0 +Unspecified error. + +### -field Success:1 +The GATT device service was successfully opened. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_fromparts_382258841.md b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_fromparts_382258841.md new file mode 100644 index 0000000000..718ce9149e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattpresentationformat_fromparts_382258841.md @@ -0,0 +1,40 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.FromParts(System.Byte,System.Int32,System.UInt16,System.Byte,System.UInt16) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattPresentationFormat.FromParts + +## -description +Creates a GattPresentationFormat object from parts. + +## -parameters + +### -param formatType +The Format Type. + +### -param exponent +The exponent. + +### -param unit +The unit. + +### -param namespaceId +The namespace ID. + +### -param description +The description. + +## -returns +An instance of GattPresentationFormat. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror.md new file mode 100644 index 0000000000..e2f55f4ac6 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError + +## -description +This class contains byte values for GATT protocol errors. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_attributenotfound.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_attributenotfound.md new file mode 100644 index 0000000000..6267630ef8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_attributenotfound.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.AttributeNotFound +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.AttributeNotFound + +## -description +Gets the byte value for an attribute not found error. + +## -property-value +The byte value for an attribute not found error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_attributenotlong.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_attributenotlong.md new file mode 100644 index 0000000000..74c8b01197 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_attributenotlong.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.AttributeNotLong +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.AttributeNotLong + +## -description +Gets the byte value for an attribute not long error. + +## -property-value +The byte value for an attribute not long error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientauthentication.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientauthentication.md new file mode 100644 index 0000000000..17c7701be5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientauthentication.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientAuthentication +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientAuthentication + +## -description +Gets the byte value for an insufficient authentication error. + +## -property-value +The byte value for an insufficient authentication error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientauthorization.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientauthorization.md new file mode 100644 index 0000000000..cb6626c058 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientauthorization.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientAuthorization +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientAuthorization + +## -description +Gets the byte value for an insufficient authorization error. + +## -property-value +The byte value for an insufficient authorization error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientencryption.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientencryption.md new file mode 100644 index 0000000000..939680fb42 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientencryption.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientEncryption +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientEncryption + +## -description +Gets the byte value for an insufficient encryption error. + +## -property-value +The byte value for an insufficient encryption error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientencryptionkeysize.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientencryptionkeysize.md new file mode 100644 index 0000000000..1f75e6ecd0 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientencryptionkeysize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientEncryptionKeySize +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientEncryptionKeySize + +## -description +Gets the byte value for an insufficient encryption key size error. + +## -property-value +The byte value for an insufficient encryption key size error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientresources.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientresources.md new file mode 100644 index 0000000000..3175d55ea4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_insufficientresources.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientResources +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InsufficientResources + +## -description +Gets the byte value for an insufficient resources error. + +## -property-value +The byte value for an insufficient resources error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidattributevaluelength.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidattributevaluelength.md new file mode 100644 index 0000000000..b8277c1b65 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidattributevaluelength.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidAttributeValueLength +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidAttributeValueLength + +## -description +Gets the byte value for an invalid attribute value length error. + +## -property-value +The byte value for an invalid attribute value length error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidhandle.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidhandle.md new file mode 100644 index 0000000000..6dd9a7aaa3 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidhandle.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidHandle +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidHandle + +## -description +Gets the byte value for an invalid handle error. + +## -property-value +The byte value for an invalid handle error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidoffset.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidoffset.md new file mode 100644 index 0000000000..945aee88a1 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidoffset.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidOffset +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidOffset + +## -description +Gets the byte value for an invalid offset error. + +## -property-value +The byte value for an invalid offset error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidpdu.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidpdu.md new file mode 100644 index 0000000000..1233b95058 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_invalidpdu.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidPdu +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.InvalidPdu + +## -description +Gets the byte value for an invalid PDU error. + +## -property-value +The byte value for an invalid PDU error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_preparequeuefull.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_preparequeuefull.md new file mode 100644 index 0000000000..9c375dfe75 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_preparequeuefull.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.PrepareQueueFull +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.PrepareQueueFull + +## -description +Gets the byte value for a prepare queue full error. + +## -property-value +The byte value for a prepare queue full error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_readnotpermitted.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_readnotpermitted.md new file mode 100644 index 0000000000..46ce24c802 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_readnotpermitted.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.ReadNotPermitted +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.ReadNotPermitted + +## -description +Gets the byte value for a read not permitted error. + +## -property-value +The byte value for a read not permitted error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_requestnotsupported.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_requestnotsupported.md new file mode 100644 index 0000000000..aee366df2b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_requestnotsupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.RequestNotSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.RequestNotSupported + +## -description +Gets the byte value for a request not supported error. + +## -property-value +The byte value for a request not supported error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_unlikelyerror.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_unlikelyerror.md new file mode 100644 index 0000000000..74767ac99f --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_unlikelyerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.UnlikelyError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.UnlikelyError + +## -description +Gets the byte value for an unlikely error. + +## -property-value +The byte value for an unsupported group type error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_unsupportedgrouptype.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_unsupportedgrouptype.md new file mode 100644 index 0000000000..e05ffdf221 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_unsupportedgrouptype.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.UnsupportedGroupType +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.UnsupportedGroupType + +## -description +Gets the byte value for an unsupported group type error. + +## -property-value +The byte value for an unsupported group type error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_writenotpermitted.md b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_writenotpermitted.md new file mode 100644 index 0000000000..f8e546e22e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattprotocolerror_writenotpermitted.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.WriteNotPermitted +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattProtocolError.WriteNotPermitted + +## -description +Gets the byte value for a write not permitted error. + +## -property-value +The byte value for a write not permitted error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_protocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_protocolerror.md new file mode 100644 index 0000000000..865a174ff4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadclientcharacteristicconfigurationdescriptorresult_protocolerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.ProtocolError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadClientCharacteristicConfigurationDescriptorResult.ProtocolError + +## -description +Gets the protocol error. + +## -property-value +The protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequest.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest.md new file mode 100644 index 0000000000..cf46d630b2 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest + +## -description +This class represents a Bluetooth GATT read request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_length.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_length.md new file mode 100644 index 0000000000..c0c22bb5e6 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_length.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.Length +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.Length + +## -description +Gets the buffer length of the read request. + +## -property-value +The buffer length of the read request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_offset.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_offset.md new file mode 100644 index 0000000000..760750321a --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_offset.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.Offset +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.Offset + +## -description +Gets the read request offset. + +## -property-value +The read request offset. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_respondwithprotocolerror_160672409.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_respondwithprotocolerror_160672409.md new file mode 100644 index 0000000000..3d2383dba5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_respondwithprotocolerror_160672409.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.RespondWithProtocolError(System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.RespondWithProtocolError + +## -description +Responds to the read request with a protocol error. + +## -parameters + +### -param protocolError +The protocol error to send. A list of errors with the byte values can be found in [GattProtocolError](gattprotocolerror.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_respondwithvalue_1420944567.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_respondwithvalue_1420944567.md new file mode 100644 index 0000000000..11b601a05b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_respondwithvalue_1420944567.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.RespondWithValue(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.RespondWithValue + +## -description +Responds to a read request with a value. + +## -parameters + +### -param value +The value to respond with. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_state.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_state.md new file mode 100644 index 0000000000..6f20040178 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_state.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.State +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.State + +## -description +Gets the read request state. + +## -property-value +The read request state. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_statechanged.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_statechanged.md new file mode 100644 index 0000000000..bc9dc7562e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequest_statechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.StateChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequest.StateChanged + +## -description +This is an event that is triggered when the read request state was changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs.md new file mode 100644 index 0000000000..298a89a1c4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs + +## -description +This class contains the arguments for the [StateChanged](gattwriterequest_statechanged.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_getdeferral_254836512.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..d21c1e1946 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_getdeferral_254836512.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs.GetDeferral + +## -description +Gets a deferral. + +## -parameters + +## -returns +Returns a deferral object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_getrequestasync_1101580146.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_getrequestasync_1101580146.md new file mode 100644 index 0000000000..0c9d4f9ae1 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_getrequestasync_1101580146.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs.GetRequestAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs.GetRequestAsync + +## -description +Gets the GATT read request. + +## -parameters + +## -returns +An asynchronous operation that completes with a GattReadRequest object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_session.md b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_session.md new file mode 100644 index 0000000000..110ac4ba25 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadrequestedeventargs_session.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs.Session +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadRequestedEventArgs.Session + +## -description +Gets the session. + +## -property-value +The session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreadresult_protocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattreadresult_protocolerror.md new file mode 100644 index 0000000000..92c51ce55d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreadresult_protocolerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.ProtocolError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReadResult.ProtocolError + +## -description +Gets the protocol error. + +## -property-value +The protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_commitwithresultasync_462820141.md b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_commitwithresultasync_462820141.md new file mode 100644 index 0000000000..b9ae79782a --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattreliablewritetransaction_commitwithresultasync_462820141.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.CommitWithResultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattReliableWriteTransaction.CommitWithResultAsync + +## -description +Performs all the queued writes, in sequence, writing the data to the device. Once a transaction object has been committed, no further operations are possible on the GattReliableWriteTransaction object. + +## -parameters + +## -returns +An asynchronous operation that completes with a GattWriteResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattrequeststate.md b/windows.devices.bluetooth.genericattributeprofile/gattrequeststate.md new file mode 100644 index 0000000000..0281fff9f4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattrequeststate.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestState +-api-type: winrt enum +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestState + +## -description +This enumeration defines a GATT request state. + +## -enum-fields +### -field Pending:0 +The request is pending. + +### -field Completed:1 +The request if completed. + +### -field Canceled:2 +The request is canceled. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs.md b/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs.md new file mode 100644 index 0000000000..3229f43856 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestStateChangedEventArgs + +## -description +This class defines arguments of [StateChanged](gattreadrequest_statechanged.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs_error.md b/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs_error.md new file mode 100644 index 0000000000..5321248199 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs_error.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestStateChangedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestStateChangedEventArgs.Error + +## -description +Gets the Bluetooth error. + +## -property-value +The Bluetooth error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs_state.md b/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs_state.md new file mode 100644 index 0000000000..5e57479ae7 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattrequeststatechangedeventargs_state.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestStateChangedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattRequestStateChangedEventArgs.State + +## -description +Gets the state of the read request. + +## -property-value +The state of the read request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider.md new file mode 100644 index 0000000000..023c7d3852 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider + +## -description +This class is used to advertise a GATT service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_advertisementstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_advertisementstatus.md new file mode 100644 index 0000000000..7efd1c1c88 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_advertisementstatus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.AdvertisementStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.AdvertisementStatus + +## -description +Gets the advertisement status of this GATT service. + +## -property-value +The advertisement service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_advertisementstatuschanged.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_advertisementstatuschanged.md new file mode 100644 index 0000000000..2d5309fd06 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_advertisementstatuschanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.AdvertisementStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.AdvertisementStatusChanged + +## -description +An event that is triggered when the advertisement status has changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_createasync_1929238600.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_createasync_1929238600.md new file mode 100644 index 0000000000..d41492457b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_createasync_1929238600.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.CreateAsync(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.CreateAsync + +## -description +Creates a new GATT service with the specified serviceUuid + +## -parameters + +### -param serviceUuid +The service UUID. + +## -returns +An asynchronous operation that completes with a GattServiceProviderResult object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_service.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_service.md new file mode 100644 index 0000000000..c5229975c4 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_service.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.Service +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.Service + +## -description +Gets the GATT service. + +## -property-value +The GATT service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_startadvertising_2125788460.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_startadvertising_2125788460.md new file mode 100644 index 0000000000..549462e4aa --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_startadvertising_2125788460.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.StartAdvertising(Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.StartAdvertising + +## -description +Start advertising the GATT service. + +## -parameters + +### -param parameters +The advertising parameters. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_startadvertising_805321238.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_startadvertising_805321238.md new file mode 100644 index 0000000000..c8a1aa7487 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_startadvertising_805321238.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.StartAdvertising +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.StartAdvertising + +## -description +Start advertising the GATT service. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_stopadvertising_1074698824.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_stopadvertising_1074698824.md new file mode 100644 index 0000000000..d19ac9287d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovider_stopadvertising_1074698824.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.StopAdvertising +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProvider.StopAdvertising + +## -description +Stop advertising the GATT service. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatus.md new file mode 100644 index 0000000000..85669d50ab --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatus.md @@ -0,0 +1,33 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatus +-api-type: winrt enum +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatus + +## -description +This enumeration defines the advertisement status of a [GattServiceProvider](gattserviceprovider.md). + +## -enum-fields +### -field Stopped:1 +The GATT service is not advertising. + +### -field Started:2 +The GATT service advertising has started. + +### -field Created:0 +The GATT service was created. + +### -field Aborted:3 +The GATT service was aborted. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs.md new file mode 100644 index 0000000000..0cc9bb29b8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatusChangedEventArgs + +## -description +The event args for the [GattServiceProvider](gattserviceprovider_advertisementstatuschanged.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs_error.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs_error.md new file mode 100644 index 0000000000..713562310d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs_error.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatusChangedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatusChangedEventArgs.Error + +## -description +Gets the error of the GATT service. + +## -property-value +The error of the GATT service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs_status.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs_status.md new file mode 100644 index 0000000000..bfc6fde309 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisementstatuschangedeventargs_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatusChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisementStatusChangedEventArgs.Status + +## -description +Gets the status of the GATT service. + +## -property-value +The status of the GATT service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters.md new file mode 100644 index 0000000000..06e1bdf07f --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters + +## -description +This class is used to define a GATT service advertisement parameters. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_gattserviceprovideradvertisingparameters_1221375020.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_gattserviceprovideradvertisingparameters_1221375020.md new file mode 100644 index 0000000000..04d71c616b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_gattserviceprovideradvertisingparameters_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters.GattServiceProviderAdvertisingParameters + +## -description +Creates a new GattServiceProviderAdvertisingParameters object. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_isconnectable.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_isconnectable.md new file mode 100644 index 0000000000..f1bfe1e26e --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_isconnectable.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters.IsConnectable +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters.IsConnectable + +## -description +Gets or sets a boolean that indicates if the GATT service is connectable. + +## -property-value +A boolean that indicates if the GATT service is connectable. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_isdiscoverable.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_isdiscoverable.md new file mode 100644 index 0000000000..212eeb89e2 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceprovideradvertisingparameters_isdiscoverable.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters.IsDiscoverable +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderAdvertisingParameters.IsDiscoverable + +## -description +Gets or sets a boolean indicating that the GATT service is discoverable. + +## -property-value +A boolean indicating that the GATT service is discoverable. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult.md new file mode 100644 index 0000000000..531c0b44ad --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderResult + +## -description +This class is the result of the [CreateAsync](gattserviceprovider_createasync_1929238600.md) operation. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult_error.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult_error.md new file mode 100644 index 0000000000..31cc775582 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult_error.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderResult.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderResult.Error + +## -description +Gets the error. + +## -property-value +The error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult_serviceprovider.md b/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult_serviceprovider.md new file mode 100644 index 0000000000..e5e4521227 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattserviceproviderresult_serviceprovider.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderResult.ServiceProvider +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattServiceProviderResult.ServiceProvider + +## -description +Gets the service provider. + +## -property-value +The service provider. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession.md b/windows.devices.bluetooth.genericattributeprofile/gattsession.md new file mode 100644 index 0000000000..67692c231d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession + +## -description +This class represents a GATT session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_canmaintainconnection.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_canmaintainconnection.md new file mode 100644 index 0000000000..550f88a3d0 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_canmaintainconnection.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.CanMaintainConnection +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.CanMaintainConnection + +## -description +Gets a boolean that indicates if the connection can be maintained. + +## -property-value +A boolean that indicates if the connection can be maintained. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_close_811482585.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_close_811482585.md new file mode 100644 index 0000000000..27e788e78a --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_close_811482585.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.Close + +## -description +Closes the GattSession. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_deviceid.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_deviceid.md new file mode 100644 index 0000000000..76a87291e6 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_deviceid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.DeviceId + +## -description +Gets the device ID. + +## -property-value +The device ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_fromdeviceidasync_173697330.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_fromdeviceidasync_173697330.md new file mode 100644 index 0000000000..fb53acdcdc --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_fromdeviceidasync_173697330.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.FromDeviceIdAsync(Windows.Devices.Bluetooth.BluetoothDeviceId) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.FromDeviceIdAsync + +## -description +Creates a new GattSession object from the specified deviceId. + +## -parameters + +### -param deviceId +The deviceId. + +## -returns +An asynchronous operation that completes with a new GattSession object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_maintainconnection.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_maintainconnection.md new file mode 100644 index 0000000000..2b5d31eba5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_maintainconnection.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.MaintainConnection +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.MaintainConnection + +## -description +Gets or sets a boolean that indicates if the connection should be maintained. + +## -property-value +A boolean that indicates if the connection should be maintained. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_maxpdusize.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_maxpdusize.md new file mode 100644 index 0000000000..3b6c7d5b27 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_maxpdusize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.MaxPduSize +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.MaxPduSize + +## -description +Gets the max PDU size. + +## -property-value +The max PDU size. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_maxpdusizechanged.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_maxpdusizechanged.md new file mode 100644 index 0000000000..3540e9bc79 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_maxpdusizechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.MaxPduSizeChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.MaxPduSizeChanged + +## -description +An event that is triggered when the max PDU size changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_sessionstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_sessionstatus.md new file mode 100644 index 0000000000..adb58f018c --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_sessionstatus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.SessionStatus +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.SessionStatus + +## -description +Gets the session status. + +## -property-value +The session status. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsession_sessionstatuschanged.md b/windows.devices.bluetooth.genericattributeprofile/gattsession_sessionstatuschanged.md new file mode 100644 index 0000000000..2f647bca98 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsession_sessionstatuschanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.SessionStatusChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSession.SessionStatusChanged + +## -description +An event that is triggered when the GATT session status has changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsessionstatus.md b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatus.md new file mode 100644 index 0000000000..6b9962aec1 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatus.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatus +-api-type: winrt enum +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatus + +## -description +This enumeration defines a GattSession status. + +## -enum-fields +### -field Closed:0 +The GATT session is closed. + +### -field Active:1 +The GATT session is active. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs.md b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs.md new file mode 100644 index 0000000000..3e6fd4ccb3 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatusChangedEventArgs + +## -description +This class represents the [SessionStatusChanged](gattsession_sessionstatuschanged.md) event args. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs_error.md b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs_error.md new file mode 100644 index 0000000000..6af0cd401f --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs_error.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatusChangedEventArgs.Error +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatusChangedEventArgs.Error + +## -description +Gets the error of the GATT session. + +## -property-value +The error of the GATT session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs_status.md b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs_status.md new file mode 100644 index 0000000000..700db68bcb --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsessionstatuschangedeventargs_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatusChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSessionStatusChangedEventArgs.Status + +## -description +Gets the status of the GATT session. + +## -property-value +The status of the GATT session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsharingmode.md b/windows.devices.bluetooth.genericattributeprofile/gattsharingmode.md new file mode 100644 index 0000000000..3f9699ef27 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsharingmode.md @@ -0,0 +1,33 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSharingMode +-api-type: winrt enum +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSharingMode + +## -description +This enumeration represents the GATT sharing mode. + +## -enum-fields +### -field Unspecified:0 +The sharing mode is unspecified. + +### -field SharedReadOnly:2 +The sharing mode is read only. + +### -field SharedReadAndWrite:3 +The sharing mode is read and write. + +### -field Exclusive:1 +The sharing mode is exclusive. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient.md b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient.md new file mode 100644 index 0000000000..93ecee94dc --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient + +## -description +This class represents a subscribed client of a GATT session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_maxnotificationsize.md b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_maxnotificationsize.md new file mode 100644 index 0000000000..afceaca3d8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_maxnotificationsize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient.MaxNotificationSize +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient.MaxNotificationSize + +## -description +Gets the max notification size. + +## -property-value +The max notification size. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_maxnotificationsizechanged.md b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_maxnotificationsizechanged.md new file mode 100644 index 0000000000..bea9a62c24 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_maxnotificationsizechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient.MaxNotificationSizeChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient.MaxNotificationSizeChanged + +## -description +An event that is triggered when the max notification size has changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_session.md b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_session.md new file mode 100644 index 0000000000..42cf15660b --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattsubscribedclient_session.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient.Session +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattSubscribedClient.Session + +## -description +Gets the session of the subscribed client. + +## -property-value +The session of the subscribed client. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest.md new file mode 100644 index 0000000000..892ed6c618 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest + +## -description +This class represents a GATT write request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_offset.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_offset.md new file mode 100644 index 0000000000..d4a7d3a0a0 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_offset.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Offset +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Offset + +## -description +Gets the offset. + +## -property-value +The offset. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_option.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_option.md new file mode 100644 index 0000000000..9f5ed46f69 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_option.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Option +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Option + +## -description +Gets the write request option. + +## -property-value +The write request option. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_respond_1285730570.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_respond_1285730570.md new file mode 100644 index 0000000000..f6361cb607 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_respond_1285730570.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Respond +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Respond + +## -description +Responds to the write request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_respondwithprotocolerror_160672409.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_respondwithprotocolerror_160672409.md new file mode 100644 index 0000000000..3bd088b711 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_respondwithprotocolerror_160672409.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.RespondWithProtocolError(System.Byte) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.RespondWithProtocolError + +## -description +Responds with a protocol error. + +## -parameters + +### -param protocolError +The GATT protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_state.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_state.md new file mode 100644 index 0000000000..36fe2b19c5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_state.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.State +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.State + +## -description +Gets the state of the write request. + +## -property-value +The state of the write request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_statechanged.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_statechanged.md new file mode 100644 index 0000000000..e9ff2b01c5 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_statechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.StateChanged +-api-type: winrt event +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.StateChanged + +## -description +An event that is triggered when the state of the write request has changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_value.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_value.md new file mode 100644 index 0000000000..96661dd390 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequest_value.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Value +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequest.Value + +## -description +Gets the buffer value of the write request. + +## -property-value +The buffer value of the write request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs.md new file mode 100644 index 0000000000..b355c6acd2 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs + +## -description +This class represents the event args for [WriteRequested](gattlocalcharacteristic_writerequested.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_getdeferral_254836512.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..0fcf86c180 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_getdeferral_254836512.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs.GetDeferral + +## -description +Gets a deferral. + +## -parameters + +## -returns +An asynchronous operation that completes with the deferral. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_getrequestasync_1101580146.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_getrequestasync_1101580146.md new file mode 100644 index 0000000000..8792e887e8 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_getrequestasync_1101580146.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs.GetRequestAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs.GetRequestAsync + +## -description +Gets the write request. + +## -parameters + +## -returns +An asynchronous operation that completes with the write request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_session.md b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_session.md new file mode 100644 index 0000000000..8d3a75054d --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriterequestedeventargs_session.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs.Session +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteRequestedEventArgs.Session + +## -description +Gets the session. + +## -property-value +The session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriteresult.md b/windows.devices.bluetooth.genericattributeprofile/gattwriteresult.md new file mode 100644 index 0000000000..ec12542dbe --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriteresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteResult +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteResult + +## -description +Contains the result of GATT write operations like [**WriteValueWithResultAsync**](../../windows.devices.bluetooth.genericattributeprofile/gattcharacteristic_writevaluewithresultasync_2074671654.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriteresult_protocolerror.md b/windows.devices.bluetooth.genericattributeprofile/gattwriteresult_protocolerror.md new file mode 100644 index 0000000000..348e390b48 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriteresult_protocolerror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteResult.ProtocolError +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteResult.ProtocolError + +## -description +Gets the protocol error. + +## -property-value +The protocol error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth.genericattributeprofile/gattwriteresult_status.md b/windows.devices.bluetooth.genericattributeprofile/gattwriteresult_status.md new file mode 100644 index 0000000000..94b409bbc6 --- /dev/null +++ b/windows.devices.bluetooth.genericattributeprofile/gattwriteresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteResult.Status +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.GenericAttributeProfile.GattWriteResult.Status + +## -description +Gets the status of the write result. + +## -property-value +The status of the write result. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter.md b/windows.devices.bluetooth/bluetoothadapter.md new file mode 100644 index 0000000000..d10180cbba --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothAdapter +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter + +## -description +Represents a Bluetooth adapter. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +bluetooth \ No newline at end of file diff --git a/windows.devices.bluetooth/bluetoothadapter_bluetoothaddress.md b/windows.devices.bluetooth/bluetoothadapter_bluetoothaddress.md new file mode 100644 index 0000000000..4fb2ee2a6d --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_bluetoothaddress.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothAdapter.BluetoothAddress +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.BluetoothAddress + +## -description +Gets the device address. + +## -property-value +The device address. + +## -remarks + +## -see-also + +## -examples + +## -capabilities +bluetooth diff --git a/windows.devices.bluetooth/bluetoothadapter_deviceid.md b/windows.devices.bluetooth/bluetoothadapter_deviceid.md new file mode 100644 index 0000000000..7e0d4a44cb --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_deviceid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothAdapter.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.DeviceId + +## -description +Gets the device ID. + +## -property-value +The ID of the device. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +bluetooth + diff --git a/windows.devices.bluetooth/bluetoothadapter_fromidasync_1322863552.md b/windows.devices.bluetooth/bluetoothadapter_fromidasync_1322863552.md new file mode 100644 index 0000000000..8dd85627d1 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_fromidasync_1322863552.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothAdapter.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.FromIdAsync + +## -description +Gets a [BluetoothAdapter](bluetoothadapter.md) object identified by the given [DeviceId](bluetoothadapter_deviceid.md). + +## -parameters + +### -param deviceId +The DeviceId value that identifies the BluetoothAdapter instance. + +## -returns +After the asynchronous operation completes, returns the [BluetoothAdapter](bluetoothadapter.md) object identified by the given [DeviceId](bluetoothadapter_deviceid.md). + +## -remarks + +## -examples + +## -see-also + +## -capabilities +bluetooth + diff --git a/windows.devices.bluetooth/bluetoothadapter_getdefaultasync_1549573963.md b/windows.devices.bluetooth/bluetoothadapter_getdefaultasync_1549573963.md new file mode 100644 index 0000000000..5290087db1 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_getdefaultasync_1549573963.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothAdapter.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.GetDefaultAsync + +## -description +Gets the default BluetoothAdapter. + +## -parameters + +## -returns +An asynchronous operation that completes with a BluetoothAdapter. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter_getdeviceselector_838466080.md b/windows.devices.bluetooth/bluetoothadapter_getdeviceselector_838466080.md new file mode 100644 index 0000000000..a80bc572cb --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_getdeviceselector_838466080.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothAdapter.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string for identifying instances of this adapter. This string is passed to the FindAllAsync or CreateWatcher method. + +## -parameters + +## -returns +Returns an AQS string. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter_getradioasync_1950748834.md b/windows.devices.bluetooth/bluetoothadapter_getradioasync_1950748834.md new file mode 100644 index 0000000000..2f68da1938 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_getradioasync_1950748834.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothAdapter.GetRadioAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.GetRadioAsync + +## -description +Gets the radio represented by this Bluetooth adapter. + +## -parameters + +## -returns +Returns an asynchronous operation that completes with the Radio. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter_isadvertisementoffloadsupported.md b/windows.devices.bluetooth/bluetoothadapter_isadvertisementoffloadsupported.md new file mode 100644 index 0000000000..b30a849023 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_isadvertisementoffloadsupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothAdapter.IsAdvertisementOffloadSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.IsAdvertisementOffloadSupported + +## -description +Gets a boolean indicating if the adapter supports advertisement offload. + +## -property-value +Gets a boolean indicating if the adapter supports advertisement offload. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter_iscentralrolesupported.md b/windows.devices.bluetooth/bluetoothadapter_iscentralrolesupported.md new file mode 100644 index 0000000000..39f6773022 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_iscentralrolesupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothAdapter.IsCentralRoleSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.IsCentralRoleSupported + +## -description +Gets a boolean indicating if the adapater supports LowEnergy central role. + +## -property-value +Gets a boolean indicating if the adapater supports LowEnergy central role. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter_isclassicsupported.md b/windows.devices.bluetooth/bluetoothadapter_isclassicsupported.md new file mode 100644 index 0000000000..8491eb4121 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_isclassicsupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothAdapter.IsClassicSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.IsClassicSupported + +## -description +Gets a boolean indicating if the adapter supports the Bluetooth Classic transport type. + +## -property-value +Gets a boolean indicating if the adapter supports the Bluetooth Classic transport type. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter_islowenergysupported.md b/windows.devices.bluetooth/bluetoothadapter_islowenergysupported.md new file mode 100644 index 0000000000..4dfa402cf5 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_islowenergysupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothAdapter.IsLowEnergySupported +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.IsLowEnergySupported + +## -description +Gets a boolean indicating if the adapater supports LowEnergy Bluetooth Transport type. + +## -property-value +Gets a boolean indicating if the adapater supports LowEnergy Bluetooth Transport type. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothadapter_isperipheralrolesupported.md b/windows.devices.bluetooth/bluetoothadapter_isperipheralrolesupported.md new file mode 100644 index 0000000000..7032fa3d21 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothadapter_isperipheralrolesupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothAdapter.IsPeripheralRoleSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothAdapter.IsPeripheralRoleSupported + +## -description +Gets a boolean indicating if the adapater supports LowEnergy peripheral role. + +## -property-value +Gets a boolean indicating if the adapater supports LowEnergy peripheral role. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothaddresstype.md b/windows.devices.bluetooth/bluetoothaddresstype.md index 7327e8bc08..6a3b806ef1 100644 --- a/windows.devices.bluetooth/bluetoothaddresstype.md +++ b/windows.devices.bluetooth/bluetoothaddresstype.md @@ -20,8 +20,11 @@ Public address. Random address. +### -field Unspecified:2 + + ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.devices.bluetooth/bluetoothdeviceid.md b/windows.devices.bluetooth/bluetoothdeviceid.md new file mode 100644 index 0000000000..e232960d5f --- /dev/null +++ b/windows.devices.bluetooth/bluetoothdeviceid.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothDeviceId +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothDeviceId + +## -description +Represents a bluetooth device ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothdeviceid_id.md b/windows.devices.bluetooth/bluetoothdeviceid_id.md new file mode 100644 index 0000000000..91f7f324bb --- /dev/null +++ b/windows.devices.bluetooth/bluetoothdeviceid_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDeviceId.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDeviceId.Id + +## -description +Gets the bluetooth device ID. + +## -property-value +Gets the bluetooth device ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothdeviceid_isclassicdevice.md b/windows.devices.bluetooth/bluetoothdeviceid_isclassicdevice.md new file mode 100644 index 0000000000..09b5e63ee1 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothdeviceid_isclassicdevice.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDeviceId.IsClassicDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDeviceId.IsClassicDevice + +## -description +Gets a boolean indicating if this is a classic device. + +## -property-value +Gets a boolean indicating if this is a classic device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothdeviceid_islowenergydevice.md b/windows.devices.bluetooth/bluetoothdeviceid_islowenergydevice.md new file mode 100644 index 0000000000..2b48730ec8 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothdeviceid_islowenergydevice.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothDeviceId.IsLowEnergyDevice +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothDeviceId.IsLowEnergyDevice + +## -description +Gets a boolean indicating if this is a LowEnergy device. + +## -property-value +Gets a boolean indicating if this is a LowEnergy device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetootherror.md b/windows.devices.bluetooth/bluetootherror.md index 673ca8e35b..9b740d643a 100644 --- a/windows.devices.bluetooth/bluetootherror.md +++ b/windows.devices.bluetooth/bluetootherror.md @@ -41,6 +41,9 @@ The operation is disabled by the user. The operation requires consent. +### -field TransportNotSupported:9 + + ## -remarks ## -examples @@ -49,4 +52,4 @@ The operation requires consent. ## -capabilities -bluetooth \ No newline at end of file +bluetooth diff --git a/windows.devices.bluetooth/bluetoothledevice_deviceaccessinformation.md b/windows.devices.bluetooth/bluetoothledevice_deviceaccessinformation.md new file mode 100644 index 0000000000..e84fb39700 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothledevice_deviceaccessinformation.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceAccessInformation +-api-type: winrt property +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.DeviceAccessInformation + +## -description +Gets the DeviceAccessInformation. + +## -property-value +Gets the DeviceAccessInformation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothledevice_getgattservicesasync_1174771000.md b/windows.devices.bluetooth/bluetoothledevice_getgattservicesasync_1174771000.md new file mode 100644 index 0000000000..bd00226338 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothledevice_getgattservicesasync_1174771000.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesAsync(Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesAsync + +## -description +Returns the GattDeviceServices for this Bluetooth LowEnergy device with the specified cache mode. + +## -parameters + +### -param cacheMode +The cache mode. + +## -returns +Returns an asynchronous operation that completes with a GattDeviceServicesResult. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothledevice_getgattservicesasync_220222675.md b/windows.devices.bluetooth/bluetoothledevice_getgattservicesasync_220222675.md new file mode 100644 index 0000000000..a3c4abdd58 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothledevice_getgattservicesasync_220222675.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesAsync + +## -description +Gets the GattDeviceServices for this Bluetooth LowEnergy device. + +## -parameters + +## -returns +Returns an asynchronous operation that completes with a GattDeviceServicesResult. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothledevice_getgattservicesforuuidasync_1989029475.md b/windows.devices.bluetooth/bluetoothledevice_getgattservicesforuuidasync_1989029475.md new file mode 100644 index 0000000000..2a82a41402 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothledevice_getgattservicesforuuidasync_1989029475.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesForUuidAsync(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesForUuidAsync + +## -description +Returns the GattDeviceServices for the Bluetooth LowEnergy device with the specified UUID. + +## -parameters + +### -param serviceUuid +The service UUID. + +## -returns + +## -remarks +Returns an asynchronous operation that completes with a GattDeviceServicesResult. + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothledevice_getgattservicesforuuidasync_523915863.md b/windows.devices.bluetooth/bluetoothledevice_getgattservicesforuuidasync_523915863.md new file mode 100644 index 0000000000..d9f3f09493 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothledevice_getgattservicesforuuidasync_523915863.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesForUuidAsync(System.Guid,Windows.Devices.Bluetooth.BluetoothCacheMode) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.GetGattServicesForUuidAsync + +## -description +Returns the GattDeviceServices for the Bluetooth LowEnergy device with the specified UUID. + +## -parameters + +### -param serviceUuid +The service UUID. + +### -param cacheMode +The cache mode. + +## -returns +Returns an asynchronous operation that completes with a GattDeviceServicesResult. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothledevice_requestaccessasync_380675631.md b/windows.devices.bluetooth/bluetoothledevice_requestaccessasync_380675631.md new file mode 100644 index 0000000000..c22a466037 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothledevice_requestaccessasync_380675631.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothLEDevice.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothLEDevice.RequestAccessAsync + +## -description +Requests access to the Bluetooth LowEnergy device. + +## -parameters + +## -returns +Returns an asynchronous operation that completes with a DeviceAccessStatus. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothuuidhelper.md b/windows.devices.bluetooth/bluetoothuuidhelper.md new file mode 100644 index 0000000000..d4ec5bd7b7 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothuuidhelper.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Bluetooth.BluetoothUuidHelper +-api-type: winrt class +--- + + + +# Windows.Devices.Bluetooth.BluetoothUuidHelper + +## -description +A helper class that provides methods to convert between bluetooth device UUID and short ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothuuidhelper_fromshortid_1277388785.md b/windows.devices.bluetooth/bluetoothuuidhelper_fromshortid_1277388785.md new file mode 100644 index 0000000000..af05d85041 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothuuidhelper_fromshortid_1277388785.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothUuidHelper.FromShortId(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothUuidHelper.FromShortId + +## -description +Returns the bluetooth device UUID from a short ID. + +## -parameters + +### -param shortId +The short ID. + +## -returns +Returns the UUID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.bluetooth/bluetoothuuidhelper_trygetshortid_872928158.md b/windows.devices.bluetooth/bluetoothuuidhelper_trygetshortid_872928158.md new file mode 100644 index 0000000000..2ed15bb9d6 --- /dev/null +++ b/windows.devices.bluetooth/bluetoothuuidhelper_trygetshortid_872928158.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Bluetooth.BluetoothUuidHelper.TryGetShortId(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Devices.Bluetooth.BluetoothUuidHelper.TryGetShortId + +## -description +Attempts to get the short bluetooth device ID from a UUID. + +## -parameters + +### -param uuid +The UUID. + +## -returns +Returns the short ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecount.md b/windows.devices.gpio/gpiochangecount.md new file mode 100644 index 0000000000..157417b8b4 --- /dev/null +++ b/windows.devices.gpio/gpiochangecount.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Devices.Gpio.GpioChangeCount +-api-type: winrt struct +--- + + + +# Windows.Devices.Gpio.GpioChangeCount + +## -description +Represents a near-simultaneous sampling of the number of times a pin has changed value, and the time at which this count was samples. This structure can be used to determine the number of times a pin changed value over a period of time. + +## -struct-fields + +### -field Count +The number of times the transition of polarity specified by [GpioChangeCounter.Polarity](gpiochangecounter_polarity) occured on the pin. + +### -field RelativeTime +The time at which this count was sampled. The time is sampled close to, but not simultaneously with, the count. This timestamp can be used to determine the elapsed time between two GpioChangeCount records. It does not correspond to any absolute or system time. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter.md b/windows.devices.gpio/gpiochangecounter.md new file mode 100644 index 0000000000..cb3882ed67 --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Devices.Gpio.GpioChangeCounter +-api-type: winrt class +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter + +## -description +Counts changes of a specified polarity on a general-purpose I/O (GPIO) pin. + +## -remarks +When the pin is an input, interrupts are used to detect pin changes. Interrupts for the pin are enabled for the specified polarity, and the count is incremented when an interrupt occurs. + +When the pis is an output, the count will increment whenenver the specified transition occurs in the pin. For example, if the pin is configured as an output and counting is enabled for rising edges, writing a 0 and then a 1 will cause the count to be incremented. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_close_811482585.md b/windows.devices.gpio/gpiochangecounter_close_811482585.md new file mode 100644 index 0000000000..8c34fd8ef0 --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_close_811482585.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeCounter.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.Close + +## -description +Closes the change counter, disassociating it from its pin. + +## -parameters + +## -remarks +If change counting is active for this counter, calling this method will also stop it. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_gpiochangecounter_193920446.md b/windows.devices.gpio/gpiochangecounter_gpiochangecounter_193920446.md new file mode 100644 index 0000000000..819c0c6eb0 --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_gpiochangecounter_193920446.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeCounter.#ctor(Windows.Devices.Gpio.GpioPin) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.GpioChangeCounter + +## -description +Creates a new GpioChangeCounter associated with the specified pin. Only a single GpioChangeCounter may be associated with a pin at any given time. + +## -parameters + +### -param pin +The pin on which to count changes. This pin must have been opened in Exclusive mode, and cannot be associated with another GpioChangeCounter. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_isstarted.md b/windows.devices.gpio/gpiochangecounter_isstarted.md new file mode 100644 index 0000000000..dd50fc7fc8 --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_isstarted.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeCounter.IsStarted +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.IsStarted + +## -description +Gets whether pin change counting is currently active. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_polarity.md b/windows.devices.gpio/gpiochangecounter_polarity.md new file mode 100644 index 0000000000..d472f5a0fa --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_polarity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeCounter.Polarity +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.Polarity + +## -description +Gets or sets the polarity of transitions that will be counted. The polarity may only be changed when pin counting is not started. + +## -property-value + +## -remarks +The default polarity value is Falling. See [GpioChangePolarity](gpiochangepolarity.md) for more information on polarity values. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_read_431746835.md b/windows.devices.gpio/gpiochangecounter_read_431746835.md new file mode 100644 index 0000000000..c23361fb9a --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_read_431746835.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeCounter.Read +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.Read + +## -description +Reads the current count of polarity changes. Before counting has been started, this will return 0. + +## -parameters + +## -returns +[GpioChangeCount](gpiochangecount.md) + +A structure containing a count and an associated timestamp. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_reset_1636126115.md b/windows.devices.gpio/gpiochangecounter_reset_1636126115.md new file mode 100644 index 0000000000..f79727b3ef --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_reset_1636126115.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeCounter.Reset +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.Reset + +## -description +Resets the count to 0 and returns the previous count. + +## -parameters + +## -returns +[GpioChangeCount](gpiochangecount.md) + +A structure containing a count and an associated timestamp. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_start_1587696324.md b/windows.devices.gpio/gpiochangecounter_start_1587696324.md new file mode 100644 index 0000000000..fd854e7351 --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_start_1587696324.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeCounter.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.Start + +## -description +Starts counting changes in pin polarity. This method may only be called when change counting is not already active. + +## -parameters + +## -remarks +Calling Start() may enable or reconfigure interrupts for the pin. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangecounter_stop_1201535524.md b/windows.devices.gpio/gpiochangecounter_stop_1201535524.md new file mode 100644 index 0000000000..c8bed174d6 --- /dev/null +++ b/windows.devices.gpio/gpiochangecounter_stop_1201535524.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeCounter.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeCounter.Stop + +## -description +Stop counting changes in pin polarity. This method may only be called when change counting is currently active. + +## -parameters + +## -remarks +Calling Stop() may disable or reconfigure interrupts for the pin. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangepolarity.md b/windows.devices.gpio/gpiochangepolarity.md new file mode 100644 index 0000000000..31831e5bf7 --- /dev/null +++ b/windows.devices.gpio/gpiochangepolarity.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Devices.Gpio.GpioChangePolarity +-api-type: winrt enum +--- + + + +# Windows.Devices.Gpio.GpioChangePolarity + +## -description +Represents the polarity of changes that are relevant to the associated action. + +## -enum-fields +### -field Rising:1 +Transitions from low to high should trigger the associated action. + +### -field Falling:0 +Transitions from high to low should trigger the associated action. + +### -field Both:2 +Transitions from both low to high and high to low should trigger the associated action. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader.md b/windows.devices.gpio/gpiochangereader.md new file mode 100644 index 0000000000..a6f4b822b9 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Devices.Gpio.GpioChangeReader +-api-type: winrt class +--- + + + +# Windows.Devices.Gpio.GpioChangeReader + +## -description +Represents a shared circular buffer between kernal mode and user mode into which high-resolution timestamps are placed when a general-purpose I/O (GPIO) pin changes value. + +## -remarks +Kernal mode places a timestamp into the buffer when a pin changes value, and user mode removes items from the buffer. An overflow occurs when there is no longer sufficient room in the buffer to place additional timestamps. Upon overflow, further events are not reforced, and the [IsOverflowed](gpiochangereader_isoverflowed.md) property will return true. + +This class is not thread-safe. Calling functions of this class concurrently from multiple threads will have unpredictable results. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_capacity.md b/windows.devices.gpio/gpiochangereader_capacity.md new file mode 100644 index 0000000000..9c8dd189e5 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_capacity.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeReader.Capacity +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.Capacity + +## -description +Gets the maximum number of change records that the GpioChangeReader can store at one time. + +## -property-value +The maximum number of change records. + +## -remarks +When this maximum number of records is met, further changes will not be recorded and the [IsOverflowed](gpiochangereader_isoverflowed.md) property will return true. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_clear_556466.md b/windows.devices.gpio/gpiochangereader_clear_556466.md new file mode 100644 index 0000000000..791daae2a9 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_clear_556466.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.Clear +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.Clear + +## -description +Discards all change records from the reader's buffer. + +## -parameters + +## -remarks +This will also reset an active overflow condition, causing the [IsOverflowed](gpiochangereader_isoverflowed.md) property to return false. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_close_811482585.md b/windows.devices.gpio/gpiochangereader_close_811482585.md new file mode 100644 index 0000000000..71e5408100 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_close_811482585.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.Close +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.Close + +## -description +Closes the change reader, releasing the associated memory buffer and disassociating the reader from its pin. + +## -parameters + +## -remarks +Calling this method will also cancel any pending [WaitForItemsAsync()](gpiochangereader_waitforitemsasync_799637968.md) actions. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_getallitems_1229873107.md b/windows.devices.gpio/gpiochangereader_getallitems_1229873107.md new file mode 100644 index 0000000000..63b2570ce1 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_getallitems_1229873107.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.GetAllItems +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.GetAllItems + +## -description +Removes and returns all items current in the reader's buffer. + +## -parameters + +## -returns +IVector<[GpioChangeRecord](gpiochangerecord.md)> + +The returned vector enables random access to all the change records removed from the buffer. + +## -remarks +This will also reset an active overflow condition, causing the [IsOverflowed](gpiochangereader_isoverflowed.md) property to return false. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_getnextitem_397795694.md b/windows.devices.gpio/gpiochangereader_getnextitem_397795694.md new file mode 100644 index 0000000000..e94e2371c1 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_getnextitem_397795694.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.GetNextItem +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.GetNextItem + +## -description +Retrieves and removes the earliest inserted change record from the reader's buffer. + +## -parameters + +## -returns +[GpioChangeRecord](gpiochangerecord.md) + +A structure containing the timestamp and polarity (rising or falling) of the change. + +## -remarks +This will also reset an active overflow condition, causing the [IsOverflowed](gpiochangereader_isoverflowed.md) property to return false. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_gpiochangereader_1023478990.md b/windows.devices.gpio/gpiochangereader_gpiochangereader_1023478990.md new file mode 100644 index 0000000000..5d15a7de7a --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_gpiochangereader_1023478990.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.#ctor(Windows.Devices.Gpio.GpioPin,System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.GpioChangeReader + +## -description +Creates a new GpioChangeReader associated with the specified pin and with the specified minimum capacity for change records. Only a single GpioChangeReader may be associated with a pin at any given time. + +## -parameters + +### -param pin +The pin on which to read changes. The pin must have been opened in Exclusive mode, and cannot be associated with another change reader. + +### -param minCapacity +The minimum number of change records that the reader must be able to hold. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_gpiochangereader_193920446.md b/windows.devices.gpio/gpiochangereader_gpiochangereader_193920446.md new file mode 100644 index 0000000000..dfadaae33b --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_gpiochangereader_193920446.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.#ctor(Windows.Devices.Gpio.GpioPin) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.GpioChangeReader + +## -description +Creates a new GpioChangeReader associated with the specified pin. Only a single GpioChangeReader may be associated with a pin at any given time. + +## -parameters + +### -param pin +The pin on which to read changes. The pin must have been opened in Exclusive mode, and cannot be associated with another change reader. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_isempty.md b/windows.devices.gpio/gpiochangereader_isempty.md new file mode 100644 index 0000000000..14e61e15ce --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_isempty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeReader.IsEmpty +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.IsEmpty + +## -description +Gets whether there are currently zero change records in the reader. + +## -property-value +Returns true if there are zero change items in the reader, and false otherwise. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_isoverflowed.md b/windows.devices.gpio/gpiochangereader_isoverflowed.md new file mode 100644 index 0000000000..a0e571ed36 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_isoverflowed.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeReader.IsOverflowed +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.IsOverflowed + +## -description +Gets whether an attempt to place a change record into the reader's buffer has failed due to the buffer being full. + +## -property-value +Returns true if an attempt at placement has been unsuccessful, and false otherwise. + +## -remarks +Removing an item from the buffer will cause IsOverflowed to reset to false. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_isstarted.md b/windows.devices.gpio/gpiochangereader_isstarted.md new file mode 100644 index 0000000000..e380eb901c --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_isstarted.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeReader.IsStarted +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.IsStarted + +## -description +Gets whether pin change recording is currently active. + +## -property-value +Returns true if pin changes are currently being recorded, and false otherwise. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_length.md b/windows.devices.gpio/gpiochangereader_length.md new file mode 100644 index 0000000000..b1655682df --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_length.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeReader.Length +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.Length + +## -description +Gets the number of records currently in the change reader. + +## -property-value +The current number of change records. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_peeknextitem_644888255.md b/windows.devices.gpio/gpiochangereader_peeknextitem_644888255.md new file mode 100644 index 0000000000..2db99226c5 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_peeknextitem_644888255.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.PeekNextItem +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.PeekNextItem + +## -description +Retrieves the earlier inserted change record from the reader's buffer, without removing it. + +## -parameters + +## -returns +[GpioChangeRecord](gpiochangerecord.md) + +A structure containing the timestamp and polarity (rising or falling) of the change. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_polarity.md b/windows.devices.gpio/gpiochangereader_polarity.md new file mode 100644 index 0000000000..b24a60ecf5 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_polarity.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Gpio.GpioChangeReader.Polarity +-api-type: winrt property +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.Polarity + +## -description +Gets or sets the polarity of transitions that will be recorded. The polarity may only be changed when pin change recording is not started. + +## -property-value +Rising or Falling. The default polarity value is Falling. + +## -remarks +Listening to a single edge (Falling or Rising) can be considerably more efficient than listening to both edges. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_start_1587696324.md b/windows.devices.gpio/gpiochangereader_start_1587696324.md new file mode 100644 index 0000000000..ee8ffbe17b --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_start_1587696324.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.Start +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.Start + +## -description +Starts recording changes in pin polarity. This method may only be called when change recording is not already active. + +## -parameters + +## -remarks +Calling Start() may enable or reconfigure interrupts for the pin. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_stop_1201535524.md b/windows.devices.gpio/gpiochangereader_stop_1201535524.md new file mode 100644 index 0000000000..b21ecb2fb7 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_stop_1201535524.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.Stop +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.Stop + +## -description +Stop recording changes in pin polarity. This method may only be called when change recording is currently active. + +## -parameters + +## -remarks +Calling Stop() may disable or reconfigure interrupts for the pin. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangereader_waitforitemsasync_799637968.md b/windows.devices.gpio/gpiochangereader_waitforitemsasync_799637968.md new file mode 100644 index 0000000000..8d940f42e1 --- /dev/null +++ b/windows.devices.gpio/gpiochangereader_waitforitemsasync_799637968.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Gpio.GpioChangeReader.WaitForItemsAsync(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Devices.Gpio.GpioChangeReader.WaitForItemsAsync + +## -description +Waits for the buffer to fill with at least *count* number of items, at which point the async action will complete. This action is cancelable. + +## -parameters + +### -param count +The number of items with which the buffer must fill before the async operation completes. + +## -returns + +## -remarks +If the pin or change reader is closed while a wait is in progress, the async operation will be cancelled. + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpiochangerecord.md b/windows.devices.gpio/gpiochangerecord.md new file mode 100644 index 0000000000..47a0181fc7 --- /dev/null +++ b/windows.devices.gpio/gpiochangerecord.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Devices.Gpio.GpioChangeRecord +-api-type: winrt struct +--- + + + +# Windows.Devices.Gpio.GpioChangeRecord + +## -description +Stores a relative timestap of a general-purpose I/O (GPIO) pin value change, and whether the pin transitioned from low to high or from high to low. + +## -struct-fields + +### -field Edge +A [GpioPinEdge](gpiopinedge.md) object corresponding to the transition type. + +### -field RelativeTime +A relative timestamp that can be used to determine the difference in time between two change records. This timestamp does not correspond to any absolute or system time. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.gpio/gpioopenstatus.md b/windows.devices.gpio/gpioopenstatus.md index dbf6b2f94d..b4249c1055 100644 --- a/windows.devices.gpio/gpioopenstatus.md +++ b/windows.devices.gpio/gpioopenstatus.md @@ -28,9 +28,16 @@ The pin is currently open in an incompatible sharing mode. For example: +### -field MuxingConflict:3 + + +### -field UnknownError:4 + + ## -remarks ## -examples ## -see-also -[GpioController.TryOpenPin](gpiocontroller_tryopenpin.md), [GpioSharingMode](gpiosharingmode.md) \ No newline at end of file +[GpioController.TryOpenPin](gpiocontroller_tryopenpin.md), [GpioSharingMode](gpiosharingmode.md) + diff --git a/windows.devices.haptics/knownsimplehapticscontrollerwaveforms.md b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms.md new file mode 100644 index 0000000000..b8bb11f3cc --- /dev/null +++ b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms +-api-type: winrt class +--- + + + +# Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms + +## -description +Provides a set of well-known haptic waveform types. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_buzzcontinuous.md b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_buzzcontinuous.md new file mode 100644 index 0000000000..1eff9a666b --- /dev/null +++ b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_buzzcontinuous.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.BuzzContinuous +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.BuzzContinuous + +## -description +Gets a buzz waveform that is generated continuously without interruption until terminated. + +## -property-value +An unsigned 16-bit waveform ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_click.md b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_click.md new file mode 100644 index 0000000000..2ea9964a1a --- /dev/null +++ b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_click.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.Click +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.Click + +## -description +Gets a click waveform. + +## -property-value +An unsigned 16-bit waveform ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_press.md b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_press.md new file mode 100644 index 0000000000..5947e3539d --- /dev/null +++ b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_press.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.Press +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.Press + +## -description +Gets a press waveform. + +## -property-value +An unsigned 16-bit waveform ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_release.md b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_release.md new file mode 100644 index 0000000000..32ec9df016 --- /dev/null +++ b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_release.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.Release +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.Release + +## -description +Gets a release waveform. + +## -property-value +An unsigned 16-bit waveform ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_rumblecontinuous.md b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_rumblecontinuous.md new file mode 100644 index 0000000000..178a43b768 --- /dev/null +++ b/windows.devices.haptics/knownsimplehapticscontrollerwaveforms_rumblecontinuous.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.RumbleContinuous +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.KnownSimpleHapticsControllerWaveforms.RumbleContinuous + +## -description +Gets a rumble waveform that is generated continuously without interruption until terminated. + +## -property-value +An unsigned 16-bit waveform ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller.md b/windows.devices.haptics/simplehapticscontroller.md new file mode 100644 index 0000000000..94f28e88d6 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Haptics.SimpleHapticsController +-api-type: winrt class +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController + +## -description +Provides access to a single haptic input device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_id.md b/windows.devices.haptics/simplehapticscontroller_id.md new file mode 100644 index 0000000000..cc2db0e652 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsController.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.Id + +## -description +Gets the identifier for the haptic input device. + +## -property-value +The Global Unique Identifier (GUID) used to identify a single input device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_isintensitysupported.md b/windows.devices.haptics/simplehapticscontroller_isintensitysupported.md new file mode 100644 index 0000000000..c4b5ae811e --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_isintensitysupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsController.IsIntensitySupported +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.IsIntensitySupported + +## -description +Gets whether the haptic input device supports feedback intensity. + +## -property-value +**true** if feedback intensity is supported. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_isplaycountsupported.md b/windows.devices.haptics/simplehapticscontroller_isplaycountsupported.md new file mode 100644 index 0000000000..04d42b21b7 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_isplaycountsupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsController.IsPlayCountSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.IsPlayCountSupported + +## -description +Gets whether the haptic input device supports feedback counts. + +## -property-value +**true** if feedback counts are supported. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_isplaydurationsupported.md b/windows.devices.haptics/simplehapticscontroller_isplaydurationsupported.md new file mode 100644 index 0000000000..e9416d8128 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_isplaydurationsupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsController.IsPlayDurationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.IsPlayDurationSupported + +## -description +Gets whether the haptic input device supports feedback duration. + +## -property-value +**true** if duration is supported. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_isreplaypauseintervalsupported.md b/windows.devices.haptics/simplehapticscontroller_isreplaypauseintervalsupported.md new file mode 100644 index 0000000000..d9751c365e --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_isreplaypauseintervalsupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsController.IsReplayPauseIntervalSupported +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.IsReplayPauseIntervalSupported + +## -description +Gets whether the haptic input device supports pause intervals between feedback cycles. + +## -property-value +**true** if intervals are supported. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_sendhapticfeedback_1295394442.md b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedback_1295394442.md new file mode 100644 index 0000000000..93ab4b7bb0 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedback_1295394442.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedback(Windows.Devices.Haptics.SimpleHapticsControllerFeedback) +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedback + +## -description +Start haptic feedback by the input device. + +## -parameters + +### -param feedback +The type of haptic feedback. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_sendhapticfeedback_1352523374.md b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedback_1352523374.md new file mode 100644 index 0000000000..0e0e5a9ef9 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedback_1352523374.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedback(Windows.Devices.Haptics.SimpleHapticsControllerFeedback,System.Double) +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedback + +## -description +Start haptic feedback by the input device with the specified intensity. + +## -parameters + +### -param feedback +The type of haptic feedback. + +### -param intensity +The relative strength of the haptic feedback as a percentage of the capability of the input device. +- 0 disables haptic feedback +- 100 is maximum strength + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_sendhapticfeedbackforduration_1429380461.md b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedbackforduration_1429380461.md new file mode 100644 index 0000000000..534c22ac64 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedbackforduration_1429380461.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedbackForDuration(Windows.Devices.Haptics.SimpleHapticsControllerFeedback,System.Double,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedbackForDuration + +## -description +Start haptic feedback by the input device and continue for the specified amount of time. + +## -parameters + +### -param feedback +The type of haptic feedback. + +### -param intensity +The relative strength of the haptic feedback as a percentage of the capability of the input device. +- 0 disables haptic feedback +- 100 is maximum strength + +### -param playDuration +The time period expressed in 100-nanosecond units. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_sendhapticfeedbackforplaycount_378377622.md b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedbackforplaycount_378377622.md new file mode 100644 index 0000000000..934b1c5917 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_sendhapticfeedbackforplaycount_378377622.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedbackForPlayCount(Windows.Devices.Haptics.SimpleHapticsControllerFeedback,System.Double,System.Int32,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.SendHapticFeedbackForPlayCount + +## -description +Start haptic feedback by the input device and repeat for the specified number of times. + +## -parameters + +### -param feedback +The type of haptic feedback. + +### -param intensity +The relative strength of the haptic feedback as a percentage of the capability of the input device. +- 0 disables haptic feedback +- 100 is maximum strength + +### -param playCount +The number of times to repeat the haptic feedback. + +### -param replayPauseInterval +The time period between feedback cycles, expressed in 100-nanosecond units. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_stopfeedback_481424790.md b/windows.devices.haptics/simplehapticscontroller_stopfeedback_481424790.md new file mode 100644 index 0000000000..35fda6bd7a --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_stopfeedback_481424790.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Devices.Haptics.SimpleHapticsController.StopFeedback +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.StopFeedback + +## -description +Terminates haptic feedback by the input device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontroller_supportedfeedback.md b/windows.devices.haptics/simplehapticscontroller_supportedfeedback.md new file mode 100644 index 0000000000..6af170c1fa --- /dev/null +++ b/windows.devices.haptics/simplehapticscontroller_supportedfeedback.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsController.SupportedFeedback +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsController.SupportedFeedback + +## -description +Gets the types of feedback supported by the haptic input device. + +## -property-value +The collection of feedback types supported and their duration. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontrollerfeedback.md b/windows.devices.haptics/simplehapticscontrollerfeedback.md new file mode 100644 index 0000000000..51a44a3948 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontrollerfeedback.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Haptics.SimpleHapticsControllerFeedback +-api-type: winrt class +--- + + + +# Windows.Devices.Haptics.SimpleHapticsControllerFeedback + +## -description +Provides access to the feedback behaviors supported by the haptic input device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontrollerfeedback_duration.md b/windows.devices.haptics/simplehapticscontrollerfeedback_duration.md new file mode 100644 index 0000000000..4428852f47 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontrollerfeedback_duration.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsControllerFeedback.Duration +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsControllerFeedback.Duration + +## -description +Gets the feedback duration for the haptic input device. + +## -property-value +The time period, expressed in 100-nanosecond units. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/simplehapticscontrollerfeedback_waveform.md b/windows.devices.haptics/simplehapticscontrollerfeedback_waveform.md new file mode 100644 index 0000000000..b29c7b2ca2 --- /dev/null +++ b/windows.devices.haptics/simplehapticscontrollerfeedback_waveform.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.SimpleHapticsControllerFeedback.Waveform +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.SimpleHapticsControllerFeedback.Waveform + +## -description +Gets the haptic waveform type for the haptic input device. + +## -property-value +An unsigned 16-bit waveform ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationaccessstatus.md b/windows.devices.haptics/vibrationaccessstatus.md new file mode 100644 index 0000000000..994c521115 --- /dev/null +++ b/windows.devices.haptics/vibrationaccessstatus.md @@ -0,0 +1,33 @@ +--- +-api-id: T:Windows.Devices.Haptics.VibrationAccessStatus +-api-type: winrt enum +--- + + + +# Windows.Devices.Haptics.VibrationAccessStatus + +## -description +Specifies the access rights to the vibration device. + +## -enum-fields +### -field DeniedByUser:1 +Vibration disabled by user. + +### -field DeniedBySystem:2 +Vibration disabled by system. + +### -field DeniedByEnergySaver:3 +Vibration disabled for energy saving. + +### -field Allowed:0 +Vibration enabled. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice.md b/windows.devices.haptics/vibrationdevice.md new file mode 100644 index 0000000000..a1a76b47e4 --- /dev/null +++ b/windows.devices.haptics/vibrationdevice.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.Haptics.VibrationDevice +-api-type: winrt class +--- + + + +# Windows.Devices.Haptics.VibrationDevice + +## -description +Provides access to a device that supports vibration notifications only. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice_findallasync_326280522.md b/windows.devices.haptics/vibrationdevice_findallasync_326280522.md new file mode 100644 index 0000000000..46d0926c8a --- /dev/null +++ b/windows.devices.haptics/vibrationdevice_findallasync_326280522.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Haptics.VibrationDevice.FindAllAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.VibrationDevice.FindAllAsync + +## -description +Asynchronously retrieves all vibration devices detected. + +## -returns +The collection of [VibrationDevices](vibrationdevice.md) detected. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice_fromidasync_1322863552.md b/windows.devices.haptics/vibrationdevice_fromidasync_1322863552.md new file mode 100644 index 0000000000..9153388f23 --- /dev/null +++ b/windows.devices.haptics/vibrationdevice_fromidasync_1322863552.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Haptics.VibrationDevice.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.VibrationDevice.FromIdAsync + +## -description +Asynchronously retrieves the vibration device specified. + +## -parameters + +### -param deviceId +The Global Unique Identifier (GUID) used to identify a single input device. + +## -returns +The [VibrationDevice](vibrationdevice.md) from the specified identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice_getdefaultasync_1549573963.md b/windows.devices.haptics/vibrationdevice_getdefaultasync_1549573963.md new file mode 100644 index 0000000000..13757c4ec3 --- /dev/null +++ b/windows.devices.haptics/vibrationdevice_getdefaultasync_1549573963.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Haptics.VibrationDevice.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.VibrationDevice.GetDefaultAsync + +## -description +Asynchronously retrieves the default vibration device. + +## -returns +The default [VibrationDevice](vibrationdevice.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice_getdeviceselector_838466080.md b/windows.devices.haptics/vibrationdevice_getdeviceselector_838466080.md new file mode 100644 index 0000000000..eb04c30f53 --- /dev/null +++ b/windows.devices.haptics/vibrationdevice_getdeviceselector_838466080.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Haptics.VibrationDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.VibrationDevice.GetDeviceSelector + +## -description +Retrieves an identifier as a query string that can be used as a reference to a vibration device. + +## -returns +The unique identifier for a vibration device. + +## -remarks +To access the vibration device, pass the query string to [FromIdAsync](vibrationdevice_fromidasync_1322863552.md). + +## -see-also +- [FromIdAsync](vibrationdevice_fromidasync_1322863552.md) + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice_id.md b/windows.devices.haptics/vibrationdevice_id.md new file mode 100644 index 0000000000..441fc233f8 --- /dev/null +++ b/windows.devices.haptics/vibrationdevice_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.VibrationDevice.Id +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.VibrationDevice.Id + +## -description +Gets the identifier for the vibration device. + +## -property-value +The Global Unique Identifier (GUID) used to identify a single input device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice_requestaccessasync_380675631.md b/windows.devices.haptics/vibrationdevice_requestaccessasync_380675631.md new file mode 100644 index 0000000000..adffaaaf06 --- /dev/null +++ b/windows.devices.haptics/vibrationdevice_requestaccessasync_380675631.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Devices.Haptics.VibrationDevice.RequestAccessAsync +-api-type: winrt method +--- + + + +# Windows.Devices.Haptics.VibrationDevice.RequestAccessAsync + +## -description +Asynchronously retrieves the access status of the vibration device. + +## -returns +The [VibrationAccessStatus](vibrationaccessstatus.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/vibrationdevice_simplehapticscontroller.md b/windows.devices.haptics/vibrationdevice_simplehapticscontroller.md new file mode 100644 index 0000000000..ab351fbf25 --- /dev/null +++ b/windows.devices.haptics/vibrationdevice_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.Haptics.VibrationDevice.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.Devices.Haptics.VibrationDevice.SimpleHapticsController + +## -description +Gets a reference to a [SimpleHapticsController](simplehapticscontroller.md) object to specify haptic feedback behavior. + +## -property-value +The haptic input device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.haptics/windows_devices_haptics.md b/windows.devices.haptics/windows_devices_haptics.md new file mode 100644 index 0000000000..5883d65552 --- /dev/null +++ b/windows.devices.haptics/windows_devices_haptics.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.Devices.Haptics +-api-type: winrt namespace +--- + + + +# Windows.Devices.Haptics + +## -description +Provides support for basic, non-directional haptic feedback such as clicks, buzzes, and rumbles that can be tuned through characteristics such as intensity and timing. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.humaninterfacedevice/hidbooleancontrol.md b/windows.devices.humaninterfacedevice/hidbooleancontrol.md index 8155841249..0e10c379d0 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontrol.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontrol.md @@ -13,7 +13,6 @@ public class HidBooleanControl : Windows.Devices.HumanInterfaceDevice.IHidBoolea Represents a simple Boolean control on a HID device that returns on/off values. An example would be the LED light on a keyboard. ## -remarks - ## -examples diff --git a/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md b/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md index e52d539b45..5322e9b51b 100644 --- a/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md +++ b/windows.devices.humaninterfacedevice/hidbooleancontroldescription.md @@ -13,7 +13,6 @@ public class HidBooleanControlDescription : Windows.Devices.HumanInterfaceDevice Describes a Boolean control for a given HID device. ## -remarks - ## -examples diff --git a/windows.devices.humaninterfacedevice/hidcollection.md b/windows.devices.humaninterfacedevice/hidcollection.md index d26d09d4ef..6f8a81770d 100644 --- a/windows.devices.humaninterfacedevice/hidcollection.md +++ b/windows.devices.humaninterfacedevice/hidcollection.md @@ -15,7 +15,6 @@ Retrieves the collection information for a group of related controls. The HID protocol uses collections to group a set of controls that are similar to one another, or, are related by physical or operational proximity. ## -remarks - ## -examples diff --git a/windows.devices.humaninterfacedevice/hidfeaturereport.md b/windows.devices.humaninterfacedevice/hidfeaturereport.md index b877145186..da5663865c 100644 --- a/windows.devices.humaninterfacedevice/hidfeaturereport.md +++ b/windows.devices.humaninterfacedevice/hidfeaturereport.md @@ -15,7 +15,6 @@ Represents a feature report. Feature reports are issued by both the device and the host. Devices issue feature reports to describe their capabilities and default settings to a host. Hosts issue feature reports to make requests of the device. ## -remarks - ## -examples diff --git a/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md b/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md index 41125e9ef2..e4ecf4d11d 100644 --- a/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md +++ b/windows.devices.humaninterfacedevice/hidinputreportreceivedeventargs.md @@ -13,7 +13,6 @@ public class HidInputReportReceivedEventArgs : Windows.Devices.HumanInterfaceDev Represents the arguments which the HID API sends as part of an input-report event. ## -remarks - ## -examples diff --git a/windows.devices.humaninterfacedevice/hidnumericcontrol.md b/windows.devices.humaninterfacedevice/hidnumericcontrol.md index 263fdd4df2..b99b057261 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontrol.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontrol.md @@ -13,7 +13,6 @@ public class HidNumericControl : Windows.Devices.HumanInterfaceDevice.IHidNumeri Represents a numeric control on a HID device that returns a range of values. An example would be the volume control on a speaker. ## -remarks - ## -examples diff --git a/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md b/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md index d990ddaca2..d26c5e6b66 100644 --- a/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md +++ b/windows.devices.humaninterfacedevice/hidnumericcontroldescription.md @@ -13,7 +13,6 @@ public class HidNumericControlDescription : Windows.Devices.HumanInterfaceDevice Describes a numeric control for a given HID device. ## -remarks - ## -examples diff --git a/windows.devices.i2c/i2ctransferstatus.md b/windows.devices.i2c/i2ctransferstatus.md index 0ddfa394ae..36ff4fb68a 100644 --- a/windows.devices.i2c/i2ctransferstatus.md +++ b/windows.devices.i2c/i2ctransferstatus.md @@ -29,9 +29,16 @@ The bus address was not acknowledged. For this status code, the value of the **I2cTransferResult.BytesTransferred** member that the method returns of the method is 0. +### -field ClockStretchTimeout:3 +The transfer failed due to the clock being stretched for too long. Ensure the clock line is not being held low. + +### -field UnknownError:4 +The transfer failed for an unknown reason. + ## -remarks ## -examples ## -see-also -[ReadPartial](i2cdevice_readpartial.md), [WritePartial](i2cdevice_writepartial.md), [WriteReadPartial](i2cdevice_writereadpartial.md), [I2cTransferResult](i2ctransferresult.md) \ No newline at end of file +[ReadPartial](i2cdevice_readpartial.md), [WritePartial](i2cdevice_writepartial.md), [WriteReadPartial](i2cdevice_writereadpartial.md), [I2cTransferResult](i2ctransferresult.md) + diff --git a/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md b/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md index 3d789fa7f0..b70fad45fc 100644 --- a/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md +++ b/windows.devices.pointofservice/barcodescanner_claimscannerasync_558793678.md @@ -1,30 +1,31 @@ ---- --api-id: M:Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync - -## -description -Attempts to get an exclusive access to the barcode scanner. - -## -returns -When the method completes, it returns a [ClaimedBarcodeScanner](claimedbarcodescanner.md). - -## -remarks - -## -examples - - -[!code-cpp[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetClaimBarcodeScanner)] - -[!code-csharp[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetClaimBarcodeScanner)] - -[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] - -## -see-also -[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.ClaimScannerAsync + +## -description +Attempts to get an exclusive access to the barcode scanner. + +## -returns +When the method completes, it returns a [ClaimedBarcodeScanner](claimedbarcodescanner.md). + +## -remarks + +## -examples + + +[!code-cpp[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetClaimBarcodeScanner)] + +[!code-csharp[ClaimBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetClaimBarcodeScanner)] + +[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] + +## -see-also +[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +soft.com/fwlink/p/?LinkId=620014) diff --git a/windows.devices.pointofservice/barcodescanner_close_811482585.md b/windows.devices.pointofservice/barcodescanner_close_811482585.md new file mode 100644 index 0000000000..5b154b4da3 --- /dev/null +++ b/windows.devices.pointofservice/barcodescanner_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.Close + +## -description +Close the barcode scanner session, allowing it to be claimed by another client. + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md b/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md index 2026dae556..5e51703565 100644 --- a/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md +++ b/windows.devices.pointofservice/barcodescanner_fromidasync_1322863552.md @@ -27,4 +27,4 @@ The barcode scanner specified by the unique device identifier. Returns a null ob ## -examples ## -see-also -[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) \ No newline at end of file +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) diff --git a/windows.devices.pointofservice/barcodescanner_getdeviceselector_321048197.md b/windows.devices.pointofservice/barcodescanner_getdeviceselector_321048197.md new file mode 100644 index 0000000000..478b61f140 --- /dev/null +++ b/windows.devices.pointofservice/barcodescanner_getdeviceselector_321048197.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Devices.PointOfService.BarcodeScanner.GetDeviceSelector(Windows.Devices.PointOfService.PosConnectionTypes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.BarcodeScanner.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the barcode scanners available over the specified connection types + +## -parameters +### -param connectionTypes +A list of the connection types to test for available barcode scanners. + +## -returns +An Advanced Query Syntax (AQS) string that is used to enumerate the barcode scanners available over the specified connection types + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodescannerstatus.md b/windows.devices.pointofservice/barcodescannerstatus.md index 0a242a57d4..5e5f6ab1ae 100644 --- a/windows.devices.pointofservice/barcodescannerstatus.md +++ b/windows.devices.pointofservice/barcodescannerstatus.md @@ -10,7 +10,7 @@ public enum Windows.Devices.PointOfService.BarcodeScannerStatus : int # BarcodeScannerStatus ## -description -Defines the constants that indicates the barcode scanner status. +Defines the constants that indicate the barcode scanner status. ## -enum-fields ### -field Online:0 @@ -33,4 +33,4 @@ Vendor specific status information. ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.devices.pointofservice/barcodesymbologies.md b/windows.devices.pointofservice/barcodesymbologies.md index 851a62c8ba..8b98b63833 100644 --- a/windows.devices.pointofservice/barcodesymbologies.md +++ b/windows.devices.pointofservice/barcodesymbologies.md @@ -4,7 +4,7 @@ --- # Windows.Devices.PointOfService.BarcodeSymbologies diff --git a/windows.devices.pointofservice/barcodesymbologies_gs1dwcode.md b/windows.devices.pointofservice/barcodesymbologies_gs1dwcode.md new file mode 100644 index 0000000000..46be9488f8 --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologies_gs1dwcode.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DWCode +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologies.Gs1DWCode + +## -description +Gets the GS1DWCode barcode symbology. + +## -property-value +The GS1DWCode barcode symbology. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes.md b/windows.devices.pointofservice/barcodesymbologyattributes.md new file mode 100644 index 0000000000..4f1dca7052 --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeSymbologyAttributes +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes + +## -description +The symbology attributes of a barcode scanner. + +## -remarks +This object is created when a [ClaimedBarcodeScanner.GetSymbologyAttributesAsync](claimedbarcodescanner_getsymbologyattributesasync.md) method completes. + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_decodelength1.md b/windows.devices.pointofservice/barcodesymbologyattributes_decodelength1.md new file mode 100644 index 0000000000..57d3d85904 --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_decodelength1.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.DecodeLength1 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.DecodeLength1 + +## -description +Gets or sets the first value used to determine the barcode symbology decode length. + +## -property-value +The first part of the decode length. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_decodelength2.md b/windows.devices.pointofservice/barcodesymbologyattributes_decodelength2.md new file mode 100644 index 0000000000..4cc9948644 --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_decodelength2.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.DecodeLength2 +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.DecodeLength2 + +## -description +Gets or sets the second value used to determine the barcode symbology decode length. + +## -property-value +The second part of the decode length. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_decodelengthkind.md b/windows.devices.pointofservice/barcodesymbologyattributes_decodelengthkind.md new file mode 100644 index 0000000000..aa4b42542e --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_decodelengthkind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.DecodeLengthKind +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.DecodeLengthKind + +## -description +Gets or sets the decode length kind used by the barcode symbology. + +## -property-value +The decode length kind used by the barcode symbology. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigittransmissionenabled.md b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigittransmissionenabled.md new file mode 100644 index 0000000000..03e7010ff3 --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigittransmissionenabled.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitTransmissionEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitTransmissionEnabled + +## -description +Gets or sets whether the check digit will be transmitted to the host as part of the raw data. + +## -property-value +True if the check digit will be tranmissted to the host as raw data; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigittransmissionsupported.md b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigittransmissionsupported.md new file mode 100644 index 0000000000..431cf5105b --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigittransmissionsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitTransmissionSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitTransmissionSupported + +## -description +Gets whether the barcode symbology supports transmitting the check digit to the host as part of the raw data. + +## -property-value +True if the barcode symbology supports transmitting the check digit as raw data; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigitvalidationenabled.md b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigitvalidationenabled.md new file mode 100644 index 0000000000..502cde980d --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigitvalidationenabled.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitValidationEnabled +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitValidationEnabled + +## -description +Gets whether barcode check digit will be validated. + +## -property-value +True if the barcode check digit will be validated; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigitvalidationsupported.md b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigitvalidationsupported.md new file mode 100644 index 0000000000..66db85f62b --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_ischeckdigitvalidationsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitValidationSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsCheckDigitValidationSupported + +## -description +Gets whether the barcode symbology supports check digit validation. + +## -property-value +True if the barcode symbology supports check digit validation; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologyattributes_isdecodelengthsupported.md b/windows.devices.pointofservice/barcodesymbologyattributes_isdecodelengthsupported.md new file mode 100644 index 0000000000..01e28fe9e8 --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologyattributes_isdecodelengthsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsDecodeLengthSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyAttributes.IsDecodeLengthSupported + +## -description +Gets whether the barcode symbology supports multiple decode lengths. + +## -property-value +True if the barcode symbology supports multiple decode lengths; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/barcodesymbologydecodelengthkind.md b/windows.devices.pointofservice/barcodesymbologydecodelengthkind.md new file mode 100644 index 0000000000..a249a1f1dc --- /dev/null +++ b/windows.devices.pointofservice/barcodesymbologydecodelengthkind.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.Devices.PointOfService.BarcodeSymbologyDecodeLengthKind +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.BarcodeSymbologyDecodeLengthKind + +## -description +The types of decode lengths that barcode symbologies can support. + +## -enum-fields +### -field Range:2 +Decode lengths between [DecodeLength1](barcodesymbologyattributes_decodelength1.md) and [DecodeLength2](barcodesymbologyattributes_decodelength2.md) single-byte characters. The order of [DecodeLength1](barcodesymbologyattributes_decodelength1.md) and [DecodeLength2](barcodesymbologyattributes_decodelength2.md) do not matter (either can be higher or lower than the other). + +### -field Discrete:1 +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. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/cashdrawer_close_811482585.md b/windows.devices.pointofservice/cashdrawer_close_811482585.md new file mode 100644 index 0000000000..9593fc2228 --- /dev/null +++ b/windows.devices.pointofservice/cashdrawer_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.Close + +## -description +Close the cash drawer session. + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/cashdrawer_getdeviceselector_321048197.md b/windows.devices.pointofservice/cashdrawer_getdeviceselector_321048197.md new file mode 100644 index 0000000000..738a9b9c74 --- /dev/null +++ b/windows.devices.pointofservice/cashdrawer_getdeviceselector_321048197.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.CashDrawer.GetDeviceSelector(Windows.Devices.PointOfService.PosConnectionTypes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.CashDrawer.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the cash drawers available over the specified connection types + +## -parameters + +### -param connectionTypes +A list of the connection types to check for available cash drawers. + +## -returns +An Advanced Query Syntax (AQS) string that is used to enumerate the cash drawers available over the specified connection types + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md b/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md index 346ed455b7..c4595ea39f 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_enableasync_208845947.md @@ -1,29 +1,29 @@ ---- --api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync - -## -description -Gets the barcode scanner into a ready state for [DataReceived](claimedbarcodescanner_datareceived.md) events. - -## -returns -No object or value is returned when this method completes. - -## -remarks - -## -examples - - -[!code-cpp[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetEnableBarcodeScanner)] - -[!code-csharp[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetEnableBarcodeScanner)] - -[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] - -## -see-also +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.EnableAsync + +## -description +Gets the barcode scanner into a ready state for [DataReceived](claimedbarcodescanner_datareceived.md) events. + +## -returns +No object or value is returned when this method completes. + +## -remarks + +## -examples + + +[!code-cpp[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetEnableBarcodeScanner)] + +[!code-csharp[EnableBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetEnableBarcodeScanner)] + +[!code-js[CreateBarcodeScannerJS](../windows.devices.pointofservice/code/BarcodeScanner/js/scenario1.js#SnippetCreateBarcodeScannerJS)] + +## -see-also diff --git a/windows.devices.pointofservice/claimedbarcodescanner_getsymbologyattributesasync_1783019997.md b/windows.devices.pointofservice/claimedbarcodescanner_getsymbologyattributesasync_1783019997.md new file mode 100644 index 0000000000..378bd53351 --- /dev/null +++ b/windows.devices.pointofservice/claimedbarcodescanner_getsymbologyattributesasync_1783019997.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.GetSymbologyAttributesAsync(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.GetSymbologyAttributesAsync + +## -description +Gets the attributes of the specified barcode symbology. + +## -parameters + +### -param barcodeSymbology +The barcode symbology. + +## -returns +A [BarcodeSymbologyAttributes](barcodesymbologyattributes.md) object, containing the attributes of the specified barcode symbology. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md b/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md index f19df53779..f6144f8e43 100644 --- a/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md +++ b/windows.devices.pointofservice/claimedbarcodescanner_releasedevicerequested.md @@ -1,34 +1,35 @@ ---- --api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested --api-type: winrt event ---- - - - -# Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested - -## -description -Occurs when the device gets a request to release its exclusive claim. - -## -remarks -If your application receives a [ReleaseDeviceRequested](claimedbarcodescanner_releasedevicerequested.md) event from another application, it may lose its exclusive claim unless your application retains the device. - -## -examples -The following example shows how to setup the event handler. - - - -[!code-cpp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetSetupBarcodeScanner)] - -[!code-csharp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetSetupBarcodeScanner)] - - - -[!code-cpp[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetReleaseDeviceRequested)] - -[!code-csharp[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetReleaseDeviceRequested)] - -## -see-also -[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.ReleaseDeviceRequested + +## -description +Occurs when the device gets a request to release its exclusive claim. + +## -remarks +If your application receives a [ReleaseDeviceRequested](claimedbarcodescanner_releasedevicerequested.md) event from another application, it may lose its exclusive claim unless your application retains the device. + +## -examples +The following example shows how to setup the event handler. + + + +[!code-cpp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetSetupBarcodeScanner)] + +[!code-csharp[SetupBarcodeScanner](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetSetupBarcodeScanner)] + + + +[!code-cpp[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cpp/Scenario1.xaml.cpp#SnippetReleaseDeviceRequested)] + +[!code-csharp[ReleaseDeviceRequested](../windows.devices.pointofservice/code/BarcodeScanner/cs/Scenario1.xaml.cs#SnippetReleaseDeviceRequested)] + +## -see-also +[Barcode scanner sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) +ample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620014) diff --git a/windows.devices.pointofservice/claimedbarcodescanner_setsymbologyattributesasync_268186065.md b/windows.devices.pointofservice/claimedbarcodescanner_setsymbologyattributesasync_268186065.md new file mode 100644 index 0000000000..82c91a787c --- /dev/null +++ b/windows.devices.pointofservice/claimedbarcodescanner_setsymbologyattributesasync_268186065.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetSymbologyAttributesAsync(System.UInt32,Windows.Devices.PointOfService.BarcodeSymbologyAttributes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedBarcodeScanner.SetSymbologyAttributesAsync + +## -description +Sets the attributes of the barcode symbology used by the claimed barcode scanner. + +## -parameters + +### -param barcodeSymbology +The barcode symbology. + +### -param attributes +The barcode symbology attributes. + +## -returns +True if the barcode symbology attributes were successfully set; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay.md b/windows.devices.pointofservice/claimedlinedisplay.md new file mode 100644 index 0000000000..83902911cd --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.ClaimedLineDisplay +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay + +## -description +Represents a claimed line display device. + +## -remarks +This object is created when the [LineDisplay.ClaimAsync](linedisplay_claimasync.md) method completes. + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_capabilities.md b/windows.devices.pointofservice/claimedlinedisplay_capabilities.md new file mode 100644 index 0000000000..605af4ba86 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_capabilities.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.Capabilities + +## -description +Gets the capabilities of the claimed line display. + +## -property-value +The capabilities of the line display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_close_811482585.md b/windows.devices.pointofservice/claimedlinedisplay_close_811482585.md new file mode 100644 index 0000000000..964ad29c5d --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.Close + +## -description +Close the line display session. + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_defaultwindow.md b/windows.devices.pointofservice/claimedlinedisplay_defaultwindow.md new file mode 100644 index 0000000000..612f0247de --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_defaultwindow.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.DefaultWindow +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.DefaultWindow + +## -description +Gets the default device window of the line display. + +## -property-value +The default device window, covering the entire screen area. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_devicecontroldescription.md b/windows.devices.pointofservice/claimedlinedisplay_devicecontroldescription.md new file mode 100644 index 0000000000..7ed046d93e --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_devicecontroldescription.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceControlDescription +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceControlDescription + +## -description +Gets the device control description of the line display. + +## -property-value +The control description of the line display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_devicecontrolversion.md b/windows.devices.pointofservice/claimedlinedisplay_devicecontrolversion.md new file mode 100644 index 0000000000..7ce15fe38c --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_devicecontrolversion.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceControlVersion +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceControlVersion + +## -description +Gets the device control version number of the line display. + +## -property-value +The UnifiedPOS control version number of the line display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_deviceid.md b/windows.devices.pointofservice/claimedlinedisplay_deviceid.md new file mode 100644 index 0000000000..c77e00c08e --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_deviceid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the line display. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the line display. + +## -remarks + +## -see-also +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_deviceserviceversion.md b/windows.devices.pointofservice/claimedlinedisplay_deviceserviceversion.md new file mode 100644 index 0000000000..0441f7ff45 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_deviceserviceversion.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceServiceVersion +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.DeviceServiceVersion + +## -description +Gets the service version number of the line display. + +## -property-value +The service version number. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_fromidasync_1322863552.md b/windows.devices.pointofservice/claimedlinedisplay_fromidasync_1322863552.md new file mode 100644 index 0000000000..17eb29829f --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_fromidasync_1322863552.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.FromIdAsync + +## -description +Creates a [LineDisplay](linedisplay.md) object from the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). + +## -parameters + +### -param deviceId +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific line display, which can be retrieved from the [DeviceId](barcodescanner_deviceid.md) property. + +## -returns +The line display specified by the unique device identifier. Returns a null object in the following cases: ++ The specific device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_getdeviceselector_321048197.md b/windows.devices.pointofservice/claimedlinedisplay_getdeviceselector_321048197.md new file mode 100644 index 0000000000..6d29a3f46d --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_getdeviceselector_321048197.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.GetDeviceSelector(Windows.Devices.PointOfService.PosConnectionTypes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the line displays available over the specified connection types + +## -parameters + +### -param connectionTypes +A list of the connection types to check for available line displays. + +## -returns +An AQS string that is used to enumerate available line displays available over the specified connection types + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_getdeviceselector_838466080.md b/windows.devices.pointofservice/claimedlinedisplay_getdeviceselector_838466080.md new file mode 100644 index 0000000000..d25d3bcc51 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_getdeviceselector_838466080.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays. + +## -parameters + +## -returns +An Advanced Query Syntax string that is used to enumerate available line displays. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_physicaldevicedescription.md b/windows.devices.pointofservice/claimedlinedisplay_physicaldevicedescription.md new file mode 100644 index 0000000000..2537674f3f --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_physicaldevicedescription.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.PhysicalDeviceDescription +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.PhysicalDeviceDescription + +## -description +Gets the physical device description. + +## -property-value +The physical device description given by the UnifiedPOS specification. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_physicaldevicename.md b/windows.devices.pointofservice/claimedlinedisplay_physicaldevicename.md new file mode 100644 index 0000000000..53049619dc --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_physicaldevicename.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.ClaimedLineDisplay.PhysicalDeviceName +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.PhysicalDeviceName + +## -description +Gets the physical device name. + +## -property-value +The physical device name given by the UnifiedPOS specification. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_releasedevicerequested.md b/windows.devices.pointofservice/claimedlinedisplay_releasedevicerequested.md new file mode 100644 index 0000000000..62bf31c091 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_releasedevicerequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedLineDisplay.ReleaseDeviceRequested +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.ReleaseDeviceRequested + +## -description +Occurs when a claimed line display claimed is claimed by another app with [LineDisplay.ClaimAsync](linedisplay_claimasync.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedlinedisplay_retaindevice_1634489834.md b/windows.devices.pointofservice/claimedlinedisplay_retaindevice_1634489834.md new file mode 100644 index 0000000000..31b4556075 --- /dev/null +++ b/windows.devices.pointofservice/claimedlinedisplay_retaindevice_1634489834.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedLineDisplay.RetainDevice +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedLineDisplay.RetainDevice + +## -description +Retains an app's claim on a line display device after it has been claimed by another app with [LineDisplay.ClaimAsync](linedisplay_claimasync.md). + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md b/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md index e4cd4ddbf3..b44ce9d330 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_bankcarddatareceived.md @@ -1,41 +1,41 @@ ---- --api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived --api-type: winrt event ---- - - - -# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived - -## -description -Occurs when a bank card is swiped. - -## -remarks -An application can register for this event event handler to get the bank card data each time a bank card is swiped through the magnetic stripe reader. - -## -examples -The following example shows how to setup the magnetic stripe reader to receive data after a scanning event. - - - -[!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)] - -[!code-csharp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] - - - -[!code-cpp[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderDataReceived)] - -[!code-csharp[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderDataReceived)] - - -[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] - - - -[!code-js[MagStripeReaderDataReceivedJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetMagStripeReaderDataReceivedJS)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.BankCardDataReceived + +## -description +Occurs when a bank card is swiped. + +## -remarks +An application can register for this event event handler to get the bank card data each time a bank card is swiped through the magnetic stripe reader. + +## -examples +The following example shows how to setup the magnetic stripe reader to receive data after a scanning event. + + + +[!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)] + +[!code-csharp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] + + + +[!code-cpp[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderDataReceived)] + +[!code-csharp[MagStripeReaderDataReceived](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderDataReceived)] + + +[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] + + + +[!code-js[MagStripeReaderDataReceivedJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetMagStripeReaderDataReceivedJS)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md b/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md index 7d3e5e008b..b873fcd1dd 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_enableasync_208845947.md @@ -1,30 +1,31 @@ ---- --api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync - -## -description -Gets the magnetic stripe reader into a ready state to receive data events. - -## -returns -No object or value is returned by this method when it completes. - -## -remarks - -## -examples - - -[!code-cpp[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetEnableMagStripeReader)] - -[!code-csharp[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetEnableMagStripeReader)] - -[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: M:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.EnableAsync + +## -description +Gets the magnetic stripe reader into a ready state to receive data events. + +## -returns +No object or value is returned by this method when it completes. + +## -remarks + +## -examples + + +[!code-cpp[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetEnableMagStripeReader)] + +[!code-csharp[EnableMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetEnableMagStripeReader)] + +[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +soft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md b/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md index 7000a771b0..9f63fcba57 100644 --- a/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md +++ b/windows.devices.pointofservice/claimedmagneticstripereader_releasedevicerequested.md @@ -1,33 +1,34 @@ ---- --api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested --api-type: winrt event ---- - - - -# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested - -## -description -Occurs when the device gets a request to release its exclusive claim. - -## -remarks - -## -examples -The following example shows how to setup the event handler. - - - -[!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)] - -[!code-csharp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] - - - -[!code-cpp[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderReleaseDeviceRequested)] - -[!code-csharp[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderReleaseDeviceRequested)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: E:Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested +-api-type: winrt event +--- + + + +# Windows.Devices.PointOfService.ClaimedMagneticStripeReader.ReleaseDeviceRequested + +## -description +Occurs when the device gets a request to release its exclusive claim. + +## -remarks + +## -examples +The following example shows how to setup the event handler. + + + +[!code-cpp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetSetupMagStripeReader)] + +[!code-csharp[SetupMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetSetupMagStripeReader)] + + + +[!code-cpp[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetMagStripeReaderReleaseDeviceRequested)] + +[!code-csharp[MagStripeReaderReleaseDeviceRequested](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetMagStripeReaderReleaseDeviceRequested)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +ample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/linedisplay.md b/windows.devices.pointofservice/linedisplay.md new file mode 100644 index 0000000000..1099f0607f --- /dev/null +++ b/windows.devices.pointofservice/linedisplay.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplay +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplay + +## -description +Represents a line display device. + +## -remarks +This object is created when a [GetDefaultAsync](linedisplay_getdefaultasync.md) or [FromIdAsync](linedisplay_fromidasync.md) method completes. + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_capabilities.md b/windows.devices.pointofservice/linedisplay_capabilities.md new file mode 100644 index 0000000000..5f01156ab0 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_capabilities.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.Capabilities + +## -description +Gets the capabilities of the specified line display. + +## -property-value +The capabilities of the line display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_claimasync_1760840245.md b/windows.devices.pointofservice/linedisplay_claimasync_1760840245.md new file mode 100644 index 0000000000..122e1c1fa5 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_claimasync_1760840245.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplay.ClaimAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplay.ClaimAsync + +## -description +Attempts to gain exclusive access to the line display. + +## -parameters + +## -returns +When the method completes, it returns a [ClaimedLineDisplay](claimedlinedisplay.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_close_811482585.md b/windows.devices.pointofservice/linedisplay_close_811482585.md new file mode 100644 index 0000000000..a461ac5ee2 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplay.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplay.Close + +## -description +Close the line display session, allowing it to be claimed by another client. + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_devicecontroldescription.md b/windows.devices.pointofservice/linedisplay_devicecontroldescription.md new file mode 100644 index 0000000000..7cda0c017b --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_devicecontroldescription.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.DeviceControlDescription +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.DeviceControlDescription + +## -description +Gets the device control description of the line display. + +## -property-value +The control description of the line display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_devicecontrolversion.md b/windows.devices.pointofservice/linedisplay_devicecontrolversion.md new file mode 100644 index 0000000000..17221289e9 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_devicecontrolversion.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.DeviceControlVersion +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.DeviceControlVersion + +## -description +Gets the device control version number of the line display. + +## -property-value +The UnifiedPOS control version number of the line display, formatted as a string. +Read-only string that describes the UnifiedPOS control version number formatted as a string. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_deviceid.md b/windows.devices.pointofservice/linedisplay_deviceid.md new file mode 100644 index 0000000000..e4a6db677d --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_deviceid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.DeviceId +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.DeviceId + +## -description +Gets the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the line display. + +## -property-value +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) of the line display. + +## -remarks + +## -see-also +[DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_deviceserviceversion.md b/windows.devices.pointofservice/linedisplay_deviceserviceversion.md new file mode 100644 index 0000000000..0055d63589 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_deviceserviceversion.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.DeviceServiceVersion +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.DeviceServiceVersion + +## -description +Gets the service version number of the line display. + +## -property-value +The UnifiedPOS service version number, formatted as a string. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_fromidasync_1322863552.md b/windows.devices.pointofservice/linedisplay_fromidasync_1322863552.md new file mode 100644 index 0000000000..df1774fab3 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_fromidasync_1322863552.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplay.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplay.FromIdAsync + +## -description +Creates a [LineDisplay](linedisplay.md) object from the [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md). + +## -parameters + +### -param deviceId +The [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md) that identifies a specific line display, which can be retrieved from the [DeviceId](barcodescanner_deviceid.md) property. + +## -returns +The line display specified by the unique device identifier. Returns a null object in the following cases: ++ The specific device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_getdefaultasync_1549573963.md b/windows.devices.pointofservice/linedisplay_getdefaultasync_1549573963.md new file mode 100644 index 0000000000..c6e12725c3 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_getdefaultasync_1549573963.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplay.GetDefaultAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplay.GetDefaultAsync + +## -description +Returns the first available line display. + +## -parameters + +## -returns +The first available line display. Returns a null object in the following cases: ++ A device is not found. ++ Access denied to the existing device. The user can deny access to a device, which is not treated as an exception. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_getdeviceselector_321048197.md b/windows.devices.pointofservice/linedisplay_getdeviceselector_321048197.md new file mode 100644 index 0000000000..542106b15e --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_getdeviceselector_321048197.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplay.GetDeviceSelector(Windows.Devices.PointOfService.PosConnectionTypes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplay.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the line displays available over the specified connection types + +## -parameters + +### -param connectionTypes +A list of the connection types to check for available line displays. + +## -returns +An AQS string that is used to enumerate the line displays available over the specified connection types + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_getdeviceselector_838466080.md b/windows.devices.pointofservice/linedisplay_getdeviceselector_838466080.md new file mode 100644 index 0000000000..4801265745 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_getdeviceselector_838466080.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplay.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplay.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays. + +## -parameters + +## -returns +An Advanced Query Syntax string that is used to enumerate available line displays. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_physicaldevicedescription.md b/windows.devices.pointofservice/linedisplay_physicaldevicedescription.md new file mode 100644 index 0000000000..60d7fd3b81 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_physicaldevicedescription.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.PhysicalDeviceDescription +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.PhysicalDeviceDescription + +## -description +Gets the physical device description. + +## -property-value +The physical device description given by the UnifiedPOS specification. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplay_physicaldevicename.md b/windows.devices.pointofservice/linedisplay_physicaldevicename.md new file mode 100644 index 0000000000..b66bfdc566 --- /dev/null +++ b/windows.devices.pointofservice/linedisplay_physicaldevicename.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplay.PhysicalDeviceName +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplay.PhysicalDeviceName + +## -description +Gets the physical device name. + +## -property-value +The physical device name given by the UnifiedPOS specification. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities.md b/windows.devices.pointofservice/linedisplaycapabilities.md new file mode 100644 index 0000000000..e05ab4ff1d --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayCapabilities +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities + +## -description +Represents the line display capabilities. + +## -remarks +This object is accessed when you retrieve the [Capabilities](linedisplay_capabilities.md) property of the [LineDisplay](linedisplay.md) object. + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_canblink.md b/windows.devices.pointofservice/linedisplaycapabilities_canblink.md new file mode 100644 index 0000000000..9cb445373f --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_canblink.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanBlink +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanBlink + +## -description +Gets whether the line display supports blinking + +## -property-value +The support for blinking. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_canchangeblinkrate.md b/windows.devices.pointofservice/linedisplaycapabilities_canchangeblinkrate.md new file mode 100644 index 0000000000..f8986f8ebf --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_canchangeblinkrate.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanChangeBlinkRate +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanChangeBlinkRate + +## -description +Gets whether the line display supports changing its blink rate. + +## -property-value +True if the line display supports changing its blink rate; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_canchangescreensize.md b/windows.devices.pointofservice/linedisplaycapabilities_canchangescreensize.md new file mode 100644 index 0000000000..2ee19ef534 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_canchangescreensize.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanChangeScreenSize +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanChangeScreenSize + +## -description +Gets whether the line display supports changing its screen size. + +## -property-value +True if the line display supports changing its screen size; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_candisplaybitmaps.md b/windows.devices.pointofservice/linedisplaycapabilities_candisplaybitmaps.md new file mode 100644 index 0000000000..79a6f26d73 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_candisplaybitmaps.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanDisplayBitmaps +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanDisplayBitmaps + +## -description +Gets whether the line display supports displaying bitmaps. + +## -property-value +True if the line display supports displaying bitmaps; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_candisplaycustomglyphs.md b/windows.devices.pointofservice/linedisplaycapabilities_candisplaycustomglyphs.md new file mode 100644 index 0000000000..20041b2248 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_candisplaycustomglyphs.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanDisplayCustomGlyphs +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanDisplayCustomGlyphs + +## -description +Gets whether the line display supports displaying custom glyphs. + +## -property-value +True if the line display supports displaying custom glyphs; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_canmapcharactersets.md b/windows.devices.pointofservice/linedisplaycapabilities_canmapcharactersets.md new file mode 100644 index 0000000000..2e7b76a588 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_canmapcharactersets.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanMapCharacterSets +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanMapCharacterSets + +## -description +Gets whether the line display supports mapping characters sets. + +## -property-value +True if the line display supports mapping character sets; otherwise false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_canreadcharacteratcursor.md b/windows.devices.pointofservice/linedisplaycapabilities_canreadcharacteratcursor.md new file mode 100644 index 0000000000..9f92a8d85e --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_canreadcharacteratcursor.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanReadCharacterAtCursor +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanReadCharacterAtCursor + +## -description +Gets whether the line display supports reading characters at the current cursor position. + +## -property-value +True if the line display supports reading characters at the cursor; otherwise false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_canreverse.md b/windows.devices.pointofservice/linedisplaycapabilities_canreverse.md new file mode 100644 index 0000000000..4e4edbc34a --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_canreverse.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.CanReverse +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.CanReverse + +## -description +Gets whether the line display supports reversing the video display. + +## -property-value +The support for reversing the video display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_isbrightnesssupported.md b/windows.devices.pointofservice/linedisplaycapabilities_isbrightnesssupported.md new file mode 100644 index 0000000000..c29625a4c7 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_isbrightnesssupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.IsBrightnessSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.IsBrightnessSupported + +## -description +Gets whether the line display supports adjusting the screen brightness. + +## -property-value +True if the line display supports adjusting the screen brightness; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_iscursorsupported.md b/windows.devices.pointofservice/linedisplaycapabilities_iscursorsupported.md new file mode 100644 index 0000000000..d2cc2cc39c --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_iscursorsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.IsCursorSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.IsCursorSupported + +## -description +Gets whether the line display supports a cursor. + +## -property-value +True if the line display supports a cursor; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_ishorizontalmarqueesupported.md b/windows.devices.pointofservice/linedisplaycapabilities_ishorizontalmarqueesupported.md new file mode 100644 index 0000000000..b0b73a3f2a --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_ishorizontalmarqueesupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.IsHorizontalMarqueeSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.IsHorizontalMarqueeSupported + +## -description +Gets whether the line display supports horizontal marquee scrolling. + +## -property-value +True if the line display supports horizontal marquee scrolling; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_isintercharacterwaitsupported.md b/windows.devices.pointofservice/linedisplaycapabilities_isintercharacterwaitsupported.md new file mode 100644 index 0000000000..78078e4f05 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_isintercharacterwaitsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.IsInterCharacterWaitSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.IsInterCharacterWaitSupported + +## -description +Gets whether the line display supports delaying between displaying successive characters. + +## -property-value +True if the line display supports inter-character wait; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_isstatisticsreportingsupported.md b/windows.devices.pointofservice/linedisplaycapabilities_isstatisticsreportingsupported.md new file mode 100644 index 0000000000..4a076eecc6 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_isstatisticsreportingsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.IsStatisticsReportingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.IsStatisticsReportingSupported + +## -description +Gets whether the line display supports reporting statistics. + +## -property-value +True if the line display supports reporting statistics; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_isstatisticsupdatingsupported.md b/windows.devices.pointofservice/linedisplaycapabilities_isstatisticsupdatingsupported.md new file mode 100644 index 0000000000..692313809f --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_isstatisticsupdatingsupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.IsStatisticsUpdatingSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.IsStatisticsUpdatingSupported + +## -description +Gets whether the line display supports updating (or resetting) statistics. + +## -property-value +True if the line display supports updating statistics; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_isverticalmarqueesupported.md b/windows.devices.pointofservice/linedisplaycapabilities_isverticalmarqueesupported.md new file mode 100644 index 0000000000..8aed72fb63 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_isverticalmarqueesupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.IsVerticalMarqueeSupported +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.IsVerticalMarqueeSupported + +## -description +Gets whether the line display supports vertical marquee scrolling. + +## -property-value +True if the line display supports vertical marquee scrolling; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_powerreportingtype.md b/windows.devices.pointofservice/linedisplaycapabilities_powerreportingtype.md new file mode 100644 index 0000000000..58a30c33f9 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_powerreportingtype.md @@ -0,0 +1,30 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.PowerReportingType +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.PowerReportingType + +## -description +Gets the type of power reporting supported by the line display. + +## -property-value +This property can have one of the following values: + +```CSharp +typedef enum UnifiedPosPowerReportingType +{ + UnknownPowerReportingType = 0, + Standard = 1, + Advanced = 2 +} UnifiedPosPowerReportingType; +``` +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_supporteddescriptors.md b/windows.devices.pointofservice/linedisplaycapabilities_supporteddescriptors.md new file mode 100644 index 0000000000..bbe8e93a87 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_supporteddescriptors.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.SupportedDescriptors +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.SupportedDescriptors + +## -description +Gets the number of descriptors supported by the line display. + +## -property-value +The number of descriptors supported by the line display. A value of zero indicates that the line display does not support descriptors. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaycapabilities_supportedwindows.md b/windows.devices.pointofservice/linedisplaycapabilities_supportedwindows.md new file mode 100644 index 0000000000..dfa56679dc --- /dev/null +++ b/windows.devices.pointofservice/linedisplaycapabilities_supportedwindows.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayCapabilities.SupportedWindows +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayCapabilities.SupportedWindows + +## -description +Gets the maximum number of windows supported by the line display. + +## -property-value +The maximum number of windows supported by the line display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplayscrolldirection.md b/windows.devices.pointofservice/linedisplayscrolldirection.md new file mode 100644 index 0000000000..5d08738e76 --- /dev/null +++ b/windows.devices.pointofservice/linedisplayscrolldirection.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayScrollDirection +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayScrollDirection + +## -description +Defines the constants that indicate the scrolling direction of the line display. + +## -enum-fields +### -field Up:0 +The line display scrolls up. Only supported if the parent [LineDisplay.IsVerticalMarqueeSupported](linedisplaycapabilities_isverticalmarqueesupported.md) is True. + +### -field Right:3 +The line display scrolls down. Only supported if the parent [LineDisplay.IsVerticalMarqueeSupported](linedisplaycapabilities_isverticalmarqueesupported.md) is True. + +### -field Left:2 +The line display scrolls left. Only supported if the parent [LineDisplay.IsHorizontalMarqueeSupported](linedisplaycapabilities_ishorizontalmarqueesupported.md) is True. + +### -field Down:1 +The line display scrolls right. Only supported if the parent [LineDisplay.IsHorizontalMarqueeSupported](linedisplaycapabilities_ishorizontalmarqueesupported.md) is True. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaytextattribute.md b/windows.devices.pointofservice/linedisplaytextattribute.md new file mode 100644 index 0000000000..b886629ab2 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaytextattribute.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayTextAttribute +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayTextAttribute + +## -description +Defines the constants that indicate whether the line display is reversed or blinking. + +## -enum-fields +### -field ReverseBlink:3 +The display is reversed and blinking. + +### -field Reverse:2 +The display is reversed. + +### -field Normal:0 +The display not reverse or blinking (ie. normal). + +### -field Blink:1 +The display is blinking. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaytextattributegranularity.md b/windows.devices.pointofservice/linedisplaytextattributegranularity.md new file mode 100644 index 0000000000..2611d7251e --- /dev/null +++ b/windows.devices.pointofservice/linedisplaytextattributegranularity.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayTextAttributeGranularity +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.LineDisplayTextAttributeGranularity + +## -description +Defines the constants that indicate whether the line display supports blinking or reversing the display. + +## -enum-fields +### -field PerCharacter:2 +The feature is supported for individual characters. + +### -field NotSupported:0 +The feature is not supported. + +### -field EntireDisplay:1 +The feature is supported for the entire display. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow.md b/windows.devices.pointofservice/linedisplaywindow.md new file mode 100644 index 0000000000..176e8384af --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.PointOfService.LineDisplayWindow +-api-type: winrt class +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow + +## -description +Represents the line display window. + +## -remarks +This object is retrieved when you access the [DefaultWindow](claimedlinedisplay_defaultwindow.md) property of the [ClaimedLineDisplay](claimedlinedisplay.md) object. + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_close_811482585.md b/windows.devices.pointofservice/linedisplaywindow_close_811482585.md new file mode 100644 index 0000000000..ec2a8775c0 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.Close + +## -description +Close the line display window. + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_intercharacterwaitinterval.md b/windows.devices.pointofservice/linedisplaywindow_intercharacterwaitinterval.md new file mode 100644 index 0000000000..bc5ecdb56e --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_intercharacterwaitinterval.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayWindow.InterCharacterWaitInterval +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.InterCharacterWaitInterval + +## -description +Gets or sets the delay interval between displaying successive characters. + +## -property-value +The delay interval between displaying successive characters. The default value of this property is 0. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_sizeincharacters.md b/windows.devices.pointofservice/linedisplaywindow_sizeincharacters.md new file mode 100644 index 0000000000..274107bb39 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_sizeincharacters.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.PointOfService.LineDisplayWindow.SizeInCharacters +-api-type: winrt property +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.SizeInCharacters + +## -description +Gets dimensions of the window, in number of character lines (rows and columns). + +## -property-value +The number of character lines (rows and columns). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_trycleartextasync_2039536783.md b/windows.devices.pointofservice/linedisplaywindow_trycleartextasync_2039536783.md new file mode 100644 index 0000000000..d250d2c1ad --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trycleartextasync_2039536783.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryClearTextAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryClearTextAsync + +## -description +Clears the current window. Changers all characters to blanks, clears any bitmaps displayed in the window, exits **Marquee Mode** if it is being used, clears and sets **InterCharacterWait** to 0, and **Cursor.Position** to {0,0}. + +## -parameters + +## -returns +True if the window was successfully cleared; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_137322555.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_137322555.md new file mode 100644 index 0000000000..aba3f0214c --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_137322555.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync(System.String,Windows.Devices.PointOfService.LineDisplayTextAttribute) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync + +## -description +Try to display the specified text in the line display window, using the specified display attribute. + +## -parameters + +### -param text +The text to be displayed. + +### -param displayAttribute +The display attribute to be applied to the window. +## -returns +True if the text was displayed successfully; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_463125215.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_463125215.md new file mode 100644 index 0000000000..c39298f944 --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_463125215.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync(System.String,Windows.Devices.PointOfService.LineDisplayTextAttribute,Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync + +## -description +Try to display the specified text at a specified position in the line display window, using the specified display attribute. + +## -parameters + +### -param text +The text to be displayed. + +### -param displayAttribute +The display attribute to be applied to the window. + +### -param startPosition +The row and column at which to start displaying the text. + +## -returns +True if the text was displayed successfully; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_67280315.md b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_67280315.md new file mode 100644 index 0000000000..bd5a5f51fc --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_trydisplaytextasync_67280315.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryDisplayTextAsync + +## -description +Try to display the specified text in the line display window. + +## -parameters + +### -param text +The text to be displayed. + +## -returns +True if the text was displayed successfully; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_tryrefreshasync_1864090804.md b/windows.devices.pointofservice/linedisplaywindow_tryrefreshasync_1864090804.md new file mode 100644 index 0000000000..fd2c0dc2ef --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_tryrefreshasync_1864090804.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryRefreshAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryRefreshAsync + +## -description +Refresh the line display window. + +## -parameters + +## -returns +True if the window was successfully refreshed; otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/linedisplaywindow_tryscrolltextasync_1652215112.md b/windows.devices.pointofservice/linedisplaywindow_tryscrolltextasync_1652215112.md new file mode 100644 index 0000000000..c7b6e32a5c --- /dev/null +++ b/windows.devices.pointofservice/linedisplaywindow_tryscrolltextasync_1652215112.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Devices.PointOfService.LineDisplayWindow.TryScrollTextAsync(Windows.Devices.PointOfService.LineDisplayScrollDirection,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.LineDisplayWindow.TryScrollTextAsync + +## -description +Scroll the window text contents the specified number of lines in the specified direction. + +## -parameters + +### -param direction +The direction in which to scroll text. + +### -param numberOfColumnsOrRows +The number of columns or rows to scroll. Columns are used if the scroll direction is left or right; rows are used if the scroll direction is up or down. + +## -returns + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md b/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md index 0b7ed82928..5cee6a09ad 100644 --- a/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md +++ b/windows.devices.pointofservice/magneticstripereader_claimreaderasync_1639218756.md @@ -1,30 +1,31 @@ ---- --api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync --api-type: winrt method ---- - - - -# Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync - -## -description -Attempts to get an exclusive access to the magnetic stripe reader. - -## -returns -When the method completes, it returns a [ClaimedMagneticStripeReader](claimedmagneticstripereader.md) or it returns null if the operation fails to claim a magnetic stripe reader. - -## -remarks - -## -examples - - -[!code-cpp[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetClaimMagStripeReader)] - -[!code-csharp[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetClaimMagStripeReader)] - -[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] - -## -see-also -[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.ClaimReaderAsync + +## -description +Attempts to get an exclusive access to the magnetic stripe reader. + +## -returns +When the method completes, it returns a [ClaimedMagneticStripeReader](claimedmagneticstripereader.md) or it returns null if the operation fails to claim a magnetic stripe reader. + +## -remarks + +## -examples + + +[!code-cpp[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cpp/Scenario1.xaml.cpp#SnippetClaimMagStripeReader)] + +[!code-csharp[ClaimMagStripeReader](../windows.devices.pointofservice/code/MagneticStripeReader/cs/Scenario1.xaml.cs#SnippetClaimMagStripeReader)] + +[!code-js[CreateMagStripeReaderJS](../windows.devices.pointofservice/code/MagneticStripeReader/js/scenario1.js#SnippetCreateMagStripeReaderJS)] + +## -see-also +[Magnetic stripe reader sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620017) +soft.com/fwlink/p/?LinkId=620017) diff --git a/windows.devices.pointofservice/magneticstripereader_close_811482585.md b/windows.devices.pointofservice/magneticstripereader_close_811482585.md new file mode 100644 index 0000000000..40f7f791ad --- /dev/null +++ b/windows.devices.pointofservice/magneticstripereader_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.Close + +## -description +Close the magnetic stripe reader session. + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/magneticstripereader_getdeviceselector_321048197.md b/windows.devices.pointofservice/magneticstripereader_getdeviceselector_321048197.md new file mode 100644 index 0000000000..c614d7e8b9 --- /dev/null +++ b/windows.devices.pointofservice/magneticstripereader_getdeviceselector_321048197.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.PointOfService.MagneticStripeReader.GetDeviceSelector(Windows.Devices.PointOfService.PosConnectionTypes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.MagneticStripeReader.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the magnetic stripe readers available over the specified connection types + +## -parameters + +### -param connectionTypes +A list of the connection types to check for available magnetic stripe readers. + +## -returns +An Advanced Query Syntax (AQS) string that is used to enumerate the magnetic stripe readers available over the specified connection types + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/posconnectiontypes.md b/windows.devices.pointofservice/posconnectiontypes.md new file mode 100644 index 0000000000..435f2bc3f1 --- /dev/null +++ b/windows.devices.pointofservice/posconnectiontypes.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.Devices.PointOfService.PosConnectionTypes +-api-type: winrt enum +--- + + + +# Windows.Devices.PointOfService.PosConnectionTypes + +## -description +Connection types that can be used to access a point of service device. + +## -enum-fields +### -field Local:1 +Locally connected devices, such as USB. + +### -field IP:2 +Devices with an IP address, including both Wired Ethernet and Wi-Fi. + +### -field Bluetooth:4 +Devices with a Bluetooth radio. + +### -field All:4294967295 +All connection types. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/posprinter_close_811482585.md b/windows.devices.pointofservice/posprinter_close_811482585.md new file mode 100644 index 0000000000..63de41c15b --- /dev/null +++ b/windows.devices.pointofservice/posprinter_close_811482585.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.Close +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.Close + +## -description +Close the POS printer session. + +## -parameters + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/posprinter_getdeviceselector_321048197.md b/windows.devices.pointofservice/posprinter_getdeviceselector_321048197.md new file mode 100644 index 0000000000..61e98d11c1 --- /dev/null +++ b/windows.devices.pointofservice/posprinter_getdeviceselector_321048197.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Devices.PointOfService.PosPrinter.GetDeviceSelector(Windows.Devices.PointOfService.PosConnectionTypes) +-api-type: winrt method +--- + + + +# Windows.Devices.PointOfService.PosPrinter.GetDeviceSelector + +## -description +Gets an Advanced Query Syntax (AQS) string that you can use to list the point-of-service printers available over the specified connection types + +## -parameters +### -param connectionTypes +A list of the connection types to check for available point-of-service printers. + +## -returns +An Advanced Query Syntax (AQS) string that is used to enumerate the point-of-service printers available over the specified connection types + +## -remarks + +## -see-also + +## -examples diff --git a/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md b/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md index 1992c4acb3..d5ebec0723 100644 --- a/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md +++ b/windows.devices.pointofservice/receiptprintjob_printbarcode_1361148756.md @@ -36,7 +36,7 @@ Actual sizes are dependent on the capabilities of the target printer, but approx 60.750 - 0.847 mm2.000 - 2.258 mm -See the remarks in [POS Printer](https://docs.microsoft.com/en-us/windows/uwp/devices-sensors/pos-printer) for more information on ESC/POS. +See the remarks in [POS Printer](pos_printer.md) for more information on ESC/POS. ### -param textPosition The vertical position of the barcode text relative to the barcode. diff --git a/windows.devices.portable/storagedevice_fromid_114571398.md b/windows.devices.portable/storagedevice_fromid_114571398.md index 0b1409add8..bd6688c956 100644 --- a/windows.devices.portable/storagedevice_fromid_114571398.md +++ b/windows.devices.portable/storagedevice_fromid_114571398.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.Devices.Portable.StorageDevice.FromId(System.String) --api-type: winrt method ---- - - - -# Windows.Devices.Portable.StorageDevice.FromId - -## -description -Gets a [StorageFolder](../windows.storage/storagefolder.md) object from a DeviceInformation Id for a removable storage device. - -## -parameters -### -param deviceId -The [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID that identifies the removable storage device. This id can be retrieved from [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) or the [DeviceInformationId](../windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md) property of the AutoPlay device event arguments. For more information, see [Quickstart: Register an app for an AutoPlay device](http://msdn.microsoft.com/library/6a3b8910-ebec-427b-bcba-7ce3fa3f878a). In order for [FromId](storagedevice_fromid.md) to succeed, the app must declare both the removableStorage capability as shown in the [App capability declarations](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) and file type associations for the files it wishes to access on the device as shown in [How to handle file activation](http://msdn.microsoft.com/library/cd540a91-5276-4a89-b517-85cea866172c). For more information, see the [Removable Storage sample](http://go.microsoft.com/fwlink/p/?LinkID=242035). - -## -returns -The storage folder object that represents the removable storage device and provides access to content on the device. - -## -remarks -Pass the selector string from [GetDeviceSelector](storagedevice_getdeviceselector.md) to the Windows.Devices.Enumeration API to get a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects representing storage devices. Select the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the storage you want to access, and use its [Id](../windows.devices.enumeration/deviceinformation_id.md) property as the *deviceInformationId* parameter to [FromId](storagedevice_fromid.md). - -## -examples - -## -see-also -[DeviceInformation](../windows.devices.enumeration/deviceinformation.md), [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md), [Enumerating Common Devices](http://msdn.microsoft.com/library/2deddbba-de46-409e-ac76-87419cb03eba) - -## -capabilities +--- +-api-id: M:Windows.Devices.Portable.StorageDevice.FromId(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Portable.StorageDevice.FromId + +## -description +Gets a [StorageFolder](../windows.storage/storagefolder.md) object from a DeviceInformation Id for a removable storage device. + +## -parameters +### -param deviceId +The [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) ID that identifies the removable storage device. This id can be retrieved from [Windows.Devices.Enumeration](../windows.devices.enumeration/windows_devices_enumeration.md) or the [DeviceInformationId](../windows.applicationmodel.activation/deviceactivatedeventargs_deviceinformationid.md) property of the AutoPlay device event arguments. For more information, see [Quickstart: Register an app for an AutoPlay device](http://msdn.microsoft.com/library/6a3b8910-ebec-427b-bcba-7ce3fa3f878a). In order for [FromId](storagedevice_fromid.md) to succeed, the app must declare both the removableStorage capability as shown in the [App capability declarations](http://msdn.microsoft.com/library/25b18ba5-e584-4537-9f19-bb2c8c52dfe1) and file type associations for the files it wishes to access on the device as shown in [How to handle file activation](http://msdn.microsoft.com/library/cd540a91-5276-4a89-b517-85cea866172c). For more information, see the [Removable Storage sample](http://go.microsoft.com/fwlink/p/?LinkID=242035). + +## -returns +The storage folder object that represents the removable storage device and provides access to content on the device. + +## -remarks +Pass the selector string from [GetDeviceSelector](storagedevice_getdeviceselector.md) to the Windows.Devices.Enumeration API to get a collection of [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects representing storage devices. Select the [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) object for the storage you want to access, and use its [Id](../windows.devices.enumeration/deviceinformation_id.md) property as the *deviceInformationId* parameter to [FromId](storagedevice_fromid.md). + +## -examples + +## -see-also +[DeviceInformation](../windows.devices.enumeration/deviceinformation.md), [DeviceInformation.Id](../windows.devices.enumeration/deviceinformation_id.md), [Enumerating Common Devices](http://msdn.microsoft.com/library/2deddbba-de46-409e-ac76-87419cb03eba) + +## -capabilities removableStorage \ No newline at end of file diff --git a/windows.devices.portable/windows_devices_portable.md b/windows.devices.portable/windows_devices_portable.md index b5be97394c..8468da7dc6 100644 --- a/windows.devices.portable/windows_devices_portable.md +++ b/windows.devices.portable/windows_devices_portable.md @@ -6,7 +6,7 @@ # Windows.Devices.Portable ## -description -[Windows Portable Devices](XREF:TODO:nodepage.windows_portable_devices) (WPD) enables computers to communicate with attached media and storage devices. This namespace provides methods for identifying Windows Portable Device (WPD) services and storage. +[Windows Portable Devices](http://msdn.microsoft.com/library/b3833a11-631d-4860-867f-a611c9362dae) (WPD) enables computers to communicate with attached media and storage devices. This namespace provides methods for identifying Windows Portable Device (WPD) services and storage. ## -remarks This table lists the GUIDs of standard MTP device services that can be passed to the *serviceId* parameter. For more information about these MTP devices services, see [MTP Device Services for Windows](http://go.microsoft.com/fwlink/p/?LinkID=264914). @@ -48,4 +48,4 @@ This table lists GUIDs commonly used when accessing storage functionality on WPD ## -examples ## -see-also -[Windows Portable Devices](XREF:TODO:nodepage.windows_portable_devices) \ No newline at end of file +[Windows Portable Devices](http://msdn.microsoft.com/library/b3833a11-631d-4860-867f-a611c9362dae) \ No newline at end of file diff --git a/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md b/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md index 8b72c32d4e..d54edb43bb 100644 --- a/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md +++ b/windows.devices.printers.extensions/printnotificationeventdetails_eventdata.md @@ -1,25 +1,25 @@ ---- --api-id: P:Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData --api-type: winrt property ---- - - - -# Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData - -## -description -Gets or sets the event data for a print notification event. - -## -property-value -The print notification event data. - -## -remarks -The property is nested XML that is formatted as string. To get this property, parse for the Bidi request and response schema that is embedded in an ``, following the AsyncUI's [balloonUI](XREF:TODO:print.balloonui) element message, which contains the [action](XREF:TODO:print.action) element. The [action](XREF:TODO:print.action) element contains the `` where the Bidi response schema is found. Examine the Bidi response to determine the cause of the event. - - - -## -examples - -## -see-also +--- +-api-id: P:Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData +-api-type: winrt property +--- + + + +# Windows.Devices.Printers.Extensions.PrintNotificationEventDetails.EventData + +## -description +Gets or sets the event data for a print notification event. + +## -property-value +The print notification event data. + +## -remarks +The property is nested XML that is formatted as string. To get this property, parse for the Bidi request and response schema that is embedded in an ``, following the AsyncUI's [balloonUI](http://msdn.microsoft.com/library/8db15dcb-26ed-429e-ad4c-e5dc59f9bbca) element message, which contains the [action](http://msdn.microsoft.com/library/dae207ad-072e-4de6-b6a2-f1188ce91065) element. The [action](http://msdn.microsoft.com/library/dae207ad-072e-4de6-b6a2-f1188ce91065) element contains the `` where the Bidi response schema is found. Examine the Bidi response to determine the cause of the event. + + + +## -examples + +## -see-also diff --git a/windows.devices.pwm/pwmcontroller_fromidasync_1322863552.md b/windows.devices.pwm/pwmcontroller_fromidasync_1322863552.md new file mode 100644 index 0000000000..07594c6d97 --- /dev/null +++ b/windows.devices.pwm/pwmcontroller_fromidasync_1322863552.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Devices.Pwm.PwmController.FromIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmController.FromIdAsync + +## -description +Initializes a PWM controller instance based on the given [DeviceInformation ID](https://docs.microsoft.com/uwp/api/Windows.Devices.Enumeration.DeviceInformation#Windows_Devices_Enumeration_DeviceInformation_Id). + +## -parameters + +### -param deviceId +The acquired [DeviceInformation ID](https://docs.microsoft.com/uwp/api/Windows.Devices.Enumeration.DeviceInformation#Windows_Devices_Enumeration_DeviceInformation_Id). + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pwm/pwmcontroller_getdeviceselector_1752695616.md b/windows.devices.pwm/pwmcontroller_getdeviceselector_1752695616.md new file mode 100644 index 0000000000..a70d4d98b7 --- /dev/null +++ b/windows.devices.pwm/pwmcontroller_getdeviceselector_1752695616.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.Pwm.PwmController.GetDeviceSelector(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmController.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string for the PWM controller that has the specified friendly name. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those controllers. + + +## -parameters + +### -param friendlyName +A friendly name for the particular PWM controller for which you want to get the corresponding AQS string. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.pwm/pwmcontroller_getdeviceselector_838466080.md b/windows.devices.pwm/pwmcontroller_getdeviceselector_838466080.md new file mode 100644 index 0000000000..f6eff19582 --- /dev/null +++ b/windows.devices.pwm/pwmcontroller_getdeviceselector_838466080.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.Pwm.PwmController.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Devices.Pwm.PwmController.GetDeviceSelector + +## -description +Retrieves an Advanced Query Syntax (AQS) string for all the PWM controllers on the system. You can use this string with the [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) method to get [DeviceInformation](../windows.devices.enumeration/deviceinformation.md) objects for those controllers. + + +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.scanners/windows_devices_scanners.md b/windows.devices.scanners/windows_devices_scanners.md index 91dd48afb8..98edc4590a 100644 --- a/windows.devices.scanners/windows_devices_scanners.md +++ b/windows.devices.scanners/windows_devices_scanners.md @@ -6,7 +6,7 @@ # Windows.Devices.Scanners ## -description -Contains the classes, interfaces, structures and other components that are built on top of the [Windows Image Acquisition (WIA)](XREF:TODO:wia._wia_startpage) COM APIs to provide scan functionality for Windows Store app and desktop apps. +Contains the classes, interfaces, structures and other components that are built on top of the [Windows Image Acquisition (WIA)](http://msdn.microsoft.com/library/8f32422e-25ec-48bc-9d79-57dbb3b53e93) COM APIs to provide scan functionality for Windows Store app and desktop apps. ## -remarks diff --git a/windows.devices.sensors/windows_devices_sensors.md b/windows.devices.sensors/windows_devices_sensors.md index c8690c0f92..51308a9a25 100644 --- a/windows.devices.sensors/windows_devices_sensors.md +++ b/windows.devices.sensors/windows_devices_sensors.md @@ -9,7 +9,7 @@ Provides access to the supported types of sensors and related motion data. ## -remarks -This namespace provides access to the sensor types listed in the table below. The driver for a sensor must indicate that the hardware is integrated with the PC chassis for it to be accessible via this namespace. Sensors not marked as PC-integrated, even if they are of a supported type, will not be accessible. Driver developers can refer to [SensorConnectionType](XREF:TODO:sensors.sensorconnectiontype) enumeration for more details. +This namespace provides access to the sensor types listed in the table below. The driver for a sensor must indicate that the hardware is integrated with the PC chassis for it to be accessible via this namespace. Sensors not marked as PC-integrated, even if they are of a supported type, will not be accessible. Driver developers can refer to [SensorConnectionType](http://msdn.microsoft.com/library/63df4f99-ddc2-4a0b-b19b-63390771d529) enumeration for more details. diff --git a/windows.devices.smartcards/smartcardcryptogramalgorithm.md b/windows.devices.smartcards/smartcardcryptogramalgorithm.md index fd37b5750e..02860bf75e 100644 --- a/windows.devices.smartcards/smartcardcryptogramalgorithm.md +++ b/windows.devices.smartcards/smartcardcryptogramalgorithm.md @@ -38,9 +38,12 @@ Use the signed dynamic application data algorithm. Use the Public-Key Cryptography Standards 1 (PKCS) RSA algorithm. +### -field Sha256Hmac:8 + + ## -remarks ## -examples ## -see-also -[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialcharacteristicsasync_2123004404.md b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialcharacteristicsasync_2123004404.md new file mode 100644 index 0000000000..f6b816e295 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialcharacteristicsasync_2123004404.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramMaterialCharacteristicsAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramMaterialCharacteristicsAsync + +## -description +Gets all the cryptogram material characteristics. + +## -parameters + +### -param promptingBehavior +The prompting behavior. + +### -param materialPackageName +The material package name. + +## -returns +Returns an asynchronous operation that completes with the characteristics result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_1776838672.md b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_1776838672.md new file mode 100644 index 0000000000..11ccef4c04 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_1776838672.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramMaterialPackageCharacteristicsAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramMaterialPackageCharacteristicsAsync + +## -description +Gets all cryptogram material package characteristics. + +## -parameters + +## -returns +Returns an asynchronous operation that completes with the package characteristics result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_812224816.md b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_812224816.md new file mode 100644 index 0000000000..88f8f763bf --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_812224816.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramMaterialPackageCharacteristicsAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramMaterialPackageCharacteristicsAsync + +## -description +Gets all the cryptogram material package characteristics. + +## -parameters + +### -param storageKeyName +The storage key name. + +## -returns +Returns an asynchronous operation that completes with the package characteristics result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogramstoragekeycharacteristicsasync_495413597.md b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogramstoragekeycharacteristicsasync_495413597.md new file mode 100644 index 0000000000..3679607dc8 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogramstoragekeycharacteristicsasync_495413597.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramStorageKeyCharacteristicsAsync +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.GetAllCryptogramStorageKeyCharacteristicsAsync + +## -description +Gets all storage key characteristics. + +## -parameters + +## -returns +Returns an asynchronous operation that completes with the characteristics result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgenerator_validaterequestapduasync_1819041097.md b/windows.devices.smartcards/smartcardcryptogramgenerator_validaterequestapduasync_1819041097.md new file mode 100644 index 0000000000..880e0588dd --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgenerator_validaterequestapduasync_1819041097.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGenerator.ValidateRequestApduAsync(Windows.Devices.SmartCards.SmartCardUnlockPromptingBehavior,Windows.Storage.Streams.IBuffer,Windows.Foundation.Collections.IIterable{Windows.Devices.SmartCards.SmartCardCryptogramPlacementStep}) +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGenerator.ValidateRequestApduAsync + +## -description +Validates the APDU request. + +## -parameters + +### -param promptingBehavior +The prompting behavior. + +### -param apduToValidate +The APDU to validate. + +### -param cryptogramPlacementSteps +The cryptogram placement steps. + +## -returns +Returns an asynchronous operation that completes with the operation status. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md b/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md index 85bfb62b48..53fd1770ec 100644 --- a/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md +++ b/windows.devices.smartcards/smartcardcryptogramgeneratoroperationstatus.md @@ -50,9 +50,12 @@ The APDU response was not sent. An unknown error occurred. +### -field ValidationFailed:12 + + ## -remarks ## -examples ## -see-also -[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) \ No newline at end of file +[Create an NFC Smart Card app](http://msdn.microsoft.com/library/26834a51-512b-485b-84c8-abf713787588) diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult.md new file mode 100644 index 0000000000..3cfee836c4 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult + +## -description +This class contains information that is returned by [**GetAllCryptogramMaterialCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialcharacteristicsasync_2123004404.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_characteristics.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_characteristics.md new file mode 100644 index 0000000000..1087dfa5d8 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_characteristics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult.Characteristics +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult.Characteristics + +## -description +Gets the characteristics. + +## -property-value +The characteristics. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_operationstatus.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_operationstatus.md new file mode 100644 index 0000000000..b9da503d88 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_operationstatus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult.OperationStatus +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult.OperationStatus + +## -description +Gets the operation status of [**GetAllCryptogramMaterialCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialcharacteristicsasync_2123004404.md) operation. + +## -property-value +The operation status of [**GetAllCryptogramMaterialCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialcharacteristicsasync_2123004404.md) operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_1221375020.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_1221375020.md new file mode 100644 index 0000000000..160edb34f2 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult.SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult + +## -description +Creates an instance of [**SmartCardCryptogramGetAllCryptogramMaterialCharacteristicsResult**](../../windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialcharacteristicsresult.md). +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult.md new file mode 100644 index 0000000000..ce177a75f5 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult + +## -description +This class contains information that is returned by [**GetAllCryptogramMaterialPackageCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_812224816.md). +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_characteristics.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_characteristics.md new file mode 100644 index 0000000000..2c32d4d29a --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_characteristics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult.Characteristics +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult.Characteristics + +## -description +Gets the characteristics. + +## -property-value +The characteristics. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_operationstatus.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_operationstatus.md new file mode 100644 index 0000000000..e646d33962 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_operationstatus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult.OperationStatus +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult.OperationStatus + +## -description +Gets the operation status of [**GetAllCryptogramMaterialPackageCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_812224816.md). + +## -property-value +The operation status of [**GetAllCryptogramMaterialPackageCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogrammaterialpackagecharacteristicsasync_812224816.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_1221375020.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_1221375020.md new file mode 100644 index 0000000000..ae7cc7452f --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult.SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult + +## -description +Creates an instance of [**SmartCardCryptogramGetAllCryptogramMaterialPackageCharacteristicsResult**](../../windows.devices.smartcards/smartcardcryptogramgetallcryptogrammaterialpackagecharacteristicsresult.md). + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult.md new file mode 100644 index 0000000000..65f32610cc --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult + +## -description +This class contains information that is returned by [**GetAllCryptogramStorageKeyCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogramstoragekeycharacteristicsasync_495413597.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_characteristics.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_characteristics.md new file mode 100644 index 0000000000..4bdb03ad1c --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_characteristics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult.Characteristics +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult.Characteristics + +## -description +Gets the characteristics. + +## -property-value +The characteristics. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_operationstatus.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_operationstatus.md new file mode 100644 index 0000000000..69dda33a34 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_operationstatus.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult.OperationStatus +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult.OperationStatus + +## -description +Gets the operation status of [**GetAllCryptogramStorageKeyCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogramstoragekeycharacteristicsasync_495413597.md). +## -property-value +The operation status of [**GetAllCryptogramStorageKeyCharacteristicsAsync**](../../windows.devices.smartcards/smartcardcryptogramgenerator_getallcryptogramstoragekeycharacteristicsasync_495413597.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_1221375020.md b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_1221375020.md new file mode 100644 index 0000000000..fd70c1112c --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult.SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult + +## -description +Creates a new instance of [**SmartCardCryptogramGetAllCryptogramStorageKeyCharacteristicsResult**](../../windows.devices.smartcards/smartcardcryptogramgetallcryptogramstoragekeycharacteristicsresult.md). + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics.md new file mode 100644 index 0000000000..c3cdf48f4d --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics + +## -description +This class contains characteristics of cryptogram material. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedalgorithms.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedalgorithms.md new file mode 100644 index 0000000000..667dd50299 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedalgorithms.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.AllowedAlgorithms +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.AllowedAlgorithms + +## -description +Gets the allowed algorithms. + +## -property-value +The allowed algorithms. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedproofofpossessionalgorithms.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedproofofpossessionalgorithms.md new file mode 100644 index 0000000000..f5edab2149 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedproofofpossessionalgorithms.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.AllowedProofOfPossessionAlgorithms +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.AllowedProofOfPossessionAlgorithms + +## -description +Gets the allowed proof of allowed proof of possession algorithms. + +## -property-value +The allowed proof of allowed proof of possession algorithms. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedvalidations.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedvalidations.md new file mode 100644 index 0000000000..6a2974c9fb --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_allowedvalidations.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.AllowedValidations +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.AllowedValidations + +## -description +Gets the allowed validation algorithms. + +## -property-value +The allowed calidation algorithms. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materiallength.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materiallength.md new file mode 100644 index 0000000000..23631beebb --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materiallength.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.MaterialLength +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.MaterialLength + +## -description +Gets the material length. + +## -property-value +The material length. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materialname.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materialname.md new file mode 100644 index 0000000000..b5ad6b4594 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materialname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.MaterialName +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.MaterialName + +## -description +Gets the material name. + +## -property-value +The material name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materialtype.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materialtype.md new file mode 100644 index 0000000000..933753023c --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_materialtype.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.MaterialType +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.MaterialType + +## -description +Gets the material type. + +## -property-value +The material type. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_protectionmethod.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_protectionmethod.md new file mode 100644 index 0000000000..66801a1404 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_protectionmethod.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.ProtectionMethod +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.ProtectionMethod + +## -description +Gets the protection method. + +## -property-value +The protection method. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_protectionversion.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_protectionversion.md new file mode 100644 index 0000000000..da568d6fe8 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_protectionversion.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.ProtectionVersion +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.ProtectionVersion + +## -description +Gets the protection version. + +## -property-value +The protection version. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_smartcardcryptogrammaterialcharacteristics_1221375020.md b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_smartcardcryptogrammaterialcharacteristics_1221375020.md new file mode 100644 index 0000000000..a2df9e4f86 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics_smartcardcryptogrammaterialcharacteristics_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialCharacteristics.SmartCardCryptogramMaterialCharacteristics + +## -description +Creates a new instance of [**SmartCardCryptogramMaterialCharacteristics**](../../windows.devices.smartcards/smartcardcryptogrammaterialcharacteristics.md) +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics.md b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics.md new file mode 100644 index 0000000000..ebb62fa0cc --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics + +## -description +This class contains characteristics of a cryptogram material package. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_dateimported.md b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_dateimported.md new file mode 100644 index 0000000000..5eea3097e8 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_dateimported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.DateImported +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.DateImported + +## -description +Gets the date that the material package was imported. + +## -property-value +The date that the material package was imported. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_packageformat.md b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_packageformat.md new file mode 100644 index 0000000000..f236d1ca44 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_packageformat.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.PackageFormat +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.PackageFormat + +## -description +Gets the package format. + +## -property-value +The packge format. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_packagename.md b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_packagename.md new file mode 100644 index 0000000000..df64c85df7 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_packagename.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.PackageName +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.PackageName + +## -description +Gets the package name. + +## -property-value +The package name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_smartcardcryptogrammaterialpackagecharacteristics_1221375020.md b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_smartcardcryptogrammaterialpackagecharacteristics_1221375020.md new file mode 100644 index 0000000000..6e73c805ed --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_smartcardcryptogrammaterialpackagecharacteristics_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.SmartCardCryptogramMaterialPackageCharacteristics + +## -description +Creates a new instance of [**SmartCardCryptogramMaterialPackageCharacteristics**](../../windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics.md). +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_storagekeyname.md b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_storagekeyname.md new file mode 100644 index 0000000000..cb8cc933a4 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialpackagecharacteristics_storagekeyname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.StorageKeyName +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialPackageCharacteristics.StorageKeyName + +## -description +Gets the storage key name. + +## -property-value +The storage key name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogrammaterialprotectionmethod.md b/windows.devices.smartcards/smartcardcryptogrammaterialprotectionmethod.md new file mode 100644 index 0000000000..8aeb07f13d --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogrammaterialprotectionmethod.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramMaterialProtectionMethod +-api-type: winrt enum +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramMaterialProtectionMethod + +## -description +Defines the cryptogram material protection method. + +## -enum-fields +### -field WhiteBoxing:1 +Protect the cryptogram material by whiteboxing. + +### -field None:0 +Do not protect the cryptogram material. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics.md b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics.md new file mode 100644 index 0000000000..6c23a57336 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics +-api-type: winrt class +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics + +## -description +This class contains characteristics of storage keys. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_algorithm.md b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_algorithm.md new file mode 100644 index 0000000000..0469e7db5c --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_algorithm.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.Algorithm +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.Algorithm + +## -description +Gets the algorithm. + +## -property-value +The algorithm. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_capabilities.md b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_capabilities.md new file mode 100644 index 0000000000..8159d7c37e --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_capabilities.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.Capabilities +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.Capabilities + +## -description +Gets the capabilities. + +## -property-value +The capabilities. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_datecreated.md b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_datecreated.md new file mode 100644 index 0000000000..0f02ff50d6 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_datecreated.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.DateCreated +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.DateCreated + +## -description +Gets the date this storage key was created. + +## -property-value +The date this storage key was created. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_smartcardcryptogramstoragekeycharacteristics_1221375020.md b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_smartcardcryptogramstoragekeycharacteristics_1221375020.md new file mode 100644 index 0000000000..eca8ba8953 --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_smartcardcryptogramstoragekeycharacteristics_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.#ctor +-api-type: winrt method +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.SmartCardCryptogramStorageKeyCharacteristics + +## -description +Creates a new instance of [**SmartCardCryptogramStorageKeyCharacteristics**](../../windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics.md). +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_storagekeyname.md b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_storagekeyname.md new file mode 100644 index 0000000000..07baec9d9b --- /dev/null +++ b/windows.devices.smartcards/smartcardcryptogramstoragekeycharacteristics_storagekeyname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.StorageKeyName +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardCryptogramStorageKeyCharacteristics.StorageKeyName + +## -description +Gets the storage key name. + +## -property-value +The storage key name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.smartcards/smartcardtriggerdetails_smartcard.md b/windows.devices.smartcards/smartcardtriggerdetails_smartcard.md new file mode 100644 index 0000000000..1019c4a5e8 --- /dev/null +++ b/windows.devices.smartcards/smartcardtriggerdetails_smartcard.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Devices.SmartCards.SmartCardTriggerDetails.SmartCard +-api-type: winrt property +--- + + + +# Windows.Devices.SmartCards.SmartCardTriggerDetails.SmartCard + +## -description +Gets the smart card. + +## -property-value +The smart card. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.devices.wifidirect/wifidirectdevice.md b/windows.devices.wifidirect/wifidirectdevice.md index 347268e283..7dfaa7fb0c 100644 --- a/windows.devices.wifidirect/wifidirectdevice.md +++ b/windows.devices.wifidirect/wifidirectdevice.md @@ -26,7 +26,10 @@ You must enable the **Proximity** capability to communicate with Wi-Fi Direct de [!code-csharp[2](../windows.devices.wifidirect/code/WiFiDirect_Device/cs/MainPage.xaml.cs#Snippet2)] +[!code-js[2](../windows.devices.wifidirect/code/WiFiDirect_Device/js/default.js#Snippet2)] + [!code-js[2_JS](../windows.devices.wifidirect/code/WiFiDirect_Device/js/default.js#Snippet2_JS)] ## -see-also [WiFiDirectDevice sample](http://go.microsoft.com/fwlink/p/?LinkID=301419) +soft.com/fwlink/p/?LinkID=301419) diff --git a/windows.foundation.collections/ivector_1_getmany_1494237036.md b/windows.foundation.collections/ivector_1_getmany_1494237036.md new file mode 100644 index 0000000000..6b553c6700 --- /dev/null +++ b/windows.foundation.collections/ivector_1_getmany_1494237036.md @@ -0,0 +1,37 @@ +--- +-api-id: M:Windows.Foundation.Collections.IVector`1.GetMany(System.UInt32,`0[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.IVector.GetMany + +## -description + +Gets a collection of items from the vector beginning at the given index. + +## -parameters + +### -param startIndex + +The zero-based index to start at. + +### -param items + +An array to copy the items into. + +## -returns + +A status code indicating the result of the operation. + +## -remarks + +When programming with .NET, this interface is hidden. Use the IList interface instead. + +## -see-also + +## -examples + diff --git a/windows.foundation.collections/ivectorview_1_getmany_1494237036.md b/windows.foundation.collections/ivectorview_1_getmany_1494237036.md new file mode 100644 index 0000000000..2452205e5d --- /dev/null +++ b/windows.foundation.collections/ivectorview_1_getmany_1494237036.md @@ -0,0 +1,37 @@ +--- +-api-id: M:Windows.Foundation.Collections.IVectorView`1.GetMany(System.UInt32,`0[]) +-api-type: winrt method +--- + + + +# Windows.Foundation.Collections.IVectorView.GetMany + +## -description + +Gets a collection of items from the vector view beginning at the given index. + +## -parameters + +### -param startIndex + +The zero-based index to start at. + +### -param items + +An array to copy the items into. + +## -returns + +A status code indicating the result of the operation. + +## -remarks + +When programming with .NET, this interface is hidden. Use the IList interface instead. + +## -see-also + +## -examples + diff --git a/windows.foundation.diagnostics/erroroptions.md b/windows.foundation.diagnostics/erroroptions.md index 2c2031787d..646e5c6e0d 100644 --- a/windows.foundation.diagnostics/erroroptions.md +++ b/windows.foundation.diagnostics/erroroptions.md @@ -23,10 +23,10 @@ Exceptions are suppressed and not reported. Exceptions are reported. ### -field UseSetErrorInfo:4 -Error information for [SetErrorInfo](XREF:TODO:8eaacfac-fc37-4eaa-870b-10b99d598d66) is used. +Error information for [SetErrorInfo](http://msdn.microsoft.com/library/8eaacfac-fc37-4eaa-870b-10b99d598d66) is used. ### -field SuppressSetErrorInfo:8 -Error information for [SetErrorInfo](XREF:TODO:8eaacfac-fc37-4eaa-870b-10b99d598d66) is suppressed and not reported. +Error information for [SetErrorInfo](http://msdn.microsoft.com/library/8eaacfac-fc37-4eaa-870b-10b99d598d66) is suppressed and not reported. ## -remarks @@ -34,4 +34,4 @@ Error information for [SetErrorInfo](XREF:TODO:8eaacfac-fc37-4eaa-870b-10b99d598 ## -examples ## -see-also -[GetErrorOptions](runtimebrokererrorsettings_geterroroptions.md), [SetErrorOptions](runtimebrokererrorsettings_seterroroptions.md) \ No newline at end of file +[GetErrorOptions](runtimebrokererrorsettings_geterroroptions.md), [SetErrorOptions](runtimebrokererrorsettings_seterroroptions.md) diff --git a/windows.foundation.diagnostics/loggingfieldformat.md b/windows.foundation.diagnostics/loggingfieldformat.md index 1bb01fc226..d41a125506 100644 --- a/windows.foundation.diagnostics/loggingfieldformat.md +++ b/windows.foundation.diagnostics/loggingfieldformat.md @@ -62,7 +62,7 @@ A 32-bit Windows **NTSTATUS** value. A 32-bit Windows **HRESULT** value. ### -field FileTime:16 -A 64-bit [FILETIME](XREF:TODO:base.filetime_str) value. +A 64-bit [FILETIME](https://msdn.microsoft.com/library/windows/desktop/ms724284) value. ### -field Signed:17 A signed value. @@ -78,4 +78,4 @@ For example, an int32 field may specify the **Hexadecimal ** format to indicate ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.foundation.diagnostics/loggingoptions_opcode.md b/windows.foundation.diagnostics/loggingoptions_opcode.md index 137cb61c17..3530244b66 100644 --- a/windows.foundation.diagnostics/loggingoptions_opcode.md +++ b/windows.foundation.diagnostics/loggingoptions_opcode.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Opcode --api-type: winrt property ---- - - - -# Windows.Foundation.Diagnostics.LoggingOptions.Opcode - -## -description -Gets or sets the operation code value for an event. - -## -property-value -The operation code. - -## -remarks -This value corresponds to the Event Tracing for Windows (ETW) definition of an opcode. Most events should use the **Info** opcode. - -The [LoggingActivity](loggingactivity.md) class will generate events with the **Opcode** set to **Start** and **Stop**. - -## -examples - -## -see-also -[LoggingOpcode enumeration](loggingopcode.md), [Defining Tasks and Opcodes](XREF:TODO:wes.defining_tasks_and_opcodes) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Opcode +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.Opcode + +## -description +Gets or sets the operation code value for an event. + +## -property-value +The operation code. + +## -remarks +This value corresponds to the Event Tracing for Windows (ETW) definition of an opcode. Most events should use the **Info** opcode. + +The [LoggingActivity](loggingactivity.md) class will generate events with the **Opcode** set to **Start** and **Stop**. + +## -examples + +## -see-also +[LoggingOpcode enumeration](loggingopcode.md), [Defining Tasks and Opcodes](http://msdn.microsoft.com/library/6a872517-14de-423e-a7ff-7edb9a29b22d) \ No newline at end of file diff --git a/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md b/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md index 2f1bfc7032..cb7cf477e4 100644 --- a/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md +++ b/windows.foundation.diagnostics/loggingoptions_relatedactivityid.md @@ -21,4 +21,4 @@ This value corresponds to the Event Tracing for Windows (ETW) definition of a re ## -examples ## -see-also -[EVENT_EXTENDED_ITEM_RELATED_ACTIVITYID](XREF:TODO:etw.event_extended_item_related_activityid) \ No newline at end of file +[EVENT_EXTENDED_ITEM_RELATED_ACTIVITYID](https://msdn.microsoft.com/library/windows/desktop/aa363756) diff --git a/windows.foundation.diagnostics/loggingoptions_task.md b/windows.foundation.diagnostics/loggingoptions_task.md index 28076bc1f7..64c94a0024 100644 --- a/windows.foundation.diagnostics/loggingoptions_task.md +++ b/windows.foundation.diagnostics/loggingoptions_task.md @@ -1,24 +1,24 @@ ---- --api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Task --api-type: winrt property ---- - - - -# Windows.Foundation.Diagnostics.LoggingOptions.Task - -## -description -Gets or sets the user-defined value that identifies a larger unit of work within an application or component. - -## -property-value -The task value. - -## -remarks -This value corresponds to the Event Tracing for Windows (ETW) definition of a task. It is a user-defined value. A task is a larger unit of work within an application or component, i.e. it identifies a scope of work that is broader than an [Opcode](loggingopcode.md). - -## -examples - -## -see-also -[Defining Tasks and Opcodes](XREF:TODO:wes.defining_tasks_and_opcodes) \ No newline at end of file +--- +-api-id: P:Windows.Foundation.Diagnostics.LoggingOptions.Task +-api-type: winrt property +--- + + + +# Windows.Foundation.Diagnostics.LoggingOptions.Task + +## -description +Gets or sets the user-defined value that identifies a larger unit of work within an application or component. + +## -property-value +The task value. + +## -remarks +This value corresponds to the Event Tracing for Windows (ETW) definition of a task. It is a user-defined value. A task is a larger unit of work within an application or component, i.e. it identifies a scope of work that is broader than an [Opcode](loggingopcode.md). + +## -examples + +## -see-also +[Defining Tasks and Opcodes](http://msdn.microsoft.com/library/6a872517-14de-423e-a7ff-7edb9a29b22d) \ No newline at end of file diff --git a/windows.foundation.metadata/apicontractattribute.md b/windows.foundation.metadata/apicontractattribute.md new file mode 100644 index 0000000000..4b8e622260 --- /dev/null +++ b/windows.foundation.metadata/apicontractattribute.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Foundation.Metadata.ApiContractAttribute +-api-type: winrt class +--- + + + +# Windows.Foundation.Metadata.ApiContractAttribute + +## -description +Specifies that the type represents an API contract. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/apicontractattribute_apicontractattribute_1221375020.md b/windows.foundation.metadata/apicontractattribute_apicontractattribute_1221375020.md new file mode 100644 index 0000000000..4d616e3472 --- /dev/null +++ b/windows.foundation.metadata/apicontractattribute_apicontractattribute_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Foundation.Metadata.ApiContractAttribute.#ctor +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ApiContractAttribute.ApiContractAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/contractversionattribute.md b/windows.foundation.metadata/contractversionattribute.md new file mode 100644 index 0000000000..4858ff1694 --- /dev/null +++ b/windows.foundation.metadata/contractversionattribute.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Foundation.Metadata.ContractVersionAttribute +-api-type: winrt class +--- + + + +# Windows.Foundation.Metadata.ContractVersionAttribute + +## -description +Indicates the version of the API contract. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/contractversionattribute_contractversionattribute_381309182.md b/windows.foundation.metadata/contractversionattribute_contractversionattribute_381309182.md new file mode 100644 index 0000000000..c04cc7305a --- /dev/null +++ b/windows.foundation.metadata/contractversionattribute_contractversionattribute_381309182.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Foundation.Metadata.ContractVersionAttribute.#ctor(System.String,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ContractVersionAttribute.ContractVersionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters + +### -param contract +The type to associate with the API contract. + +### -param version +The version of the API contract. + +## -remarks +This constructor applies to a type with the [ApiContractAttribute](apicontractattribute.md) and specifies the contract version of that API contract. + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/contractversionattribute_contractversionattribute_810136521.md b/windows.foundation.metadata/contractversionattribute_contractversionattribute_810136521.md new file mode 100644 index 0000000000..b984b88e91 --- /dev/null +++ b/windows.foundation.metadata/contractversionattribute_contractversionattribute_810136521.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Foundation.Metadata.ContractVersionAttribute.#ctor(System.Type,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ContractVersionAttribute.ContractVersionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters + +### -param contract +The type to associate with the API contract. + +### -param version +The version of the API contract. + +## -remarks +This constructor applies to any type that does not have the [ApiContractAttribute](apicontractattribute.md) and indicates the API contract version in which this type was added to the specified API contract. + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/contractversionattribute_contractversionattribute_885572907.md b/windows.foundation.metadata/contractversionattribute_contractversionattribute_885572907.md new file mode 100644 index 0000000000..64f9617961 --- /dev/null +++ b/windows.foundation.metadata/contractversionattribute_contractversionattribute_885572907.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Foundation.Metadata.ContractVersionAttribute.#ctor(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.ContractVersionAttribute.ContractVersionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters + +### -param version +The version of the API contract. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/featureattribute.md b/windows.foundation.metadata/featureattribute.md new file mode 100644 index 0000000000..139cfb3953 --- /dev/null +++ b/windows.foundation.metadata/featureattribute.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Foundation.Metadata.FeatureAttribute +-api-type: winrt class +--- + + + +# Windows.Foundation.Metadata.FeatureAttribute + +## -description +Expresses the state of the Windows Runtime feature associated with a Windows Runtime Type. + +## -remarks +This attribute is used for Microsoft internal prerelease build tracking and is only included here for completeness. + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/featureattribute_featureattribute_1855204165.md b/windows.foundation.metadata/featureattribute_featureattribute_1855204165.md new file mode 100644 index 0000000000..4c11fa6525 --- /dev/null +++ b/windows.foundation.metadata/featureattribute_featureattribute_1855204165.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Foundation.Metadata.FeatureAttribute.#ctor(Windows.Foundation.Metadata.FeatureStage,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.FeatureAttribute.FeatureAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters + +### -param featureStage +Specifies if the named feature is enabled or disabled. + +### -param validInAllBranches +Boolean value that indicates if the named feature is valid in all branches. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/featurestage.md b/windows.foundation.metadata/featurestage.md new file mode 100644 index 0000000000..5ec6e2f64c --- /dev/null +++ b/windows.foundation.metadata/featurestage.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.Foundation.Metadata.FeatureStage +-api-type: winrt enum +--- + + + +# Windows.Foundation.Metadata.FeatureStage + +## -description +Values that indicate if a Windows feature is enabled or disabled. + +## -enum-fields +### -field EnabledByDefault:2 +The feature is enabled by default. + +### -field DisabledByDefault:1 +The feature is diabled by default. + +### -field AlwaysEnabled:3 +The feature is always enabled. + +### -field AlwaysDisabled:0 +The feature is always disabled. + +## -remarks +This attribute is used for Microsoft internal prerelease build tracking and is only included here for completeness. + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/previouscontractversionattribute.md b/windows.foundation.metadata/previouscontractversionattribute.md new file mode 100644 index 0000000000..3d846ce211 --- /dev/null +++ b/windows.foundation.metadata/previouscontractversionattribute.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Foundation.Metadata.PreviousContractVersionAttribute +-api-type: winrt class +--- + + + +# Windows.Foundation.Metadata.PreviousContractVersionAttribute + +## -description +Indicates that the type was previously associated with a different API contract. + +## -remarks +This attribute is present if a type has been moved from one API contract to another type. It expresses the history of the type in relation to the API contracts in which it has existed. + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/previouscontractversionattribute_previouscontractversionattribute_424962842.md b/windows.foundation.metadata/previouscontractversionattribute_previouscontractversionattribute_424962842.md new file mode 100644 index 0000000000..d4b9535af7 --- /dev/null +++ b/windows.foundation.metadata/previouscontractversionattribute_previouscontractversionattribute_424962842.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Foundation.Metadata.PreviousContractVersionAttribute.#ctor(System.String,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.PreviousContractVersionAttribute.PreviousContractVersionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters + +### -param contract +The name of the previous contract. + +### -param versionLow +The first version of the previous contract to which the type was associated. + +### -param versionHigh +The last version of the previous contract to which the type was associated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.foundation.metadata/previouscontractversionattribute_previouscontractversionattribute_715415014.md b/windows.foundation.metadata/previouscontractversionattribute_previouscontractversionattribute_715415014.md new file mode 100644 index 0000000000..d7711fdb5a --- /dev/null +++ b/windows.foundation.metadata/previouscontractversionattribute_previouscontractversionattribute_715415014.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Foundation.Metadata.PreviousContractVersionAttribute.#ctor(System.String,System.UInt32,System.UInt32,System.String) +-api-type: winrt method +--- + + + +# Windows.Foundation.Metadata.PreviousContractVersionAttribute.PreviousContractVersionAttribute + +## -description +Creates and initializes a new instance of the attribute. + +## -parameters + +### -param contract +The name of the previous contract. + +### -param versionLow +The first version of the previous contract to which the type was associated. + +### -param versionHigh +The last version of the previous contract to which the type was associated. + +### -param newContract +The name of the new contract to which the type is associated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.foundation/datetime.md b/windows.foundation/datetime.md index c77c8cf272..bc9b1b4648 100644 --- a/windows.foundation/datetime.md +++ b/windows.foundation/datetime.md @@ -4,7 +4,7 @@ --- # DateTime @@ -12,35 +12,28 @@ public struct DateTime ## -description Represents an instant in time, typically expressed as a date and time of day. - - > **JavaScript** -> This type appears as the [Date](XREF:TODO:ce2202bb-7ec9-4f5a-bf48-3a04feff283e) object. - - +> This type appears as the [Date](https://msdn.microsoft.com/library/cd9w2te4) object. > **.NET** -> When programming with .NET, this type is hidden, and developers should use the [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx) structure. - - +> When programming with .NET, this type is hidden, and developers should use the [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset) structure. > **C++** -> Similar to [FILETIME](XREF:TODO:base.filetime_str) but with important differences. See Remarks. +> Similar to [FILETIME](https://msdn.microsoft.com/library/windows/desktop/ms724284) but with important differences. See Remarks. ## -struct-fields ### -field UniversalTime A 64-bit signed integer that represents a point in time as the number of 100-nanosecond intervals prior to or after midnight on January 1, 1601 (according to the Gregorian Calendar). - ## -remarks -JavaScript and Microsoft .NET languages do not use this type directly. In JavaScript a [DateTime](datetime.md) is projected as a [Date](XREF:TODO:ce2202bb-7ec9-4f5a-bf48-3a04feff283e) object, and in Microsoft .NET it is projected as a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx). Each language transparently handles the conversion to the granularity and date ranges for the respective language. +JavaScript and Microsoft .NET languages do not use this type directly. In JavaScript a [DateTime](datetime.md) is projected as a [Date](https://msdn.microsoft.com/library/cd9w2te4) object, and in Microsoft .NET it is projected as a [System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx). Each language transparently handles the conversion to the granularity and date ranges for the respective language. -In Visual C++ component extensions (C++/CX), a **DateTime.UniversalTime** value has the same granularity as a [FILETIME](XREF:TODO:base.filetime_str) (100-nanosecond intervals). For positive values, a **DateTime.UniversalTime** value is identical to a [FILETIME](XREF:TODO:base.filetime_str) value although it can only represent dates up to about 29000 C.E. A negative value represents the number of intervals prior to January 1, 1601 and can represent dates back to about 27,400 B.C.E. For the Gregorian Calendar, you can use a [DateTimeFormatter](../windows.globalization.datetimeformatting/datetimeformatter.md) to create string representations of a [DateTime](datetime.md) for dates after midnight on Year 1 C.E. +In Visual C++ component extensions (C++/CX), a **DateTime.UniversalTime** value has the same granularity as a [FILETIME](https://msdn.microsoft.com/library/windows/desktop/ms724284) (100-nanosecond intervals). For positive values, a **DateTime.UniversalTime** value is identical to a [FILETIME](https://msdn.microsoft.com/library/windows/desktop/ms724284) value although it can only represent dates up to about 29000 C.E. A negative value represents the number of intervals prior to January 1, 1601 and can represent dates back to about 27,400 B.C.E. For the Gregorian Calendar, you can use a [DateTimeFormatter](../windows.globalization.datetimeformatting/datetimeformatter.md) to create string representations of a [DateTime](datetime.md) for dates after midnight on Year 1 C.E. -To convert the **UniversalTime** to [SYSTEMTIME](XREF:TODO:base.systemtime_str), use [ULARGE_INTEGER](http://msdn.microsoft.com/library/83a10c12-2cd1-449a-af3f-b2138fc50ee0) to convert the **int64** value to [FILETIME](XREF:TODO:base.filetime_str), then use [FileTimeToSystemTime](XREF:TODO:base.filetimetosystemtime) to get [SYSTEMTIME](XREF:TODO:base.systemtime_str). +To convert the **UniversalTime** to [SYSTEMTIME](https://msdn.microsoft.com/library/windows/desktop/ms724950), use [ULARGE_INTEGER](http://msdn.microsoft.com/library/83a10c12-2cd1-449a-af3f-b2138fc50ee0) to convert the **int64** value to [FILETIME](https://msdn.microsoft.com/library/windows/desktop/ms724284), then use [FileTimeToSystemTime](https://msdn.microsoft.com/library/windows/desktop/ms724280) to get [SYSTEMTIME](https://msdn.microsoft.com/library/windows/desktop/ms724950). ## -examples ## -see-also -[System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx), [Date object](XREF:TODO:ce2202bb-7ec9-4f5a-bf48-3a04feff283e), [FILETIME](XREF:TODO:base.filetime_str), [Calendar sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624043) \ No newline at end of file +[System.DateTimeOffset](https://msdn.microsoft.com/library/system.datetimeoffset.aspx), [Date object](https://msdn.microsoft.com/library/cd9w2te4), [FILETIME](https://msdn.microsoft.com/library/windows/desktop/ms724284), [Calendar sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=624043) diff --git a/windows.foundation/eventhandler_1.md b/windows.foundation/eventhandler_1.md index 4444d15536..117e1ee9b0 100644 --- a/windows.foundation/eventhandler_1.md +++ b/windows.foundation/eventhandler_1.md @@ -1,7 +1,7 @@ --- -api-id: T:Windows.Foundation.EventHandler`1 -api-type: winrt delegate ---- +--- @@ -11,7 +11,7 @@ public delegate void EventHandler(System.Object sender, T args) Represents a method that handles general events. > **.NET** -> This type appears as [System.EventHandler<TEventArgs>](XREF:TODO:T:System.EventHandler`1). +> This type appears as [System.EventHandler<TEventArgs>](https://msdn.microsoft.com/library/windows/apps/db0etb8x). ## -parameters ### -param sender @@ -22,9 +22,9 @@ The event data. ## -remarks -When programming with .NET, this class is hidden and developers should use the [System.EventHandler<TEventArgs>](XREF:TODO:T:System.EventHandler`1) class. Existing Windows Runtime events have an event data type constraint for **TEventArgs**, so use that event-data type if you need the event data in your specific handler implementation. +When programming with .NET, this class is hidden and developers should use the [System.EventHandler<TEventArgs>](https://msdn.microsoft.com/library/windows/apps/db0etb8x) class. Existing Windows Runtime events have an event data type constraint for **TEventArgs**, so use that event-data type if you need the event data in your specific handler implementation. ## -examples ## -see-also -[System.EventHandler<TEventArgs>](XREF:TODO:T:System.EventHandler`1), [Events and routed events overview](http://msdn.microsoft.com/library/34c219e8-3efb-45bc-8bbd-6fd937698832) \ No newline at end of file +[System.EventHandler<TEventArgs>](https://msdn.microsoft.com/library/windows/apps/db0etb8x), [Events and routed events overview](http://msdn.microsoft.com/library/34c219e8-3efb-45bc-8bbd-6fd937698832) \ No newline at end of file diff --git a/windows.foundation/eventregistrationtoken.md b/windows.foundation/eventregistrationtoken.md index c79e77e0b2..0ec312b795 100644 --- a/windows.foundation/eventregistrationtoken.md +++ b/windows.foundation/eventregistrationtoken.md @@ -4,7 +4,7 @@ --- # EventRegistrationToken @@ -31,4 +31,4 @@ In the event subscription model, a delegate registers to receive change notifica ## -examples ## -see-also -[System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken](https://msdn.microsoft.com/library/system.runtime.interopservices.windowsruntime.eventregistrationtoken.aspx), [Events (C++/CX)](XREF:TODO:31c8e08a-00ad-40f9-8f7e-124864aaad58), [Delegates (C++/CX)](XREF:TODO:3175bf1c-86d8-4eda-8d8f-c5b6753d8e38) +[System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken](https://msdn.microsoft.com/library/system.runtime.interopservices.windowsruntime.eventregistrationtoken.aspx), [Events (C++/CX)](http://msdn.microsoft.com/library/31c8e08a-00ad-40f9-8f7e-124864aaad58), [Delegates (C++/CX)](http://msdn.microsoft.com/library/3175bf1c-86d8-4eda-8d8f-c5b6753d8e38) diff --git a/windows.foundation/hresult.md b/windows.foundation/hresult.md index f22b99e477..7311155898 100644 --- a/windows.foundation/hresult.md +++ b/windows.foundation/hresult.md @@ -26,15 +26,19 @@ When programming with .NET, this class is hidden. All exceptions that are visibl For more info on how to handle exceptions using C# or Visual Basic, see [Exception handling for in C# or Visual Basic](http://msdn.microsoft.com/library/825c5d4f-5ce0-ee93-fd1e-aca1372b1670). -For more info on how to handle exceptions using Visual C++ component extensions (C++/CX), see [Exceptions (C++/CX)](XREF:TODO:6cbdc1f1-e4d7-4707-a670-86365146432f). +For more info on how to handle exceptions using Visual C++ component extensions (C++/CX), see [Exceptions (C++/CX)](http://msdn.microsoft.com/library/6cbdc1f1-e4d7-4707-a670-86365146432f). -For more info on how to handle errors in JavaScript, see [JavaScript Run-time Errors](XREF:TODO:c111469d-8f31-4bde-9d46-16d58775db7d). +For more info on how to handle errors in JavaScript, see [JavaScript Run-time Errors](http://msdn.microsoft.com/library/c111469d-8f31-4bde-9d46-16d58775db7d). -The Windows Runtime **HResult** is based on the [Windows Error codes model](XREF:TODO:1bc92ddf-b79e-413c-bbaa-99a5281a6c90). The **Value** field combines all the parts of a conventional **HRESULT** as a single integer (preceding bits, facility, error code). The Windows Runtime does have its own facility, but also uses (and can throw) error codes defined by other facilities. +The Windows Runtime **HResult** is based on the [Windows Error codes model](http://msdn.microsoft.com/library/1bc92ddf-b79e-413c-bbaa-99a5281a6c90). The **Value** field combines all the parts of a conventional **HRESULT** as a single integer (preceding bits, facility, error code). The Windows Runtime does have its own facility, but also uses (and can throw) error codes defined by other facilities. ## -examples ## -see-also -[Exception handling for in C# or Visual Basic](http://msdn.microsoft.com/library/825c5d4f-5ce0-ee93-fd1e-aca1372b1670), [Exceptions (C++/CX)](XREF:TODO:6cbdc1f1-e4d7-4707-a670-86365146432f), [JavaScript Run-time Errors](XREF:TODO:c111469d-8f31-4bde-9d46-16d58775db7d), [Application.UnhandledException](../windows.ui.xaml/application_unhandledexception.md), [Debug apps in Visual Studio](XREF:TODO:48a85bcf-290b-4390-9993-f6f9dd73ad03) \ No newline at end of file +[Exception handling in C# or Visual Basic](http://msdn.microsoft.com/library/825c5d4f-5ce0-ee93-fd1e-aca1372b1670) +[Exceptions (C++/CX)](https://msdn.microsoft.com/library/6cbdc1f1-e4d7-4707-a670-86365146432f) +[JavaScript Run-time Errors](http://msdn.microsoft.com/library/c111469d-8f31-4bde-9d46-16d58775db7d) +[Application.UnhandledException](../windows.ui.xaml/application_unhandledexception.md) +[Debug apps in Visual Studio](http://msdn.microsoft.com/library/48a85bcf-290b-4390-9993-f6f9dd73ad03) \ No newline at end of file diff --git a/windows.foundation/iasyncaction.md b/windows.foundation/iasyncaction.md index 541712fee0..2d2e7b0e36 100644 --- a/windows.foundation/iasyncaction.md +++ b/windows.foundation/iasyncaction.md @@ -19,7 +19,7 @@ When you use methods that return [IAsyncAction](iasyncaction.md) in your app cod [IAsyncAction](iasyncaction.md) is also an input type for some advanced-scenario utility APIs such as [CoreDispatcher.RunAsync](../windows.ui.core/coredispatcher_runasync.md) and [ThreadPool.RunAsync](../windows.system.threading/threadpool_runasync.md). -It's not common to use [IAsyncAction](iasyncaction.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** syntax. .NET has the [AsTask](XREF:TODO:M:System.WindowsRuntimeSystemExtensions.AsTask(Windows.Foundation.IAsyncAction)) extension method, and once the [IAsyncAction](iasyncaction.md) is converted to a [Task](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](XREF:TODO:6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncAction](iasyncaction.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. +It's not common to use [IAsyncAction](iasyncaction.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** syntax. .NET has the [AsTask](https://msdn.microsoft.com/library/hh779334) extension method, and once the [IAsyncAction](iasyncaction.md) is converted to a [Task](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](http://msdn.microsoft.com/library/6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncAction](iasyncaction.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. Instead of using [IAsyncAction](iasyncaction.md), some Windows Runtime asynchronous methods use custom action types (which might have "Operation" rather than "Action" in their name). For example, [SignOutUserOperation](../windows.security.authentication.onlineid/signoutuseroperation.md) is a Windows Runtime type that implements [IAsyncAction](iasyncaction.md). The [SignOutUserOperation](../windows.security.authentication.onlineid/signoutuseroperation.md) type is then used as the custom action return type for the [SignOutUserAsync](../windows.security.authentication.onlineid/onlineidauthenticator_signoutuserasync.md) method. @@ -35,7 +35,7 @@ Instead of using [IAsyncAction](iasyncaction.md), some Windows Runtime asynchron ### Notes to implementers -As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncInfo](iasyncinfo.md) directly. If writing code using .NET, your method can return a [Task](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](XREF:TODO:9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. +As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncInfo](iasyncinfo.md) directly. If writing code using .NET, your method can return a [Task](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](http://msdn.microsoft.com/library/9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. ## -examples diff --git a/windows.foundation/iasyncactionwithprogress_1.md b/windows.foundation/iasyncactionwithprogress_1.md index 50fb4a5cb6..a86b8fc2cf 100644 --- a/windows.foundation/iasyncactionwithprogress_1.md +++ b/windows.foundation/iasyncactionwithprogress_1.md @@ -17,9 +17,9 @@ Represents an asynchronous action that can report progress updates to callers. T When you use methods that return [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) in your app code, you usually don't access the [IAsyncAction](iasyncaction.md) return value directly. That's because you almost always use the language-specific awaitable syntax. In this case, the apparent return value of the method is **void**. For more info, see [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), or one of the language-specific guides to Windows Runtime asynchronous programming ([Call asynchronous APIs in C# or Visual Basic](http://msdn.microsoft.com/library/066711e0-d5c4-467e-8683-3cc64edbcc83), [C++](http://msdn.microsoft.com/library/34c00f9f-2196-46a3-a32f-0067ab48291b), [JavaScript](http://msdn.microsoft.com/library/b1544667-77f5-4269-8d58-ad81d3ca5dcf)). -It's not common to use [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** with **onProgress** syntax. .NET has the [AsTask](XREF:TODO:M:System.WindowsRuntimeSystemExtensions.AsTask``1(Windows.Foundation.IAsyncActionWithProgress{``0})) extension methods, and once the [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) is converted to a [Task](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to cancel, get notification on completion, use [IProgress<T>](XREF:TODO:T:System.IProgress`1), and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](XREF:TODO:6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. +It's not common to use [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** with **onProgress** syntax. .NET has the [AsTask](http://msdn.microsoft.com/library/hh779749) extension methods, and once the [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) is converted to a [Task](http://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to cancel, get notification on completion, use [IProgress<T>](http://msdn.microsoft.com/library/hh138298), and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](http://msdn.microsoft.com/library/6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. -Specifically, if you want to handle progress in .NET code, use the **AsTask** signature that in an extension usage has a single [IProgress](XREF:TODO:T:System.IProgress`1) reference parameter. (In this usage, the progress unit is already constrained and matches the [IAsyncActionWithProgress](iasyncactionwithprogress_1.md) method you're using.) Provide an object that implements [IProgress](XREF:TODO:T:System.IProgress`1), and your [Report](XREF:TODO:M:System.IProgress`1.Report(`0)) method implementation is invoked each time the Windows Runtime method reports a progress notification. +Specifically, if you want to handle progress in .NET code, use the **AsTask** signature that in an extension usage has a single [IProgress](http://msdn.microsoft.com/library/hh138298) reference parameter. (In this usage, the progress unit is already constrained and matches the [IAsyncActionWithProgress](iasyncactionwithprogress_1.md) method you're using.) Provide an object that implements [IProgress](http://msdn.microsoft.com/library/hh138298), and your [Report](http://msdn.microsoft.com/library/hh193864) method implementation is invoked each time the Windows Runtime method reports a progress notification. To monitor the progress of the action (if not using the language-specific techniques described above), set the [Progress](iasyncactionwithprogress_1_progress.md) property, providing it the name of a method that implements the [AsyncActionProgressHandler<TProgress>](asyncactionprogresshandler_1.md) delegate. @@ -35,7 +35,7 @@ To monitor the progress of the action (if not using the language-specific techni ### Notes to implementers -As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) directly. If writing code using .NET, your method can return a [Task](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](XREF:TODO:9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. +As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncActionWithProgress<TProgress>](iasyncactionwithprogress_1.md) directly. If writing code using .NET, your method can return a [Task](http://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](http://msdn.microsoft.com/library/9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. ## -examples diff --git a/windows.foundation/iasyncinfo.md b/windows.foundation/iasyncinfo.md index a28b8ff948..cfd92a11aa 100644 --- a/windows.foundation/iasyncinfo.md +++ b/windows.foundation/iasyncinfo.md @@ -22,7 +22,7 @@ Supports asynchronous actions and operations. [IAsyncInfo](iasyncinfo.md) is a b When you use asynchronous methods in your app code, you usually don't see any of these interfaces as the return value. That's because you almost always use the language-specific awaitable syntax, which handles the interfaces internally. For more info, see [Asynchronous programming](http://msdn.microsoft.com/library/23fe28f1-89c5-4a17-a732-a722648f9c5e), or one of the language-specific guides to Windows Runtime asynchronous programming ([Call asynchronous APIs in C# or Visual Basic](http://msdn.microsoft.com/library/066711e0-d5c4-467e-8683-3cc64edbcc83), [C++](http://msdn.microsoft.com/library/34c00f9f-2196-46a3-a32f-0067ab48291b), [JavaScript](http://msdn.microsoft.com/library/b1544667-77f5-4269-8d58-ad81d3ca5dcf)). -For most app code, it's uncommon to use [IAsyncInfo](iasyncinfo.md) as an API even if you don't use an awaitable syntax. Each of the languages has extension points that are generally easier to use than is the Windows Runtime[IAsyncInfo](iasyncinfo.md) interface. JavaScript has the **then/done** syntax. .NET has the [AsTask](XREF:TODO:M:System.WindowsRuntimeSystemExtensions.AsTask(Windows.Foundation.IAsyncAction)) extension method, and once the [IAsyncAction](iasyncaction.md) is converted to a [Task](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1). In other words, [IAsyncInfo](iasyncinfo.md) is runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax in their own way. +For most app code, it's uncommon to use [IAsyncInfo](iasyncinfo.md) as an API even if you don't use an awaitable syntax. Each of the languages has extension points that are generally easier to use than is the Windows Runtime[IAsyncInfo](iasyncinfo.md) interface. JavaScript has the **then/done** syntax. .NET has the [AsTask](http://msdn.microsoft.com/library/windows/apps/hh779207) extension method, and once the [IAsyncAction](iasyncaction.md) is converted to a [Task](http://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1). In other words, [IAsyncInfo](iasyncinfo.md) is runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax in their own way. If you're implementing a custom action or custom operation (an advanced scenario) don't implement [IAsyncAction](iasyncaction.md) directly. Implement one of the 4 interfaces previously listed instead. diff --git a/windows.foundation/iasyncinfo_errorcode.md b/windows.foundation/iasyncinfo_errorcode.md index d2ca60f564..a0c94ac478 100644 --- a/windows.foundation/iasyncinfo_errorcode.md +++ b/windows.foundation/iasyncinfo_errorcode.md @@ -18,8 +18,8 @@ The error string. ## -remarks Error codes are exposed as different types depending on the programming language you are using. Similarly, each language has different techniques for wrapping asynchronous method calls so that error conditions or cancellation can be handled. For more info see one of these topics: + [Exception handling for in C# or Visual Basic](http://msdn.microsoft.com/library/825c5d4f-5ce0-ee93-fd1e-aca1372b1670) -+ [Exceptions (C++/CX)](XREF:TODO:6cbdc1f1-e4d7-4707-a670-86365146432f) -+ [JavaScript Run-time Errors](XREF:TODO:c111469d-8f31-4bde-9d46-16d58775db7d) ++ [Exceptions (C++/CX)](http://msdn.microsoft.com/library/6cbdc1f1-e4d7-4707-a670-86365146432f) ++ [JavaScript Run-time Errors](http://msdn.microsoft.com/library/c111469d-8f31-4bde-9d46-16d58775db7d) ## -examples diff --git a/windows.foundation/iasyncoperation_1.md b/windows.foundation/iasyncoperation_1.md index 8db5c33f3a..89f389da7c 100644 --- a/windows.foundation/iasyncoperation_1.md +++ b/windows.foundation/iasyncoperation_1.md @@ -19,7 +19,7 @@ When you use methods that return [IAsyncOperation<TResult>](iasyncoperatio -It's not common to use [IAsyncOperation<TResult>](iasyncoperation_1.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** syntax. .NET has the [AsTask](XREF:TODO:M:System.WindowsRuntimeSystemExtensions.AsTask(Windows.Foundation.IAsyncAction)) extension method, and once the [IAsyncOperation<TResult>](iasyncoperation_1.md) is converted to a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to get the result, cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](XREF:TODO:6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncOperation<TResult>](iasyncoperation_1.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. +It's not common to use [IAsyncOperation<TResult>](iasyncoperation_1.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** syntax. .NET has the [AsTask](https://msdn.microsoft.com/library/windows/apps/hh779207) extension method, and once the [IAsyncOperation<TResult>](iasyncoperation_1.md) is converted to a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to get the result, cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](http://msdn.microsoft.com/library/6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncOperation<TResult>](iasyncoperation_1.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. Instead of using [IAsyncOperation<TResult>](iasyncoperation_1.md), some Windows Runtime asynchronous methods use custom operation types. For example, [DataReaderLoadOperation](../windows.storage.streams/datareaderloadoperation.md) is a Windows Runtime type that implements [IAsyncOperation](iasyncoperation_1.md) using **uint** as the result type. The [DataReaderLoadOperation](../windows.storage.streams/datareaderloadoperation.md) type is then used as the custom operation/result type for the [DataReader.LoadAsync](../windows.storage.streams/datareader_loadasync.md) method. @@ -35,7 +35,7 @@ Instead of using [IAsyncOperation<TResult>](iasyncoperation_1.md), some Wi ### Notes to implementers -As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncOperation<TResult>](iasyncoperation_1.md) directly. If writing code using .NET, your method can return a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](XREF:TODO:9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. +As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncOperation<TResult>](iasyncoperation_1.md) directly. If writing code using .NET, your method can return a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](http://msdn.microsoft.com/library/9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. ## -examples diff --git a/windows.foundation/iasyncoperationwithprogress_2.md b/windows.foundation/iasyncoperationwithprogress_2.md index 1607a8a4f1..52bcf4e387 100644 --- a/windows.foundation/iasyncoperationwithprogress_2.md +++ b/windows.foundation/iasyncoperationwithprogress_2.md @@ -19,9 +19,9 @@ When you use methods that return [IAsyncOperationWithProgress<TResult,TProgre -It's not common to use [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** syntax. .NET has the [AsTask](XREF:TODO:M:System.WindowsRuntimeSystemExtensions.AsTask``1(Windows.Foundation.IAsyncActionWithProgress{``0})) extension method, and once the [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) is converted to a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to get the result, cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](XREF:TODO:6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. +It's not common to use [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) directly even if you don't use a language-specific awaitable syntax. Each of the languages has extension points that are generally easier to use than the Windows Runtime interface. JavaScript has [WinJS.Promise](http://msdn.microsoft.com/library/df6a1939-0c42-4079-a9d5-ab49488d0375), and the **then/done** syntax. .NET has the [AsTask](https://msdn.microsoft.com/library/windows/apps/hh779744) extension method, and once the [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) is converted to a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx), it's easier to get the result, cancel, get notification on completion, and so on. For C++/CX, you can wrap the calls using the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1) (and use [create_task](http://msdn.microsoft.com/library/6e364052-c923-4006-9e03-8516bf041482)). In other words, [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) can be considered runtime-level infrastructure, which each of the languages use as a framework to support awaitable syntax or asynchronous programming models in their own way. -Specifically, if you want to handle progress in .NET code, use the **AsTask** signature that in an extension usage has a single [IProgress](XREF:TODO:T:System.IProgress`1) reference parameter. (In this usage, the progress unit is already constrained and matches the [IAsyncOperationWithProgress](iasyncoperationwithprogress_2.md) method you're using.) Provide an object that implements [IProgress](XREF:TODO:T:System.IProgress`1), and your [Report](XREF:TODO:M:System.IProgress`1.Report(`0)) method implementation is invoked each time the Windows Runtime method reports a progress notification. +Specifically, if you want to handle progress in .NET code, use the **AsTask** signature that in an extension usage has a single [IProgress](https://msdn.microsoft.com/library/windows/apps/hh138298) reference parameter. (In this usage, the progress unit is already constrained and matches the [IAsyncOperationWithProgress](iasyncoperationwithprogress_2.md) method you're using.) Provide an object that implements [IProgress](https://msdn.microsoft.com/library/windows/apps/hh138298), and your [Report](https://msdn.microsoft.com/library/windows/apps/hh193864) method implementation is invoked each time the Windows Runtime method reports a progress notification. To monitor the progress of the action (if not using the language-specific techniques described above), set the [Progress](iasyncoperationwithprogress_2_progress.md) property, providing it the name of a method that implements the [AsyncOperationProgressHandler<TResult,TProgress>](asyncoperationprogresshandler_2.md) delegate. @@ -39,7 +39,7 @@ To monitor the progress of the action (if not using the language-specific techni ### Notes to implementers -As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) directly. If writing code using .NET, your method can return a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](XREF:TODO:f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](XREF:TODO:9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. +As with calling the existing methods, there are language-specific ways to define asynchronous methods that don't use [IAsyncOperationWithProgress<TResult,TProgress>](iasyncoperationwithprogress_2.md) directly. If writing code using .NET, your method can return a [Task<TResult>](https://msdn.microsoft.com/library/system.threading.tasks.task.aspx). For C++/CX, you can use the [Concurrency runtime](http://msdn.microsoft.com/library/f1d33ca2-679b-4442-b140-22a9d9df61d1). However, if you're defining a [ component](http://msdn.microsoft.com/library/9a6b8f0a-7d5e-40a0-a9c5-a59b4908e133), you can use **Task**/**task** internally but you must return one of the Windows Runtime interfaces for your public methods. The language-specific asynchronous support types (and many other language-specific types you might conventionally use in code) can't be used for the public surface area of a Windows Runtime component. ## -examples diff --git a/windows.foundation/iclosable.md b/windows.foundation/iclosable.md index f3e84d96e3..14bfde13ce 100644 --- a/windows.foundation/iclosable.md +++ b/windows.foundation/iclosable.md @@ -20,22 +20,22 @@ Defines a method to release allocated resources. > **C++/CX** -> This interface appears as [Platform::IDisposable](XREF:TODO:f4344056-7030-42ed-bc98-b140edffddcd). +> This interface appears as [Platform::IDisposable](http://msdn.microsoft.com/library/f4344056-7030-42ed-bc98-b140edffddcd). ## -remarks -This interface is projected to a different interface for all possible languages, so it should be considered as an infrastructure piece that the overall Windows Runtime programming experience uses as an implementation detail. There are no typical app development scenarios that rely on implementing or using the [IClosable](iclosable.md) interface directly, unless you're using WRL. For more info, see [WRL Integration](XREF:TODO:3ad43894-c574-477c-ad3e-240301f381d4). +This interface is projected to a different interface for all possible languages, so it should be considered as an infrastructure piece that the overall Windows Runtime programming experience uses as an implementation detail. There are no typical app development scenarios that rely on implementing or using the [IClosable](iclosable.md) interface directly, unless you're using WRL. For more info, see [WRL Integration](http://msdn.microsoft.com/library/3ad43894-c574-477c-ad3e-240301f381d4). ### Notes to implementers When programming with .NET, this interface is hidden and is replaced by the [System.IDisposable](https://msdn.microsoft.com/library/system.idisposable.aspx) interface. -If you are defining a runtime class in C++/CX and define a destructor, don't implement [IClosable](iclosable.md). There's already compiler-based behavior that implements a cleanup behavior for you, (as [Platform::IDisposable](XREF:TODO:f4344056-7030-42ed-bc98-b140edffddcd)) and your explicit implementation will clash with the built-in behavior. For more info, see the "Destructors" section of [Ref classes and structs (C++/CX)](XREF:TODO:3d736b82-0bf0-48cf-bac1-cc9d110b70d1). +If you are defining a runtime class in C++/CX and define a destructor, don't implement [IClosable](iclosable.md). There's already compiler-based behavior that implements a cleanup behavior for you, (as [Platform::IDisposable](http://msdn.microsoft.com/library/f4344056-7030-42ed-bc98-b140edffddcd)) and your explicit implementation will clash with the built-in behavior. For more info, see the "Destructors" section of [Ref classes and structs (C++/CX)](http://msdn.microsoft.com/library/3d736b82-0bf0-48cf-bac1-cc9d110b70d1). The purpose of this interface (as exposed by the languages) is so that Windows Runtime objects can wrap and dispose of exclusive system or device/hardware resources appropriately, such as file handles and network sockets. You do not implement this interface for Windows Runtime objects that wrap shared system resources, such as memory and shareable devices. ### Notes to callers -The scenario for [Platform::IDisposable](XREF:TODO:f4344056-7030-42ed-bc98-b140edffddcd)/[System.IDisposable](https://msdn.microsoft.com/library/system.idisposable.aspx) is to support language-specific syntax that isolates references, such as the **using()** syntax in C#, or scoping behavior for reference counting in C++. Actually casting to the interfaces or invoking its methods from any app code in any language is rarely necessary. +The scenario for [Platform::IDisposable](http://msdn.microsoft.com/library/f4344056-7030-42ed-bc98-b140edffddcd)/[System.IDisposable](https://msdn.microsoft.com/library/system.idisposable.aspx) is to support language-specific syntax that isolates references, such as the **using()** syntax in C#, or scoping behavior for reference counting in C++. Actually casting to the interfaces or invoking its methods from any app code in any language is rarely necessary. ## -examples diff --git a/windows.foundation/iclosable_close_811482585.md b/windows.foundation/iclosable_close_811482585.md index f4e4e6638f..d5146dd925 100644 --- a/windows.foundation/iclosable_close_811482585.md +++ b/windows.foundation/iclosable_close_811482585.md @@ -20,7 +20,7 @@ Releases system resources that are exposed by a Windows Runtime object. > **C++/CX** -> This interface appears as [Platform::IDisposable](XREF:TODO:f4344056-7030-42ed-bc98-b140edffddcd). +> This interface appears as [Platform::IDisposable](http://msdn.microsoft.com/library/f4344056-7030-42ed-bc98-b140edffddcd). ## -remarks Implementation / caller notes that follow are mainly relevant for WRL. diff --git a/windows.foundation/ireference_1.md b/windows.foundation/ireference_1.md index f81dc10751..b0512f5ded 100644 --- a/windows.foundation/ireference_1.md +++ b/windows.foundation/ireference_1.md @@ -15,17 +15,17 @@ Enables arbitrary enumerations, structures, and delegate types to be used as pro > **.NET** -> This interface appears as [Nullable<T>](XREF:TODO:T:System.Nullable`1). +> This interface appears as [Nullable<T>](https://msdn.microsoft.com/library/windows/apps/b3h38hb0). > **C++/CX** -> This interface appears as [Platform::IBox<T>](XREF:TODO:774df45d-f8a7-45a3-ae24-eecc3c681040) +> This interface appears as [Platform::IBox<T>](http://msdn.microsoft.com/library/774df45d-f8a7-45a3-ae24-eecc3c681040) ## -remarks -When programming with .NET, this interface is hidden and developers should use the [Nullable<T>](XREF:TODO:T:System.Nullable`1) class. All Windows Runtime members where the basic IDL signature shows [IReference](ireference_1.md) (with a constraint) are instead exposed using the nullable syntax of the nullable value type (for example, **?bool**). +When programming with .NET, this interface is hidden and developers should use the [Nullable<T>](https://msdn.microsoft.com/library/windows/apps/b3h38hb0) class. All Windows Runtime members where the basic IDL signature shows [IReference](ireference_1.md) (with a constraint) are instead exposed using the nullable syntax of the nullable value type (for example, **?bool**). -When programming with C++/CX, this interface is hidden and developers should use the [Platform::IBox<T>](XREF:TODO:774df45d-f8a7-45a3-ae24-eecc3c681040) interface. All Windows Runtime members where the basic IDL signature shows [IReference](ireference_1.md) (with a constraint) are instead exposed using [Platform::IBox<T>](XREF:TODO:774df45d-f8a7-45a3-ae24-eecc3c681040) with the template as a particular value type. This is how C++/CX implements nullable value types. For more info, see [Value classes and structs (C++/CX)](XREF:TODO:262a0992-9721-4c02-8297-efc07d90e5a4). +When programming with C++/CX, this interface is hidden and developers should use the [Platform::IBox<T>](http://msdn.microsoft.com/library/774df45d-f8a7-45a3-ae24-eecc3c681040) interface. All Windows Runtime members where the basic IDL signature shows [IReference](ireference_1.md) (with a constraint) are instead exposed using [Platform::IBox<T>](http://msdn.microsoft.com/library/774df45d-f8a7-45a3-ae24-eecc3c681040) with the template as a particular value type. This is how C++/CX implements nullable value types. For more info, see [Value classes and structs (C++/CX)](http://msdn.microsoft.com/library/262a0992-9721-4c02-8297-efc07d90e5a4). Because both .NET and C++/CX have projection equivalents, don't implement this interface unless you are using WRL and/or writing code for a Windows Runtime component and need a nullable value type. @@ -36,4 +36,4 @@ Because both .NET and C++/CX have projection equivalents, don't implement this i ## -examples ## -see-also -[IPropertyValue](ipropertyvalue.md), [Nullable<T>](XREF:TODO:T:System.Nullable`1), [Platform::IBox<T>](XREF:TODO:774df45d-f8a7-45a3-ae24-eecc3c681040), [Value classes and structs (C++/CX)](XREF:TODO:262a0992-9721-4c02-8297-efc07d90e5a4) \ No newline at end of file +[IPropertyValue](ipropertyvalue.md), [Nullable<T>](https://msdn.microsoft.com/library/windows/apps/b3h38hb0), [Platform::IBox<T>](http://msdn.microsoft.com/library/774df45d-f8a7-45a3-ae24-eecc3c681040), [Value classes and structs (C++/CX)](http://msdn.microsoft.com/library/262a0992-9721-4c02-8297-efc07d90e5a4) diff --git a/windows.foundation/ireferencearray_1.md b/windows.foundation/ireferencearray_1.md index 673cc5ce92..70a066d4b5 100644 --- a/windows.foundation/ireferencearray_1.md +++ b/windows.foundation/ireferencearray_1.md @@ -15,7 +15,7 @@ Enables arbitrary enumerations, structures, and delegate types to be used as an ## -remarks You can't implement the [IReferenceArray](ireferencearray_1.md) interface or include it in a signature. [IReferenceArray](ireferencearray_1.md) is mainly an internal implementation detail of how the Windows Runtime implements boxing and nullable values. -(C++ only) In C++, this interface is exposed as [Platform::IBoxArray<T>](XREF:TODO:6cd82c9e-4230-4147-9edb-7a652875dbf1). In scenarios such as XAML data-binding in which a collection of either reference types or value types is passed as type Platform::Object^, you can use safe_cast to convert the object to IBoxArray, and then use the [IBoxArray::Value](XREF:TODO:96f33f35-5e3f-459c-b35e-c7d53d315fc7) property to access the strongly typed Platform::Array object that contains the elements of the collection. +(C++ only) In C++, this interface is exposed as [Platform::IBoxArray<T>](http://msdn.microsoft.com/library/6cd82c9e-4230-4147-9edb-7a652875dbf1). In scenarios such as XAML data-binding in which a collection of either reference types or value types is passed as type Platform::Object^, you can use safe_cast to convert the object to IBoxArray, and then use the [IBoxArray::Value](http://msdn.microsoft.com/library/96f33f35-5e3f-459c-b35e-c7d53d315fc7) property to access the strongly typed Platform::Array object that contains the elements of the collection. ### Interface inheritance @@ -24,4 +24,4 @@ You can't implement the [IReferenceArray](ireferencearray_1.md) interface or inc ## -examples ## -see-also -[IPropertyValue](ipropertyvalue.md), [Nullable<T>](XREF:TODO:T:System.Nullable`1) \ No newline at end of file +[IPropertyValue](ipropertyvalue.md), [Nullable<T>](https://msdn.microsoft.com/library/windows/apps/b3h38hb0) \ No newline at end of file diff --git a/windows.foundation/point.md b/windows.foundation/point.md index 46a04dd594..7f22d26d41 100644 --- a/windows.foundation/point.md +++ b/windows.foundation/point.md @@ -54,7 +54,7 @@ Some XAML usages use the [Point](point.md) type to represent a *logical point*. If you are using a Microsoft .NET language (C# or Microsoft Visual Basic), or Visual C++ component extensions (C++/CX), then [Point](point.md) has non-data members available, and its data members are exposed as read-write properties, not fields. Microsoft .NET supports this functionality through the System.Runtime.WindowsRuntime.dll interop assembly that's shipped as part of .NET for Windows Runtime app. Visual C++ component extensions (C++/CX) supports it through the language-specific platform.winmd metadata and the runtime behavior it represents. -If you are programming with C++ using the Windows Template Runtime Library (WRL), then only the data member fields exist as members of [Point](point.md), and you cannot use the utility methods or properties listed in the members table. WRL code can access similar utility methods that are available from the [PointHelper](../windows.ui.xaml/pointhelper.md) static class. For more info on WRL, see [WRL Integration](XREF:TODO:3ad43894-c574-477c-ad3e-240301f381d4). +If you are programming with C++ using the Windows Template Runtime Library (WRL), then only the data member fields exist as members of [Point](point.md), and you cannot use the utility methods or properties listed in the members table. WRL code can access similar utility methods that are available from the [PointHelper](../windows.ui.xaml/pointhelper.md) static class. For more info on WRL, see [Windows Runtime C++ Template Library (WRL)](https://msdn.microsoft.com/en-us/library/hh438466.aspx). ### **Point** values and how they are interpreted by properties @@ -82,7 +82,7 @@ Some graphics elements use multiple [Point](point.md) values represented in a si A [Point](point.md) value is returned by the event data for certain input events. For example, [GetCurrentPoint](../windows.ui.xaml.input/pointerroutedeventargs_getcurrentpoint.md) provides a coordinate value of where a [Pointer](../windows.ui.xaml.input/pointer.md) event occurred in app UI. Generally speaking, these [Point](point.md) values refer to a certain frame of coordinate reference and it is important to know what that frame of reference represents. For input events, the frame of reference by default is the main app window, not the overall screen/display. This enables a consistent frame of reference in case the window is moved or resized. Some API such as [GetCurrentPoint](../windows.ui.xaml.input/pointerroutedeventargs_getcurrentpoint.md) and [GetPosition](../windows.ui.xaml.input/tappedroutedeventargs_getposition.md) also provide a way to translate to an element-specific frame of reference, which is useful when working with input events that are handled by an individual control. For more info, see [Handle pointer input](http://msdn.microsoft.com/library/bdbc9e33-4037-4671-9596-471dcf855c82). -XAML UI development also has a concept known as *hit testing*, where you can use utility methods to test how input events would report info if the user were to perform a pointer action in a particular coordinate location of the UI. To support the hit testing concept, 2 signatures of [FindElementsInHostCoordinates](../windows.ui.xaml.media/visualtreehelper_findelementsinhostcoordinates.md) use a [Point](point.md) input parameter, as does [FindSubElementsForTouchTargeting](../windows.ui.xaml/uielement_findsubelementsfortouchtargeting.md). For more info, see [Mouse interactions](http://msdn.microsoft.com/library/c8a158ef-70a9-4ba2-a270-7d08125700ac). +XAML UI development also has a concept known as *hit testing*, where you can use utility methods to test how input events would report info if the user were to perform a pointer action in a particular coordinate location of the UI. To support the hit testing concept, 2 signatures of [FindElementsInHostCoordinates](../windows.ui.xaml.media/visualtreehelper_findelementsinhostcoordinates.md) use a [Point](point.md) input parameter, as does [FindSubElementsForTouchTargeting](../windows.ui.xaml/uielement_findsubelementsfortouchtargeting_2073429826.md). For more info, see [Mouse interactions](http://msdn.microsoft.com/library/c8a158ef-70a9-4ba2-a270-7d08125700ac). ### Animating **Point** values diff --git a/windows.foundation/wwwformurldecoder.md b/windows.foundation/wwwformurldecoder.md index 4be51b907d..2f5c15e98a 100644 --- a/windows.foundation/wwwformurldecoder.md +++ b/windows.foundation/wwwformurldecoder.md @@ -17,14 +17,14 @@ Use the [WwwFormUrlDecoder](wwwformurldecoder.md) class to parse a query string Use [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) to find a specific named query string parameter. All languages can use this method. You'd typically use [GetFirstValueByName](wwwformurldecoder_getfirstvaluebyname.md) rather than [GetAt](wwwformurldecoder_getat.md) or [Item](wwwformurldecoder_item.md) because the order of items in a query string usually isn't important, whereas the parameter name is the important identifier of the parts of a query. Or, if you're not sure what names exist in the query string, you might enumerate over the complete [WwwFormUrlDecoder](wwwformurldecoder.md) collection. -The [Uri.QueryParsed](uri_queryparsed.md) property returns a complete [WwwFormUrlDecoder](wwwformurldecoder.md) based on a [Uri](uri.md) instance. So if you're using Visual C++ component extensions (C++/CX) or JavaScript code, and you already have a [Uri](uri.md) instance, you won't need to construct a new [WwwFormUrlDecoder](wwwformurldecoder.md) object, the [Uri](uri.md) instance already has one. You might construct a [WwwFormUrlDecoder](wwwformurldecoder.md) if you have a string representing a URL or its query string component from other sources, such as from a [Windows.Web.Http](../windows.web.http/windows_web_http.md) API. +The [Uri.QueryParsed](uri_queryparsed.md) property returns a complete [WwwFormUrlDecoder](wwwformurldecoder.md) based on a [Uri](uri.md) instance. So if you're using Visual C++ component extensions (C++/CX) or JavaScript code, and you already have a [Uri](uri.md) instance, you won't need to construct a new [WwwFormUrlDecoder](wwwformurldecoder.md) object, the [Uri](uri.md) instance already has one. You might construct a [WwwFormUrlDecoder](wwwformurldecoder.md) if you have a string representing a URL or its query string component from other sources, such as from a [Windows.Web.Http](../windows.web.http/windows_web_http.md) API. > [!NOTE] > This collection is a vector rather than a map in case the original order has any meaning to an implementation, and also because it's legal for the same name to appear in the query string twice, whereas it's not legal for maps to have duplicate keys. ### Collection member lists -For .NET usage, [WwwFormUrlDecoder](wwwformurldecoder.md) has the projected APIs of a generic [IReadOnlyList](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) with a [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) constraint. The APIs that are available for each language are indicated in the member lists. +For .NET usage, [WwwFormUrlDecoder](wwwformurldecoder.md) has the projected APIs of a generic [IReadOnlyList](https://msdn.microsoft.com/library/windows/apps/hh192385) with a [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) constraint. The APIs that are available for each language are indicated in the member lists. For JavaScript, [WwwFormUrlDecoder](wwwformurldecoder.md) has the members shown in the member lists. In addition, [WwwFormUrlDecoder](wwwformurldecoder.md) supports a **length** property, members of **Array.prototype**, and using an index to access items. @@ -34,7 +34,7 @@ For JavaScript, [WwwFormUrlDecoder](wwwformurldecoder.md) has the members shown Use the [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) interface for the type of the items in the collection (this is how the items are typed by [Item](wwwformurldecoder_item.md), [IndexOf](wwwformurldecoder_indexof.md) and so on). Don't use the [WwwFormUrlDecoderEntry](wwwformurldecoderentry.md) class, it isn't available for .NET usage. -[WwwFormUrlDecoder](wwwformurldecoder.md) also has the projected APIs of a generic [IReadOnlyList](XREF:TODO:T:System.Collections.Generic.IReadOnlyList`1) with a [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) constraint, but these APIs aren't commonly used. +[WwwFormUrlDecoder](wwwformurldecoder.md) also has the projected APIs of a generic [IReadOnlyList](https://msdn.microsoft.com/library/windows/apps/hh192385) with a [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) constraint, but these APIs aren't commonly used. > [!NOTE] > `System.Web.HttpUtility.ParseQueryString` isn't available for .NET for Windows Runtime app. [WwwFormUrlDecoder](wwwformurldecoder.md) is the recommended replacement for it. @@ -43,7 +43,7 @@ Use the [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) interface for the ### Enumerating the collection in C# or Microsoft Visual Basic -[WwwFormUrlDecoder](wwwformurldecoder.md) is enumerable, so you can use language-specific syntax such as **foreach** in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to `IEnumerable` explicitly. If you do need to cast explicitly, for example if you want to call [GetEnumerator](XREF:TODO:M:System.Collections.Generic.IEnumerable`1.GetEnumerator), cast to [IEnumerable<T>](XREF:TODO:T:System.Collections.Generic.IEnumerable`1) with an [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) constraint. +[WwwFormUrlDecoder](wwwformurldecoder.md) is enumerable, so you can use language-specific syntax such as **foreach** in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to `IEnumerable` explicitly. If you do need to cast explicitly, for example if you want to call [GetEnumerator](https://msdn.microsoft.com/library/windows/apps/system.collections.ienumerable.getenumerator), cast to [IEnumerable<T>](https://msdn.microsoft.com/library/windows/apps/system.collections.ienumerable) with an [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) constraint. @@ -51,4 +51,4 @@ Use the [IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md) interface for the ## -examples ## -see-also -[IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md), [Uri.QueryParsed](uri_queryparsed.md) \ No newline at end of file +[IWwwFormUrlDecoderEntry](iwwwformurldecoderentry.md), [Uri.QueryParsed](uri_queryparsed.md) diff --git a/windows.gaming.input.custom/gamecontrollerfactorymanager_trygetfactorycontrollerfromgamecontroller_1189083569.md b/windows.gaming.input.custom/gamecontrollerfactorymanager_trygetfactorycontrollerfromgamecontroller_1189083569.md new file mode 100644 index 0000000000..9cf097e3b7 --- /dev/null +++ b/windows.gaming.input.custom/gamecontrollerfactorymanager_trygetfactorycontrollerfromgamecontroller_1189083569.md @@ -0,0 +1,42 @@ +--- +-api-id: M:Windows.Gaming.Input.Custom.GameControllerFactoryManager.TryGetFactoryControllerFromGameController(Windows.Gaming.Input.Custom.ICustomGameControllerFactory,Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.GameControllerFactoryManager.TryGetFactoryControllerFromGameController + +## -description + +Tries to get a game controller that belongs to the specified factory and references the same underlying game controller as the one that was specified. + +## -parameters + +### -param factory + +The factory for the type of game controller that you want to get. + +### -param gameController + +The game controller that references the underlying device for which you want to get another game controller representation. + +## -returns + +If found, a game controller that belongs to the specified factory and references the same underlying device as the specified game controller; otherwise, **null**. + +## -remarks + +This method provides the implementation for each game controller class's **FromGameController** method. A class's **FromGameController** method allows you to pass in an instance of one game controller class, and get an object from another game controller class that references the same underlying device. For example, if you have an [ArcadeStick](../windows.gaming.input/arcadestick.md) and you want to get a [RawGameController](../windows.gaming.input/rawgamecontroller.md) representation of that same underlying controller, you would call [RawGameController.FromGameController](../windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md), passing in the **ArcadeStick** (which you can do, since the method takes an [IGameController](../windows.gaming.input/igamecontroller.md) object, and **ArcadeStick** inherits from **IGameController**). Your custom game controller classes must also inherit from **IGameController**. + +Since each game controller class implements [ICustomGameControllerFactory](icustomgamecontrollerfactory.md) (including your own custom classes), you can pass the factory for the game controller class that you want into **GameControllerFactoryManager.TryGetFactoryControllerFromGameController**, and then the **GameControllerFactoryManager** can try to return an object of that class that references the same underlying device as the game controller that you specified. + +## -see-also + +* [Windows.Gaming.Input.IGameController](../windows.gaming.input/igamecontroller.md) +* [Windows.Gaming.Input.Custom.ICustomGameControllerFactory](icustomgamecontrollerfactory.md) + +## -examples + diff --git a/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md b/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md index 7e65a7375b..bca47414a9 100644 --- a/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md +++ b/windows.gaming.input.custom/gipgamecontrollerprovider_updatefirmwareasync_363935500.md @@ -14,7 +14,7 @@ Attempts to asynchronously update the firmware for the controller. ## -parameters ### -param firmwareImage -A stream pointing to the firmware image to update the controller with. +A stream pointing to the firmware image with which to update the controller. ## -returns Returns the result of the asynchronous operation. diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider.md b/windows.gaming.input.custom/hidgamecontrollerprovider.md new file mode 100644 index 0000000000..5d6d085569 --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Gaming.Input.Custom.HidGameControllerProvider +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider + +## -description + +Represents the underlying device for a HID (Human Interface Device) game controller. + +## -remarks + +This class provides functions for sending raw HID output reports, as well as reading and writing raw HID feature reports. These reports are in their original format—no parsing is done on them. + +This class also exposes the HID page and usage of the TLC (top-level collection), so that you can interface correctly with each supported TLC. + +## -see-also + +* [IGameControllerProvider](igamecontrollerprovider.md) + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_firmwareversioninfo.md b/windows.gaming.input.custom/hidgamecontrollerprovider_firmwareversioninfo.md new file mode 100644 index 0000000000..9a5339dc79 --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_firmwareversioninfo.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Gaming.Input.Custom.HidGameControllerProvider.FirmwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.FirmwareVersionInfo + +## -description + +The firmware version of the controller. + +## -property-value + +The firmware version of the controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.Custom.GameControllerVersionInfo](gamecontrollerversioninfo.md) + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_getfeaturereport_1780258401.md b/windows.gaming.input.custom/hidgamecontrollerprovider_getfeaturereport_1780258401.md new file mode 100644 index 0000000000..bd7a9a4c3c --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_getfeaturereport_1780258401.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Gaming.Input.Custom.HidGameControllerProvider.GetFeatureReport(System.Byte,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.GetFeatureReport + +## -description + +Gets the specified HID (Human Interface Device) feature report from the controller. + +## -parameters + +### -param reportId + +The ID of the report to get. + +### -param reportBuffer + +The buffer in which the report data is returned. + +## -remarks + +When using this method for your own custom classes, make sure to pass in a valid report ID that is supported by your device; otherwise, the report buffer will be unchanged. Also make sure that your report buffer is the correct size for the type of report that you're requesting. + +The report that you get from this method is the raw, unmodified version in its original format; no parsing is done on it. + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_hardwareproductid.md b/windows.gaming.input.custom/hidgamecontrollerprovider_hardwareproductid.md new file mode 100644 index 0000000000..40e731ddf9 --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_hardwareproductid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Gaming.Input.Custom.HidGameControllerProvider.HardwareProductId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.HardwareProductId + +## -description + +The hardware product ID of the controller. + +## -property-value + +The hardware product ID of the controller. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_hardwarevendorid.md b/windows.gaming.input.custom/hidgamecontrollerprovider_hardwarevendorid.md new file mode 100644 index 0000000000..2db3bd0ae1 --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_hardwarevendorid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Gaming.Input.Custom.HidGameControllerProvider.HardwareVendorId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.HardwareVendorId + +## -description + +The hardware vendor ID of the controller. + +## -property-value + +The hardware vendor ID of the controller. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_hardwareversioninfo.md b/windows.gaming.input.custom/hidgamecontrollerprovider_hardwareversioninfo.md new file mode 100644 index 0000000000..e56b7612bc --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_hardwareversioninfo.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Gaming.Input.Custom.HidGameControllerProvider.HardwareVersionInfo +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.HardwareVersionInfo + +## -description + +Contains information on the hardware version of the controller. + +## -property-value + +Contains information on the hardware version of the controller. + +## -remarks + +## -see-also + +* [GameControllerVersionInfo](gamecontrollerversioninfo.md) + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_isconnected.md b/windows.gaming.input.custom/hidgamecontrollerprovider_isconnected.md new file mode 100644 index 0000000000..acb0c92241 --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_isconnected.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Gaming.Input.Custom.HidGameControllerProvider.IsConnected +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.IsConnected + +## -description + +Boolean value indicating whether the controller is connected. + +## -property-value + +Boolean value indicating whether the controller is connected. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_sendfeaturereport_2081746948.md b/windows.gaming.input.custom/hidgamecontrollerprovider_sendfeaturereport_2081746948.md new file mode 100644 index 0000000000..f367d0364e --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_sendfeaturereport_2081746948.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Gaming.Input.Custom.HidGameControllerProvider.SendFeatureReport(System.Byte,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.SendFeatureReport + +## -description + +Sends the specified HID (Human Interface Device) feature report to the device. + +## -parameters + +### -param reportId + +The ID of the report to send. + +### -param reportBuffer + +The buffer containing the report data to send. + +## -remarks + +When using this method for your own custom classes, make sure to pass in a valid report ID that is supported by your device; otherwise, the device will ignore it. Also make sure that your report buffer is the correct size and has valid contents. + +The report that you send from this method is the raw, unmodified version in its original format; no parsing is done on it. + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_sendoutputreport_979595345.md b/windows.gaming.input.custom/hidgamecontrollerprovider_sendoutputreport_979595345.md new file mode 100644 index 0000000000..8dee82e179 --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_sendoutputreport_979595345.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Gaming.Input.Custom.HidGameControllerProvider.SendOutputReport(System.Byte,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.SendOutputReport + +## -description + +Sends the specified HID (Human Interface Device) output report to the device. + +## -parameters + +### -param reportId + +The ID of the report to send. + +### -param reportBuffer + +The buffer containing the report data to send. + +## -remarks + +When using this method for your own custom classes, make sure to pass in a valid report ID that is supported by your device; otherwise, the device will ignore it. Also make sure that your report buffer is the correct size and has valid contents. + +The report that you send from this function is the raw, unmodified version in its original format; no parsing is done on it. + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_usageid.md b/windows.gaming.input.custom/hidgamecontrollerprovider_usageid.md new file mode 100644 index 0000000000..9f2d0218e0 --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_usageid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Gaming.Input.Custom.HidGameControllerProvider.UsageId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.UsageId + +## -description + +The usage ID of the top-level collection. + +## -property-value + +The usage ID of the top-level collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/hidgamecontrollerprovider_usagepage.md b/windows.gaming.input.custom/hidgamecontrollerprovider_usagepage.md new file mode 100644 index 0000000000..d96f304dfc --- /dev/null +++ b/windows.gaming.input.custom/hidgamecontrollerprovider_usagepage.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Gaming.Input.Custom.HidGameControllerProvider.UsagePage +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.Custom.HidGameControllerProvider.UsagePage + +## -description + +The usage page of the top-level collection. + +## -property-value + +The usage page of the top-level collection. + +## -remarks + +The **UsagePage** is retrieved from the HID (Human Interface Device) report descriptor. + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller_716729334.md b/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller_716729334.md index 438f8f6332..8ca5176434 100644 --- a/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller_716729334.md +++ b/windows.gaming.input.custom/icustomgamecontrollerfactory_creategamecontroller_716729334.md @@ -17,7 +17,7 @@ Creates an instance of a game controller. The controller provider for the controller. ## -returns -Returns the created object. +The created object. ## -remarks diff --git a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded_16058344.md b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded_16058344.md index d87655093f..b1b117c988 100644 --- a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded_16058344.md +++ b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrolleradded_16058344.md @@ -10,11 +10,11 @@ public void OnGameControllerAdded(Windows.Gaming.Input.IGameController value) # Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerAdded ## -description -Event triggered when the controller is added. +Event raised when the controller is added. ## -parameters ### -param value -An interface representing the added controller. +The added controller. ## -remarks diff --git a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved_407594117.md b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved_407594117.md index b6176e25f9..6f6623a588 100644 --- a/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved_407594117.md +++ b/windows.gaming.input.custom/icustomgamecontrollerfactory_ongamecontrollerremoved_407594117.md @@ -10,11 +10,11 @@ public void OnGameControllerRemoved(Windows.Gaming.Input.IGameController value) # Windows.Gaming.Input.Custom.ICustomGameControllerFactory.OnGameControllerRemoved ## -description -Event triggered when the controller is removed. +Event raised when the controller is removed. ## -parameters ### -param value -An interface representing the removed controller. +The removed controller. ## -remarks diff --git a/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed_1042659281.md b/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed_1042659281.md index 38e2f97795..b0488a938c 100644 --- a/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed_1042659281.md +++ b/windows.gaming.input.custom/igamecontrollerinputsink_oninputresumed_1042659281.md @@ -10,7 +10,7 @@ public void OnInputResumed(System.UInt64 timestamp) # Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputResumed ## -description -Event triggered when input for the controller is resumed. +Event raised when input for the controller is resumed. ## -parameters ### -param timestamp diff --git a/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended_1674919629.md b/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended_1674919629.md index ea5333f5b1..d13377a98e 100644 --- a/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended_1674919629.md +++ b/windows.gaming.input.custom/igamecontrollerinputsink_oninputsuspended_1674919629.md @@ -10,7 +10,7 @@ public void OnInputSuspended(System.UInt64 timestamp) # Windows.Gaming.Input.Custom.IGameControllerInputSink.OnInputSuspended ## -description -Event triggered when input for the controller is suspended. +Event raised when input for the controller is suspended. ## -parameters ### -param timestamp diff --git a/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md b/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md index bcf9dae9a7..fe19ef43c8 100644 --- a/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md +++ b/windows.gaming.input.custom/igamecontrollerprovider_firmwareversioninfo.md @@ -13,7 +13,7 @@ public Windows.Gaming.Input.Custom.GameControllerVersionInfo FirmwareVersionInfo Contains information on the firmware version of the controller. ## -property-value -Contains information on the firmware version of the controller. +Information on the firmware version of the controller. ## -remarks diff --git a/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md b/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md index fcc9713686..9d113e8518 100644 --- a/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md +++ b/windows.gaming.input.custom/igamecontrollerprovider_hardwareversioninfo.md @@ -13,7 +13,7 @@ public Windows.Gaming.Input.Custom.GameControllerVersionInfo HardwareVersionInfo Contains information on the hardware version. ## -property-value -Contains information on the hardware version. +Information on the hardware version. ## -remarks diff --git a/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived_1108351975.md b/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived_1108351975.md index 7f4b7735fa..bd06ba045a 100644 --- a/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived_1108351975.md +++ b/windows.gaming.input.custom/igipgamecontrollerinputsink_onkeyreceived_1108351975.md @@ -10,14 +10,14 @@ public void OnKeyReceived(System.UInt64 timestamp, System.Byte keyCode, System.B # Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnKeyReceived ## -description -Event triggered when a key is received. +Event raised when a key is received. ## -parameters ### -param timestamp Timestamp for the event. ### -param keyCode -The key code for the button that triggered the event.. +The key code for the button that raised the event. ### -param isPressed Boolean indicating whether the key is pressed or released. diff --git a/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived_580857462.md b/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived_580857462.md index 230a43d135..0388444c96 100644 --- a/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived_580857462.md +++ b/windows.gaming.input.custom/igipgamecontrollerinputsink_onmessagereceived_580857462.md @@ -10,7 +10,7 @@ public void OnMessageReceived(System.UInt64 timestamp, Windows.Gaming.Input.Cust # Windows.Gaming.Input.Custom.IGipGameControllerInputSink.OnMessageReceived ## -description -Event triggered when a message is received. +Event raised when a message is received. ## -parameters ### -param timestamp @@ -26,7 +26,7 @@ The ID of the message. Sequence ID of the message. ### -param messageBuffer -A buffer containing the message. +Buffer containing the message. ## -remarks diff --git a/windows.gaming.input.custom/ihidgamecontrollerinputsink.md b/windows.gaming.input.custom/ihidgamecontrollerinputsink.md new file mode 100644 index 0000000000..eb447e845c --- /dev/null +++ b/windows.gaming.input.custom/ihidgamecontrollerinputsink.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.Gaming.Input.Custom.IHidGameControllerInputSink +-api-type: winrt interface +--- + + + +# Windows.Gaming.Input.Custom.IHidGameControllerInputSink + +## -description + +Defines the methods necessary for a custom HID (Human Interface Device) controller interface. + +## -remarks + +This interface must be implemented by a HID custom controller class to receive input reports from the underlying HID device. No parsing or modifications are done on these reports; they are retrieved in their original format. + +## -see-also + +* [Windows.Gaming.Input.Custom.IGameControllerInputSink](igamecontrollerinputsink.md) + +## -examples + diff --git a/windows.gaming.input.custom/ihidgamecontrollerinputsink_oninputreportreceived_689282015.md b/windows.gaming.input.custom/ihidgamecontrollerinputsink_oninputreportreceived_689282015.md new file mode 100644 index 0000000000..e3171b2877 --- /dev/null +++ b/windows.gaming.input.custom/ihidgamecontrollerinputsink_oninputreportreceived_689282015.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Gaming.Input.Custom.IHidGameControllerInputSink.OnInputReportReceived(System.UInt64,System.Byte,System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Custom.IHidGameControllerInputSink.OnInputReportReceived + +## -description + +Event raised when input is received. + +## -parameters + +### -param timestamp + +Timestamp of the event. + +### -param reportId + +The ID of the report. + +### -param reportBuffer + +Buffer containing the received input. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived_58393461.md b/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived_58393461.md index 4ac85d4940..2a2748ae4c 100644 --- a/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived_58393461.md +++ b/windows.gaming.input.custom/ixusbgamecontrollerinputsink_oninputreceived_58393461.md @@ -10,17 +10,17 @@ public void OnInputReceived(System.UInt64 timestamp, System.Byte reportId, Syste # Windows.Gaming.Input.Custom.IXusbGameControllerInputSink.OnInputReceived ## -description -Event triggered when input is received. +Event raised when input is received. ## -parameters ### -param timestamp Timestamp of the event. ### -param reportId -The ID of the report. +ID of the report. ### -param inputBuffer -A buffer containing the received input. +Buffer containing the received input. ## -remarks diff --git a/windows.gaming.input.custom/windows_gaming_input_custom.md b/windows.gaming.input.custom/windows_gaming_input_custom.md index cab8b64ae6..8c44ff5927 100644 --- a/windows.gaming.input.custom/windows_gaming_input_custom.md +++ b/windows.gaming.input.custom/windows_gaming_input_custom.md @@ -6,7 +6,7 @@ # Windows.Gaming.Input.Custom ## -description -Contains APIs enabling equipment manufacturers to write custom WinRT class libraries for their devices. +Contains APIs enabling equipment manufacturers to write custom WinRT (Windows Runtime) class libraries for their devices. ## -remarks It is important to be aware that the APIs in this namespace are not targeted at apps; in fact, no app should ever call these APIs directly. This namespace is only meant to provide a framework for authoring WinRT component libraries, and it is those libraries (and the APIs they expose) that apps will ultimately consume. As such, these APIs are focused primarily on low-level, raw access to game controller devices. diff --git a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md index 6ec7e26453..bd931558e1 100644 --- a/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md +++ b/windows.gaming.input.custom/xusbgamecontrollerprovider_hardwareversioninfo.md @@ -13,7 +13,7 @@ public Windows.Gaming.Input.Custom.GameControllerVersionInfo HardwareVersionInfo Contains information on the hardware version of the controller. ## -property-value -Structure containing information on the hardware version of the controller. +Information on the hardware version of the controller. ## -remarks diff --git a/windows.gaming.input/arcadestick.md b/windows.gaming.input/arcadestick.md index 8e52e2fd6f..93f586acdb 100644 --- a/windows.gaming.input/arcadestick.md +++ b/windows.gaming.input/arcadestick.md @@ -10,16 +10,19 @@ public class ArcadeStick : Windows.Gaming.Input.IArcadeStick, Windows.Gaming.Inp # Windows.Gaming.Input.ArcadeStick ## -description -Represents an Arcade Stick. + +Represents an arcade stick. ## -remarks -### Supported Device -s - **ArcadeStick** - supports any Xbox One certified or Xbox 360 compatible arcade stick. +Instances of the **ArcadeStick** class cannot be created directly; instead, instances of the class are retrieved through the [ArcadeStick.ArcadeSticks](arcadestick_arcadesticks.md) property listing all connected arcade sticks or through the [ArcadeStick.ArcadeStickAdded](arcadestick_arcadestickadded.md) event. + +### Supported Devices + +**ArcadeStick** supports any Xbox One-certified or Xbox 360-compatible arcade stick. ## -examples ## -see-also -[IGameController](igamecontroller.md) \ No newline at end of file + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_arcadestickadded.md b/windows.gaming.input/arcadestick_arcadestickadded.md index e96eef8421..97a61a43c7 100644 --- a/windows.gaming.input/arcadestick_arcadestickadded.md +++ b/windows.gaming.input/arcadestick_arcadestickadded.md @@ -10,10 +10,12 @@ static public event Windows.Foundation.EventHandler ArcadeStickAdded + +# Windows.Gaming.Input.ArcadeStick.FromGameController + +## -description + +Returns the given game controller as an arcade stick. + +## -params + +## -param gameController + +The game controller to be returned as an arcade stick. + +## -returns + +The arcade stick that was returned from the given game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) + +## -examples + + \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md b/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md index 38136bd756..8ae8fb34b9 100644 --- a/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md +++ b/windows.gaming.input/arcadestick_getbuttonlabel_1981773638.md @@ -1,26 +1,32 @@ ---- --api-id: M:Windows.Gaming.Input.ArcadeStick.GetButtonLabel(Windows.Gaming.Input.ArcadeStickButtons) --api-type: winrt method ---- - - - -# Windows.Gaming.Input.ArcadeStick.GetButtonLabel - -## -description -Retrieves the button label for the specified button. - -## -parameters -### -param button -The button to retrieve the label for. - -## -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. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Gaming.Input.ArcadeStick.GetButtonLabel(Windows.Gaming.Input.ArcadeStickButtons) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.ArcadeStick.GetButtonLabel + +## -description + +Retrieves the button label for the specified button. + +## -parameters + +### -param button + +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. + +## -remarks + +## -examples + +## -see-also + +* [Windows.Gaming.Input.GameControllerButtonLabel](gamecontrollerbuttonlabel.md) +* [Windows.Gaming.Input.ArcadeStickButtons](arcadestickbuttons.md) \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md b/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md index 9afc028a2a..44d3ea0c8e 100644 --- a/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md +++ b/windows.gaming.input/arcadestick_getcurrentreading_1416488181.md @@ -10,13 +10,17 @@ public Windows.Gaming.Input.ArcadeStickReading GetCurrentReading() # Windows.Gaming.Input.ArcadeStick.GetCurrentReading ## -description -Gets a snapshot of the acrade stick state. + +Gets a snapshot of the arcade stick state. ## -returns -Returns an [ArcadeStickReading](arcadestickreading.md) containing the current state of the arcade stick. + +The current state of the arcade stick. ## -remarks ## -examples ## -see-also + +* [Windows.Gaming.Input.ArcadeStickReading](arcadestickreading.md) \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_headset.md b/windows.gaming.input/arcadestick_headset.md index b3015a8d80..c624b6077d 100644 --- a/windows.gaming.input/arcadestick_headset.md +++ b/windows.gaming.input/arcadestick_headset.md @@ -10,9 +10,11 @@ public Windows.Gaming.Input.Headset Headset { get; } # Windows.Gaming.Input.ArcadeStick.Headset ## -description + The audio headset attached to the arcade stick. ## -property-value + The audio headset attached to the arcade stick. ## -remarks @@ -20,3 +22,5 @@ The audio headset attached to the arcade stick. ## -examples ## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_headsetconnected.md b/windows.gaming.input/arcadestick_headsetconnected.md index 1f2c19b412..345b0d2478 100644 --- a/windows.gaming.input/arcadestick_headsetconnected.md +++ b/windows.gaming.input/arcadestick_headsetconnected.md @@ -10,6 +10,7 @@ public event Windows.Foundation.TypedEventHandler HeadsetConnected + +# Windows.Gaming.Input.ArcadeStick.TryGetBatteryReport + +## -description + +Gets information about the arcade stick's current battery state. + +## -returns + +Information about the arcade stick's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples + + \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_user.md b/windows.gaming.input/arcadestick_user.md index cae909f435..e2e218cd47 100644 --- a/windows.gaming.input/arcadestick_user.md +++ b/windows.gaming.input/arcadestick_user.md @@ -10,9 +10,11 @@ public Windows.System.User User { get; } # Windows.Gaming.Input.ArcadeStick.User ## -description + The user associated with the arcade stick. ## -property-value + The user associated with the arcade stick. ## -remarks @@ -20,3 +22,5 @@ The user associated with the arcade stick. ## -examples ## -see-also + +* [Windows.System.User](../windows.system/user.md) \ No newline at end of file diff --git a/windows.gaming.input/arcadestick_userchanged.md b/windows.gaming.input/arcadestick_userchanged.md index 3f220d43ae..a8cbd16863 100644 --- a/windows.gaming.input/arcadestick_userchanged.md +++ b/windows.gaming.input/arcadestick_userchanged.md @@ -10,6 +10,7 @@ public event Windows.Foundation.TypedEventHandler UserChanged + +# Windows.Gaming.Input.FlightStick + +## -description + +Represents a flight stick. + +## -remarks + +**FlightStick** is targeted at simple, arcade-style flight games. It provides several basic inputs, which are derived from the lowest common denominator of inputs available across the majority of popular flight stick devices. These inputs include: + +* Two buttons for firing primary and secondary weapons. +* A hat switch for camera view and/or target selection. +* Axis data for pitch, roll, yaw, and throttle position. + +### Supported Devices + +`FlightStick` supports any Xbox One certified or Xbox 360 compatible flight stick. + +## -see-also + +* [IGameController](igamecontroller.md) +* [IGameControllerBatteryInfo](igamecontrollerbatteryinfo.md) + +## -examples diff --git a/windows.gaming.input/flightstick_flightstickadded.md b/windows.gaming.input/flightstick_flightstickadded.md new file mode 100644 index 0000000000..97981ce5a5 --- /dev/null +++ b/windows.gaming.input/flightstick_flightstickadded.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.Gaming.Input.FlightStick.FlightStickAdded +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.FlightStick.FlightStickAdded + +## -description + +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). + +## -see-also + +## -examples diff --git a/windows.gaming.input/flightstick_flightstickremoved.md b/windows.gaming.input/flightstick_flightstickremoved.md new file mode 100644 index 0000000000..7c631b272c --- /dev/null +++ b/windows.gaming.input/flightstick_flightstickremoved.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Gaming.Input.FlightStick.FlightStickRemoved +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.FlightStick.FlightStickRemoved + +## -description + +Signals when a flight stick is disconnected. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/flightstick_flightsticks.md b/windows.gaming.input/flightstick_flightsticks.md new file mode 100644 index 0000000000..05d8882399 --- /dev/null +++ b/windows.gaming.input/flightstick_flightsticks.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.FlightStick.FlightSticks +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.FlightStick.FlightSticks + +## -description + +The list of all connected flight sticks. + +## -property-value + +The list of all connected flight sticks. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/flightstick_fromgamecontroller_421915006.md b/windows.gaming.input/flightstick_fromgamecontroller_421915006.md new file mode 100644 index 0000000000..bffbe458ce --- /dev/null +++ b/windows.gaming.input/flightstick_fromgamecontroller_421915006.md @@ -0,0 +1,49 @@ +--- +-api-id: M:Windows.Gaming.Input.FlightStick.FromGameController(Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.FlightStick.FromGameController + +## -description + +Returns the given game controller as a flight stick. + +## -params + +## -param gameController + +The game controller to be returned as a flight stick. + +## -returns + +The flight stick that was returned from the given game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) + +## -examples + + \ No newline at end of file diff --git a/windows.gaming.input/flightstick_getbuttonlabel_2119068015.md b/windows.gaming.input/flightstick_getbuttonlabel_2119068015.md new file mode 100644 index 0000000000..ab64667768 --- /dev/null +++ b/windows.gaming.input/flightstick_getbuttonlabel_2119068015.md @@ -0,0 +1,50 @@ +--- +-api-id: M:Windows.Gaming.Input.FlightStick.GetButtonLabel(Windows.Gaming.Input.FlightStickButtons) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.FlightStick.GetButtonLabel + +## -description + +Retrieves the button label for the specified button. + +## -params + +## -param button + +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. + +## -remarks + +## -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 new file mode 100644 index 0000000000..8d55c7dbeb --- /dev/null +++ b/windows.gaming.input/flightstick_getcurrentreading_1416488181.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Gaming.Input.FlightStick.GetCurrentReading +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.FlightStick.GetCurrentReading + +## -description + +Gets a snapshot of the flight stick state. + +## -params + +## -returns + +The current state of the flight stick. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.FlightStickReading](flightstickreading.md) + +## -examples diff --git a/windows.gaming.input/flightstick_hatswitchkind.md b/windows.gaming.input/flightstick_hatswitchkind.md new file mode 100644 index 0000000000..52314a8ec1 --- /dev/null +++ b/windows.gaming.input/flightstick_hatswitchkind.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Gaming.Input.FlightStick.HatSwitchKind +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.FlightStick.HatSwitchKind + +## -description + +The type of hat switch on the flight stick. + +## -property-value + +The type of hat switch on the flight stick. + +## -remarks + +A hat switch is a control often used for camera view and/or target selection. It can be two-way, four-way, or eight-way, and its current position can be described by a cardinal coordinate system. A hat switch can be in exactly one position at any given time. + +## -see-also + +* [Windows.Gaming.Input.GameControllerSwitchKind](gamecontrollerswitchkind.md) + +## -examples diff --git a/windows.gaming.input/flightstick_headset.md b/windows.gaming.input/flightstick_headset.md new file mode 100644 index 0000000000..8de733cac3 --- /dev/null +++ b/windows.gaming.input/flightstick_headset.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Gaming.Input.FlightStick.Headset +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.FlightStick.Headset + +## -description + +The audio headset attached to the flight stick. + +## -property-value + +The audio headset attached to the flight stick. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) + +## -examples diff --git a/windows.gaming.input/flightstick_headsetconnected.md b/windows.gaming.input/flightstick_headsetconnected.md new file mode 100644 index 0000000000..004929db6b --- /dev/null +++ b/windows.gaming.input/flightstick_headsetconnected.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Gaming.Input.FlightStick.HeadsetConnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.FlightStick.HeadsetConnected + +## -description + +Signals when a headset is attached to the flight stick. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) + +## -examples diff --git a/windows.gaming.input/flightstick_headsetdisconnected.md b/windows.gaming.input/flightstick_headsetdisconnected.md new file mode 100644 index 0000000000..d096988954 --- /dev/null +++ b/windows.gaming.input/flightstick_headsetdisconnected.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Gaming.Input.FlightStick.HeadsetDisconnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.FlightStick.HeadsetDisconnected + +## -description + +Signals when a headset is disconnected from the flight stick. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) + +## -examples diff --git a/windows.gaming.input/flightstick_iswireless.md b/windows.gaming.input/flightstick_iswireless.md new file mode 100644 index 0000000000..65031c654d --- /dev/null +++ b/windows.gaming.input/flightstick_iswireless.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.FlightStick.IsWireless +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.FlightStick.IsWireless + +## -description + +Gets a value that indicates the wireless state of the flight stick. + +## -property-value + +True if the flight stick is wireless. Otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/flightstick_trygetbatteryreport_340082979.md b/windows.gaming.input/flightstick_trygetbatteryreport_340082979.md new file mode 100644 index 0000000000..554384911f --- /dev/null +++ b/windows.gaming.input/flightstick_trygetbatteryreport_340082979.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Gaming.Input.FlightStick.TryGetBatteryReport +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.FlightStick.TryGetBatteryReport + +## -description + +Gets information about the flight stick's current battery state. + +## -returns + +Information about the flight stick's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples diff --git a/windows.gaming.input/flightstick_user.md b/windows.gaming.input/flightstick_user.md new file mode 100644 index 0000000000..a6b8018b09 --- /dev/null +++ b/windows.gaming.input/flightstick_user.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Gaming.Input.FlightStick.User +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.FlightStick.User + +## -description + +The user associated with the flight stick. + +## -property-value + +The user associated with the flight stick. + +## -remarks + +## -see-also + +[Windows.System.User](../windows.system/user.md) + +## -examples diff --git a/windows.gaming.input/flightstick_userchanged.md b/windows.gaming.input/flightstick_userchanged.md new file mode 100644 index 0000000000..6745b77b86 --- /dev/null +++ b/windows.gaming.input/flightstick_userchanged.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Gaming.Input.FlightStick.UserChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.FlightStick.UserChanged + +## -description + +Signals when the user associated with the flight stick has changed. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.System.UserChangedEventArgs](../windows.system/userchangedeventargs.md) + +## -examples diff --git a/windows.gaming.input/flightstickbuttons.md b/windows.gaming.input/flightstickbuttons.md new file mode 100644 index 0000000000..fdc8fcfc08 --- /dev/null +++ b/windows.gaming.input/flightstickbuttons.md @@ -0,0 +1,40 @@ +--- +-api-id: T:Windows.Gaming.Input.FlightStickButtons +-api-type: winrt enumeration +--- + + + +# Windows.Gaming.Input.FlightStickButtons + +## -description + +Specifies the type of flight stick button. + +## -enum-fields + +## -field None:0 + +No button. + +## -field FireSecondary:2 + +The secondary fire button. + +## -field FirePrimary:1 + +The primary fire button. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.FlightStick](flightstick.md) + +## -examples diff --git a/windows.gaming.input/flightstickreading.md b/windows.gaming.input/flightstickreading.md new file mode 100644 index 0000000000..f8363daeca --- /dev/null +++ b/windows.gaming.input/flightstickreading.md @@ -0,0 +1,62 @@ +--- +-api-id: T:Windows.Gaming.Input.FlightStickReading +-api-type: winrt structure +--- + + + +# Windows.Gaming.Input.FlightStickReading + +## -description + +The current state of the flight stick. + +## -fields + +## -field Buttons + +The button currently being pressed. + +## -field HatSwitch + +The position of the hat switch. + +## -field Pitch + +The amount of pitch (rotation around the X-axis; forward and backward movement on the flight stick). + +## -field Roll + +The amount of roll (rotation around the Z-axis; left and right movement on the flight stick). + +## -field Throttle + +The position of the throttle. + +## -field Timestamp + +The time that the reading was reported from the hardware. + +## -field Yaw + +The amount of yaw (rotation around the Y-axis; usually read from twisting the joystick or from some other input). + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.FlightStickButtons](flightstickbuttons.md) +* [Windows.Gaming.Input.GameControllerSwitchPosition](gamecontrollerswitchposition.md) +* [Windows.Gaming.Input.FlightStick](flightstick.md) + +## -examples diff --git a/windows.gaming.input/gamecontrollerswitchkind.md b/windows.gaming.input/gamecontrollerswitchkind.md new file mode 100644 index 0000000000..3c4d6ff820 --- /dev/null +++ b/windows.gaming.input/gamecontrollerswitchkind.md @@ -0,0 +1,40 @@ +--- +-api-id: T:Windows.Gaming.Input.GameControllerSwitchKind +-api-type: winrt enumeration +--- + + + +# Windows.Gaming.Input.GameControllerSwitchKind + +## -description + +The type of switch on the game controller. + +## -enum-fields + +## -field TwoWay:0 + +A two-way switch, which has **Up**, **Down**, and **Center** positions. + +## -field FourWay:1 + +A four-way switch, which has **Up**, **Down**, **Left**, **Right**, and **Center** positions. + +## -field EightWay:2 + +An eight-way switch, which has all positions in the **GameControllerSwitchPosition** enumeration. + +## -remarks + +## -see-also + +* [GameControllerSwitchPosition](gamecontrollerswitchposition.md) + +## -examples diff --git a/windows.gaming.input/gamecontrollerswitchposition.md b/windows.gaming.input/gamecontrollerswitchposition.md new file mode 100644 index 0000000000..6add4f44b3 --- /dev/null +++ b/windows.gaming.input/gamecontrollerswitchposition.md @@ -0,0 +1,68 @@ +--- +-api-id: T:Windows.Gaming.Input.GameControllerSwitchPosition +-api-type: winrt enumeration +--- + + + +# Windows.Gaming.Input.GameControllerSwitchPosition + +## -description + +The position of the game controller's switch. + +## -enum-fields + +## -field UpRight:2 + +The top-right position. + +## -field UpLeft:8 + +The top-left position. + +## -field Up:1 + +The top position. + +## -field Right:3 + +The right position. + +## -field Left:7 + +The left position. + +## -field DownRight:4 + +The bottom right position. + +## -field DownLeft:6 + +The bottom left position. + +## -field Down:5 + +The bottom position. + +## -field Center:0 + +The center position. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/gamepad.md b/windows.gaming.input/gamepad.md index 6aca54b411..fbb4c94423 100644 --- a/windows.gaming.input/gamepad.md +++ b/windows.gaming.input/gamepad.md @@ -10,18 +10,16 @@ public class Gamepad : Windows.Gaming.Input.IGameController, Windows.Gaming.Inpu # Windows.Gaming.Input.Gamepad ## -description -Represents a game controller. +Represents a gamepad. ## -remarks -Instances of the [Gamepad](gamepad.md) class cannot be created directly, instead instances of the [Gamepad](gamepad.md) class are retrieved through the [Gamepads](gamepad_gamepads.md) property listing all connected gamepads or through the [GamepadAdded](gamepad_gamepadadded.md) event. +Instances of the **Gamepad** class cannot be created directly; instead, instances of the **Gamepad** class are retrieved through the [Gamepad.Gamepads](gamepad_gamepads.md) property listing all connected gamepads or through the [Gamepad.GamepadAdded](gamepad_gamepadadded.md) event. -### Supported Device -s +### Supported Devices - **Gamepad** - supports any Xbox One certified or Xbox 360 compatible gamepad. +**Gamepad** supports any Xbox One certified or Xbox 360 compatible gamepad. ## -examples ## -see-also -[IGameController](igamecontroller.md) \ No newline at end of file +* [Windows.Gaming.Input.IGameController](igamecontroller.md) \ No newline at end of file diff --git a/windows.gaming.input/gamepad_fromgamecontroller_421915006.md b/windows.gaming.input/gamepad_fromgamecontroller_421915006.md new file mode 100644 index 0000000000..b6202b7dae --- /dev/null +++ b/windows.gaming.input/gamepad_fromgamecontroller_421915006.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Gaming.Input.Gamepad.FromGameController(Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Gamepad.FromGameController + +## -description + +Returns the given game controller as a gamepad. + +## -params + +## -param gameController + +The game controller to be returned as a gamepad. + +## -returns + +The gamepad that was returned from the given game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) + +## -examples diff --git a/windows.gaming.input/gamepad_gamepadadded.md b/windows.gaming.input/gamepad_gamepadadded.md index a371fa7f4f..bdc7807914 100644 --- a/windows.gaming.input/gamepad_gamepadadded.md +++ b/windows.gaming.input/gamepad_gamepadadded.md @@ -13,7 +13,7 @@ static public event Windows.Foundation.EventHandler GamepadAdded + +# Windows.Gaming.Input.Gamepad.TryGetBatteryReport + +## -description + +Gets information about the gamepad's current battery state. + +## -returns + +Information about the arcade stick's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples diff --git a/windows.gaming.input/gamepad_user.md b/windows.gaming.input/gamepad_user.md index 7519e49b03..87c01b1a56 100644 --- a/windows.gaming.input/gamepad_user.md +++ b/windows.gaming.input/gamepad_user.md @@ -20,3 +20,5 @@ The user associated with the gamepad. ## -examples ## -see-also + +* [Windows.System.User](../windows.system/user.md) \ No newline at end of file diff --git a/windows.gaming.input/gamepad_userchanged.md b/windows.gaming.input/gamepad_userchanged.md index 264c24f314..48dc990618 100644 --- a/windows.gaming.input/gamepad_userchanged.md +++ b/windows.gaming.input/gamepad_userchanged.md @@ -17,3 +17,6 @@ Signals when the user associated with the gamepad has changed. ## -examples ## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.System.UserChangedEventArgs](../windows.system/userchangedeventargs.md) \ No newline at end of file diff --git a/windows.gaming.input/gamepad_vibration.md b/windows.gaming.input/gamepad_vibration.md index a95176f6bd..2473778e7e 100644 --- a/windows.gaming.input/gamepad_vibration.md +++ b/windows.gaming.input/gamepad_vibration.md @@ -20,3 +20,5 @@ Describes the gamepad motor speed. ## -examples ## -see-also + +* [Windows.Gaming.Input.GamepadVibration](gamepadvibration.md) \ No newline at end of file diff --git a/windows.gaming.input/gamepadreading.md b/windows.gaming.input/gamepadreading.md index 6b6491bafb..3f36e55ec3 100644 --- a/windows.gaming.input/gamepadreading.md +++ b/windows.gaming.input/gamepadreading.md @@ -10,16 +10,16 @@ public struct GamepadReading # GamepadReading ## -description -Represents the current state of the controller. +Represents the current state of the gamepad. ## -struct-fields ### -field Timestamp -Time when the state was retrieved from the controller. +Time when the state was retrieved from the gamepad. ### -field Buttons -The state of the controller buttons. +The state of the gamepad's buttons. ### -field LeftTrigger @@ -35,11 +35,11 @@ The position of the left thumbstick on the X-axis. The value is between -1.0 and ### -field LeftThumbstickY -The position of the left thumbstick on the Y-axis.The value is between -1.0 and 1.0. +The position of the left thumbstick on the Y-axis. The value is between -1.0 and 1.0. ### -field RightThumbstickX -The position of the right thumbstick on the X-axis.The value is between -1.0 and 1.0. +The position of the right thumbstick on the X-axis. The value is between -1.0 and 1.0. ### -field RightThumbstickY diff --git a/windows.gaming.input/gamepadvibration.md b/windows.gaming.input/gamepadvibration.md index 1570a19b9d..2dfff77f2a 100644 --- a/windows.gaming.input/gamepadvibration.md +++ b/windows.gaming.input/gamepadvibration.md @@ -27,7 +27,7 @@ The left trigger vibration level. Valid values are between 0.0 and 1.0, where 0. ### -field RightTrigger -The right trigger vibration level, Valid values are between 0.0 and 1.0, where 0.0 signifies no motor use and 1.0 signifies max vibration. +The right trigger vibration level. Valid values are between 0.0 and 1.0, where 0.0 signifies no motor use and 1.0 signifies max vibration. ## -remarks diff --git a/windows.gaming.input/headset.md b/windows.gaming.input/headset.md index 9fa2905ce7..baf409f191 100644 --- a/windows.gaming.input/headset.md +++ b/windows.gaming.input/headset.md @@ -13,7 +13,7 @@ public class Headset : Windows.Gaming.Input.IHeadset Contains information about an audio headset attached to a gamepad. ## -remarks -Instances of the [Headset](headset.md) class cannot be created directly, instead instances of the [Headset](headset.md) class are retrieved through the [Gamepad.Headset](gamepad_headset.md) property or the [Gamepad.HeadsetConnected](gamepad_headsetconnected.md) event. +Instances of the [Headset](headset.md) class cannot be created directly; instead, instances of the [Headset](headset.md) class are retrieved through the [Gamepad.Headset](gamepad_headset.md) property or the [Gamepad.HeadsetConnected](gamepad_headsetconnected.md) event. ## -examples diff --git a/windows.gaming.input/headset_trygetbatteryreport_340082979.md b/windows.gaming.input/headset_trygetbatteryreport_340082979.md new file mode 100644 index 0000000000..8cbf4c6479 --- /dev/null +++ b/windows.gaming.input/headset_trygetbatteryreport_340082979.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Gaming.Input.Headset.TryGetBatteryReport +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.Headset.TryGetBatteryReport + +## -description + +Gets information about the headset's current battery state. + +## -returns + +Information about the headset's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples diff --git a/windows.gaming.input/igamecontroller.md b/windows.gaming.input/igamecontroller.md index 482b0b0d71..7ca4bdd238 100644 --- a/windows.gaming.input/igamecontroller.md +++ b/windows.gaming.input/igamecontroller.md @@ -10,7 +10,7 @@ public interface IGameController : # Windows.Gaming.Input.IGameController ## -description -The core interface required to be implemented by all controller devices, regardless of their actual type (i.e. gamepads, steering wheels, flight sticks, etc). This interface exists mainly to support extensibility for game controllers, which allows OEMs to publish WinRT classes that provide rich access to their device's features, while integrating into the underlying game controller device enumeration framework. +The core interface required to be implemented by all controller devices, regardless of their actual type (gamepad, racing wheel, flight stick, and so on). This interface exists mainly to support extensibility for game controllers, which allows OEMs (Original Equipment Manufacturers) to publish WinRT (Windows Runtime) classes that provide rich access to their device's features, while integrating into the underlying game controller device enumeration framework. ## -remarks diff --git a/windows.gaming.input/igamecontroller_headset.md b/windows.gaming.input/igamecontroller_headset.md index a975ae11b7..aa97ace62d 100644 --- a/windows.gaming.input/igamecontroller_headset.md +++ b/windows.gaming.input/igamecontroller_headset.md @@ -20,3 +20,5 @@ The audio headset attached to the controller. ## -examples ## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/igamecontroller_headsetconnected.md b/windows.gaming.input/igamecontroller_headsetconnected.md index b4493aa0b3..dfb1dcaf5e 100644 --- a/windows.gaming.input/igamecontroller_headsetconnected.md +++ b/windows.gaming.input/igamecontroller_headsetconnected.md @@ -17,3 +17,5 @@ Signals when a headset is attached to the controller. ## -examples ## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/igamecontroller_headsetdisconnected.md b/windows.gaming.input/igamecontroller_headsetdisconnected.md index 1395f57056..099ac74f56 100644 --- a/windows.gaming.input/igamecontroller_headsetdisconnected.md +++ b/windows.gaming.input/igamecontroller_headsetdisconnected.md @@ -17,3 +17,5 @@ Signals when a headset is disconnected from the controller. ## -examples ## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/igamecontroller_user.md b/windows.gaming.input/igamecontroller_user.md index f620183ecc..9c2a7758e4 100644 --- a/windows.gaming.input/igamecontroller_user.md +++ b/windows.gaming.input/igamecontroller_user.md @@ -20,3 +20,5 @@ The user associated with the controller. ## -examples ## -see-also + +* [Windows.System.User](../windows.system/user.md) \ No newline at end of file diff --git a/windows.gaming.input/igamecontroller_userchanged.md b/windows.gaming.input/igamecontroller_userchanged.md index aee53207ac..b6a729d2da 100644 --- a/windows.gaming.input/igamecontroller_userchanged.md +++ b/windows.gaming.input/igamecontroller_userchanged.md @@ -17,3 +17,5 @@ Signals when the user associated with the controller has changed. ## -examples ## -see-also + +* [Windows.System.UserChangedEventArgs](../windows.system/userchangedeventargs.md) \ No newline at end of file diff --git a/windows.gaming.input/igamecontrollerbatteryinfo.md b/windows.gaming.input/igamecontrollerbatteryinfo.md new file mode 100644 index 0000000000..32421d1ed7 --- /dev/null +++ b/windows.gaming.input/igamecontrollerbatteryinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Gaming.Input.IGameControllerBatteryInfo +-api-type: winrt interface +--- + + + +# Windows.Gaming.Input.IGameControllerBatteryInfo + +## -description + +Interface that allows game controller (or headset) classes to query for information about the current battery state, regardless of their actual type (gamepad, racing wheel, flight stick, and so on). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/igamecontrollerbatteryinfo_trygetbatteryreport_340082979.md b/windows.gaming.input/igamecontrollerbatteryinfo_trygetbatteryreport_340082979.md new file mode 100644 index 0000000000..17a8541a9e --- /dev/null +++ b/windows.gaming.input/igamecontrollerbatteryinfo_trygetbatteryreport_340082979.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Gaming.Input.IGameControllerBatteryInfo.TryGetBatteryReport +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.IGameControllerBatteryInfo.TryGetBatteryReport + +## -description + +Gets information about the game controller's current battery state. + +## -returns + +Information about the game controller's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples diff --git a/windows.gaming.input/racingwheel.md b/windows.gaming.input/racingwheel.md index d2fa685af6..95002ac9cf 100644 --- a/windows.gaming.input/racingwheel.md +++ b/windows.gaming.input/racingwheel.md @@ -13,11 +13,9 @@ public class RacingWheel : Windows.Gaming.Input.IGameController, Windows.Gaming. Represents a racing wheel. ## -remarks -### Supported Device -s +### Supported Devices - **RacingWheel** - supports any Xbox One certified or Xbox 360 compatible racing wheel without force feedback support. +**RacingWheel** supports any Xbox One-certified or Xbox 360-compatible racing wheel without force feedback support. Force feedback is supported on the following device models: @@ -38,7 +36,7 @@ Force feedback is supported on the following device models:
SensorDescription
HID-mode for the Xbox One
-Note that to use the devices listed above you should include a HID capability declaration in your app's appxmanifest: +Note that to use the devices listed above you should include a HID (Human Interface Device) capability declaration in your app's appxmanifest: ```xml diff --git a/windows.gaming.input/racingwheel_fromgamecontroller_421915006.md b/windows.gaming.input/racingwheel_fromgamecontroller_421915006.md new file mode 100644 index 0000000000..88c000010c --- /dev/null +++ b/windows.gaming.input/racingwheel_fromgamecontroller_421915006.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Gaming.Input.RacingWheel.FromGameController(Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RacingWheel.FromGameController + +## -description + +Returns the given game controller as a racing wheel. + +## -params + +## -param gameController + +The game controller to be returned as a racing wheel. + +## -returns + +The racing wheel that was returned from the given game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) + +## -examples diff --git a/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md b/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md index dd7b348966..cc7bdd2b95 100644 --- a/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md +++ b/windows.gaming.input/racingwheel_getbuttonlabel_39927013.md @@ -14,13 +14,16 @@ Retrieves the button label for the specified button. ## -parameters ### -param button -The button to retrieve the label for. +The button for which to retrieve the label. ## -returns -Returns the button 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. +Returns the button 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 ## -examples ## -see-also + +* [Windows.Gaming.Input.GameControllerButtonLabel](gamecontrollerbuttonlabel.md) +* [Windows.Gaming.Input.RacingWheelButtons](racingwheelbuttons.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md b/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md index 2baba37bdc..a97c83ff16 100644 --- a/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md +++ b/windows.gaming.input/racingwheel_getcurrentreading_1416488181.md @@ -10,13 +10,15 @@ public Windows.Gaming.Input.RacingWheelReading GetCurrentReading() # Windows.Gaming.Input.RacingWheel.GetCurrentReading ## -description -Gets a snapshot of the racing wheel state. +Gets a snapshot of the racing wheel's state. ## -returns -Returns a [RacingWheelReading](racingwheelreading.md) containing the current state of the racing wheel. +The current state of the racing wheel. ## -remarks ## -examples ## -see-also + +* [Windows.Gaming.Input.RacingWheelReading](racingwheelreading.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_headset.md b/windows.gaming.input/racingwheel_headset.md index 69935e38d1..2f176df89e 100644 --- a/windows.gaming.input/racingwheel_headset.md +++ b/windows.gaming.input/racingwheel_headset.md @@ -20,3 +20,5 @@ The audio headset attached to the racing wheel. ## -examples ## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_headsetconnected.md b/windows.gaming.input/racingwheel_headsetconnected.md index f650459f30..2a29b73773 100644 --- a/windows.gaming.input/racingwheel_headsetconnected.md +++ b/windows.gaming.input/racingwheel_headsetconnected.md @@ -17,3 +17,6 @@ Signals when a headset is attached to the racing wheel. ## -examples ## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_headsetdisconnected.md b/windows.gaming.input/racingwheel_headsetdisconnected.md index f5754161ed..268f3c223a 100644 --- a/windows.gaming.input/racingwheel_headsetdisconnected.md +++ b/windows.gaming.input/racingwheel_headsetdisconnected.md @@ -17,3 +17,6 @@ Signals when a headset is disconnected from the racing wheel. ## -examples ## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_racingwheeladded.md b/windows.gaming.input/racingwheel_racingwheeladded.md index 89da5bd2b3..033845baca 100644 --- a/windows.gaming.input/racingwheel_racingwheeladded.md +++ b/windows.gaming.input/racingwheel_racingwheeladded.md @@ -13,7 +13,7 @@ static public event Windows.Foundation.EventHandler RacingWheelAdded + +# Windows.Gaming.Input.RacingWheel.TryGetBatteryReport + +## -description + +Gets information about the racing wheel's current battery state. + +## -returns + +Information about the racing wheel's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples diff --git a/windows.gaming.input/racingwheel_user.md b/windows.gaming.input/racingwheel_user.md index 0b72ac4106..089d5476d2 100644 --- a/windows.gaming.input/racingwheel_user.md +++ b/windows.gaming.input/racingwheel_user.md @@ -20,3 +20,5 @@ The user associated with the racing wheel. ## -examples ## -see-also + +* [Windows.System.User](../windows.system/user.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_userchanged.md b/windows.gaming.input/racingwheel_userchanged.md index 46fe2adcf1..240828b9ec 100644 --- a/windows.gaming.input/racingwheel_userchanged.md +++ b/windows.gaming.input/racingwheel_userchanged.md @@ -17,3 +17,6 @@ Signals when the user associated with the racing wheel has changed. ## -examples ## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.System.UserChangedEventArgs](../windows.system/userchangedeventargs.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheel_wheelmotor.md b/windows.gaming.input/racingwheel_wheelmotor.md index e41f7f182a..8042b50df7 100644 --- a/windows.gaming.input/racingwheel_wheelmotor.md +++ b/windows.gaming.input/racingwheel_wheelmotor.md @@ -13,11 +13,13 @@ public Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor WheelMotor { get; } The force feedback motor for the racing wheel. ## -property-value -The force feedback motor for the racing wheel. If the controller does not support force feedback, this property will be null. +The force feedback motor for the racing wheel. If the controller does not support force feedback, this property will be **null**. ## -remarks -Force feedback is only supported for selected HID controllers. Xbox 360 and Xbox One racing wheels do not support force feedback in Windows 10 at this time. +Force feedback is only supported for selected HID (Human Interface Device) controllers. Xbox 360 and Xbox One racing wheels do not support force feedback in Windows 10 at this time. ## -examples ## -see-also + +* [Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor](../windows.gaming.input.forcefeedback/forcefeedbackmotor.md) \ No newline at end of file diff --git a/windows.gaming.input/racingwheelbuttons.md b/windows.gaming.input/racingwheelbuttons.md index 5aa2782975..5dd76eb7db 100644 --- a/windows.gaming.input/racingwheelbuttons.md +++ b/windows.gaming.input/racingwheelbuttons.md @@ -84,7 +84,7 @@ Button 16. ## -remarks -The assignment of buttons to the Button# values may change from controller to controller. They are intended to be used via a button mapping UI to assign functionality based on the user’s choices. +The assignment of buttons to the **Button#** values may change from controller to controller. They are intended to be used via a button mapping UI to assign functionality based on the user’s choices. ## -examples diff --git a/windows.gaming.input/rawgamecontroller.md b/windows.gaming.input/rawgamecontroller.md new file mode 100644 index 0000000000..d84e1ddf32 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.Gaming.Input.RawGameController +-api-type: winrt class +--- + + + +# Windows.Gaming.Input.RawGameController + +## -description + +Represents any type of game controller. + +## -remarks + +Instances of the **RawGameController** class cannot be created directly; instead, instances of the class are retrieved through the [RawGameController.RawGameControllers](rawgamecontroller_rawgamecontrollers.md) property listing all connected game controllers or through the [RawGameController.RawGameControllerAdded](rawgamecontroller_rawgamecontrolleradded.md) event. + +All inputs available on a **RawGameController** are exposed as simple arrays of unnamed buttons, switches, and axes. Using this class, you can allow customers to create custom input mappings no matter what type of controller they're using. + +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-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.IGameControllerBatteryInfo](igamecontrollerbatteryinfo.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_axiscount.md b/windows.gaming.input/rawgamecontroller_axiscount.md new file mode 100644 index 0000000000..1c95bf7f01 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_axiscount.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.AxisCount +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.AxisCount + +## -description + +The number of axes on the raw game controller. + +## -property-value + +The number of axes on the raw game controller. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_buttoncount.md b/windows.gaming.input/rawgamecontroller_buttoncount.md new file mode 100644 index 0000000000..90b336ea80 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_buttoncount.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.ButtonCount +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.ButtonCount + +## -description + +The number of buttons on the raw game controller. + +## -property-value + +The number of buttons on the raw game controller. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_forcefeedbackmotors.md b/windows.gaming.input/rawgamecontroller_forcefeedbackmotors.md new file mode 100644 index 0000000000..0a8ea54a1a --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_forcefeedbackmotors.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.ForceFeedbackMotors +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.ForceFeedbackMotors + +## -description + +The list of force feedback motors in the raw game controller. + +## -property-value + +The list of force feedback motors in the raw game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.ForceFeedback.ForceFeedbackMotor](../windows.gaming.input.forcefeedback/forcefeedbackmotor.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md b/windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md new file mode 100644 index 0000000000..65c9d28cfb --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_fromgamecontroller_421915006.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Gaming.Input.RawGameController.FromGameController(Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RawGameController.FromGameController + +## -description + +Returns the given game controller as a raw game controller. + +## -params + +## -param gameController + +The game controller to be returned as a raw game controller. + +## -returns + +The raw game controller that was returned from the given game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_getbuttonlabel_214310582.md b/windows.gaming.input/rawgamecontroller_getbuttonlabel_214310582.md new file mode 100644 index 0000000000..689752c5e6 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_getbuttonlabel_214310582.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.Gaming.Input.RawGameController.GetButtonLabel(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RawGameController.GetButtonLabel + +## -description + +Retrieves the button label for the specified button. + +## -params + +## -param buttonIndex + +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. + +## -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. + +## -see-also + +* [Windows.Gaming.Input.GameControllerButtonLabel](gamecontrollerbuttonlabel.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_getcurrentreading_123740519.md b/windows.gaming.input/rawgamecontroller_getcurrentreading_123740519.md new file mode 100644 index 0000000000..df1dc3ec7b --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_getcurrentreading_123740519.md @@ -0,0 +1,44 @@ +--- +-api-id: M:Windows.Gaming.Input.RawGameController.GetCurrentReading(System.Boolean[],Windows.Gaming.Input.GameControllerSwitchPosition[],System.Double[]) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RawGameController.GetCurrentReading + +## -description + +Gets a snapshot of the raw game controller's state. + +## -params + +## -param buttonArray + +The button array for the raw game controller to be populated with the current state of each button. + +## -param switchArray + +The switch array for the raw game controller to be populated with the current state of each switch. + +## -param axisArray + +The axis array for the raw game controller to be populated with the current state of each axis. + +## -returns + +The timestamp of when the reading was retrieved from the raw game controller. + +## -remarks + +Unlike the **GetCurrentReading** member functions of other classes, such as [ArcadeStick.GetCurrentReading](arcadestick_getcurrentreading.md), **RawGameController.GetCurrentReading** takes three parameters: the button, switch, and axis arrays of the raw game controller. You create these arrays yourself, with the sizes [RawGameController.ButtonCount](rawgamecontroller_buttoncount.md), [RawGameController.SwitchCount](rawgamecontroller_switchcount.md), and [RawGameController.AxisCount](rawgamecontroller_axiscount.md), respectively. + +**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-also + +* [Windows.Gaming.Input.GameControllerSwitchPosition](gamecontrollerswitchposition.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_getswitchkind_1074485771.md b/windows.gaming.input/rawgamecontroller_getswitchkind_1074485771.md new file mode 100644 index 0000000000..818684dfff --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_getswitchkind_1074485771.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Gaming.Input.RawGameController.GetSwitchKind(System.Int32) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RawGameController.GetSwitchKind + +## -description + +Gets the type of the specified switch on the raw game controller. + +## -params + +## -param switchIndex + +The index in the raw game controller's switch array of the switch whose type you are querying. + +## -returns + +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. + +## -see-also + +* [Windows.Gaming.Input.GameControllerSwitchKind](gamecontrollerswitchkind.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_hardwareproductid.md b/windows.gaming.input/rawgamecontroller_hardwareproductid.md new file mode 100644 index 0000000000..397fae3c97 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_hardwareproductid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.HardwareProductId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.HardwareProductId + +## -description + +The hardware product ID of the raw game controller. + +## -property-value + +The hardware product ID of the raw game controller. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_hardwarevendorid.md b/windows.gaming.input/rawgamecontroller_hardwarevendorid.md new file mode 100644 index 0000000000..a29d321c98 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_hardwarevendorid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.HardwareVendorId +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.HardwareVendorId + +## -description + +The hardware vendor ID of the raw game controller. + +## -property-value + +The hardware vendor ID of the raw game controller. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_headset.md b/windows.gaming.input/rawgamecontroller_headset.md new file mode 100644 index 0000000000..bb8c1e4cbd --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_headset.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.Headset +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.Headset + +## -description + +The audio headset attached to the raw game controller. + +## -property-value + +The audio headset attached to the raw game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_headsetconnected.md b/windows.gaming.input/rawgamecontroller_headsetconnected.md new file mode 100644 index 0000000000..b973d04fbe --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_headsetconnected.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Gaming.Input.RawGameController.HeadsetConnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RawGameController.HeadsetConnected + +## -description + +Signals when a headset is attached to the raw game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_headsetdisconnected.md b/windows.gaming.input/rawgamecontroller_headsetdisconnected.md new file mode 100644 index 0000000000..3d44f2688d --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_headsetdisconnected.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Gaming.Input.RawGameController.HeadsetDisconnected +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RawGameController.HeadsetDisconnected + +## -description + +Signals when a headset is disconnected from the raw game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_iswireless.md b/windows.gaming.input/rawgamecontroller_iswireless.md new file mode 100644 index 0000000000..bc2d1c5f36 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_iswireless.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.IsWireless +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.IsWireless + +## -description + +Gets a value that indicates the wireless state of the raw game controller. + +## -property-value + +True if the raw game controller is wireless. Otherwise, false. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_rawgamecontrolleradded.md b/windows.gaming.input/rawgamecontroller_rawgamecontrolleradded.md new file mode 100644 index 0000000000..2b63d013d7 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_rawgamecontrolleradded.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.Gaming.Input.RawGameController.RawGameControllerAdded +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RawGameController.RawGameControllerAdded + +## -description + +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). + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_rawgamecontrollerremoved.md b/windows.gaming.input/rawgamecontroller_rawgamecontrollerremoved.md new file mode 100644 index 0000000000..135327d6df --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_rawgamecontrollerremoved.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Gaming.Input.RawGameController.RawGameControllerRemoved +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RawGameController.RawGameControllerRemoved + +## -description + +Signals when a raw game controller is disconnected. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_rawgamecontrollers.md b/windows.gaming.input/rawgamecontroller_rawgamecontrollers.md new file mode 100644 index 0000000000..92a9c8ec35 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_rawgamecontrollers.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.RawGameControllers +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.RawGameControllers + +## -description + +The list of all connected raw game controllers. + +## -property-value + +The list of all connected raw game controllers. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_switchcount.md b/windows.gaming.input/rawgamecontroller_switchcount.md new file mode 100644 index 0000000000..2cb091f78f --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_switchcount.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.SwitchCount +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.SwitchCount + +## -description + +The number of switches on the raw game controller. + +## -property-value + +The number of switches on the raw game controller. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_trygetbatteryreport_340082979.md b/windows.gaming.input/rawgamecontroller_trygetbatteryreport_340082979.md new file mode 100644 index 0000000000..7c2acfe120 --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_trygetbatteryreport_340082979.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Gaming.Input.RawGameController.TryGetBatteryReport +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.RawGameController.TryGetBatteryReport + +## -description + +Gets information about the raw game controller's current battery state. + +## -returns + +Information about the raw game controller's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_user.md b/windows.gaming.input/rawgamecontroller_user.md new file mode 100644 index 0000000000..bbaf5b14ee --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_user.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Gaming.Input.RawGameController.User +-api-type: winrt property +--- + + + +# Windows.Gaming.Input.RawGameController.User + +## -description + +The user associated with the raw game controller. + +## -property-value + +The user associated with the raw game controller. + +## -remarks + +## -see-also + +* [Windows.System.User](../windows.system/user.md) + +## -examples diff --git a/windows.gaming.input/rawgamecontroller_userchanged.md b/windows.gaming.input/rawgamecontroller_userchanged.md new file mode 100644 index 0000000000..ff1fc8248f --- /dev/null +++ b/windows.gaming.input/rawgamecontroller_userchanged.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Gaming.Input.RawGameController.UserChanged +-api-type: winrt event +--- + + + +# Windows.Gaming.Input.RawGameController.UserChanged + +## -description + +Signals when the user associated with the raw game controller has changed. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.System.UserChangedEventArgs](../windows.system/userchangedeventargs.md) + +## -examples diff --git a/windows.gaming.input/uinavigationcontroller.md b/windows.gaming.input/uinavigationcontroller.md index 8d86112025..ddd060b4eb 100644 --- a/windows.gaming.input/uinavigationcontroller.md +++ b/windows.gaming.input/uinavigationcontroller.md @@ -10,11 +10,11 @@ public class UINavigationController : Windows.Gaming.Input.IGameController, Wind # Windows.Gaming.Input.UINavigationController ## -description -Represents buttons on a controller of any type that can be used for UI navigation. Most Gamepads, ArcadeSticks, and RacingWheels can also be accessed as a UINavigationController. It is recommended that games use the controller specific class during gameplay and the UINavigationController class for UI menus. +Represents a controller of any type that can be used for UI navigation. Most gamepads, arcade sticks, and racing wheels can also be accessed as a **UINavigationController**. It is recommended that games use the controller-specific class during gameplay and the **UINavigationController** class for UI menus. ## -remarks ## -examples ## -see-also -[IGameController](igamecontroller.md) \ No newline at end of file +[Windows.Gaming.Input.IGameController](igamecontroller.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_fromgamecontroller_421915006.md b/windows.gaming.input/uinavigationcontroller_fromgamecontroller_421915006.md new file mode 100644 index 0000000000..e0c528cc3a --- /dev/null +++ b/windows.gaming.input/uinavigationcontroller_fromgamecontroller_421915006.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Gaming.Input.UINavigationController.FromGameController(Windows.Gaming.Input.IGameController) +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.UINavigationController.FromGameController + +## -description + +Returns the given game controller as a UI navigation controller. + +## -params + +## -param gameController + +The game controller to be returned as a UI navigation controller. + +## -returns + +The UI navigation controller that was returned from the given game controller. + +## -remarks + +## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) + +## -examples diff --git a/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md b/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md index 3603fb8c9e..13c74a3ee0 100644 --- a/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md +++ b/windows.gaming.input/uinavigationcontroller_getcurrentreading_1416488181.md @@ -10,13 +10,15 @@ public Windows.Gaming.Input.UINavigationReading GetCurrentReading() # Windows.Gaming.Input.UINavigationController.GetCurrentReading ## -description -Gets a snapshot of the UI navigation controller state. +Gets a snapshot of the UI navigation controller's state. ## -returns -Returns a [UINavigationReading](uinavigationreading.md) containing the state of the UI navigation controller. +The state of the UI navigation controller. ## -remarks ## -examples ## -see-also + +* [Windows.Gaming.Input.UINavigationReading](uinavigationreading.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md b/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md index a7387882f1..70ed24ab1d 100644 --- a/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md +++ b/windows.gaming.input/uinavigationcontroller_getoptionalbuttonlabel_1634356858.md @@ -14,7 +14,7 @@ Retrieves a label for an optional UI navigation button. ## -parameters ### -param button -Enumeration indicating which UI navigation button to retrieve the label for. +Enumeration indicating the UI navigation button whose label to retrieve. ## -returns The label of the specified button. @@ -24,3 +24,6 @@ The label of the specified button. ## -examples ## -see-also + +* [Windows.Gaming.Input.GameControllerButtonLabel](gamecontrollerbuttonlabel.md) +* [Windows.Gaming.Input.OptionalUINavigationButtons](optionaluinavigationbuttons.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md b/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md index 956cb0cfdc..1ddc65aebb 100644 --- a/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md +++ b/windows.gaming.input/uinavigationcontroller_getrequiredbuttonlabel_473734303.md @@ -14,7 +14,7 @@ Retrieves a label for a required UI navigation button. ## -parameters ### -param button -Enumeration indicating which UI navigation button to retrieve the label for. +Enumeration indicating the UI navigation button whose label to retrieve. ## -returns The label of the specified button. @@ -24,3 +24,6 @@ The label of the specified button. ## -examples ## -see-also + +* [Windows.Gaming.Input.GameControllerButtonLabel](gamecontrollerbuttonlabel.md) +* [Windows.Gaming.Input.RequiredUINavigationButtons](requireduinavigationbuttons.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_headset.md b/windows.gaming.input/uinavigationcontroller_headset.md index 55133aec53..14d07fff01 100644 --- a/windows.gaming.input/uinavigationcontroller_headset.md +++ b/windows.gaming.input/uinavigationcontroller_headset.md @@ -20,3 +20,5 @@ The audio headset attached to the UI navigation controller. ## -examples ## -see-also + +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_headsetconnected.md b/windows.gaming.input/uinavigationcontroller_headsetconnected.md index c78885ffb8..9e48911c23 100644 --- a/windows.gaming.input/uinavigationcontroller_headsetconnected.md +++ b/windows.gaming.input/uinavigationcontroller_headsetconnected.md @@ -17,3 +17,6 @@ Signals when a headset is attached to the UI navigation controller. ## -examples ## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md b/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md index 305f972763..8365febb9c 100644 --- a/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md +++ b/windows.gaming.input/uinavigationcontroller_headsetdisconnected.md @@ -17,3 +17,6 @@ Signals when a headset is disconnected from the UI navigation controller. ## -examples ## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.Gaming.Input.Headset](headset.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_iswireless.md b/windows.gaming.input/uinavigationcontroller_iswireless.md index cd43cf6681..e07019191d 100644 --- a/windows.gaming.input/uinavigationcontroller_iswireless.md +++ b/windows.gaming.input/uinavigationcontroller_iswireless.md @@ -13,7 +13,7 @@ public bool IsWireless { get; } Gets a value that indicates the wireless state of the UI navigation controller. ## -property-value -True if the gamepad is wireless. Otherwise, false. +True if the UI navigation controller is wireless. Otherwise, false. ## -remarks diff --git a/windows.gaming.input/uinavigationcontroller_trygetbatteryreport_340082979.md b/windows.gaming.input/uinavigationcontroller_trygetbatteryreport_340082979.md new file mode 100644 index 0000000000..cf2618609e --- /dev/null +++ b/windows.gaming.input/uinavigationcontroller_trygetbatteryreport_340082979.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Gaming.Input.UINavigationController.TryGetBatteryReport +-api-type: winrt method +--- + + + +# Windows.Gaming.Input.UINavigationController.TryGetBatteryReport + +## -description + +Gets information about the UI navigation controller's current battery state. + +## -returns + +Information about the UI navigation controller's current battery state. + +## -remarks + +## -see-also + +* [Windows.Devices.Power.BatteryReport](../windows.devices.power/batteryreport.md) + +## -examples diff --git a/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md b/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md index a5d3696454..c730771a29 100644 --- a/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md +++ b/windows.gaming.input/uinavigationcontroller_uinavigationcontrolleradded.md @@ -13,7 +13,7 @@ static public event Windows.Foundation.EventHandler UINavigationControllerAdded< Signals when a new UI navigation controller is connected. ## -remarks -To identify controllers that have allready been added, you query the list of conected controllers using [UINavigationController.UINavigationControllers](uinavigationcontroller_uinavigationcontrollers.md). +To identify controllers that have already been added, you query the list of connected controllers using [UINavigationController.UINavigationControllers](uinavigationcontroller_uinavigationcontrollers.md). ## -examples diff --git a/windows.gaming.input/uinavigationcontroller_user.md b/windows.gaming.input/uinavigationcontroller_user.md index 44ed6bf1f3..b4327a07b5 100644 --- a/windows.gaming.input/uinavigationcontroller_user.md +++ b/windows.gaming.input/uinavigationcontroller_user.md @@ -20,3 +20,5 @@ The user associated with the UI navigation controller. ## -examples ## -see-also + +* [Windows.System.User](../windows.system/user.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationcontroller_userchanged.md b/windows.gaming.input/uinavigationcontroller_userchanged.md index 2fc420502c..275568e197 100644 --- a/windows.gaming.input/uinavigationcontroller_userchanged.md +++ b/windows.gaming.input/uinavigationcontroller_userchanged.md @@ -17,3 +17,6 @@ Signals when the user associated with the UI navigation controller has changed. ## -examples ## -see-also + +* [Windows.Gaming.Input.IGameController](igamecontroller.md) +* [Windows.System.UserChangedEventArgs](../windows.system/userchangedeventargs.md) \ No newline at end of file diff --git a/windows.gaming.input/uinavigationreading.md b/windows.gaming.input/uinavigationreading.md index 13e02686ec..ac55696681 100644 --- a/windows.gaming.input/uinavigationreading.md +++ b/windows.gaming.input/uinavigationreading.md @@ -19,11 +19,11 @@ Time when the state was retrieved from the UI navigation controller. ### -field RequiredButtons -The state of the required UI navigation controller buttons . +The state of the required UI navigation controller buttons. ### -field OptionalButtons -The state of the optional UI navigation controller buttons . +The state of the optional UI navigation controller buttons. ## -remarks diff --git a/windows.graphics.display.core/hdmidisplaycolorspace.md b/windows.graphics.display.core/hdmidisplaycolorspace.md new file mode 100644 index 0000000000..bff80902f9 --- /dev/null +++ b/windows.graphics.display.core/hdmidisplaycolorspace.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Graphics.Display.Core.HdmiDisplayColorSpace +-api-type: winrt enum +--- + + + +# Windows.Graphics.Display.Core.HdmiDisplayColorSpace + +## -description + +## -enum-fields +### -field RgbLimited:0 + +### -field RgbFull:1 + +### -field BT709:3 + +### -field BT2020:2 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride.md b/windows.graphics.display/brightnessoverride.md new file mode 100644 index 0000000000..10bcaf489f --- /dev/null +++ b/windows.graphics.display/brightnessoverride.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Graphics.Display.BrightnessOverride +-api-type: winrt class +--- + + + +# Windows.Graphics.Display.BrightnessOverride + +## -description +Overrides the screen brightness level setting on a device. This API provides the ability to have per-application brightness control on devices that support controllable brightness. +Use the [BrightnessOverride](brightnessoverride.md) object to override the user's brightness level setting temporarily or permanently. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.graphics.display/brightnessoverride_brightnesslevel.md b/windows.graphics.display/brightnessoverride_brightnesslevel.md new file mode 100644 index 0000000000..1e9332b0ac --- /dev/null +++ b/windows.graphics.display/brightnessoverride_brightnesslevel.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Graphics.Display.BrightnessOverride.BrightnessLevel +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.BrightnessOverride.BrightnessLevel + +## -description +Gets the current screen brightness level. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_brightnesslevelchanged.md b/windows.graphics.display/brightnessoverride_brightnesslevelchanged.md new file mode 100644 index 0000000000..d8f5b22e73 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_brightnesslevelchanged.md @@ -0,0 +1,22 @@ +<<<<<<< HEAD +--- +-api-id: E:Windows.Graphics.Display.BrightnessOverride.BrightnessLevelChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.BrightnessOverride.BrightnessLevelChanged + +## -description +Occurs when the screen brightness level changes. + +## -remarks +This event is raised whenever the screen brightness changes, regardless whether the app has requested to start the override session or not. + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_getdefaultforsystem_1452001692.md b/windows.graphics.display/brightnessoverride_getdefaultforsystem_1452001692.md new file mode 100644 index 0000000000..7d1ee4fe9b --- /dev/null +++ b/windows.graphics.display/brightnessoverride_getdefaultforsystem_1452001692.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.GetDefaultForSystem +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.BrightnessOverride.GetDefaultForSystem + +## -description +Returns a brightness override object. This method does not require [CoreWindow](../windows.ui.core/corewindow.md) so it can be used by apps that are running in the background. + +## -returns +The brightness override object. + +## -remarks +Requires the Embedded Mode capability to be declared and enabled. + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_getforcurrentview_1363600702.md b/windows.graphics.display/brightnessoverride_getforcurrentview_1363600702.md new file mode 100644 index 0000000000..754c8f29e5 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_getforcurrentview_1363600702.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.BrightnessOverride.GetForCurrentView + +## -description +Returns a brightness override object. This method requires [CoreWindow](../windows.ui.core/corewindow.md) so it can only be used by apps that are currently running in a window. The returned [BrightnessOverride](brightnessoverride.md) object may not be the same between multiple [GetForCurrentView()](brightnessoverride_getforcurrentview_1363600702.md) calls on the same thread. + +## -returns +The brightness override object. + +## -remarks +This method fails if there is no [CoreWindow](../windows.ui.core/corewindow.md) on the calling thread. + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_getlevelforscenario_599977480.md b/windows.graphics.display/brightnessoverride_getlevelforscenario_599977480.md new file mode 100644 index 0000000000..3243ab6438 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_getlevelforscenario_599977480.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.GetLevelForScenario(Windows.Graphics.Display.DisplayBrightnessScenario) +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.BrightnessOverride.GetLevelForScenario + +## -description +Gets the brightness level associated with the specified scenario. + +## -parameters + +### -param scenario +The enum value of the scenario that you want to retrieve the brightness level for, as defined in [DisplayBrightnessScenario](displaybrightnessscenario.md). + +## -returns +A value to indicate the brightness level. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_isoverrideactive.md b/windows.graphics.display/brightnessoverride_isoverrideactive.md new file mode 100644 index 0000000000..ff942013a6 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_isoverrideactive.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Graphics.Display.BrightnessOverride.IsOverrideActive +-api-type: winrt property +--- + + + +# Windows.Graphics.Display.BrightnessOverride.IsOverrideActive + +## -description +BOOLEAN value that indicates whether the brightness override is active. If TRUE, the current brightness level matches the override brightness level. This property value will always be FALSE if [StartOverride()](brightnessoverride_startoverride_1290413150.md) isn’t called. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_isoverrideactivechanged.md b/windows.graphics.display/brightnessoverride_isoverrideactivechanged.md new file mode 100644 index 0000000000..4bc0b47734 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_isoverrideactivechanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Graphics.Display.BrightnessOverride.IsOverrideActiveChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.BrightnessOverride.IsOverrideActiveChanged + +## -description +Occurs when the screen brightness level either starts to match or stops to match the override brightness level. This event is raised when the [IsOverrideActive](brightnessoverride_isoverrideactive.md) property changes state. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_issupported.md b/windows.graphics.display/brightnessoverride_issupported.md new file mode 100644 index 0000000000..45f9f0d27f --- /dev/null +++ b/windows.graphics.display/brightnessoverride_issupported.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Graphics.Display.BrightnessOverride.IsSupported +-api-type: winrt property +--- + + + +# 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. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_issupportedchanged.md b/windows.graphics.display/brightnessoverride_issupportedchanged.md new file mode 100644 index 0000000000..bd1dedf8ac --- /dev/null +++ b/windows.graphics.display/brightnessoverride_issupportedchanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Graphics.Display.BrightnessOverride.IsSupportedChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Display.BrightnessOverride.IsSupportedChanged + +## -description +Occurs when a brightness controllable display is detected or removed. This event is raised when the [IsSupported](brightnessoverride_issupported.md) property changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_saveforsystemasync_723572109.md b/windows.graphics.display/brightnessoverride_saveforsystemasync_723572109.md new file mode 100644 index 0000000000..24da7a1f24 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_saveforsystemasync_723572109.md @@ -0,0 +1,29 @@ +- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.SaveForSystemAsync(Windows.Graphics.Display.BrightnessOverride) +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.BrightnessOverride.SaveForSystemAsync + +## -description +Saves the specified brightness override settings by committing these values to user settings. Use this method to persist the override settings after overriding stops. If a NULL object is passed in, the system turns on auto-brightness. + +## -parameters + +### -param value +The brightness override object. + +## -returns +BOOLEAN value to indicate if the operation is successful or not. + +## -remarks +Requires the Embedded Mode capability to be declared and enabled. + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_setbrightnesslevel_519170707.md b/windows.graphics.display/brightnessoverride_setbrightnesslevel_519170707.md new file mode 100644 index 0000000000..c7329488a9 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_setbrightnesslevel_519170707.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.SetBrightnessLevel(System.Double,Windows.Graphics.Display.DisplayBrightnessOverrideOptions) +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.BrightnessOverride.SetBrightnessLevel + +## -description +Sets the brightness level and the override options. + +## -parameters + +### -param brightnessLevel +Brightness of the screen. Value should be in the range of 0.0 and 1.0, where 1.0 is for 100% brightness. + +### -param options +Options that modify the brightness level of the screen during the brightness override session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_setbrightnessscenario_1995700297.md b/windows.graphics.display/brightnessoverride_setbrightnessscenario_1995700297.md new file mode 100644 index 0000000000..338b7a81c3 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_setbrightnessscenario_1995700297.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.SetBrightnessScenario(Windows.Graphics.Display.DisplayBrightnessScenario,Windows.Graphics.Display.DisplayBrightnessOverrideOptions) +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.BrightnessOverride.SetBrightnessScenario + +## -description +Sets the brightness level, by specifying a scenario that has a well-known brightness level, and the override options of the brightness override. + +## -parameters + +### -param scenario +A scenario that has a well-known brightness level. + +### -param options +Options that modify the brightness level of the screen during the brightness override session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_startoverride_1290413150.md b/windows.graphics.display/brightnessoverride_startoverride_1290413150.md new file mode 100644 index 0000000000..8796962962 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_startoverride_1290413150.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.StartOverride +-api-type: winrt method +--- + + + +# 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. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/brightnessoverride_stopoverride_1207260318.md b/windows.graphics.display/brightnessoverride_stopoverride_1207260318.md new file mode 100644 index 0000000000..ef2710e187 --- /dev/null +++ b/windows.graphics.display/brightnessoverride_stopoverride_1207260318.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Graphics.Display.BrightnessOverride.StopOverride +-api-type: winrt method +--- + + + +# Windows.Graphics.Display.BrightnessOverride.StopOverride + +## -description +Stops overriding the brightness level. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/displaybrightnessoverrideoptions.md b/windows.graphics.display/displaybrightnessoverrideoptions.md new file mode 100644 index 0000000000..e85d68eed4 --- /dev/null +++ b/windows.graphics.display/displaybrightnessoverrideoptions.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Graphics.Display.DisplayBrightnessOverrideOptions +-api-type: winrt enum +--- + + + +# Windows.Graphics.Display.DisplayBrightnessOverrideOptions + +## -description +Describes the options that modify the brightness level of the screen during the override session. When __UseDimmedPolicyWhenBatteryIsLow__ is set, it reduces the specified override brightness level in order to conserve battery if the device +battery is low during the override session. For example, if the override brightness level is set to 100% and __UseDimmedPolicyWhenBatteryIsLow__ is set, the screen will dim to 70% instead. + +## -enum-fields +### -field UseDimmedPolicyWhenBatteryIsLow:1 +Screen display dims when the device battery is low and a brightness override session is running. + +### -field None:0 +Screen display stays at the specified override brightness level when the device battery is low. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.display/displaybrightnessscenario.md b/windows.graphics.display/displaybrightnessscenario.md new file mode 100644 index 0000000000..5f443747b1 --- /dev/null +++ b/windows.graphics.display/displaybrightnessscenario.md @@ -0,0 +1,33 @@ +--- +-api-id: T:Windows.Graphics.Display.DisplayBrightnessScenario +-api-type: winrt enum +--- + + + +# Windows.Graphics.Display.DisplayBrightnessScenario + +## -description +Describes common brightness scenarios that have well-known brightness levels. These scenarios are used in the [GetLevelForScenario()](brightnessoverride_getlevelforscenario_599977480.md) and [SetBrightnessScenario()](brightnessoverride_setbrightnessscenario_1995700297.md) methods. + +## -enum-fields +### -field IdleBrightness:1 +Sets the screen to a battery friendly yet readable brightness level. This is currently set to 10% brightness. + +### -field FullBrightness:3 +Sets the screen to 100% brightness. + +### -field DefaultBrightness:0 +Sets the screen to the current screen brightness, essentially freezing the brightness. + +### -field BarcodeReadingBrightness:2 +Sets the screen to the brightness level that it is easily readable by barcode readers. This is currently set to 100% brightness. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccamera.md b/windows.graphics.holographic/holographiccamera.md index 240f429ec9..7e23153cde 100644 --- a/windows.graphics.holographic/holographiccamera.md +++ b/windows.graphics.holographic/holographiccamera.md @@ -1,20 +1,20 @@ ---- --api-id: T:Windows.Graphics.Holographic.HolographicCamera --api-type: winrt class ---- - - - -# Windows.Graphics.Holographic.HolographicCamera - -## -description -Represents a display that requires an app to render the holographic space from a particular perspective. An app must render to each HolographicCamera each frame. - -## -remarks -An app must render to each HolographicCamera each frame. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Graphics.Holographic.HolographicCamera +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicCamera + +## -description +Provides rendering state for a display to which a holographic view must render each frame from that frame's pose. + +## -remarks +An app must render to each HolographicCamera before presenting each HolographicFrame. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamera_display.md b/windows.graphics.holographic/holographiccamera_display.md new file mode 100644 index 0000000000..f40da63ab1 --- /dev/null +++ b/windows.graphics.holographic/holographiccamera_display.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.Display +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.Display + +## -description +Gets metadata about the display represented by this HolographicCamera. + +## -property-value +The display's metadata. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccamera_leftviewportparameters.md b/windows.graphics.holographic/holographiccamera_leftviewportparameters.md new file mode 100644 index 0000000000..c369acc028 --- /dev/null +++ b/windows.graphics.holographic/holographiccamera_leftviewportparameters.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.LeftViewportParameters +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.LeftViewportParameters + +## -description +Gets rendering parameters related to display's left-eye viewport. + +## -property-value +The left viewport parameters. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccamera_rightviewportparameters.md b/windows.graphics.holographic/holographiccamera_rightviewportparameters.md new file mode 100644 index 0000000000..5d23be19d0 --- /dev/null +++ b/windows.graphics.holographic/holographiccamera_rightviewportparameters.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.RightViewportParameters +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.RightViewportParameters + +## -description +Gets rendering parameters related to display's right-eye viewport. + +## -property-value +The right viewport parameters. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccamera_viewportscalefactor.md b/windows.graphics.holographic/holographiccamera_viewportscalefactor.md index 430bc12e21..52b4d41ac1 100644 --- a/windows.graphics.holographic/holographiccamera_viewportscalefactor.md +++ b/windows.graphics.holographic/holographiccamera_viewportscalefactor.md @@ -1,26 +1,25 @@ ---- --api-id: P:Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor --api-type: winrt property ---- - - - -# Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor - -## -description -Gets or sets the scale factor to apply to the default viewport size. - -Each frame, the system decides the size of the viewport within the render target that the app must render that frame. Sometimes the system may lower this to free up system resources, for example when video capture is occurring. Regardless of the viewport size, the rendered image is always scaled up to the full size of the displays. An app looking to lower its rendering cost for other reasons can request a smaller viewport. - -You can specify a scale factor between 0.0 and 1.0, which is multiplied by the default viewport size. In future frames, the system will specify that you render to the nearest valid viewport size to this requested size. - -## -property-value -The viewport scale factor. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCamera.ViewportScaleFactor + +## -description +Gets or sets the scale factor to apply to the default viewport size. + +## -property-value +The viewport scale factor. + +## -remarks +Each frame, the system decides the size of the viewport within the render target that the app must render that frame. Sometimes the system may lower this to free up system resources, for example when video capture is occurring. Regardless of the viewport size, the rendered image is always scaled up to the full size of the displays. An app looking to lower its rendering cost for other reasons can request a smaller viewport. + +You can specify a scale factor between 0.0 and 1.0, which is multiplied by the default viewport size. In future frames, the system will specify that you render to the nearest valid viewport size to this requested size. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md b/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md index 1d5cfff3ec..f56c4730e5 100644 --- a/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md +++ b/windows.graphics.holographic/holographiccamerapose_trygetvisiblefrustum_1642166699.md @@ -1,32 +1,31 @@ ---- --api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum - -## -description -Gets the predicted view frustum for the current pose, expressed in the specified coordinate system. - -If this is a stereo display, this is the combined frustum of both stereo views, including the left and right view and projection matrices. - -This frustum shares the same dimensions as the true view frustum at the time of rendering, although it may be off by some amount due to prediction error. Call TryGetCullingFrustum to get a conservative frustum that takes this uncertainty into account. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the visible frustum. - -## -returns -The visible frustum. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.TryGetVisibleFrustum + +## -description +Gets the predicted view frustum for the current pose, expressed in the specified coordinate system. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the visible frustum. + +## -returns +The visible frustum. + +## -remarks +If this is a stereo display, this is the combined frustum of both stereo views, including the left and right view and projection matrices. + +This frustum shares the same dimensions as the true view frustum at the time of rendering, although it may be off by some amount due to prediction error. Call TryGetCullingFrustum to get a conservative frustum that takes this uncertainty into account. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerapose_viewport.md b/windows.graphics.holographic/holographiccamerapose_viewport.md index e228b0430d..4cc46f7d2e 100644 --- a/windows.graphics.holographic/holographiccamerapose_viewport.md +++ b/windows.graphics.holographic/holographiccamerapose_viewport.md @@ -1,22 +1,23 @@ ---- --api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.Viewport --api-type: winrt property ---- - - - -# Windows.Graphics.Holographic.HolographicCameraPose.Viewport - -## -description -Gets the viewport rectangle that the app must render to for this camera in this frame. To shrink this viewport for future frames, set the ViewportScaleFactor on the HolographicCamera. - -## -property-value -The viewport rect. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraPose.Viewport +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraPose.Viewport + +## -description +Gets the viewport rectangle that the app must render to for this camera in this frame. + +## -property-value +The viewport rect. + +## -remarks +To shrink this viewport for future frames, set the ViewportScaleFactor on the HolographicCamera. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters.md b/windows.graphics.holographic/holographiccamerarenderingparameters.md index 572d34ed7e..fb5b5d2aac 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters.md @@ -1,22 +1,20 @@ ---- --api-id: T:Windows.Graphics.Holographic.HolographicCameraRenderingParameters --api-type: winrt class ---- - - - -# Windows.Graphics.Holographic.HolographicCameraRenderingParameters - -## -description -Represents per-camera parameters for rendering holographic content. - -An app can call the SetFocusPoint method each frame to improve holographic image quality. The app can specify the position, normal, and velocity of the user's likely focus point within the scene. Holograms will be most stable both at the specified position, and along the plane defined by that position and the normal. If the content does not have an obvious normal, omit it or have it face the user. - -## -remarks - - -## -examples - -## -see-also +--- +-api-id: T:Windows.Graphics.Holographic.HolographicCameraRenderingParameters +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters + +## -description +Represents per-camera parameters for rendering holographic content. + +## -remarks +An app can call the SetFocusPoint method each frame to improve holographic image quality. The app can specify the position, normal, and velocity of the user's likely focus point within the scene. Holograms will be most stable both at the specified position, and along the plane defined by that position and the normal. If the content does not have an obvious normal, omit it or have it face the user. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_commitdirect3d11depthbuffer_1424767526.md b/windows.graphics.holographic/holographiccamerarenderingparameters_commitdirect3d11depthbuffer_1424767526.md new file mode 100644 index 0000000000..e03ad12d86 --- /dev/null +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_commitdirect3d11depthbuffer_1424767526.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.CommitDirect3D11DepthBuffer(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.CommitDirect3D11DepthBuffer + +## -description +Provides a depth buffer for this frame to the holographic display pipeline, enabling depth-based stabilization of the frame relative to the user's head motion. + +## -parameters + +### -param value +The Direct3D 11 surface containing the app's depth buffer. + +## -remarks +If an app provides a depth buffer for a frame and then skips calling SetFocusPoint, the focus point and normal are inferred based on the depth buffer. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_reprojectionmode.md b/windows.graphics.holographic/holographiccamerarenderingparameters_reprojectionmode.md new file mode 100644 index 0000000000..bd8f1e76af --- /dev/null +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_reprojectionmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.ReprojectionMode +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.ReprojectionMode + +## -description +Gets or sets the kind of reprojection the app is requesting to stabilize its holographic rendering relative to the user's head motion. + +## -property-value +The kind of reprojection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md index e2ae0a47a3..7bee6a7f86 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1040378076.md @@ -1,37 +1,36 @@ ---- --api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) --api-type: winrt method ---- - - - -# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint - -## -description -Sets the moving point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. - -This is used to improve image quality at the moving focus point and along its focus plane. - -You must set the focus point each frame, or it will reset to its default. - -## -parameters -### -param coordinateSystem -The coordinate system of the position, normal and velocity vectors. - -### -param position -The location of the focus point in the specified coordinate system. - -### -param normal -The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. - -### -param linearVelocity -The velocity vector of the focus point in the specified coordinate system. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint + +## -description +Sets the moving point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. + +## -parameters +### -param coordinateSystem +The coordinate system of the position, normal and velocity vectors. + +### -param position +The location of the focus point in the specified coordinate system. + +### -param normal +The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. + +### -param linearVelocity +The velocity vector of the focus point in the specified coordinate system. + +## -remarks +This is used to improve image quality at the focus point and along its focus plane. + +You must set the focus point each frame, or it will reset to its default. If you call [CommitDirect3D11DepthBuffer](holographiccamerarenderingparameters_commitdirect3d11depthbuffer_1424767526.md), the default focus point and normal will be inferred from your rendered depth data. Otherwise, the default focus point will be 2 meters away from the headset, with a normal facing the headset. + +## -examples + +## -see-also [SetFocusPoint(SpatialCoordinateSystem, Vector3)](holographiccamerarenderingparameters_setfocuspoint_184506220.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1275160748.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md index 4ba0dd1e5e..16752653d3 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_1275160748.md @@ -1,34 +1,33 @@ ---- --api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) --api-type: winrt method ---- - - - -# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint - -## -description -Sets the stationary point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. - -This is used to improve image quality at the focus point and along its focus plane. - -You must set the focus point each frame, or it will reset to its default. - -## -parameters -### -param coordinateSystem -The coordinate system of the position and normal vectors. - -### -param position -The location of the focus point in the specified coordinate system. - -### -param normal -The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3,Windows.Foundation.Numerics.Vector3) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint + +## -description +Sets the stationary point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point. + +## -parameters +### -param coordinateSystem +The coordinate system of the position and normal vectors. + +### -param position +The location of the focus point in the specified coordinate system. + +### -param normal +The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. + +## -remarks +This is used to improve image quality at the focus point and along its focus plane. + +You must set the focus point each frame, or it will reset to its default. If you call [CommitDirect3D11DepthBuffer](holographiccamerarenderingparameters_commitdirect3d11depthbuffer_1424767526.md), the default focus point and normal will be inferred from your rendered depth data. Otherwise, the default focus point will be 2 meters away from the headset, with a normal facing the headset. + +## -examples + +## -see-also [SetFocusPoint(SpatialCoordinateSystem, Vector3)](holographiccamerarenderingparameters_setfocuspoint_184506220.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1040378076.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md index 0b32094688..e3b73c486f 100644 --- a/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md +++ b/windows.graphics.holographic/holographiccamerarenderingparameters_setfocuspoint_184506220.md @@ -1,31 +1,30 @@ ---- --api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3) --api-type: winrt method ---- - - - -# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint - -## -description -Sets the stationary point in the holographic space that the user will likely focus on for the current frame. - -This is used to improve image quality at the focus point and along a default focus plane that faces the user. - -You must set the focus point each frame, or it will reset to its default. - -## -parameters -### -param coordinateSystem -The coordinate system of the position vector. - -### -param position -The location of the focus point in the specified coordinate system. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Foundation.Numerics.Vector3) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicCameraRenderingParameters.SetFocusPoint + +## -description +Sets the stationary point in the holographic space that the user will likely focus on for the current frame. + +## -parameters +### -param coordinateSystem +The coordinate system of the position vector. + +### -param position +The location of the focus point in the specified coordinate system. + +## -remarks +This is used to improve image quality at the focus point and along its focus plane. + +You must set the focus point each frame, or it will reset to its default. If you call [CommitDirect3D11DepthBuffer](holographiccamerarenderingparameters_commitdirect3d11depthbuffer_1424767526.md), the default focus point and normal will be inferred from your rendered depth buffer. Otherwise, the default focus point will be 2 meters away from the headset, with a normal facing the headset. + +## -examples + +## -see-also [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1275160748.md), [SetFocusPoint(SpatialCoordinateSystem, Vector3, Vector3, Vector3)](holographiccamerarenderingparameters_setfocuspoint_1040378076.md) \ No newline at end of file diff --git a/windows.graphics.holographic/holographiccameraviewportparameters.md b/windows.graphics.holographic/holographiccameraviewportparameters.md new file mode 100644 index 0000000000..b956a3a311 --- /dev/null +++ b/windows.graphics.holographic/holographiccameraviewportparameters.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Graphics.Holographic.HolographicCameraViewportParameters +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicCameraViewportParameters + +## -description +Represents per-viewport parameters for rendering holographic content. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccameraviewportparameters_hiddenareamesh.md b/windows.graphics.holographic/holographiccameraviewportparameters_hiddenareamesh.md new file mode 100644 index 0000000000..b3cefb0fb0 --- /dev/null +++ b/windows.graphics.holographic/holographiccameraviewportparameters_hiddenareamesh.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraViewportParameters.HiddenAreaMesh +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraViewportParameters.HiddenAreaMesh + +## -description +Gets screen-space vertices that define the viewport area the user cannot see, given the headset's lens geometry. + +## -property-value +The hidden area mesh vertices. + +## -remarks +An app can improve performance by not rendering to the pixels covered by the hidden area mesh. + +If it is more convenient to reason about the visible area rather than the hidden area, inspect the [VisibleAreaMesh](holographiccameraviewportparameters_visibleareamesh.md) property instead. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographiccameraviewportparameters_visibleareamesh.md b/windows.graphics.holographic/holographiccameraviewportparameters_visibleareamesh.md new file mode 100644 index 0000000000..fdf225cbad --- /dev/null +++ b/windows.graphics.holographic/holographiccameraviewportparameters_visibleareamesh.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicCameraViewportParameters.VisibleAreaMesh +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicCameraViewportParameters.VisibleAreaMesh + +## -description +Gets screen-space vertices that define the viewport area the user can see, given the headset's lens geometry. + +## -property-value +The visible area mesh vertices. + +## -remarks +An app can improve performance by only rendering to the pixels covered by the visible area mesh. + +If it is more convenient to reason about the hidden area rather than the visible area, inspect the [HiddenAreaMesh](holographiccameraviewportparameters_hiddenareamesh.md) property instead. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay.md b/windows.graphics.holographic/holographicdisplay.md new file mode 100644 index 0000000000..24d3e79506 --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Graphics.Holographic.HolographicDisplay +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay + +## -description +Provides metadata for a display to which a holographic view must render each frame from that frame's pose. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay_adapterid.md b/windows.graphics.holographic/holographicdisplay_adapterid.md new file mode 100644 index 0000000000..8753eef8d8 --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay_adapterid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicDisplay.AdapterId +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay.AdapterId + +## -description +Gets the identifier of the graphics adapter to be used when displaying holographic content to this HolographicDisplay. + +## -property-value +The identifier. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay_displayname.md b/windows.graphics.holographic/holographicdisplay_displayname.md new file mode 100644 index 0000000000..659bb7f944 --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay_displayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicDisplay.DisplayName +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay.DisplayName + +## -description +Gets a friendly name for this display that can be displayed to the user. + +## -property-value +The friendly name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay_getdefault_846721868.md b/windows.graphics.holographic/holographicdisplay_getdefault_846721868.md new file mode 100644 index 0000000000..da9510d738 --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay_getdefault_846721868.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Graphics.Holographic.HolographicDisplay.GetDefault +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay.GetDefault + +## -description +Gets the default display that represents the user's primary Mixed Reality headset. + +## -returns +The default display. + +## -remarks +This will be null when [HolographicSpace.IsAvailable](holographicspace_isavailable.md) is false, representing a Desktop which does not have a headset attached. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay_isopaque.md b/windows.graphics.holographic/holographicdisplay_isopaque.md new file mode 100644 index 0000000000..9baf60e38d --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay_isopaque.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicDisplay.IsOpaque +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay.IsOpaque + +## -description +Gets whether this display is occluded, blocking the user's view of the physical world around them. + +## -property-value +Whether this display is occluded. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay_isstereo.md b/windows.graphics.holographic/holographicdisplay_isstereo.md new file mode 100644 index 0000000000..665406d871 --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay_isstereo.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicDisplay.IsStereo +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay.IsStereo + +## -description +Gets whether this display requires separate rendering for the left and right eyes. + +## -property-value +Whether this display is stereo. + +## -remarks +While actual Mixed Reality headsets are always stereo, an app will sometimes be asked to render to a mono HolographicDisplay, such as within the Mixed Reality emulator or during remoting to a desktop monitor. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay_maxviewportsize.md b/windows.graphics.holographic/holographicdisplay_maxviewportsize.md new file mode 100644 index 0000000000..e199ede322 --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay_maxviewportsize.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicDisplay.MaxViewportSize +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay.MaxViewportSize + +## -description +Gets the maximum viewport size that an app will ever be asked to render to for this display. + +## -property-value +The maximum viewport size. + +## -remarks +An app can use this maximum size to pre-allocate secondary buffers for its own use during rendering. + +Note that this maximum viewport size will exceed the physical resolution of the headset's screen for displays with lens distortion. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicdisplay_spatiallocator.md b/windows.graphics.holographic/holographicdisplay_spatiallocator.md new file mode 100644 index 0000000000..0246333ba9 --- /dev/null +++ b/windows.graphics.holographic/holographicdisplay_spatiallocator.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicDisplay.SpatialLocator +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicDisplay.SpatialLocator + +## -description +Gets a spatial locator that can be used to create frames of reference relative to this display. + +## -property-value +The spatial locator. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicframe.md b/windows.graphics.holographic/holographicframe.md index eaf7bcbcad..994ae97aae 100644 --- a/windows.graphics.holographic/holographicframe.md +++ b/windows.graphics.holographic/holographicframe.md @@ -1,22 +1,21 @@ ---- --api-id: T:Windows.Graphics.Holographic.HolographicFrame --api-type: winrt class ---- - - - -# Windows.Graphics.Holographic.HolographicFrame - -## -description -Represents a frame of holographic content that an app must render to all cameras. - -Each HolographicFrame tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. - -## -remarks - - -## -examples - -## -see-also +--- +-api-id: T:Windows.Graphics.Holographic.HolographicFrame +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicFrame + +## -description +Represents a frame of holographic content that an app must render to all cameras. + +## -remarks +Each HolographicFrame tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_addedcameras.md b/windows.graphics.holographic/holographicframe_addedcameras.md index e000af57c6..5d2ee268a1 100644 --- a/windows.graphics.holographic/holographicframe_addedcameras.md +++ b/windows.graphics.holographic/holographicframe_addedcameras.md @@ -1,24 +1,23 @@ ---- --api-id: P:Windows.Graphics.Holographic.HolographicFrame.AddedCameras --api-type: winrt property ---- - - - -# Windows.Graphics.Holographic.HolographicFrame.AddedCameras - -## -description -Gets the list of HolographicCamera objects that were added since last frame. - -Cameras only show up in this list after they surface in the CameraAdded event to //! let apps initialize any per-camera buffers on a background thread. - -## -property-value -A collection of HolographicCamera objects that were added. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Graphics.Holographic.HolographicFrame.AddedCameras +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.AddedCameras + +## -description +Gets the list of HolographicCamera objects that were added since last frame. + +## -property-value +A collection of HolographicCamera objects that were added. + +## -remarks +Cameras only show up in this list after they surface in the CameraAdded event to //! let apps initialize any per-camera buffers on a background thread. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md b/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md index a08257d0e5..4796b513d0 100644 --- a/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md +++ b/windows.graphics.holographic/holographicframe_waitforframetofinish_1671614440.md @@ -1,21 +1,20 @@ ---- --api-id: M:Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish --api-type: winrt method ---- - - - -# Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish - -## -description -Blocks the current thread until this frame has finished and is showing on the displays. - -Note that the default wait behavior of PresentUsingCurrentPrediction already waits for the frame to finish. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicFrame.WaitForFrameToFinish + +## -description +Blocks the current thread until this frame has finished and is showing on the displays. + +## -remarks +Note that the default wait behavior of PresentUsingCurrentPrediction already waits for the frame to finish. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicframeprediction.md b/windows.graphics.holographic/holographicframeprediction.md index 0266660d15..ee8949e1c6 100644 --- a/windows.graphics.holographic/holographicframeprediction.md +++ b/windows.graphics.holographic/holographicframeprediction.md @@ -1,20 +1,20 @@ ---- --api-id: T:Windows.Graphics.Holographic.HolographicFramePrediction --api-type: winrt class ---- - - - -# Windows.Graphics.Holographic.HolographicFramePrediction - -## -description -holographicframeprediction - -## -remarks - - -## -examples - -## -see-also +--- +-api-id: T:Windows.Graphics.Holographic.HolographicFramePrediction +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicFramePrediction + +## -description +Represents the poses for each holographic camera at the time that they're predicted to be displayed. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicreprojectionmode.md b/windows.graphics.holographic/holographicreprojectionmode.md new file mode 100644 index 0000000000..d2bc46ff74 --- /dev/null +++ b/windows.graphics.holographic/holographicreprojectionmode.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Graphics.Holographic.HolographicReprojectionMode +-api-type: winrt enum +--- + + + +# Windows.Graphics.Holographic.HolographicReprojectionMode + +## -description +Represents the kind of reprojection an app is requesting to stabilize its holographic rendering relative to the user's head motion. + +## -enum-fields +### -field PositionAndOrientation:0 +The image should be stabilized for changes to both the user's head position and orientation. This is best for world-locked content that should remain physically stationary as the user walks around. + +### -field OrientationOnly:1 +The image should be stabilized only for changes to both the user's head orientation, ignoring positional changes. This is best for body-locked content that should tag along with the user as they walk around, such as 360-degree video. + +### -field Disabled:2 +The image should not be stabilized for the user's head motion, instead remaining fixed in the display. This is generally discouraged, as it is only comfortable for users when used sparingly, such as when the only visible content is a small cursor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicspace.md b/windows.graphics.holographic/holographicspace.md index 85dc9f3ab7..6c122afdf3 100644 --- a/windows.graphics.holographic/holographicspace.md +++ b/windows.graphics.holographic/holographicspace.md @@ -1,20 +1,20 @@ ---- --api-id: T:Windows.Graphics.Holographic.HolographicSpace --api-type: winrt class ---- - - - -# Windows.Graphics.Holographic.HolographicSpace - -## -description -Represents a holographic scene, with one or more holographic cameras rendering its content. - -## -remarks - - -## -examples - -## -see-also +--- +-api-id: T:Windows.Graphics.Holographic.HolographicSpace +-api-type: winrt class +--- + + + +# Windows.Graphics.Holographic.HolographicSpace + +## -description +Represents a holographic scene, with one or more holographic cameras rendering its content. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_cameraadded.md b/windows.graphics.holographic/holographicspace_cameraadded.md index d650317017..e2f7fb9a07 100644 --- a/windows.graphics.holographic/holographicspace_cameraadded.md +++ b/windows.graphics.holographic/holographicspace_cameraadded.md @@ -1,23 +1,22 @@ ---- --api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraAdded --api-type: winrt event ---- - - - -# Windows.Graphics.Holographic.HolographicSpace.CameraAdded - -## -description -Occurs when a HolographicCamera is added to the current HolographicSpace. - -Apps can use this event to set up any per-camera resources they may need. - -Unless the deferral is taken, once all event handlers are complete, the system will include this camera in the list of cameras that the app must render to each frame. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraAdded +-api-type: winrt event +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CameraAdded + +## -description +Occurs when a HolographicCamera is added to the current HolographicSpace. + +## -remarks +Apps can use this event to set up any per-camera resources they may need. + +Unless the deferral is taken, once all event handlers are complete, the system will include this camera in the list of cameras that the app must render to each frame. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_cameraremoved.md b/windows.graphics.holographic/holographicspace_cameraremoved.md index bb402d76f2..d8ed06d504 100644 --- a/windows.graphics.holographic/holographicspace_cameraremoved.md +++ b/windows.graphics.holographic/holographicspace_cameraremoved.md @@ -1,23 +1,22 @@ ---- --api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraRemoved --api-type: winrt event ---- - - - -# Windows.Graphics.Holographic.HolographicSpace.CameraRemoved - -## -description -Occurs when a HolographicCamera is removed from the current HolographicSpace. - -Apps can use this event to tear down any per-camera resources they may have set up during CameraAdded. - -The system will no longer require that the app render to this camera, starting in the next frame after this event. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.Graphics.Holographic.HolographicSpace.CameraRemoved +-api-type: winrt event +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CameraRemoved + +## -description +Occurs when a HolographicCamera is removed from the current HolographicSpace. + +## -remarks +Apps can use this event to tear down any per-camera resources they may have set up during CameraAdded. + +The system will no longer require that the app render to this camera, starting in the next frame after this event. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md b/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md index df77e60b27..f3e29bc063 100644 --- a/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md +++ b/windows.graphics.holographic/holographicspace_createforcorewindow_1849825339.md @@ -1,28 +1,27 @@ ---- --api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow(Windows.UI.Core.CoreWindow) --api-type: winrt method ---- - - - -# Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow - -## -description -Creates a HolographicSpace that corresponds with the specified window's CoreApplicationView. - -Calling this method permanently assigns the CoreApplicationView to be holographic. You may no longer call IDXGIFactory2::CreateSwapChainForCoreWindow after calling this method, or vice versa. - -## -parameters -### -param window -The window to create a HolographicSpace for. - -## -returns -The HolographicSpace. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow(Windows.UI.Core.CoreWindow) +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CreateForCoreWindow + +## -description +Creates a HolographicSpace that corresponds with the specified window's CoreApplicationView. + +## -parameters +### -param window +The window to create a HolographicSpace for. + +## -returns +The HolographicSpace. + +## -remarks +Calling this method permanently assigns the CoreApplicationView to be holographic. You may no longer call IDXGIFactory2::CreateSwapChainForCoreWindow after calling this method, or vice versa. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_createnextframe_767085077.md b/windows.graphics.holographic/holographicspace_createnextframe_767085077.md index 702971c100..178ac5d061 100644 --- a/windows.graphics.holographic/holographicspace_createnextframe_767085077.md +++ b/windows.graphics.holographic/holographicspace_createnextframe_767085077.md @@ -1,26 +1,25 @@ ---- --api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame --api-type: winrt method ---- - - - -# Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame - -## -description -Creates a HolographicFrame for the next frame to display. - -Apps use the HolographicFrame returned here to find out the predicted positions of each HolographicCamera at the time of frame display, render their views based on that prediction, and then call the PresentUsingCurrentPrediction method to send them to the displays. - -The system tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. - -## -returns -The next frame. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame +-api-type: winrt method +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.CreateNextFrame + +## -description +Creates a HolographicFrame for the next frame to display. + +## -returns +The next frame. + +## -remarks +Apps use the HolographicFrame returned here to find out the predicted positions of each HolographicCamera at the time of frame display, render their views based on that prediction, and then call the PresentUsingCurrentPrediction method to send them to the displays. + +The system tracks end-to-end latency from the CreateNextFrame call until the frame is presented. This determines the number of frames the system will look forward for the next frame's prediction. + +## -examples + +## -see-also diff --git a/windows.graphics.holographic/holographicspace_isavailable.md b/windows.graphics.holographic/holographicspace_isavailable.md new file mode 100644 index 0000000000..8966b27195 --- /dev/null +++ b/windows.graphics.holographic/holographicspace_isavailable.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicSpace.IsAvailable +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.IsAvailable + +## -description +Gets whether a Mixed Reality headset is ready for holographic rendering. + +## -property-value +Whether a headset is ready. + +## -remarks +On Desktop PCs, this tells an app whether a Mixed Reality headset is attached to the PC, has been set up by the user, and is ready for holographic rendering. When the headset is detached, this will become false. + +On HoloLens, this is always true. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicspace_isavailablechanged.md b/windows.graphics.holographic/holographicspace_isavailablechanged.md new file mode 100644 index 0000000000..118850ea1a --- /dev/null +++ b/windows.graphics.holographic/holographicspace_isavailablechanged.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Graphics.Holographic.HolographicSpace.IsAvailableChanged +-api-type: winrt event +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.IsAvailableChanged + +## -description +Occurs when a configured and ready Mixed Reality headset is attached or detached from the system. + +## -remarks +On Desktop PCs, this tells an app when a Mixed Reality headset that is configured and ready is either attached to the PC or detached from the PC. Inspect the [IsAvailable](holographicspace_isavailable.md) property to determine the current state of the system. + +On HoloLens, this event will never occur, as holographic rendering is always available. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicspace_issupported.md b/windows.graphics.holographic/holographicspace_issupported.md new file mode 100644 index 0000000000..7207cd2377 --- /dev/null +++ b/windows.graphics.holographic/holographicspace_issupported.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Graphics.Holographic.HolographicSpace.IsSupported +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.IsSupported + +## -description +Gets whether the current system supports Mixed Reality headsets. + +## -property-value +Whether headsets are supported. + +## -remarks +On Desktop PCs running 64-bit Windows, this is always true. If [IsAvailable](holographicspace_isavailable.md) is false because the user has not yet set up their holographic headset, calling [CreateForCoreWindow](holographicspace_createforcorewindow_1849825339.md) anyway will guide them through the setup flow. + +On HoloLens, this is always true. + +On any other system, including Desktop PCs running 32-bit Windows, this is false, as Mixed Reality headsets are not supported on those systems. + +## -see-also + +## -examples + diff --git a/windows.graphics.holographic/holographicspace_primaryadapterid.md b/windows.graphics.holographic/holographicspace_primaryadapterid.md index dde73362f5..fb7432d7ce 100644 --- a/windows.graphics.holographic/holographicspace_primaryadapterid.md +++ b/windows.graphics.holographic/holographicspace_primaryadapterid.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId --api-type: winrt property ---- - - - -# Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId - -## -description -Gets the identifier of the graphics adapter to be used when displaying holographic content. - -## -property-value -The identifier. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId +-api-type: winrt property +--- + + + +# Windows.Graphics.Holographic.HolographicSpace.PrimaryAdapterId + +## -description +Gets the identifier of the graphics adapter to be used when displaying holographic content to the default HolographicDisplay. + +## -property-value +The identifier. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.graphics/pointint32.md b/windows.graphics/pointint32.md new file mode 100644 index 0000000000..5d835673ec --- /dev/null +++ b/windows.graphics/pointint32.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Graphics.PointInt32 +-api-type: winrt struct +--- + + + +# Windows.Graphics.PointInt32 + +## -description +Defines a point in a two-dimensional plane. + +## -struct-fields + +### -field X +The X coordinate value of a point. + +### -field Y +The Y coordinate value of a point. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics/rectint32.md b/windows.graphics/rectint32.md new file mode 100644 index 0000000000..f96e5d8cda --- /dev/null +++ b/windows.graphics/rectint32.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Graphics.RectInt32 +-api-type: winrt struct +--- + + + +# Windows.Graphics.RectInt32 + +## -description +Defines the size and location of a rectangular surface. + +## -struct-fields + +### -field Height +The height of a rectangle. + +### -field Width +The width of a rectangle. + +### -field X +The X coordinate at the center of a rectangle. + +### -field Y +The Y coordinate at the center of a rectangle. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics/sizeint32.md b/windows.graphics/sizeint32.md new file mode 100644 index 0000000000..52dd25fb4f --- /dev/null +++ b/windows.graphics/sizeint32.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Graphics.SizeInt32 +-api-type: winrt struct +--- + + + +# Windows.Graphics.SizeInt32 + +## -description +Defines the height and wide of a surface in a two-dimensional plane. + +## -struct-fields + +### -field Height +The height of a surface. + +### -field Width +The width of a surface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.graphics/windows_graphics.md b/windows.graphics/windows_graphics.md new file mode 100644 index 0000000000..f0c229f2ac --- /dev/null +++ b/windows.graphics/windows_graphics.md @@ -0,0 +1,22 @@ +--- +-api-id: N:Windows.Graphics +-api-type: winrt namespace +--- + + + +# Windows.Graphics + +## -description +Provides basic data types that contain info on how to draw graphics. These data structs are commonly used to define how large surfaces are drawn when using the [CompositionVirtualDrawingSurface](../windows.ui.composition/compositionvirtualdrawingsurface.md) class. + +Virtual surfaces can be used to create large, efficient scrollable regions in an app; useful for scenarios such as maps and long scrollable blocks of text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.deployment/deploymentresult_isregistered.md b/windows.management.deployment/deploymentresult_isregistered.md new file mode 100644 index 0000000000..d06a2dc72b --- /dev/null +++ b/windows.management.deployment/deploymentresult_isregistered.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.Deployment.DeploymentResult.IsRegistered +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.DeploymentResult.IsRegistered + +## -description +Describes whether or not the package is fully registered and ready to use. + +## -property-value +true if the package is registered; otherwise, false. + +## -remarks + +## -examples + +## -see-also +[Deployment.PackageStatus](packagestatus.md) + diff --git a/windows.management.deployment/packagemanager_addpackageasync_1360552771.md b/windows.management.deployment/packagemanager_addpackageasync_1360552771.md new file mode 100644 index 0000000000..027c9c8bad --- /dev/null +++ b/windows.management.deployment/packagemanager_addpackageasync_1360552771.md @@ -0,0 +1,43 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.AddPackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume,Windows.Foundation.Collections.IIterable{System.String},Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri}) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.AddPackageAsync + +## -description +Adds a package and its dependency packages to the specified volume for the current user, using the specified deployment options. + +## -params + +## -param packageUri +The Uri of the source package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. + +## -param dependencyPackageUris +The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. + +## -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. + +## -param targetVolume +The volume that the package is added to. + +## -param optionalPackageFamilyNames +The package family names from the main bundle to be registered. + +## -param externalPackageUris +The URIs of the other packages in the main bundle to be registered. + +## -returns + +## -remarks + +## -see-also +[DeploymentOptions](deploymentoptions.md) + +## -examples + diff --git a/windows.management.deployment/packagemanager_debugsettings.md b/windows.management.deployment/packagemanager_debugsettings.md new file mode 100644 index 0000000000..f31b343cb1 --- /dev/null +++ b/windows.management.deployment/packagemanager_debugsettings.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.Deployment.PackageManager.DebugSettings +-api-type: winrt property +--- + + + +# Windows.Management.Deployment.PackageManager.DebugSettings + +## -description +Get the debugging settings for package deployment. + +## -property-value +The debugging settings for package deployment. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanager_registerpackagebyfamilynameasync_483064531.md b/windows.management.deployment/packagemanager_registerpackagebyfamilynameasync_483064531.md new file mode 100644 index 0000000000..c0f52b0ead --- /dev/null +++ b/windows.management.deployment/packagemanager_registerpackagebyfamilynameasync_483064531.md @@ -0,0 +1,40 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.RegisterPackageByFamilyNameAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume,Windows.Foundation.Collections.IIterable{System.String}) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.RegisterPackageByFamilyNameAsync + +## -description +Registers a package (the main package) by its family name and its dependency packages for the current user. + +## -params + +## -param mainPackageFamilyName +A string that specifies the family name of the main package to be registered. + +## -param dependencyPackageFamilyNames +Strings that specify the family names of the dependency packages to be registered. + +## -param deploymentOptions +A [DeploymentOptions](deploymentoptions.md)-typed value that specifies the package deployment option. + +## -param appDataVolume +The package volume to store that app data on. + +## -param optionalPackageFamilyNames +Strings that specify the optional package family names from the main bundle to be registered. + +## -returns +A report of the deployment progress. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanager_stagepackageasync_926498418.md b/windows.management.deployment/packagemanager_stagepackageasync_926498418.md new file mode 100644 index 0000000000..95b87e2238 --- /dev/null +++ b/windows.management.deployment/packagemanager_stagepackageasync_926498418.md @@ -0,0 +1,43 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManager.StagePackageAsync(Windows.Foundation.Uri,Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Management.Deployment.DeploymentOptions,Windows.Management.Deployment.PackageVolume,Windows.Foundation.Collections.IIterable{System.String},Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri}) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManager.StagePackageAsync + +## -description +Stages a package to the system without registering it. + +## -params + +## -param packageUri +The source URI of the main package. + +## -param dependencyPackageUris +The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. + +## -param deploymentOptions +A bitwise combination of enumeration values from the [DeploymentOptions](deploymentoptions.md) enumeration. The resulting value specifies the package deployment options. + +## -param targetVolume +The target volume on which to stage the package. + +## -param optionalPackageFamilyNames +Strings that specify the optional package family names from the main bundle to be staged. + +## -param externalPackageUris +The source URIs of other packages in the main bundle to be staged. + +## -returns +An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanagerdebugsettings.md b/windows.management.deployment/packagemanagerdebugsettings.md new file mode 100644 index 0000000000..adaf1390e1 --- /dev/null +++ b/windows.management.deployment/packagemanagerdebugsettings.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Management.Deployment.PackageManagerDebugSettings +-api-type: winrt class +--- + + + +# Windows.Management.Deployment.PackageManagerDebugSettings + +## -description +Settings for debugging app packages. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanagerdebugsettings_setcontentgroupstateasync_1791709366.md b/windows.management.deployment/packagemanagerdebugsettings_setcontentgroupstateasync_1791709366.md new file mode 100644 index 0000000000..4258e3f982 --- /dev/null +++ b/windows.management.deployment/packagemanagerdebugsettings_setcontentgroupstateasync_1791709366.md @@ -0,0 +1,38 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManagerDebugSettings.SetContentGroupStateAsync(Windows.ApplicationModel.Package,System.String,Windows.ApplicationModel.PackageContentGroupState,System.Double) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManagerDebugSettings.SetContentGroupStateAsync + +## -description +Sets the staging state of a content group for debugging. + +## -params + +## -param package +The app package. + +## -param contentGroupName +The content group name. An AppxContentGroupMap.xml must be present when the app is registered for this API to work. + +## -param state +The [PackageContentGroupState](../Windows.ApplicationModel/PackageContentGroupState.md) enum value. + +## -param completionPercentage +The simulated percent install completion. A value between 0 and 100.0. A value greater than 100 is clamped to 100. + +## -returns +Returns an IAsyncAction that completes when the state has changed. + +## -remarks +The state of the required content group (which is specified by PackageContentGroup.RequiredGroupName) cannot be changed. The method will fail if this group is specified. + +## -see-also + +## -examples + diff --git a/windows.management.deployment/packagemanagerdebugsettings_setcontentgroupstateasync_476361510.md b/windows.management.deployment/packagemanagerdebugsettings_setcontentgroupstateasync_476361510.md new file mode 100644 index 0000000000..f8a054ce4c --- /dev/null +++ b/windows.management.deployment/packagemanagerdebugsettings_setcontentgroupstateasync_476361510.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Management.Deployment.PackageManagerDebugSettings.SetContentGroupStateAsync(Windows.ApplicationModel.Package,System.String,Windows.ApplicationModel.PackageContentGroupState) +-api-type: winrt method +--- + + + +# Windows.Management.Deployment.PackageManagerDebugSettings.SetContentGroupStateAsync + +## -description +Sets the staging state of a content group for debugging. + +## -params + +## -param package +The app package. + +## -param contentGroupName +The content group name. An AppxContentGroupMap.xml must be present when the app is registered for this API to work. + +## -param state +The [PackageContentGroupState](../Windows.ApplicationModel/PackageContentGroupState.md) enum value. + +## -returns +Returns an IAsyncAction that completes when the state has changed. + +## -remarks + +## -see-also + +## -examples \ No newline at end of file diff --git a/windows.management.policies/namedpolicy.md b/windows.management.policies/namedpolicy.md new file mode 100644 index 0000000000..bb101a1543 --- /dev/null +++ b/windows.management.policies/namedpolicy.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Management.Policies.NamedPolicy +-api-type: winrt class +--- + + + +# Windows.Management.Policies.NamedPolicy + +## -description +Provides functionality to get Mobile Device Management (MDM) policy information. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicy_getpolicyfrompath_340705329.md b/windows.management.policies/namedpolicy_getpolicyfrompath_340705329.md new file mode 100644 index 0000000000..566a64b06f --- /dev/null +++ b/windows.management.policies/namedpolicy_getpolicyfrompath_340705329.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Management.Policies.NamedPolicy.GetPolicyFromPath(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Policies.NamedPolicy.GetPolicyFromPath + +## -description +Gets the valid MDM policy information given a specified policy name and area name. + +## -params + +## -param area +A string representing the area name for a policy. + +## -param name +A string representing the name of the policy. + +## -returns +The NamedPolicyData for the policy specified by the area and name parameters. + +## -remarks +For a complete list of valid area names and policy names, see the Policy Tables in [Policy CSP](https://msdn.microsoft.com/windows/hardware/commercialize/customize/mdm/policy-configuration-service-provider). + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicy_getpolicyfrompathforuser_519375791.md b/windows.management.policies/namedpolicy_getpolicyfrompathforuser_519375791.md new file mode 100644 index 0000000000..2a372922fa --- /dev/null +++ b/windows.management.policies/namedpolicy_getpolicyfrompathforuser_519375791.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Management.Policies.NamedPolicy.GetPolicyFromPathForUser(Windows.System.User,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Management.Policies.NamedPolicy.GetPolicyFromPathForUser + +## -description +Gets a valid MDM user policy given the specified MDM policy name and area name. This is more user friendly than [GetPolicyFromPath](namedpolicy_getpolicyfrompath_340705329.md). + +## -params + +## -param user +The user data for user policies. + +## -param area +A string representing the area name for a policy. + +## -param name +A string representing the name of the policy. + +## -returns +The NamedPolicyData for the policy specified by the user, area, and name parameters. + +## -remarks + +## -see-also +[Policy CSP](https://msdn.microsoft.com/windows/hardware/commercialize/customize/mdm/policy-configuration-service-provider) + +## -examples + diff --git a/windows.management.policies/namedpolicydata.md b/windows.management.policies/namedpolicydata.md new file mode 100644 index 0000000000..f8b9a211b6 --- /dev/null +++ b/windows.management.policies/namedpolicydata.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Management.Policies.NamedPolicyData +-api-type: winrt class +--- + + + +# Windows.Management.Policies.NamedPolicyData + +## -description +Policy data information for mobile device management. + +## -remarks +Policy values can be several types, some of which include: integers, strings, booleans, and binaries. Note that each policy supports one data type, and the policy data type cannot change once it's defined. + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_area.md b/windows.management.policies/namedpolicydata_area.md new file mode 100644 index 0000000000..7f2d46b232 --- /dev/null +++ b/windows.management.policies/namedpolicydata_area.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.Policies.NamedPolicyData.Area +-api-type: winrt property +--- + + + +# Windows.Management.Policies.NamedPolicyData.Area + +## -description +Gets the MDM policy area name. + +## -property-value +The MDM policy area name. + +## -remarks + +## -see-also +[Policy CSP](https://msdn.microsoft.com/windows/hardware/commercialize/customize/mdm/policy-configuration-service-provider) + +## -examples + diff --git a/windows.management.policies/namedpolicydata_changed.md b/windows.management.policies/namedpolicydata_changed.md new file mode 100644 index 0000000000..43458d8255 --- /dev/null +++ b/windows.management.policies/namedpolicydata_changed.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Management.Policies.NamedPolicyData.Changed +-api-type: winrt event +--- + + + +# Windows.Management.Policies.NamedPolicyData.Changed + +## -description +Occurs when the MDM policy is changed. + +## -remarks +To determine any individual MDM policy's state, the developer must requery any policy in the policy area. + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_getbinary_852554179.md b/windows.management.policies/namedpolicydata_getbinary_852554179.md new file mode 100644 index 0000000000..34414ae0cb --- /dev/null +++ b/windows.management.policies/namedpolicydata_getbinary_852554179.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Management.Policies.NamedPolicyData.GetBinary +-api-type: winrt method +--- + + + +# Windows.Management.Policies.NamedPolicyData.GetBinary + +## -description +Gets the binary representation of the MDM policy value. + +## -params + +## -returns +IBuffer containing the binary value of the MDM policy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_getboolean_1304335680.md b/windows.management.policies/namedpolicydata_getboolean_1304335680.md new file mode 100644 index 0000000000..1e7ee7ecf9 --- /dev/null +++ b/windows.management.policies/namedpolicydata_getboolean_1304335680.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Management.Policies.NamedPolicyData.GetBoolean +-api-type: winrt method +--- + + + +# Windows.Management.Policies.NamedPolicyData.GetBoolean + +## -description +Gets the boolean representation of the MDM policy value. + +## -params + +## -returns +The boolean value of the MDM policy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_getint32_2082813446.md b/windows.management.policies/namedpolicydata_getint32_2082813446.md new file mode 100644 index 0000000000..eaccf723ad --- /dev/null +++ b/windows.management.policies/namedpolicydata_getint32_2082813446.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Management.Policies.NamedPolicyData.GetInt32 +-api-type: winrt method +--- + + + +# Windows.Management.Policies.NamedPolicyData.GetInt32 + +## -description +Gets the 32 bit integer representation of the MDM policy value. + +## -params + +## -returns +The 32 bit integer value of the MDM policy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_getint64_305627891.md b/windows.management.policies/namedpolicydata_getint64_305627891.md new file mode 100644 index 0000000000..1110cff763 --- /dev/null +++ b/windows.management.policies/namedpolicydata_getint64_305627891.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Management.Policies.NamedPolicyData.GetInt64 +-api-type: winrt method +--- + + + +# Windows.Management.Policies.NamedPolicyData.GetInt64 + +## -description +Gets the 64 bit integer representation of the MDM policy value. + +## -params + +## -returns +The 64 bit integer value of the MDM policy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_getstring_1001279800.md b/windows.management.policies/namedpolicydata_getstring_1001279800.md new file mode 100644 index 0000000000..de8a802bc2 --- /dev/null +++ b/windows.management.policies/namedpolicydata_getstring_1001279800.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Management.Policies.NamedPolicyData.GetString +-api-type: winrt method +--- + + + +# Windows.Management.Policies.NamedPolicyData.GetString + +## -description +Gets the string representation of the MDM policy value. + +## -params + +## -returns +The string value of the MDM policy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_ismanaged.md b/windows.management.policies/namedpolicydata_ismanaged.md new file mode 100644 index 0000000000..adc34b1145 --- /dev/null +++ b/windows.management.policies/namedpolicydata_ismanaged.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.Policies.NamedPolicyData.IsManaged +-api-type: winrt property +--- + + + +# Windows.Management.Policies.NamedPolicyData.IsManaged + +## -description +Determines whether an MDM policy is actively managed or not. + +## -property-value +True if the policy is managed; False if the policy is not managed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_isuserpolicy.md b/windows.management.policies/namedpolicydata_isuserpolicy.md new file mode 100644 index 0000000000..b2e4b4acf4 --- /dev/null +++ b/windows.management.policies/namedpolicydata_isuserpolicy.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.Policies.NamedPolicyData.IsUserPolicy +-api-type: winrt property +--- + + + +# Windows.Management.Policies.NamedPolicyData.IsUserPolicy + +## -description +Determines whether an MDM policy is a user policy or not. + +## -property-value +True if the policy is a user policy; False if the policy is not a user policy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicydata_kind.md b/windows.management.policies/namedpolicydata_kind.md new file mode 100644 index 0000000000..f6ccd32656 --- /dev/null +++ b/windows.management.policies/namedpolicydata_kind.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.Policies.NamedPolicyData.Kind +-api-type: winrt property +--- + + + +# Windows.Management.Policies.NamedPolicyData.Kind + +## -description +Gets the type of the MDM policy value. + +## -property-value +The type of the named MDM policy from the [NamedPolicyKind](NamedPolicyKind.md) enumeration. + +## -remarks + +## -see-also +[NamedPolicyKind](NamedPolicyKind.md) enumeration + +## -examples + diff --git a/windows.management.policies/namedpolicydata_name.md b/windows.management.policies/namedpolicydata_name.md new file mode 100644 index 0000000000..3382ed6e1a --- /dev/null +++ b/windows.management.policies/namedpolicydata_name.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.Policies.NamedPolicyData.Name +-api-type: winrt property +--- + + + +# Windows.Management.Policies.NamedPolicyData.Name + +## -description +Gets the MDM policy name value. + +## -property-value +The MDM policy name value. + +## -remarks + +## -see-also +[Policy CSP](https://msdn.microsoft.com/windows/hardware/commercialize/customize/mdm/policy-configuration-service-provider) + +## -examples + diff --git a/windows.management.policies/namedpolicydata_user.md b/windows.management.policies/namedpolicydata_user.md new file mode 100644 index 0000000000..a90de0e7d8 --- /dev/null +++ b/windows.management.policies/namedpolicydata_user.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.Policies.NamedPolicyData.User +-api-type: winrt property +--- + + + +# Windows.Management.Policies.NamedPolicyData.User + +## -description +Gets the user's data for the MDM user policy. + +## -property-value +[Windows.System.User](../windows.system/user.md) associated with the user policy. + +## -remarks +This is only valid for user MDM policies. + +## -see-also + +## -examples + diff --git a/windows.management.policies/namedpolicykind.md b/windows.management.policies/namedpolicykind.md new file mode 100644 index 0000000000..e72f3edb01 --- /dev/null +++ b/windows.management.policies/namedpolicykind.md @@ -0,0 +1,46 @@ +--- +-api-id: T:Windows.Management.Policies.NamedPolicyKind +-api-type: winrt enumeration +--- + + + +# Windows.Management.Policies.NamedPolicyKind + +## -description +Possible data types representing the MDM policy value. + +## -enum-fields +## -field Invalid:0 +The policy is invalid. + +## -field Binary:1 +The policy is represented by a binary. + +## -field Boolean:2 +The policy is represented by a boolean. + +## -field Int32:3 +The policy is represented by a 32 bit integer. + +## -field Int64:4 +The policy is represented by a 64 bit integer. + +## -field String:5 +The policy is represented by a string. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management.policies/windows_management_policies.md b/windows.management.policies/windows_management_policies.md new file mode 100644 index 0000000000..ec45248cd7 --- /dev/null +++ b/windows.management.policies/windows_management_policies.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.Management.Policies +-api-type: winrt namespace +--- + + + +# Windows.Management.Policies + +## -description +Provides the ability for Universal Windows Platform (UWP) apps to query the current Mobile Device Management (MDM) policies on a device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert.md b/windows.management/mdmalert.md new file mode 100644 index 0000000000..6805d6d7c0 --- /dev/null +++ b/windows.management/mdmalert.md @@ -0,0 +1,55 @@ +--- +-api-id: T:Windows.Management.MdmAlert +-api-type: winrt class +--- + + + +# Windows.Management.MdmAlert + +## -description +Provides functionality to configure the data sent to the mobile device management server. + +## -remarks +There are two uses of MdmAlert: + +1. Before you start an MdmSession: Create an alert and customize the alert parameters. +2. After you start an MdmSession: Query the session for results from the alert, including status sent back by the server for the alert. + +Note: The generic alert (1226) is most common. + +## -see-also + +## -examples + +```cpp +void MultipleMdmAlerts() +{ + Log::Comment(WEX::Common::String().Format(L"Attempt to start syncing with two Alerts...")); + Log::Comment(WEX::Common::String().Format(L"Fill in all members of first alert.")); + + Windows::Management::MdmAlert^ myAlert = ref new Windows::Management::MdmAlert(); + + // This format is mandated by the OMA-DM standards for alerts. + myAlert->Type = ref new Platform::String(L"Reversed-Domain-Name:org.domain.samplealert"); + myAlert->Format = Windows::Management::MdmAlertDataType::String; + myAlert->Data = ref new Platform::String(L"alert-specific content."); + myAlert->Mark = Windows::Management::MdmAlertMark::Critical; + + // Source and Target URIs are relative to the device and typically in the MDM namespace. + // Here, they indicate that an app was installed at "InstallSample" and the resulting + // inventory location of the app is at "Results". + myAlert->Source = ref new Platform::String(L"./Vendor/MSFT/AppManagement/InstallSample"); + myAlert->Target = ref new Platform::String(L"./Vendor/MSFT/AppManagement/Results"); + + Windows::Management::MdmAlert^ myAlertNext = ref new Windows::Management::MdmAlert(); + myAlertNext->Type = ref new Platform::String(L"Reversed-Domain-Name:org.domain.nextalert"); + + Windows::Foundation::Collections::IVector^ alertList = ref new Platform::Collections::Vector(); + + alertList->Append(myAlert); + alertList->Append(myAlertNext); +} +``` diff --git a/windows.management/mdmalert_data.md b/windows.management/mdmalert_data.md new file mode 100644 index 0000000000..c98b18a411 --- /dev/null +++ b/windows.management/mdmalert_data.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.MdmAlert.Data +-api-type: winrt property +--- + + + +# Windows.Management.MdmAlert.Data + +## -description +Custom MDM data sent to the server. + +## -property-value +String form of the data sent to the server. + +## -remarks +The [MdmSession](MdmSession.md) can be configured to allow callers to configure zero or more alerts when initiating a session with an MDM server. + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert_format.md b/windows.management/mdmalert_format.md new file mode 100644 index 0000000000..2229c803af --- /dev/null +++ b/windows.management/mdmalert_format.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.MdmAlert.Format +-api-type: winrt property +--- + + + +# Windows.Management.MdmAlert.Format + +## -description +The data format of the MDM alert. + +## -property-value +An [MdmAlertDataType](MdmAlertDataType.md) enumeration value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert_mark.md b/windows.management/mdmalert_mark.md new file mode 100644 index 0000000000..9e2b82dea1 --- /dev/null +++ b/windows.management/mdmalert_mark.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.MdmAlert.Mark +-api-type: winrt property +--- + + + +# Windows.Management.MdmAlert.Mark + +## -description +The priority or criticality of the alert. + +## -property-value +An [MdmAlertMark](MdmAlertMark.md) enumeration value. + +## -remarks +These values are limited and set by the Open Mobile Alliance (OMA) standard. + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert_mdmalert_1221375020.md b/windows.management/mdmalert_mdmalert_1221375020.md new file mode 100644 index 0000000000..4859eacdb0 --- /dev/null +++ b/windows.management/mdmalert_mdmalert_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Management.MdmAlert.#ctor +-api-type: winrt method +--- + + + +# Windows.Management.MdmAlert.MdmAlert + +## -description +An MDM alert with custom data fields. + +## -remarks +See the example at [MdmAlert](MdmAlert.md) for how to configure an alert. + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert_source.md b/windows.management/mdmalert_source.md new file mode 100644 index 0000000000..1b9511904a --- /dev/null +++ b/windows.management/mdmalert_source.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.MdmAlert.Source +-api-type: winrt property +--- + + + +# Windows.Management.MdmAlert.Source + +## -description +The local URI path to the source of the alert. + +## -property-value +The string value of the URI path. + +## -remarks +This is an optional property. + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert_status.md b/windows.management/mdmalert_status.md new file mode 100644 index 0000000000..9d05b4d792 --- /dev/null +++ b/windows.management/mdmalert_status.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.MdmAlert.Status +-api-type: winrt property +--- + + + +# Windows.Management.MdmAlert.Status + +## -description +A read-only status code sent by the server in response to the alert. + +## -property-value +Integer form of the status code (200, 404, etc.). + +## -remarks +For a complete list of status codes, see the SyncML response status codes table in [OMA DM protocol support](https://aka.ms/oma-dm-support). + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert_target.md b/windows.management/mdmalert_target.md new file mode 100644 index 0000000000..150d93e768 --- /dev/null +++ b/windows.management/mdmalert_target.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Management.MdmAlert.Target +-api-type: winrt property +--- + + + +# Windows.Management.MdmAlert.Target + +## -description +The local URI path to the inventory location of the application. + +## -property-value +The string value of the URI path. + +## -remarks +This is an optional property. + +## -see-also + +## -examples + diff --git a/windows.management/mdmalert_type.md b/windows.management/mdmalert_type.md new file mode 100644 index 0000000000..52e19ad1ae --- /dev/null +++ b/windows.management/mdmalert_type.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Management.MdmAlert.Type +-api-type: winrt property +--- + + + +# Windows.Management.MdmAlert.Type + +## -description +The type of the alert. This is also the alert ID. + +## -property-value +A reversed domain name formatted string. + +## -remarks +This format is mandated by the OMA-DM standard and follows the pattern: "Reversed-Domain-Name:<your-domain-info-here>" + +See [MdmAlert](MdmAlert.md) for an example of how to set this property. + +## -see-also + +## -examples + diff --git a/windows.management/mdmalertdatatype.md b/windows.management/mdmalertdatatype.md new file mode 100644 index 0000000000..e9e75155a4 --- /dev/null +++ b/windows.management/mdmalertdatatype.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.Management.MdmAlertDataType +-api-type: winrt enumeration +--- + + + +# Windows.Management.MdmAlertDataType + +## -description +The possible data formats of an MDM alert payload. + +## -enum-fields +## -field String:0 +String data. + +## -field Base64:1 +Base-64 data. + +## -field Boolean:2 +Boolean data. + +## -field Integer:3 +Integer data. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmalertmark.md b/windows.management/mdmalertmark.md new file mode 100644 index 0000000000..0aea90fe9b --- /dev/null +++ b/windows.management/mdmalertmark.md @@ -0,0 +1,43 @@ +--- +-api-id: T:Windows.Management.MdmAlertMark +-api-type: winrt enumeration +--- + + + +# Windows.Management.MdmAlertMark + +## -description +Values indicating priority or criticality of the MDM alert. + +## -enum-fields +## -field None:0 +No information. + +## -field Fatal:1 +The alert is fatal. + +## -field Critical:2 +The alert is critical. + +## -field Warning:3 +The alert is a warning. + +## -field Informational:4 +The alert is informational. + +## -remarks +These values are specified by the OMA-DM standard/ + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession.md b/windows.management/mdmsession.md new file mode 100644 index 0000000000..c7ab26f5f4 --- /dev/null +++ b/windows.management/mdmsession.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Management.MdmSession +-api-type: winrt class +--- + + + +# Windows.Management.MdmSession + +## -description +Provides functionality to start an MDM session with the server. + +## -remarks +Once a session is complete, the caller can determine the server's response to each alert from the client. By default, sessions persist so clients can look up the results later. + +Data from a session can be deleted by calling [MdmSession.Delete](mdmsession_delete_432759908.md) or [MdmSessionManager.DeleteSessionById](mdmsessionmanager_deletesessionbyid_612343759.md) once the session is complete. + +> Note: MDM sessions are **not** abortable. If the caller cancels a session and starts a new one, the original sessions will continue in the background until it's complete. + +This API does not expose the server ID or enrollment. + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_alerts.md b/windows.management/mdmsession_alerts.md new file mode 100644 index 0000000000..7c0a393c77 --- /dev/null +++ b/windows.management/mdmsession_alerts.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.MdmSession.Alerts +-api-type: winrt property +--- + + + +# Windows.Management.MdmSession.Alerts + +## -description +A vector list of all MdmAlerts for the current session. + +## -property-value +A vector list of [MdmAlerts](MdmAlerts.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_attachasync_267853378.md b/windows.management/mdmsession_attachasync_267853378.md new file mode 100644 index 0000000000..a8a9561f9a --- /dev/null +++ b/windows.management/mdmsession_attachasync_267853378.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Management.MdmSession.AttachAsync +-api-type: winrt method +--- + + + +# Windows.Management.MdmSession.AttachAsync + +## -description +Allows the caller to re-open an existing MDM session. + +## -returns +Results of the operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_delete_432759908.md b/windows.management/mdmsession_delete_432759908.md new file mode 100644 index 0000000000..0b61b6dbf9 --- /dev/null +++ b/windows.management/mdmsession_delete_432759908.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Management.MdmSession.Delete +-api-type: winrt method +--- + + + +# Windows.Management.MdmSession.Delete + +## -description +Deletes the MDM session. + +## -remarks +If the session is currently running (in the background), you must wait for it to complete before you can delete it. + +Deleted sessions can't be tracked after this method returns. + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_extendederror.md b/windows.management/mdmsession_extendederror.md new file mode 100644 index 0000000000..a193136823 --- /dev/null +++ b/windows.management/mdmsession_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.MdmSession.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Management.MdmSession.ExtendedError + +## -description +The extended error code for an MDM session. + +## -property-value +HRESULT value of the error. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_id.md b/windows.management/mdmsession_id.md new file mode 100644 index 0000000000..66c2a4908c --- /dev/null +++ b/windows.management/mdmsession_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.MdmSession.Id +-api-type: winrt property +--- + + + +# Windows.Management.MdmSession.Id + +## -description +The ID for the MDM session. + +## -property-value +The string value of the session ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_startasync_1931900819.md b/windows.management/mdmsession_startasync_1931900819.md new file mode 100644 index 0000000000..e877c90154 --- /dev/null +++ b/windows.management/mdmsession_startasync_1931900819.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Management.MdmSession.StartAsync +-api-type: winrt method +--- + + + +# Windows.Management.MdmSession.StartAsync + +## -description +Start an MDM session with a constant alerts. + +## -returns +Results of the operation. + +## -remarks +This method can be used if you simply want to check-in with the MDM server. + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_startasync_2129544648.md b/windows.management/mdmsession_startasync_2129544648.md new file mode 100644 index 0000000000..27632651f7 --- /dev/null +++ b/windows.management/mdmsession_startasync_2129544648.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Management.MdmSession.StartAsync(Windows.Foundation.Collections.IIterable{Windows.Management.MdmAlert}) +-api-type: winrt method +--- + + + +# Windows.Management.MdmSession.StartAsync + +## -description +Starts an MDM session with custom alerts. + +## -params +## -param alerts +An iterable list of all custom [MdmAlerts](MdmAlert.md). + +## -returns +Results of the operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsession_state.md b/windows.management/mdmsession_state.md new file mode 100644 index 0000000000..426d425794 --- /dev/null +++ b/windows.management/mdmsession_state.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.MdmSession.State +-api-type: winrt property +--- + + + +# Windows.Management.MdmSession.State + +## -description +Gets the state of an MDM session. + +## -property-value +An MdmSessionState enumeration value for the state of the session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsessionmanager.md b/windows.management/mdmsessionmanager.md new file mode 100644 index 0000000000..19053217f0 --- /dev/null +++ b/windows.management/mdmsessionmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Management.MdmSessionManager +-api-type: winrt class +--- + + + +# Windows.Management.MdmSessionManager + +## -description +This is used as an entry point for creating new sessions, viewing old sessions, or cleanup. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsessionmanager_deletesessionbyid_612343759.md b/windows.management/mdmsessionmanager_deletesessionbyid_612343759.md new file mode 100644 index 0000000000..3874cb5349 --- /dev/null +++ b/windows.management/mdmsessionmanager_deletesessionbyid_612343759.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Management.MdmSessionManager.DeleteSessionById(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.MdmSessionManager.DeleteSessionById + +## -description +Deletes past session information. + +## -params +## -param sessionId +The string value of the session ID. + +## -remarks +The caller must wait until the session if finished running (in the background) until it can be deleted. + +## -see-also + +## -examples + diff --git a/windows.management/mdmsessionmanager_getsessionbyid_1342462705.md b/windows.management/mdmsessionmanager_getsessionbyid_1342462705.md new file mode 100644 index 0000000000..4669dfd757 --- /dev/null +++ b/windows.management/mdmsessionmanager_getsessionbyid_1342462705.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Management.MdmSessionManager.GetSessionById(System.String) +-api-type: winrt method +--- + + + +# Windows.Management.MdmSessionManager.GetSessionById + +## -description +Gets the MDM session's information given the session's ID. + +## -params +## -param sessionId +The string value of the MDM session ID. + +## -returns +The [MdmSession](MdmSession.md) corresponding to the provided session ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsessionmanager_sessionids.md b/windows.management/mdmsessionmanager_sessionids.md new file mode 100644 index 0000000000..8d46af4577 --- /dev/null +++ b/windows.management/mdmsessionmanager_sessionids.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Management.MdmSessionManager.SessionIds +-api-type: winrt property +--- + + + +# Windows.Management.MdmSessionManager.SessionIds + +## -description +Gets all MDM session IDs for the current enterprise account. + +## -property-value +An IVectorView containing the session IDs. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsessionmanager_trycreatesession_729539891.md b/windows.management/mdmsessionmanager_trycreatesession_729539891.md new file mode 100644 index 0000000000..af7e3b9519 --- /dev/null +++ b/windows.management/mdmsessionmanager_trycreatesession_729539891.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Management.MdmSessionManager.TryCreateSession +-api-type: winrt method +--- + + + +# Windows.Management.MdmSessionManager.TryCreateSession + +## -description +Attempts to start an MDM session for the current enterprise account. + +## -returns +The [MdmSession](MdmSession.md) information of the created session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/mdmsessionstate.md b/windows.management/mdmsessionstate.md new file mode 100644 index 0000000000..b454f1195b --- /dev/null +++ b/windows.management/mdmsessionstate.md @@ -0,0 +1,50 @@ +--- +-api-id: T:Windows.Management.MdmSessionState +-api-type: winrt enumeration +--- + + + +# Windows.Management.MdmSessionState + +## -description +The various states of an MDM session. + +## -enum-fields +## -field NotStarted:0 +The MDM session has not started. + +## -field Starting:1 +The MDM session is starting. + +## -field Connecting:2 +The MDM session is connecting to the server. + +## -field Communicating:3 +The MDM session is communicating with the server. + +## -field AlertStatusAvailable:4 +The MDM session has an alert status available. + +## -field Retrying:5 +The MDM session is retrying. + +## -field Completed:6 +The MDM session is complete. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.management/windows_management.md b/windows.management/windows_management.md new file mode 100644 index 0000000000..64cc3bbdfa --- /dev/null +++ b/windows.management/windows_management.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.Management +-api-type: winrt namespace +--- + + + +# Windows.Management + +## -description +Provides capabilities to force a sync from an MDM device to the server. This MDM sync protocol is based on the Open Mobile Alliance - Device Management standard. + +## -remarks +This API does not expose the server ID or enrollment. The first valid enterprise enrollment found is used. + +## -see-also + +## -examples \ No newline at end of file diff --git a/windows.media.capture.frames/buffermediaframe.md b/windows.media.capture.frames/buffermediaframe.md index 177194fd9b..2b34ce0110 100644 --- a/windows.media.capture.frames/buffermediaframe.md +++ b/windows.media.capture.frames/buffermediaframe.md @@ -13,9 +13,11 @@ public class BufferMediaFrame : Windows.Media.Capture.Frames.IBufferMediaFrame Represents a frame from a [MediaFrameSource](mediaframesource.md) that provides data in an [IBuffer](../windows.storage.streams/ibuffer.md). ## -remarks -Get an instance of this class by accessing the [BufferMediaFrame](buffermediaframe.md) property of a [MediaFrameReference](mediaframereference.md) object that was obtained from a media frame source. +Get an instance of this class by accessing the [BufferMediaFrame](buffermediaframe.md) property of a [MediaFrameReference](mediaframereference.md) object that was obtained from a media frame source. The **BufferMediaFrame** property of a **MediaFrameReference** will always be non-null. This is not true for other frame types, such as [VideoMediaFrame](videomediaframe.md), which will be null if the buffer doesn't contain 2D image data or contains data in an unknown format. + +A **BufferMediaFrame** represents the 1D buffer. If the underlying sample returned by the pipeline contains non-consecutive data, the system uses [IMFMediaBuffer::Lock](https://msdn.microsoft.com/en-us/library/windows/desktop/bb970366(v=vs.85).aspx) to copy the 2D buffer into the 1D buffer. For this reason, it is recommended that you use [BufferMediaFrame](buffermediaframe.md) for arbitrary buffers, such as skeleton or body tracking data, but that you use [VideoMediaFrame](videomediaframe.md) for 2D buffers to avoid extra copy operations. + -A **BufferMediaFrame** represents the 1D buffer. If the underlying sample returned by the pipeline contains non-consecutive data, the system uses [IMFMediaBuffer::Lock](XREF:TODO:mf.imfmediabuffer_lock) to copy the 2D buffer into the 1D buffer. For this reason, it is recommended that you use [BufferMediaFrame](buffermediaframe.md) for arbitrary buffers, such as skeleton or body tracking data, but that you use [VideoMediaFrame](videomediaframe.md) for 2D buffers to avoid extra copy operations. For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). diff --git a/windows.media.capture.frames/depthmediaframe_maxreliabledepth.md b/windows.media.capture.frames/depthmediaframe_maxreliabledepth.md new file mode 100644 index 0000000000..13ced528c1 --- /dev/null +++ b/windows.media.capture.frames/depthmediaframe_maxreliabledepth.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.MaxReliableDepth +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrame.MaxReliableDepth + +## -description +Gets a value that specifies the maximum reliable depth value for the camera that captured the depth frame. + +## -property-value +A value that specifies the maximum reliable depth value for the camera that captured the depth frame. + +## -remarks +A depth camera may not be able to reliably sense the depth for the full range of the UInt16 value that is used to express depth in a depth media frame. The value of **MaxReliableDepth** is set by the depth camera device to indicate the upper limit of values within the UInt16 range for which the device can reliably capture depth data. You can safely clamp depth pixel values greater than this value. The lower limit of reliable depth values is specified with the [MinReliableDepth](./depthmediaframe_minreliabledepth.md) property. These properties are expressed in the same units as the individual depth pixel values. You can convert **MaxReliableDepth** to meters by multiplying it by the value of the [DepthScaleInMeters](./depthmediaformat_depthscaleinmeters.md) property of the [DepthFormat](./depthmediaframe_depthformat.md) property of the [DepthMediaFrame](./depthmediaframe.md) object. + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/depthmediaframe_minreliabledepth.md b/windows.media.capture.frames/depthmediaframe_minreliabledepth.md new file mode 100644 index 0000000000..421721fabd --- /dev/null +++ b/windows.media.capture.frames/depthmediaframe_minreliabledepth.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Capture.Frames.DepthMediaFrame.MinReliableDepth +-api-type: winrt property +--- + + + +# Windows.Media.Capture.Frames.DepthMediaFrame.MinReliableDepth + +## -description +Gets a value that specifies the minimum reliable depth value for the camera that captured the depth frame. + +## -property-value +A value that specifies the minimum reliable depth value for the camera that captured the depth frame. + +## -remarks +A depth camera may not be able to reliably sense the depth for the full range of the UInt16 value that is used to express depth in a depth media frame. The value of **MinReliableDepth** is set by the depth camera device to indicate the lower limit of values within the UInt16 range for which the device can reliably capture depth data. You can safely clamp depth pixel values lower than this value. The upper limit of reliable depth values is specified with the [MaxReliableDepth](./depthmediaframe_maxreliabledepth.md) property. These properties are expressed in the same units as the individual depth pixel values. You can convert **MinReliableDepth** to meters by multiplying it by the value of the [DepthScaleInMeters](./depthmediaformat_depthscaleinmeters.md) property of the [DepthFormat](./depthmediaframe_depthformat.md) property of the [DepthMediaFrame](./depthmediaframe.md) object. + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/mediaframeformat_subtype.md b/windows.media.capture.frames/mediaframeformat_subtype.md index fbf074d501..e9d9c796d1 100644 --- a/windows.media.capture.frames/mediaframeformat_subtype.md +++ b/windows.media.capture.frames/mediaframeformat_subtype.md @@ -16,7 +16,7 @@ Gets a string identifying the subtype of a media frame. A string identifying the subtype of a media frame. ## -remarks -The value of this property is one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. +The value of this property is one of the strings defined by the properties of the [MediaEncodingSubtypes](../windows.media.mediaproperties/mediaencodingsubtypes.md) class. If the friendly name for the subtype can't be found, the GUID for the subtype is returned in plain-text format. ## -examples diff --git a/windows.media.capture.frames/mediaframereader.md b/windows.media.capture.frames/mediaframereader.md index 179172ffb0..5c83eef8db 100644 --- a/windows.media.capture.frames/mediaframereader.md +++ b/windows.media.capture.frames/mediaframereader.md @@ -1,23 +1,23 @@ ---- --api-id: T:Windows.Media.Capture.Frames.MediaFrameReader --api-type: winrt class ---- - - - -# Windows.Media.Capture.Frames.MediaFrameReader - -## -description -Provides access to frames from a [MediaFrameSource](mediaframesource.md) and notification when a new frame arrives. - -## -remarks -Get an instance of this class by calling [CreateFrameReaderAsync](../windows.media.capture/mediacapture_createframereaderasync.md) on a [MediaCapture](http://msdn.microsoft.com/library/1361e82a-202f-40f7-9239-56f00dfca54b) object that has been initialized to use the desired media frame source. - -For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). - -## -examples - -## -see-also +--- +-api-id: T:Windows.Media.Capture.Frames.MediaFrameReader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader + +## -description +Provides access to frames from a [MediaFrameSource](mediaframesource.md) and notification when a new frame arrives. + +## -remarks +Get an instance of this class by calling [CreateFrameReaderAsync](../windows.media.capture/mediacapture_createframereaderasync.md) on a [MediaCapture](http://msdn.microsoft.com/library/1361e82a-202f-40f7-9239-56f00dfca54b) object that has been initialized to use the desired media frame source. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also [IClosable](../windows.foundation/iclosable.md), [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframereader_framearrived.md b/windows.media.capture.frames/mediaframereader_framearrived.md index 3622cf7368..da1c33d185 100644 --- a/windows.media.capture.frames/mediaframereader_framearrived.md +++ b/windows.media.capture.frames/mediaframereader_framearrived.md @@ -1,20 +1,20 @@ ---- --api-id: E:Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived --api-type: winrt event ---- - - - -# Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived - -## -description -Occurs when a new frame arrives from the media frame source associated with the [MediaFrameReader](mediaframereader.md). - -## -remarks -In the handler for the **FrameArrived** event, call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. - -## -examples - -## -see-also +--- +-api-id: E:Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived +-api-type: winrt event +--- + + + +# Windows.Media.Capture.Frames.MediaFrameReader.FrameArrived + +## -description +Occurs when a new frame arrives from the media frame source associated with the [MediaFrameReader](mediaframereader.md). + +## -remarks +In the handler for the **FrameArrived** event, call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) to get a [MediaFrameReference](mediaframereference.md) representing the latest frame from the media frame source. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframereaderstartstatus.md b/windows.media.capture.frames/mediaframereaderstartstatus.md index 61707c0f76..afcbb3ac85 100644 --- a/windows.media.capture.frames/mediaframereaderstartstatus.md +++ b/windows.media.capture.frames/mediaframereaderstartstatus.md @@ -30,4 +30,7 @@ The operation failed because the requested output format is not supported by the ## -examples -## -see-also \ No newline at end of file +## -see-also + +### -field ExclusiveControlNotAvailable:4 + diff --git a/windows.media.capture.frames/mediaframereference_close_811482585.md b/windows.media.capture.frames/mediaframereference_close_811482585.md index 91ed503008..dec5bf0427 100644 --- a/windows.media.capture.frames/mediaframereference_close_811482585.md +++ b/windows.media.capture.frames/mediaframereference_close_811482585.md @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- -api-id: M:Windows.Media.Capture.Frames.MediaFrameReference.Close -api-type: winrt method @@ -10,7 +11,7 @@ public void Close() # Windows.Media.Capture.Frames.MediaFrameReference.Close ## -description -Disposes of the object and associated resources. +Disposes of the object and associated resources. ## -remarks The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaFrameReference](mediaframereference.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. @@ -18,3 +19,4 @@ The **Close** method is used by Universal Windows app using JavaScript. For apps ## -examples ## -see-also + diff --git a/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md b/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md index 1e253a3fdc..c69a036919 100644 --- a/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md +++ b/windows.media.capture.frames/mediaframesource_setformatasync_966320450.md @@ -20,6 +20,8 @@ The new frame format for the media frame source. An asynchronous action. ## -remarks +This method is an alternative to [MediaCapture.SetEncodingPropertiesAsync](..\windows.media.capture\mediacapture_setencodingpropertiesasync_1218555455.md), but unlike **SetEncodingPropertiesAsync**, this method can be used with any stream, not just the color camera preview, record, and photo capture streams. + Get the list of supported frame formats for a media frame source by accessing the [SupportedFormats](mediaframesource_supportedformats.md) property. Get the current frame format of the media frame source by accessing the [CurrentFormat](mediaframesource_currentformat.md) property. diff --git a/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md b/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md index 8ce559e5be..de64017c8d 100644 --- a/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md +++ b/windows.media.capture.frames/mediaframesourcecontroller_getpropertyasync_1561087689.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync(System.String) --api-type: winrt method ---- - - - -# Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync - -## -description -Asynchronously gets an object that contains the value of a [MediaFrameSource](mediaframesource.md) property, if the property value is successfully retrieved, and describes the result status of the get operation. - -## -parameters -### -param propertyId -The identifier of the media frame source property to be retrieved. - -## -returns -An asynchronous operation that returns a [MediaFrameSourceGetPropertyResult](mediaframesourcegetpropertyresult.md) upon completion. - -## -remarks -To set the value of a media frame source property, use [SetPropertyAsync](mediaframesourcecontroller_setpropertyasync.md). - -## -examples - -## -see-also +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyAsync + +## -description +Asynchronously gets an object that contains the value of a [MediaFrameSource](mediaframesource.md) property, if the property value is successfully retrieved, and describes the result status of the get operation. + +## -parameters +### -param propertyId +The identifier of the media frame source property to be retrieved. + +## -returns +An asynchronous operation that returns a [MediaFrameSourceGetPropertyResult](mediaframesourcegetpropertyresult.md) upon completion. + +## -remarks +To set the value of a media frame source property, use [SetPropertyAsync](mediaframesourcecontroller_setpropertyasync.md). + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.media.capture.frames/mediaframesourcecontroller_getpropertybyextendedidasync_2013722339.md b/windows.media.capture.frames/mediaframesourcecontroller_getpropertybyextendedidasync_2013722339.md new file mode 100644 index 0000000000..d7d8d5893a --- /dev/null +++ b/windows.media.capture.frames/mediaframesourcecontroller_getpropertybyextendedidasync_2013722339.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyByExtendedIdAsync(System.Byte[],Windows.Foundation.IReference{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceController.GetPropertyByExtendedIdAsync + +## -description +Asynchronously gets the value of the property with the specified ID from a [MediaFrameSource](mediaframesource.md), using an extended ID with custom header information and specifying the maximum buffer size required to store the result. + +## -params + +## -param extendedPropertyId +A byte array containing the extended identifier data. + +## -param maxPropertyValueSize +The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the [Status](videodevicecontrollergetdevicepropertyresult_status.md) property of the returned [VideoDeviceControllerGetDevicePropertyResult](videodevicecontrollergetdevicepropertyresult.md) object will be **MaxPropertyValueSizeRequired**. If the value supplied is too small to store the result of the operation, the returned **Status** object will be **MaxPropertyValueSizeTooSmall**, which means that you can retry the call with a larger buffer size. + +## -returns +An asynchronous operation that, upon successful completion, returns a [MediaFrameSourceGetPropertyResult](mediaframesourcegetpropertyresult.md) object containing the status of the operation and, if successful, the returned property value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/mediaframesourcecontroller_setpropertybyextendedidasync_1978942442.md b/windows.media.capture.frames/mediaframesourcecontroller_setpropertybyextendedidasync_1978942442.md new file mode 100644 index 0000000000..f7e9472632 --- /dev/null +++ b/windows.media.capture.frames/mediaframesourcecontroller_setpropertybyextendedidasync_1978942442.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MediaFrameSourceController.SetPropertyByExtendedIdAsync(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MediaFrameSourceController.SetPropertyByExtendedIdAsync + +## -description +Asynchronously sets the value of the property with the specified ID on a [MediaFrameSource](mediaframesource.md), using an extended ID with custom header information. + +## -params + +## -param extendedPropertyId +A byte array containing the extended identifier data. + +## -param propertyValue +A byte array containing the value to be set for the property. + +## -returns +An asynchronous operation that, upon successful completion, returns a [MediaFrameSourceSetPropertyStatus](mediaframesourcesetpropertystatus.md) value indicating the status of the operation. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/mediaframesourcegetpropertystatus.md b/windows.media.capture.frames/mediaframesourcegetpropertystatus.md index c225e06cfd..60e87a90ab 100644 --- a/windows.media.capture.frames/mediaframesourcegetpropertystatus.md +++ b/windows.media.capture.frames/mediaframesourcegetpropertystatus.md @@ -30,4 +30,11 @@ The operation failed because the media frame source device is unavailable. ## -examples -## -see-also \ No newline at end of file +## -see-also + +### -field MaxPropertyValueSizeRequired:5 + + + +### -field MaxPropertyValueSizeTooSmall:4 + diff --git a/windows.media.capture.frames/multisourcemediaframearrivedeventargs.md b/windows.media.capture.frames/multisourcemediaframearrivedeventargs.md new file mode 100644 index 0000000000..8128da5970 --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframearrivedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Capture.Frames.MultiSourceMediaFrameArrivedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameArrivedEventArgs + +## -description +Provides data for the [MultiSourceMediaFrameReader.FrameArrived](./multisourceframereader_framearrived.md) event. + +## -remarks + + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereader.md b/windows.media.capture.frames/multisourcemediaframereader.md new file mode 100644 index 0000000000..d7e7feb508 --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereader.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.Media.Capture.Frames.MultiSourceMediaFrameReader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReader + +## -description +Provides access to time-correlated frames from multiple [MediaFrameSource](mediaframesource.md) and provides notifications when new frames arrive. This is useful if you need to process frames from different sources, such as a depth camera and an rbg camera, and you need to make sure that the frames from each source were captured close to each other in time. + +## -remarks +Get an instance of this class by calling [CreateMultiSourceFrameReaderAsync](../windows.media.capture/mediacapture_createmultisourceframereaderasync_1316837028.md) on a [MediaCapture](../windows.media.capture/mediacapture.md) object that has been initialized to use the desired media frame source. + +To read frames from one or more [MediaFrameSource](mediaframesource.md) objects without time correlation between different sources, you can use [MediaFrameReader](../mediaframereader.md). + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereader_close_811482585.md b/windows.media.capture.frames/multisourcemediaframereader_close_811482585.md new file mode 100644 index 0000000000..681a82145e --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereader_close_811482585.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.Close + +## -description +Disposes of the object and associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaFrameReference](mediaframereference.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + +## -examples + +## -see-also +[MediaFrameReference](mediaframereference.md) + diff --git a/windows.media.capture.frames/multisourcemediaframereader_framearrived.md b/windows.media.capture.frames/multisourcemediaframereader_framearrived.md new file mode 100644 index 0000000000..b1e88cd522 --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereader_framearrived.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.FrameArrived +-api-type: winrt event +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.FrameArrived + +## -description +Occurs when a new frame arrives from all of the media frame sources associated with the [MultiSourceMediaFrameReader](multisourcemediaframereader.md). + +## -remarks +In the handler for the **FrameArrived** event, call [TryAcquireLatestFrame](mediaframereader_tryacquirelatestframe.md) on the [MultiSourceMediaFrameReference](./multisourcemediaframereference.md) passed in as the sender parameter to the event handler to get a [MultiSourceMediaFrameReference](multisourcemediaframereference.md) representing the latest set of correlated frames from the media frame sources for which the reader was created. Then, get the time-correlated media frame from a particular media frame source by calling [TryGetFrameReferenceBySourceId](.\multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md) and passing in the value of the [MediaFrameSourceInfo.Id](./mediaframesourceinfo_id.md) property for the desired media frame source. + +Note that this event is only raised when a new frame is available from all of the media frame sources associated with the [MultiSourceMediaFrameReader](multisourcemediaframereader.md). For example, if one of the sources produces frames at twice the rate of another, half of the frames from the faster source will be dropped and this event will only be raised when the slower frame source has a new frame available. For this reason, it's a good idea to set up an event and signal it each time this event is raised. In a separate thread, you can check to see if the event has been signaled within a specified time window, 5 seconds for example. If the event has not been signaled with the time window, your app can deduce that one of the frame sources is no longer generating frames and that the reader should be stopped. + +For how-to guidance on working with time-correlated media frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + + +## -see-also +[Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereader_startasync_1931900819.md b/windows.media.capture.frames/multisourcemediaframereader_startasync_1931900819.md new file mode 100644 index 0000000000..e9238d4dff --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereader_startasync_1931900819.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.StartAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.StartAsync + +## -description +Asynchronously starts the reading of time-corellated frames from one or more [MediaFrameSource](mediaframesource.md) objects. + +## -returns +An asynchronous operation that returns a [MultiSourceMediaFrameReaderStartStatus](multisourcemediaframereaderstartstatus.md) on completion. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereader_stopasync_1648475005.md b/windows.media.capture.frames/multisourcemediaframereader_stopasync_1648475005.md new file mode 100644 index 0000000000..5956cec544 --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereader_stopasync_1648475005.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.StopAsync +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.StopAsync + +## -description +Asynchronously stops the reading of time-corellated frames from one or more [MediaFrameSource](mediaframesource.md) objects. + +## -returns +An asynchronous action + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereader_tryacquirelatestframe_612769713.md b/windows.media.capture.frames/multisourcemediaframereader_tryacquirelatestframe_612769713.md new file mode 100644 index 0000000000..d92d5efbed --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereader_tryacquirelatestframe_612769713.md @@ -0,0 +1,38 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.TryAcquireLatestFrame +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReader.TryAcquireLatestFrame + +## -description +Attempts to obtain a [MultiSourceMediaFrameReference](multisourcemediaframereference.md) object which provides access to the latest time-correlated frames from one or more [MediaFrameSource](mediaframesource.md) objects. + +## -returns +A [MultiSourceMediaFrameReference](multisourcemediaframereference.md) providing access to the latest frames from the media frame sources. + +## -remarks +After getting an instance of [MultiSourceMediaFrameReference](multisourcemediaframereference.md), get the time-correlated media frame from a particular media frame source by calling [MultiSourceMediaFrameReference.TryGetFrameReferenceBySourceId](.\multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md) and passing in the value of the [MediaFrameSourceInfo.Id](./mediaframesourceinfo_id.md) property for the desired media frame source. + + +Each [MultiSourceMediaFrameReader](multisourcemediaframereader.md) maintains a circular buffer of [MediaFrameReference](mediaframereference.md) objects obtained from **TryAcquireLatestFrame**. After all of the **MediaFrameReference** objects in the buffer have been used, subsequent calls to **TryAcquireLatestFrame** will cause the system to call [Close](mediaframereference_close.md) (or **Dispose** in C#) on the oldest buffer object in order to reuse it. Once the object has been disposed, you can no longer use it to access the frame data. For this reason, you should not store the **MediaFrameReference** object longer than you actually need to process the frame. If your app scenario requires you to keep a reference to the data for longer, you should use one of the APIs provided to get the underlying data. These methods include: + + ++ [BufferMediaFrame.Buffer](buffermediaframe_buffer.md) ++ [VideoMediaFrame.SoftwareBitmap](videomediaframe_softwarebitmap.md) ++ [VideoMediaFrame.GetVideoFrame](videomediaframe_getvideoframe.md) ++ [VideoMediaFrame.CameraIntrinsics](videomediaframe_cameraintrinsics.md) +It is the responsibility of the app to call [Close](mediaframereference_close.md) (or **Dispose**) on the objects returned by these APIs when they are no longer being used. + +> [!IMPORTANT] +> If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. + +## -examples + +## -see-also +[MediaFrameReader](mediaframereader.md) + diff --git a/windows.media.capture.frames/multisourcemediaframereaderstartstatus.md b/windows.media.capture.frames/multisourcemediaframereaderstartstatus.md new file mode 100644 index 0000000000..a804beb835 --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereaderstartstatus.md @@ -0,0 +1,43 @@ +--- +-api-id: T:Windows.Media.Capture.Frames.MultiSourceMediaFrameReaderStartStatus +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReaderStartStatus + +## -description +Specifies the status of a [MultiSourceMediaFrameReader](multisourcemediaframereader.md) start operation. A value from this enumeration is returned by the [MultiSourceMediaFrameReader.StartAsync](multisourcemediaframereader_startasync_1931900819.md) method. + +## -enum-fields + +## -field UnknownFailure:4 +There was an unknown failure. + +## -field Success:0 +The frame reader was started successfully. + +## -field NotSupported:1 +[MultiSourceMediaFrameReader](multisourcemediaframereader.md) is not supported for the current device. + +## -field InsufficientResources:2 +The reader could not be started due to insufficient system resources. + +## -field DeviceNotAvailable:3 +The reader could not be started because the capture device is unavailable. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereference.md b/windows.media.capture.frames/multisourcemediaframereference.md new file mode 100644 index 0000000000..06984e9c0f --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereference.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Media.Capture.Frames.MultiSourceMediaFrameReference +-api-type: winrt class +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReference + + +## -description +A wrapper class that provides access to time-correlated frames obtained from one or more [MediaFrameSource](mediaframesource.md) objects. Call [TryGetFrameReferenceBySourceId](multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md) to get the [MediaFrameReference](mediaframereference.md) representing a frame from a particular media frame source. + +## -remarks +To get an instance of [MultiSourceMediaFrameReference](multisourcemediaframereference.md) from a media frame source, create a [MultiSourceMediaFrameReader](multisourcemediaframereader.md) by calling [CreateMultiSourceFrameReaderAsync](../windows.media.capture/mediacapture_createmultisourceframereaderasync_1316837028.md) on a [MediaCapture](../windows.media.capture/mediacapture.md) object, passing in the [MediaFrameSource](mediaframesource.md) objects from which you want to read. After starting by calling [StartAsync](multisourcemediaframereader_startasync.md), call [TryAcquireLatestFrame](multisourcemediamediaframereader_tryacquirelatestframe.md) to get a **MultiSourceMediaFrameReference** which contains the latest correlated frames from the media frame sources. + +Get the time-correlated media frame from a particular media frame source by calling [MultiSourceMediaFrameReference.TryGetFrameReferenceBySourceId](.\multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md) and passing in the value of the [MediaFrameSourceInfo.Id](./mediaframesourceinfo_id.md) property for the desired media frame source. + +Each [MultiSourceMediaFrameReader](multisourcemediaframereader.md) maintains a circular buffer of **MediaFrameReference** objects obtained from [MultiSourceMediaFrameReference.TryGetFrameReferenceBySourceId](.\multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md). After all of the **MediaFrameReference** objects in the buffer have been used, subsequent calls to **TryAcquireLatestFrame** will cause the system to call [Close](mediaframereference_close.md) (or **Dispose** in C#) on the oldest buffer object in order to reuse it. Once the object has been disposed, you can no longer use it to access the frame data. For this reason, you should not store the **MediaFrameReference** object longer than you actually need to process the frame. If your app scenario requires you to keep a reference to the data for longer, you should use one of the APIs provided to get the underlying data. These methods include: + + ++ [BufferMediaFrame.Buffer](buffermediaframe_buffer.md) ++ [VideoMediaFrame.SoftwareBitmap](videomediaframe_softwarebitmap.md) ++ [VideoMediaFrame.GetVideoFrame](videomediaframe_getvideoframe.md) ++ [VideoMediaFrame.CameraIntrinsics](videomediaframe_cameraintrinsics.md) +It is the responsibility of the app to call [Close](mediaframereference_close.md) (or **Dispose**) on the objects returned by these APIs when they are no longer being used. + +> [!IMPORTANT] +> If you access the [SoftwareBitmap](../windows.graphics.imaging/softwarebitmap.md) or [Direct3DSurface](../windows.graphics.directx.direct3d11/idirect3dsurface.md) objects provided by the [VideoMediaFrame](mediaframereference_videomediaframe.md) property of a [MediaFrameReference](mediaframereference.md), the system creates a strong reference to these objects, which means that they will not be disposed when you call [Dispose](mediaframereference_close.md) on the containing **MediaFrameReference**. You must explicitly call the **Dispose** method of the **SoftwareBitmap** or **Direct3DSurface** directly for the objects to be immediately disposed. Otherwise, the garbage collector will eventually free the memory for these objects, but you can't know when this will occur, and if the number of allocated bitmaps or surfaces exceeds the maximum amount allowed by the system, the flow of new frames will stop. + +For how-to guidance on using [MediaFrameSource](mediaframesource.md) to capture frames, see [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader). + +## -examples + +## -see-also +[Object](https://msdn.microsoft.com/library/system.object.aspx), [IClosable](../windows.foundation/iclosable.md), [Process media frames with MediaFrameReader](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/process-media-frames-with-mediaframereader) + diff --git a/windows.media.capture.frames/multisourcemediaframereference_close_811482585.md b/windows.media.capture.frames/multisourcemediaframereference_close_811482585.md new file mode 100644 index 0000000000..d1aad1ce4d --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereference_close_811482585.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MultiSourceMediaFrameReference.Close +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReference.Close + +## -description +Disposes of the object and associated resources. + +## -remarks +The **Close** method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the **Close** method is exposed as the **Dispose()** method on the [MediaFrameReference](mediaframereference.md) object. For apps written in C++, the **Close** method will be called when using the **delete** keyword on the object. + + +## -see-also + +## -examples + diff --git a/windows.media.capture.frames/multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md b/windows.media.capture.frames/multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md new file mode 100644 index 0000000000..f9f97873e3 --- /dev/null +++ b/windows.media.capture.frames/multisourcemediaframereference_trygetframereferencebysourceid_1428642806.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Capture.Frames.MultiSourceMediaFrameReference.TryGetFrameReferenceBySourceId(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.Frames.MultiSourceMediaFrameReference.TryGetFrameReferenceBySourceId + +## -description +Attempts to get a time-correlated [MediaFrameReference](mediaframereference.md) for the specified media frame source. + +## -params + +## -param sourceId +The [Id](mediaframesourceinfo_id.md) property of the [MediaFrameSourceInfo](mediaframesourceinfo.md) object representing the media frame source from which a frame reference should be retreived. + +## -returns +A [MediaFrameReference](mediaframereference.md) representing a time-correlated media frame. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/appbroadcastbackgroundservice.md b/windows.media.capture/appbroadcastbackgroundservice.md new file mode 100644 index 0000000000..1428a01dac --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastBackgroundService +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService + +## -description +Provides an interface between the broadcasting UWP app and the system-hosted broadcast service. This class provides access to objects that facilitate broadcast service authentication, test the bandwidth capabilities of the device's internet to the broadcasting provider service, and allow your task to acquire captured audio and video frames so that they can be sent to the broadcast provider service. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by casting the [TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property of the [IBackgroundTaskInstance](../windows.applicationmodel.background/ibackgroundtaskinstance.md) passed into your background task's [Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method to a [AppBroadcastTriggerDetails](appbroadcasttriggerdetails.md) and then accessing the [BackgroundService](appbroadcasttriggerdetails_backgroundservice.md) property. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_appid.md b/windows.media.capture/appbroadcastbackgroundservice_appid.md new file mode 100644 index 0000000000..20659fbdc9 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_appid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.AppId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.AppId + +## -description +Gets a string containing an identifier for the game being broadcast. When broadcasting on a desktop device, this value is the game on which the user initiated broadcasting. + +## -property-value +A string containing a system-defined identifier for the broadcasting app. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_broadcasttitle.md b/windows.media.capture/appbroadcastbackgroundservice_broadcasttitle.md new file mode 100644 index 0000000000..e367d75a2c --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_broadcasttitle.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastTitle +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.BroadcastTitle + +## -description +Gets a string containing the user-specified title of the broadcast. + +## -property-value +A string containing the user-specified title of the broadcast. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_heartbeatrequested.md b/windows.media.capture/appbroadcastbackgroundservice_heartbeatrequested.md new file mode 100644 index 0000000000..49f6c60767 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_heartbeatrequested.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundService.HeartbeatRequested +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.HeartbeatRequested + +## -description +Raised by the system periodically to confirm that the broadcasting background task is currently active. + +## -remarks +Set the [Handled](appbroadcastheartbeatrequestedeventargs_handled.md) property to true to confirm that the background task is currently active. Failure to respond to this event and set the **Handled** property to true can result in the background task for the broadcast app being terminated. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_pluginstate.md b/windows.media.capture/appbroadcastbackgroundservice_pluginstate.md new file mode 100644 index 0000000000..caaa0d0889 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_pluginstate.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.PlugInState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.PlugInState + +## -description +Gets or sets a value specifying the current state of the broadcast background task. + +## -property-value +A value specifying the current state of the broadcast background task. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_signininfo.md b/windows.media.capture/appbroadcastbackgroundservice_signininfo.md new file mode 100644 index 0000000000..2a8b98fb83 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_signininfo.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.SignInInfo +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.SignInInfo + +## -description +Gets an object that represents the sign-in information for the app broadcast background service. + +## -property-value +An object that represents the sign-in information for the app broadcast background service. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_streaminfo.md b/windows.media.capture/appbroadcastbackgroundservice_streaminfo.md new file mode 100644 index 0000000000..baf874dda0 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_streaminfo.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.StreamInfo +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.StreamInfo + +## -description +Gets an object that manages the stream state of the app broadcast background service. + +## -property-value +An object that manages the stream state of the app broadcast background service. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_terminatebroadcast_60195882.md b/windows.media.capture/appbroadcastbackgroundservice_terminatebroadcast_60195882.md new file mode 100644 index 0000000000..77c0df5070 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_terminatebroadcast_60195882.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastBackgroundService.TerminateBroadcast(Windows.Media.Capture.AppBroadcastTerminationReason,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.TerminateBroadcast + +## -description +Terminates a broadcast. + +## -params + +## -param reason +A value indicating the reason that the broadcast is being terminated. + +## -param providerSpecificReason +An integer that conveys a provider-specific reason that the broadcast is being terminated. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_titleid.md b/windows.media.capture/appbroadcastbackgroundservice_titleid.md new file mode 100644 index 0000000000..5581acb323 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_titleid.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.TitleId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.TitleId + +## -description +Gets a unique identifier for the title being broadcast. + +## -property-value +A unique identifier for the title being broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservice_viewercount.md b/windows.media.capture/appbroadcastbackgroundservice_viewercount.md new file mode 100644 index 0000000000..68f32779ed --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservice_viewercount.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundService.ViewerCount +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundService.ViewerCount + +## -description +Gets or sets the number of viewers of the broadcast. + +## -property-value +The number of viewers of the broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo.md new file mode 100644 index 0000000000..2b777ae55d --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo + +## -description +Represents the sign-in information for the app broadcast background service. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo_authenticationresult.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo_authenticationresult.md new file mode 100644 index 0000000000..c1ec08fa8b --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo_authenticationresult.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.AuthenticationResult +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.AuthenticationResult + +## -description +Gets an object that represents the result of a Web authentication operation. + +## -property-value +An object that represents the result of a Web authentication operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo_oauthcallbackuri.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo_oauthcallbackuri.md new file mode 100644 index 0000000000..c5a68911ce --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo_oauthcallbackuri.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.OAuthCallbackUri +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.OAuthCallbackUri + +## -description +Gets or sets the OAuth callback URI. + +## -property-value +The OAuth callback URI. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo_oauthrequesturi.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo_oauthrequesturi.md new file mode 100644 index 0000000000..9758862a1a --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo_oauthrequesturi.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.OAuthRequestUri +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.OAuthRequestUri + +## -description +Gets or sets the OAuth request URI. + +## -property-value +The OAuth request URI. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo_signinstate.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo_signinstate.md new file mode 100644 index 0000000000..e341ffc5c6 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo_signinstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.SignInState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.SignInState + +## -description +Gets an object representing the sign-in state of the app broadcast background service. + +## -property-value +The sign-in state of the app broadcast background service. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo_signinstatechanged.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo_signinstatechanged.md new file mode 100644 index 0000000000..15305b3ca9 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo_signinstatechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged + +## -description +Occurs when the sign-in state of the app broadcast background service changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicesignininfo_username.md b/windows.media.capture/appbroadcastbackgroundservicesignininfo_username.md new file mode 100644 index 0000000000..04afd5fc3a --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicesignininfo_username.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.UserName +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceSignInInfo.UserName + +## -description +Gets or sets the username for app broadcast background service authentication. + +## -property-value + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo.md new file mode 100644 index 0000000000..c6ee19b053 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo + +## -description +Manages the stream state of the app broadcast background service. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_audiocodec.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_audiocodec.md new file mode 100644 index 0000000000..0484ce3653 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_audiocodec.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.AudioCodec +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.AudioCodec + +## -description +Gets or sets the audio codec used by the app broadcast background service. + +## -property-value +The audio codec used by the app broadcast background service. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_bandwidthtestbitrate.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_bandwidthtestbitrate.md new file mode 100644 index 0000000000..8311377a68 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_bandwidthtestbitrate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.BandwidthTestBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.BandwidthTestBitrate + +## -description +Gets or sets the bandwidth test bitrate for the app broadcast background service. + +## -property-value +The bandwidth test bitrate for the app broadcast background service. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_broadcaststreamreader.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_broadcaststreamreader.md new file mode 100644 index 0000000000..2e8f7d1599 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_broadcaststreamreader.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.BroadcastStreamReader +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.BroadcastStreamReader + +## -description +Gets the broadcast stream reader for the app broadcast background service. + +## -property-value +The broadcast stream reader for the app broadcast background service. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_desiredvideoencodingbitrate.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_desiredvideoencodingbitrate.md new file mode 100644 index 0000000000..47bb7960ad --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_desiredvideoencodingbitrate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.DesiredVideoEncodingBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.DesiredVideoEncodingBitrate + +## -description +Gets or sets the desired video encoding bitrate for the app broadcast background service. + +## -property-value +The desired video encoding bitrate for the app broadcast background service. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_streamstate.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_streamstate.md new file mode 100644 index 0000000000..d2bcfcde52 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_streamstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.StreamState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.StreamState + +## -description +Gets a value indicating the app broadcast stream state. + +## -property-value +A value indicating the app broadcast stream state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_streamstatechanged.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_streamstatechanged.md new file mode 100644 index 0000000000..571463a960 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_streamstatechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.StreamStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.StreamStateChanged + +## -description +Occurs when the app broadcast stream state changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_videoencodingbitratechanged.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_videoencodingbitratechanged.md new file mode 100644 index 0000000000..172676cf56 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_videoencodingbitratechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.VideoEncodingBitrateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.VideoEncodingBitrateChanged + +## -description +Occurs when the app broadcast video encoding bitrate changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastbackgroundservicestreaminfo_videoencodingresolutionchanged.md b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_videoencodingresolutionchanged.md new file mode 100644 index 0000000000..ff941a3ee8 --- /dev/null +++ b/windows.media.capture/appbroadcastbackgroundservicestreaminfo_videoencodingresolutionchanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.VideoEncodingResolutionChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastBackgroundServiceStreamInfo.VideoEncodingResolutionChanged + +## -description +Occurs when the app broadcast video encoding resolution changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastcameracapturestate.md b/windows.media.capture/appbroadcastcameracapturestate.md new file mode 100644 index 0000000000..0f8a3bec3f --- /dev/null +++ b/windows.media.capture/appbroadcastcameracapturestate.md @@ -0,0 +1,43 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastCameraCaptureState +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppBroadcastCameraCaptureState + +## -description +Specifies the state of app broadcast camera capture. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields + +## -field Stopped:0 +App broadcast camera capture is stopped. + +## -field Started:1 +App broadcast camera capture has started. + +## -field Failed:2 +App broadcast camera capture has failed. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastcameracapturestatechangedeventargs.md b/windows.media.capture/appbroadcastcameracapturestatechangedeventargs.md new file mode 100644 index 0000000000..d736fe8e9f --- /dev/null +++ b/windows.media.capture/appbroadcastcameracapturestatechangedeventargs.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastCameraCaptureStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastCameraCaptureStateChangedEventArgs + +## -description +Provides data for the [AppBroadcast.CameraCaptureStateChanged](./appbroadcaststate_cameracapturestatechanged.md) event. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastcameracapturestatechangedeventargs_errorcode.md b/windows.media.capture/appbroadcastcameracapturestatechangedeventargs_errorcode.md new file mode 100644 index 0000000000..cf8b653075 --- /dev/null +++ b/windows.media.capture/appbroadcastcameracapturestatechangedeventargs_errorcode.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastCameraCaptureStateChangedEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastCameraCaptureStateChangedEventArgs.ErrorCode + +## -description +Gets the error code associated with the event. + +## -property-value +The error code associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastcameracapturestatechangedeventargs_state.md b/windows.media.capture/appbroadcastcameracapturestatechangedeventargs_state.md new file mode 100644 index 0000000000..4bf667ffd3 --- /dev/null +++ b/windows.media.capture/appbroadcastcameracapturestatechangedeventargs_state.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastCameraCaptureStateChangedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastCameraCaptureStateChangedEventArgs.State + +## -description +Gets a value that indicates the new state of the app broadcast camera capture. + +## -property-value +A value that indicates the new state of the app broadcast camera capture. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastcameraoverlaylocation.md b/windows.media.capture/appbroadcastcameraoverlaylocation.md new file mode 100644 index 0000000000..02e835e88d --- /dev/null +++ b/windows.media.capture/appbroadcastcameraoverlaylocation.md @@ -0,0 +1,55 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastCameraOverlayLocation +-api-type: winrt enum +--- + + + +# AppBroadcastCameraOverlayLocation + +## -description +Specifies the location of the camera overlay within the broadcast video frame. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields +### -field TopLeft:0 +The overlay is positioned at the top left of the frame. + +### -field TopCenter:1 +The overlay is positioned at the top center of the frame. + +### -field TopRight:2 +The overlay is positioned at the top right of the frame. + +### -field MiddleLeft:3 +The overlay is positioned at the middle left of the frame. + +### -field MiddleCenter:4 +The overlay is positioned at the middle center of the frame. + +### -field MiddleRight:5 +The overlay is positioned at the middle right of the frame. + +### -field BottomLeft:6 +The overlay is positioned at the bottom left of the frame. + +### -field BottomCenter:7 +The overlay is positioned at the bottom center of the frame. + +### -field BottomRight:8 +The overlay is positioned at the bottom right of the frame. + + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastcameraoverlaysize.md b/windows.media.capture/appbroadcastcameraoverlaysize.md new file mode 100644 index 0000000000..0263b1f1c2 --- /dev/null +++ b/windows.media.capture/appbroadcastcameraoverlaysize.md @@ -0,0 +1,37 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastCameraOverlaySize +-api-type: winrt enum +--- + + + +# AppBroadcastCameraOverlaySize + +## -description +Specifies the size of the camera overlay within the broadcast video frame. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields +### -field Small:0 +Small overlay size. + +### -field Medium:1 +Medium overlay size. + +### -field Large:2 +Large overlay size. + + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastcapturetargettype.md b/windows.media.capture/appbroadcastcapturetargettype.md new file mode 100644 index 0000000000..04968d831b --- /dev/null +++ b/windows.media.capture/appbroadcastcapturetargettype.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastCaptureTargetType +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppBroadcastCaptureTargetType + +## -description +Specifies the type of target being captured for app broadcast. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields + +## -field EntireDisplay:1 +The entire display is captured. + +## -field AppView:0 +The app view is captured. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastexitbroadcastmodereason.md b/windows.media.capture/appbroadcastexitbroadcastmodereason.md new file mode 100644 index 0000000000..0d58a3f6bc --- /dev/null +++ b/windows.media.capture/appbroadcastexitbroadcastmodereason.md @@ -0,0 +1,47 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastExitBroadcastModeReason +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppBroadcastExitBroadcastModeReason + +## -description +Gets a value that specifies the reason that broadcast mode was exited. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields + +## -field UserCanceled:1 +The user canceled the broadcast. + +## -field NormalExit:0 +The broadcast was exited normally. + +## -field ForegroundAppActivated:3 +The broadcast was exited because a foreground app was activated. + +## -field AuthorizationFail:2 +The broadcast was exited because of an authentication failure. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings.md b/windows.media.capture/appbroadcastglobalsettings.md new file mode 100644 index 0000000000..82203f59aa --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastGlobalSettings +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings + +## -description +Specifies global broadcasting settings that persist across all broadcasting UWP apps. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by calling [AppBroadcastManager.GetGlobalSettings](appbroadcastmanager_getglobalsettings.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_cameraoverlaylocation.md b/windows.media.capture/appbroadcastglobalsettings_cameraoverlaylocation.md new file mode 100644 index 0000000000..1bb7b8f06b --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_cameraoverlaylocation.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.CameraOverlayLocation +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.CameraOverlayLocation + +## -description +Gets or sets a value that specifies the location of the camera overlay within the broadcast video frame. + +## -property-value +A value that specifies the location of the camera overlay within the broadcast video frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_cameraoverlaysize.md b/windows.media.capture/appbroadcastglobalsettings_cameraoverlaysize.md new file mode 100644 index 0000000000..a2a79a7f97 --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_cameraoverlaysize.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.CameraOverlaySize +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.CameraOverlaySize + +## -description +Gets or sets a value that specifies the size of the camera overlay within the broadcast video frame. + +## -property-value +A value that specifies the size of the camera overlay within the broadcast video frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_hashardwareencoder.md b/windows.media.capture/appbroadcastglobalsettings_hashardwareencoder.md new file mode 100644 index 0000000000..8abb168dbd --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_hashardwareencoder.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.HasHardwareEncoder +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.HasHardwareEncoder + +## -description +Gets a value indicating whether the current device supports hardware-based media encoding. + +## -property-value +True if the device supports hardware encoding; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_isaudiocaptureenabled.md b/windows.media.capture/appbroadcastglobalsettings_isaudiocaptureenabled.md new file mode 100644 index 0000000000..576a43f5f9 --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_isaudiocaptureenabled.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsAudioCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsAudioCaptureEnabled + +## -description +Gets or sets a value indicating whether audio capture is enabled for broadcasting. + +## -property-value +True if audio capture is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_isbroadcastenabled.md b/windows.media.capture/appbroadcastglobalsettings_isbroadcastenabled.md new file mode 100644 index 0000000000..587f115b3d --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_isbroadcastenabled.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsBroadcastEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsBroadcastEnabled + +## -description +Gets a value that indicates if broadcasting is enabled on the device. + +## -property-value +True if broadcasting is enabled on the device; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_iscameracaptureenabledbydefault.md b/windows.media.capture/appbroadcastglobalsettings_iscameracaptureenabledbydefault.md new file mode 100644 index 0000000000..d11d8aaa29 --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_iscameracaptureenabledbydefault.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsCameraCaptureEnabledByDefault +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsCameraCaptureEnabledByDefault + +## -description +Gets or sets a value indicating whether camera capture for broadcasting is enabled by default. + +## -property-value +True if camera capture is enabled by default; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_iscursorimagecaptureenabled.md b/windows.media.capture/appbroadcastglobalsettings_iscursorimagecaptureenabled.md new file mode 100644 index 0000000000..bb15c8f0ca --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_iscursorimagecaptureenabled.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsCursorImageCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsCursorImageCaptureEnabled + +## -description +Gets a value indicating whether the cursor image is captured. + +## -property-value +True if the cursor image is captured; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_isdisabledbypolicy.md b/windows.media.capture/appbroadcastglobalsettings_isdisabledbypolicy.md new file mode 100644 index 0000000000..517664af66 --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_isdisabledbypolicy.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsDisabledByPolicy +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsDisabledByPolicy + +## -description +Gets a value that indicates if broadcasting is disabled on the device by group policy. + +## -property-value +True if broadcasting is disabled on the device by group policy; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_isechocancellationenabled.md b/windows.media.capture/appbroadcastglobalsettings_isechocancellationenabled.md new file mode 100644 index 0000000000..7a466800ff --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_isechocancellationenabled.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsEchoCancellationEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsEchoCancellationEnabled + +## -description +Gets or sets a value indicating whether echo cancellation is enabled. + +## -property-value +True if echo cancellation is enabled; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_isgpuconstrained.md b/windows.media.capture/appbroadcastglobalsettings_isgpuconstrained.md new file mode 100644 index 0000000000..281f2b27fe --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_isgpuconstrained.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsGpuConstrained +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsGpuConstrained + +## -description +Gets a value indicating whether the GPU on the device is constrained. + +## -property-value +True if the GPU is constrained; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_ismicrophonecaptureenabledbydefault.md b/windows.media.capture/appbroadcastglobalsettings_ismicrophonecaptureenabledbydefault.md new file mode 100644 index 0000000000..588f285363 --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_ismicrophonecaptureenabledbydefault.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.IsMicrophoneCaptureEnabledByDefault +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.IsMicrophoneCaptureEnabledByDefault + +## -description +Gets or sets a value indicating whether microphone capture for broadcasting is enabled by default. + +## -property-value +True if microphone capture is enabled by default; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_microphonegain.md b/windows.media.capture/appbroadcastglobalsettings_microphonegain.md new file mode 100644 index 0000000000..a5ec23265b --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_microphonegain.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.MicrophoneGain +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.MicrophoneGain + +## -description +Gets or sets a value indicating the microphone gain for broadcast audio capture. + +## -property-value +The microphone gain for broadcast audio capture. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_selectedcameraid.md b/windows.media.capture/appbroadcastglobalsettings_selectedcameraid.md new file mode 100644 index 0000000000..22bb228e60 --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_selectedcameraid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.SelectedCameraId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.SelectedCameraId + +## -description +Gets or sets a string containing the device ID of the camera used for broadcast video capture. + +## -property-value +The device ID of the camera used for broadcast video capture. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastglobalsettings_systemaudiogain.md b/windows.media.capture/appbroadcastglobalsettings_systemaudiogain.md new file mode 100644 index 0000000000..fe843deb3f --- /dev/null +++ b/windows.media.capture/appbroadcastglobalsettings_systemaudiogain.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastGlobalSettings.SystemAudioGain +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastGlobalSettings.SystemAudioGain + +## -description +Gets or sets the system gain for broadcast audio capture. + +## -property-value +The system gain for broadcast audio capture. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastheartbeatrequestedeventargs.md b/windows.media.capture/appbroadcastheartbeatrequestedeventargs.md new file mode 100644 index 0000000000..1d854fcda1 --- /dev/null +++ b/windows.media.capture/appbroadcastheartbeatrequestedeventargs.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastHeartbeatRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastHeartbeatRequestedEventArgs + +## -description +Provides data for the [AppBroadcastBackgroundService.HeartbeatRequested](appbroadcastbackgroundservice_heartbeatrequested.md) event which is raised by the system periodically to confirm that the broadcasting background task is currently active. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +In the handler for the [HeartbeatRequested](appbroadcastbackgroundservice_heartbeatrequested.md) event, set the [Handled](appbroadcastheartbeatrequestedeventargs_handled.md) property to true to confirm that the broadcasting background task is currently active. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastheartbeatrequestedeventargs_handled.md b/windows.media.capture/appbroadcastheartbeatrequestedeventargs_handled.md new file mode 100644 index 0000000000..d440cb7da8 --- /dev/null +++ b/windows.media.capture/appbroadcastheartbeatrequestedeventargs_handled.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastHeartbeatRequestedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastHeartbeatRequestedEventArgs.Handled + +## -description +Gets or sets a value indicating whether the broadcasting background task is currently active. + +## -property-value +True if the broadcasting background task is currently active; otherwise, false. + +## -remarks +Set this value to true in the handler for the [HeartbeatRequested](appbroadcastbackgroundservice_heartbeatrequested.md) event to confirm that the broadcasting background task is currently active. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmanager.md b/windows.media.capture/appbroadcastmanager.md new file mode 100644 index 0000000000..272112b374 --- /dev/null +++ b/windows.media.capture/appbroadcastmanager.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastManager +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastManager + +## -description +Provides access to global broadcast settings for the current device and broadcast provider settings. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmanager_applyglobalsettings_948986405.md b/windows.media.capture/appbroadcastmanager_applyglobalsettings_948986405.md new file mode 100644 index 0000000000..4f598781c7 --- /dev/null +++ b/windows.media.capture/appbroadcastmanager_applyglobalsettings_948986405.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastManager.ApplyGlobalSettings(Windows.Media.Capture.AppBroadcastGlobalSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastManager.ApplyGlobalSettings + +## -description +Updates the global broadcast settings for the current device. + +## -parameters +### -param value +An object that exposes the global broadcast settings for the current device. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmanager_applyprovidersettings_1696529643.md b/windows.media.capture/appbroadcastmanager_applyprovidersettings_1696529643.md new file mode 100644 index 0000000000..d0a7ddfc7a --- /dev/null +++ b/windows.media.capture/appbroadcastmanager_applyprovidersettings_1696529643.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastManager.ApplyProviderSettings(Windows.Media.Capture.AppBroadcastProviderSettings) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastManager.ApplyProviderSettings + +## -description +Updates the broadcast provider settings. + +## -parameters +### -param value + + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmanager_getglobalsettings_2021185159.md b/windows.media.capture/appbroadcastmanager_getglobalsettings_2021185159.md new file mode 100644 index 0000000000..a429754120 --- /dev/null +++ b/windows.media.capture/appbroadcastmanager_getglobalsettings_2021185159.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastManager.GetGlobalSettings +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastManager.GetGlobalSettings + +## -description +Gets an object that exposes the global broadcast settings for the current device. + +## -returns +An object that exposes the global broadcast settings for the current device. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmanager_getprovidersettings_921685894.md b/windows.media.capture/appbroadcastmanager_getprovidersettings_921685894.md new file mode 100644 index 0000000000..6611a13940 --- /dev/null +++ b/windows.media.capture/appbroadcastmanager_getprovidersettings_921685894.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastManager.GetProviderSettings +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastManager.GetProviderSettings + +## -description +Gets an object that exposes broadcast provider settings. + +## -returns +An object that exposes broadcast provider settings. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmicrophonecapturestate.md b/windows.media.capture/appbroadcastmicrophonecapturestate.md new file mode 100644 index 0000000000..cfd53c5b7f --- /dev/null +++ b/windows.media.capture/appbroadcastmicrophonecapturestate.md @@ -0,0 +1,43 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastMicrophoneCaptureState +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppBroadcastMicrophoneCaptureState + +## -description +Specifies the state of app broadcast microphone capture. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields + +## -field Stopped:0 +Microphone capture is stopped. + +## -field Started:1 +Microphone capture has been started. + +## -field Failed:2 +Microphone capture has failed. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs.md b/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs.md new file mode 100644 index 0000000000..a8524b99e7 --- /dev/null +++ b/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastMicrophoneCaptureStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastMicrophoneCaptureStateChangedEventArgs + +## -description +Provides data for the [AppBroadcastState.MicrophoneCaptureStateChanged](./appbroadcaststate_microphonecapturestatechanged.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs_errorcode.md b/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs_errorcode.md new file mode 100644 index 0000000000..883b722a8f --- /dev/null +++ b/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs_errorcode.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastMicrophoneCaptureStateChangedEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastMicrophoneCaptureStateChangedEventArgs.ErrorCode + +## -description +Gets the error code associated with the event. + +## -property-value +The error code associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs_state.md b/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs_state.md new file mode 100644 index 0000000000..d78ada02c0 --- /dev/null +++ b/windows.media.capture/appbroadcastmicrophonecapturestatechangedeventargs_state.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastMicrophoneCaptureStateChangedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastMicrophoneCaptureStateChangedEventArgs.State + +## -description +Gets a value indicating the state of app broadcast microphone capture. + +## -property-value +A value indicating the state of app broadcast microphone capture. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastplugin.md b/windows.media.capture/appbroadcastplugin.md new file mode 100644 index 0000000000..faca51d1cb --- /dev/null +++ b/windows.media.capture/appbroadcastplugin.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPlugIn +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPlugIn + +## -description +Provides information about the app broadcast plugin. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastplugin_appid.md b/windows.media.capture/appbroadcastplugin_appid.md new file mode 100644 index 0000000000..d7eab075a1 --- /dev/null +++ b/windows.media.capture/appbroadcastplugin_appid.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugIn.AppId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugIn.AppId + +## -description +Gets the unique ID of the app associated with the app broadcast plugin. + +## -property-value +The unique ID of the app associated with the app broadcast plugin. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastplugin_displayname.md b/windows.media.capture/appbroadcastplugin_displayname.md new file mode 100644 index 0000000000..5a82999bc3 --- /dev/null +++ b/windows.media.capture/appbroadcastplugin_displayname.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugIn.DisplayName +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugIn.DisplayName + +## -description +Gets the display name of the app broadcast plugin. + +## -property-value +The display name of the app broadcast plugin. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastplugin_logo.md b/windows.media.capture/appbroadcastplugin_logo.md new file mode 100644 index 0000000000..175c2560e3 --- /dev/null +++ b/windows.media.capture/appbroadcastplugin_logo.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugIn.Logo +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugIn.Logo + +## -description +Gets a stream containing the logo image of the app broadcast plugin. + +## -property-value +A stream containing the logo image of the app broadcast plugin. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastplugin_providersettings.md b/windows.media.capture/appbroadcastplugin_providersettings.md new file mode 100644 index 0000000000..982a30f177 --- /dev/null +++ b/windows.media.capture/appbroadcastplugin_providersettings.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugIn.ProviderSettings +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugIn.ProviderSettings + +## -description +Gets an object representing the provider settings for the app broadcast plugin. + +## -property-value +The provider settings for the app broadcast plugin. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginmanager.md b/windows.media.capture/appbroadcastpluginmanager.md new file mode 100644 index 0000000000..c0df767864 --- /dev/null +++ b/windows.media.capture/appbroadcastpluginmanager.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPlugInManager +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInManager + +## -description +Manages app broadcast plugins. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginmanager_defaultplugin.md b/windows.media.capture/appbroadcastpluginmanager_defaultplugin.md new file mode 100644 index 0000000000..ec4501c466 --- /dev/null +++ b/windows.media.capture/appbroadcastpluginmanager_defaultplugin.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugInManager.DefaultPlugIn +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInManager.DefaultPlugIn + +## -description +Gets or sets the default app broadcast plugin. + +## -property-value +The default app broadcast plugin. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginmanager_getdefault_846721868.md b/windows.media.capture/appbroadcastpluginmanager_getdefault_846721868.md new file mode 100644 index 0000000000..0bd54b9237 --- /dev/null +++ b/windows.media.capture/appbroadcastpluginmanager_getdefault_846721868.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastPlugInManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInManager.GetDefault + +## -description +Gets the default plugin for app broadcast. + +## -params + +## -returns +The default plugin for app broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginmanager_getforuser_2058550280.md b/windows.media.capture/appbroadcastpluginmanager_getforuser_2058550280.md new file mode 100644 index 0000000000..124baba9d0 --- /dev/null +++ b/windows.media.capture/appbroadcastpluginmanager_getforuser_2058550280.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastPlugInManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInManager.GetForUser + +## -description +Gets the app broadcast plugin associated with the specified user. + +## -params + +## -param user +The user for which the app broadcast plugin should be retrieved. + +## -returns +The app broadcast plugin associated with the specified user. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginmanager_isbroadcastprovideravailable.md b/windows.media.capture/appbroadcastpluginmanager_isbroadcastprovideravailable.md new file mode 100644 index 0000000000..13ef07cf56 --- /dev/null +++ b/windows.media.capture/appbroadcastpluginmanager_isbroadcastprovideravailable.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugInManager.IsBroadcastProviderAvailable +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInManager.IsBroadcastProviderAvailable + +## -description +Gets a value indicating if the broadcast provider is available. + +## -property-value +True if the broadcast provider is available; otherwise, false; + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginmanager_pluginlist.md b/windows.media.capture/appbroadcastpluginmanager_pluginlist.md new file mode 100644 index 0000000000..e8aa572fbf --- /dev/null +++ b/windows.media.capture/appbroadcastpluginmanager_pluginlist.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugInManager.PlugInList +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInManager.PlugInList + +## -description +Gets a read-only list of all app broadcast plugins. + +## -property-value +A read-only list of all app broadcast plugins. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginstate.md b/windows.media.capture/appbroadcastpluginstate.md new file mode 100644 index 0000000000..f45502e418 --- /dev/null +++ b/windows.media.capture/appbroadcastpluginstate.md @@ -0,0 +1,65 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPlugInState +-api-type: winrt enum +--- + + + +# AppBroadcastPlugInState + +## -description +Specifies the current state of the broadcast background task. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields +### -field Unknown:0 +The current state is unknown. + +### -field Initialized:1 +The broadcast background task is initialized. + +### -field MicrosoftSignInRequired:2 +The current user needs to be authenticated with the Microsoft service. + +### -field OAuthSignInRequired:3 +The current user needs to be authenticated with the broadcast provider service. + +### -field ProviderSignInRequired:4 +The broadcast background task needs to authenticate the current user with the broadcast provider service. + +### -field InBandwidthTest:5 +The broadcast background task is in the process of testing the bandwidth of the device's connection to the broadcasting service provider. Once this test is complete, the system will set the [AppBroadcastBackgroundServiceStreamInfo.BandwidthTestBitrate](appbroadcastbackgroundservicestreaminfo_bandwidthbestbitrate.md) property to indicate the result of the bandwidth test. + +### -field ReadyToBroadcast:6 +The broadcast background task is ready to broadcast. + + + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings + + + + + + + + + + + + + + + diff --git a/windows.media.capture/appbroadcastpluginstatechangedeventargs.md b/windows.media.capture/appbroadcastpluginstatechangedeventargs.md new file mode 100644 index 0000000000..8fe8273336 --- /dev/null +++ b/windows.media.capture/appbroadcastpluginstatechangedeventargs.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPlugInStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInStateChangedEventArgs + +## -description +Provides data for the [AppBroadcastState.PlugInStateChanged](./appbroadcaststate_pluginstatechanged.md) event. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpluginstatechangedeventargs_pluginstate.md b/windows.media.capture/appbroadcastpluginstatechangedeventargs_pluginstate.md new file mode 100644 index 0000000000..76e30c763b --- /dev/null +++ b/windows.media.capture/appbroadcastpluginstatechangedeventargs_pluginstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPlugInStateChangedEventArgs.PlugInState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPlugInStateChangedEventArgs.PlugInState + +## -description +Gets the new app broadcast plugin state. + +## -property-value +The new app broadcast plugin state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreview.md b/windows.media.capture/appbroadcastpreview.md new file mode 100644 index 0000000000..53cb239482 --- /dev/null +++ b/windows.media.capture/appbroadcastpreview.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPreview +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPreview + +## -description +Provides status information and access to the app broadcast preview. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreview_errorcode.md b/windows.media.capture/appbroadcastpreview_errorcode.md new file mode 100644 index 0000000000..671625a7f9 --- /dev/null +++ b/windows.media.capture/appbroadcastpreview_errorcode.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreview.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreview.ErrorCode + +## -description +Gets the error code associated with the app broadcast preview. + +## -property-value +The error code associated with the app broadcast preview. + + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreview_previewstate.md b/windows.media.capture/appbroadcastpreview_previewstate.md new file mode 100644 index 0000000000..f7e4c39a52 --- /dev/null +++ b/windows.media.capture/appbroadcastpreview_previewstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreview.PreviewState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreview.PreviewState + +## -description +Gets a value that indicates the state of the app broadcast preview. + +## -property-value +A value that indicates the state of the app broadcast preview. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreview_previewstatechanged.md b/windows.media.capture/appbroadcastpreview_previewstatechanged.md new file mode 100644 index 0000000000..3e59257132 --- /dev/null +++ b/windows.media.capture/appbroadcastpreview_previewstatechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastPreview.PreviewStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastPreview.PreviewStateChanged + +## -description +Occurs when the state of the app broadcast preview changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreview_previewstreamreader.md b/windows.media.capture/appbroadcastpreview_previewstreamreader.md new file mode 100644 index 0000000000..34048517c1 --- /dev/null +++ b/windows.media.capture/appbroadcastpreview_previewstreamreader.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreview.PreviewStreamReader +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreview.PreviewStreamReader + +## -description +Gets a stream reader for the app broadcast preview. + +## -property-value +A stream reader for the app broadcast preview. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreview_stoppreview_1107365801.md b/windows.media.capture/appbroadcastpreview_stoppreview_1107365801.md new file mode 100644 index 0000000000..dbc881fb6a --- /dev/null +++ b/windows.media.capture/appbroadcastpreview_stoppreview_1107365801.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastPreview.StopPreview +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastPreview.StopPreview + +## -description +Stope the app broadcast preview. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstate.md b/windows.media.capture/appbroadcastpreviewstate.md new file mode 100644 index 0000000000..a93a36a40d --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstate.md @@ -0,0 +1,43 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPreviewState +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewState +Specifies the state of the app broadcast preview. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -description + +## -enum-fields + +## -field Stopped:1 +The app broadcast preview is stopped. + +## -field Started:0 +The app broadcast preview has been started. + +## -field Failed:2 +The app broadcast preview has failed. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstatechangedeventargs.md b/windows.media.capture/appbroadcastpreviewstatechangedeventargs.md new file mode 100644 index 0000000000..0d1e628d84 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstatechangedeventargs.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPreviewStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStateChangedEventArgs + + +## -description +Provides data for the [AppBroadcastPreview.PreviewStateChanged](./appbroadcastpreview_previewstatechanged.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstatechangedeventargs_errorcode.md b/windows.media.capture/appbroadcastpreviewstatechangedeventargs_errorcode.md new file mode 100644 index 0000000000..a761931e15 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstatechangedeventargs_errorcode.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStateChangedEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStateChangedEventArgs.ErrorCode + +## -description +Gets the error code associated with the event. + +## -property-value +The error code associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstatechangedeventargs_previewstate.md b/windows.media.capture/appbroadcastpreviewstatechangedeventargs_previewstate.md new file mode 100644 index 0000000000..461e6c5384 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstatechangedeventargs_previewstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStateChangedEventArgs.PreviewState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStateChangedEventArgs.PreviewState + +## -description +Gets the new state of the app broadcast preview. + +## -property-value +The new state of the app broadcast preview. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader.md b/windows.media.capture/appbroadcastpreviewstreamreader.md new file mode 100644 index 0000000000..c9e26e7736 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPreviewStreamReader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader + +## -description +Provides information about and access to the app broadcast preview stream. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader_trygetnextvideoframe_1410796427.md b/windows.media.capture/appbroadcastpreviewstreamreader_trygetnextvideoframe_1410796427.md new file mode 100644 index 0000000000..ff1598fb0b --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader_trygetnextvideoframe_1410796427.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastPreviewStreamReader.TryGetNextVideoFrame +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader.TryGetNextVideoFrame + +## -description +Attempts to retrieve the next video frame from the app broadcast preview stream. + +## -params + +## -returns +The next video frame from the app broadcast preview stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader_videobitmapalphamode.md b/windows.media.capture/appbroadcastpreviewstreamreader_videobitmapalphamode.md new file mode 100644 index 0000000000..ca721e1024 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader_videobitmapalphamode.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoBitmapAlphaMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoBitmapAlphaMode + +## -description +Gets the video bitmap alpha mode for the app broadcast preview stream. + +## -property-value +The video bitmap alpha mode for the app broadcast preview stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader_videobitmappixelformat.md b/windows.media.capture/appbroadcastpreviewstreamreader_videobitmappixelformat.md new file mode 100644 index 0000000000..70a063de97 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader_videobitmappixelformat.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoBitmapPixelFormat +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoBitmapPixelFormat + +## -description +Gets the video bitmap pixel format for the app broadcast preview stream. + +## -property-value +The video bitmap pixel format for the app broadcast preview stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader_videoframearrived.md b/windows.media.capture/appbroadcastpreviewstreamreader_videoframearrived.md new file mode 100644 index 0000000000..616e4cf52e --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader_videoframearrived.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoFrameArrived +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoFrameArrived + +## -description +Occurs when a new video frame arrives from the app broadcast preview stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader_videoheight.md b/windows.media.capture/appbroadcastpreviewstreamreader_videoheight.md new file mode 100644 index 0000000000..5d4cc4046d --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader_videoheight.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoHeight +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoHeight + +## -description +Gets the video height, in pixels, of the app broadcast preview stream. + +## -property-value +The video height, in pixels, of the app broadcast preview stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader_videostride.md b/windows.media.capture/appbroadcastpreviewstreamreader_videostride.md new file mode 100644 index 0000000000..d6b2dc1bb2 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader_videostride.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoStride +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoStride + +## -description +Gets the video stride of the app broadcast preview stream. + +## -property-value +The video stride of the app broadcast preview stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamreader_videowidth.md b/windows.media.capture/appbroadcastpreviewstreamreader_videowidth.md new file mode 100644 index 0000000000..9e44bbbd7a --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamreader_videowidth.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoWidth +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamReader.VideoWidth + +## -description +Gets the video width, in pixels, of the app broadcast preview stream. + +## -property-value +The video width, in pixels, of the app broadcast preview stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoframe.md b/windows.media.capture/appbroadcastpreviewstreamvideoframe.md new file mode 100644 index 0000000000..ca794b1a56 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoframe.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPreviewStreamVideoFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoFrame + +## -description +Represents a video frame from the app broadcast preview stream. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoframe_videobuffer.md b/windows.media.capture/appbroadcastpreviewstreamvideoframe_videobuffer.md new file mode 100644 index 0000000000..17bfcda45d --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoframe_videobuffer.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamVideoFrame.VideoBuffer +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoFrame.VideoBuffer + +## -description +Gets the buffer containing the image data for the app broadcast preview stream video frame. + +## -property-value +The buffer containing the image data for the app broadcast preview stream video frame. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoframe_videoheader.md b/windows.media.capture/appbroadcastpreviewstreamvideoframe_videoheader.md new file mode 100644 index 0000000000..b8efbd88a2 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoframe_videoheader.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamVideoFrame.VideoHeader +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoFrame.VideoHeader + +## -description +Gets the header describing the image data for the app broadcast preview stream video frame. + +## -property-value +The header describing the image data for the app broadcast preview stream video frame. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoheader.md b/windows.media.capture/appbroadcastpreviewstreamvideoheader.md new file mode 100644 index 0000000000..b122ebd03f --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoheader.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader + +## -description +Represents metadata about an app broadcast preview stream video frame. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoheader_absolutetimestamp.md b/windows.media.capture/appbroadcastpreviewstreamvideoheader_absolutetimestamp.md new file mode 100644 index 0000000000..95d2411e8d --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoheader_absolutetimestamp.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.AbsoluteTimestamp +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.AbsoluteTimestamp + +## -description +Gets the absolute time stamp for the app broadcast preview stream video frame. + +## -property-value +The absolute time stamp for the app broadcast preview stream video frame. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoheader_duration.md b/windows.media.capture/appbroadcastpreviewstreamvideoheader_duration.md new file mode 100644 index 0000000000..37d66e14e1 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoheader_duration.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.Duration + +## -description +Gets the duration for the app broadcast preview stream video frame. + +## -property-value +The duration for the app broadcast preview stream video frame. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoheader_frameid.md b/windows.media.capture/appbroadcastpreviewstreamvideoheader_frameid.md new file mode 100644 index 0000000000..472ef97e64 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoheader_frameid.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.FrameId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.FrameId + +## -description +Gets the frame ID for the app broadcast preview stream video frame. + +## -property-value +The frame ID for the app broadcast preview stream video frame. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastpreviewstreamvideoheader_relativetimestamp.md b/windows.media.capture/appbroadcastpreviewstreamvideoheader_relativetimestamp.md new file mode 100644 index 0000000000..e91ed4da87 --- /dev/null +++ b/windows.media.capture/appbroadcastpreviewstreamvideoheader_relativetimestamp.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.RelativeTimestamp +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastPreviewStreamVideoHeader.RelativeTimestamp + +## -description +Gets the relative time stamp for the app broadcast preview stream video frame. + +## -property-value +The relative time stamp for the app broadcast preview stream video frame. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings.md b/windows.media.capture/appbroadcastprovidersettings.md new file mode 100644 index 0000000000..39fd9ebd87 --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastProviderSettings +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings + +## -description +Provides access to the settings of the remote broadcast provider service. These settings can be viewed and changed by the broadcast provider. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by calling [AppBroadcastManager.GetProviderSettings](appbroadcastmanager_getprovidersettings.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings_audioencodingbitrate.md b/windows.media.capture/appbroadcastprovidersettings_audioencodingbitrate.md new file mode 100644 index 0000000000..83addecca4 --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings_audioencodingbitrate.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastProviderSettings.AudioEncodingBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings.AudioEncodingBitrate + +## -description +Gets or sets the audio encoding bitrate of the broadcast stream, in bits per second. + +## -property-value +The audio encoding bitrate of the broadcast stream, in bits per second. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings_customvideoencodingbitrate.md b/windows.media.capture/appbroadcastprovidersettings_customvideoencodingbitrate.md new file mode 100644 index 0000000000..d02bccbf7e --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings_customvideoencodingbitrate.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastProviderSettings.CustomVideoEncodingBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings.CustomVideoEncodingBitrate + +## -description +Gets or sets a custom video encoding bitrate of the broadcast stream, in bits per second. + +## -property-value +The custom video encoding bitrate of the broadcast stream, in bits per second. + +## -remarks +If you specify a custom video encoding bitrate, you should set the [VideoEncodingBitrateMode](appbroadcastprovidersettings_videoencodingbitratemode.md) to [Custom](appbroadcastvideoencodingbitratemode.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings_customvideoencodingheight.md b/windows.media.capture/appbroadcastprovidersettings_customvideoencodingheight.md new file mode 100644 index 0000000000..955854b362 --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings_customvideoencodingheight.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastProviderSettings.CustomVideoEncodingHeight +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings.CustomVideoEncodingHeight + +## -description +Gets or sets a custom video encoding height of the broadcast stream. + +## -property-value +The custom video encoding height of the broadcast stream. + +## -remarks +If you specify a custom video encoding height, you should set the [VideoEncodingResolutionMode](appbroadcastprovidersettings_videoencodingresolutionmode.md) to [Custom](appbroadcastvideoencodingresolutionmode.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings_customvideoencodingwidth.md b/windows.media.capture/appbroadcastprovidersettings_customvideoencodingwidth.md new file mode 100644 index 0000000000..7905093bc1 --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings_customvideoencodingwidth.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastProviderSettings.CustomVideoEncodingWidth +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings.CustomVideoEncodingWidth + +## -description +Gets or sets a custom video encoding width of the broadcast stream. + +## -property-value +The custom video encoding width of the broadcast stream. + +## -remarks +If you specify a custom video encoding width, you should set the [VideoEncodingResolutionMode](appbroadcastprovidersettings_videoencodingresolutionmode.md) to [Custom](appbroadcastvideoencodingresolutionmode.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings_defaultbroadcasttitle.md b/windows.media.capture/appbroadcastprovidersettings_defaultbroadcasttitle.md new file mode 100644 index 0000000000..64b51d39c7 --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings_defaultbroadcasttitle.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastProviderSettings.DefaultBroadcastTitle +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings.DefaultBroadcastTitle + +## -description +Gets or sets the default title for broadcasts. + +## -property-value +The default title for broadcasts. + +## -remarks +Set the title of the current broadcast by setting the [AppBroadcastBackgroundService.BroadcastTitle](appbroadcastbackgroundservice_broadcasttitle.md) property. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings_videoencodingbitratemode.md b/windows.media.capture/appbroadcastprovidersettings_videoencodingbitratemode.md new file mode 100644 index 0000000000..fa3c128115 --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings_videoencodingbitratemode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastProviderSettings.VideoEncodingBitrateMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings.VideoEncodingBitrateMode + +## -description +Gets or sets the video encoding bitrate mode for the remote broadcast provider service. + +## -property-value +The video encoding bitrate + +## -remarks +If you set this value to [Custom](appbroadcastvideoencodingbitratemode.md), you should provide a value for the [CustomVideoEncodingBitrate](appbroadcastprovidersettings_customvideoencodingbitrate.md) property. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastprovidersettings_videoencodingresolutionmode.md b/windows.media.capture/appbroadcastprovidersettings_videoencodingresolutionmode.md new file mode 100644 index 0000000000..42ddc6dbda --- /dev/null +++ b/windows.media.capture/appbroadcastprovidersettings_videoencodingresolutionmode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastProviderSettings.VideoEncodingResolutionMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastProviderSettings.VideoEncodingResolutionMode + +## -description +Gets or sets the video encoding resolution mode for the remote broadcast provider service. + +## -property-value +The video encoding resolution mode + +## -remarks +If you set this value to [Custom](appbroadcastvideoencodingbitratemode.md), you should provide a value for the [CustomVideoEncodingWidth](appbroadcastprovidersettings_customvideoencodingwidth.md) and [CustomVideoEncodingHeight](appbroadcastprovidersettings_customvideoencodingheight.md) properties. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices.md b/windows.media.capture/appbroadcastservices.md new file mode 100644 index 0000000000..4439c42a9e --- /dev/null +++ b/windows.media.capture/appbroadcastservices.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastServices +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastServices + +## -description +Manages the state of app broadcasts. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_broadcastlanguage.md b/windows.media.capture/appbroadcastservices_broadcastlanguage.md new file mode 100644 index 0000000000..866a0eb7ae --- /dev/null +++ b/windows.media.capture/appbroadcastservices_broadcastlanguage.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastServices.BroadcastLanguage +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastServices.BroadcastLanguage + +## -description +Gets or sets a string that specifies the language settings for app broadast. + +## -property-value +A string that specifies the language settings for app broadast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_broadcasttitle.md b/windows.media.capture/appbroadcastservices_broadcasttitle.md new file mode 100644 index 0000000000..70981ee629 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_broadcasttitle.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastServices.BroadcastTitle +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastServices.BroadcastTitle + +## -description +Gets or sets the title of the broadcast. + +## -property-value +The title of the broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_cancapture.md b/windows.media.capture/appbroadcastservices_cancapture.md new file mode 100644 index 0000000000..96ed6c5813 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_cancapture.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastServices.CanCapture +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastServices.CanCapture + +## -description +Gets a value indicating whether the broadcast service can capture. + +## -property-value +True if the broadcast service can capture; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_capturetargettype.md b/windows.media.capture/appbroadcastservices_capturetargettype.md new file mode 100644 index 0000000000..b6083583a3 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_capturetargettype.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastServices.CaptureTargetType +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastServices.CaptureTargetType + +## -description +Gets or sets a value that specifies the type of capture target to be used for broadcast. + +## -property-value +A value that specifies the type of capture target to be used for broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_enterbroadcastmodeasync_1862406868.md b/windows.media.capture/appbroadcastservices_enterbroadcastmodeasync_1862406868.md new file mode 100644 index 0000000000..9b11fa931a --- /dev/null +++ b/windows.media.capture/appbroadcastservices_enterbroadcastmodeasync_1862406868.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastServices.EnterBroadcastModeAsync(Windows.Media.Capture.AppBroadcastPlugIn) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastServices.EnterBroadcastModeAsync + +## -description +Causes the app broadcast service to enter broadcast mode with the specified app broadcast plugin. + +## -params + +## -param plugIn +The app broadcast plugin with which broadcast mode is entered. + +## -returns +An asynchronous operation that returns a status code on successful completion. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_exitbroadcastmode_391045451.md b/windows.media.capture/appbroadcastservices_exitbroadcastmode_391045451.md new file mode 100644 index 0000000000..50812a70b5 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_exitbroadcastmode_391045451.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastServices.ExitBroadcastMode(Windows.Media.Capture.AppBroadcastExitBroadcastModeReason) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastServices.ExitBroadcastMode + +## -description +Causes the app broadcast service to exit broadcast mode with the specified reason. + +## -params + +## -param reason +An object that specifies the reason that broadcast mode is being exited. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_pausebroadcast_1741323173.md b/windows.media.capture/appbroadcastservices_pausebroadcast_1741323173.md new file mode 100644 index 0000000000..4f08fa5171 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_pausebroadcast_1741323173.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastServices.PauseBroadcast +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastServices.PauseBroadcast + +## -description +Pauses the app broadcasting. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_resumebroadcast_1008363925.md b/windows.media.capture/appbroadcastservices_resumebroadcast_1008363925.md new file mode 100644 index 0000000000..be19938b69 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_resumebroadcast_1008363925.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastServices.ResumeBroadcast +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastServices.ResumeBroadcast + +## -description +Resumes the app broadcasting. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_startbroadcast_1245541539.md b/windows.media.capture/appbroadcastservices_startbroadcast_1245541539.md new file mode 100644 index 0000000000..379a9718b4 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_startbroadcast_1245541539.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastServices.StartBroadcast +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastServices.StartBroadcast + +## -description +Starts app broadcasting. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_startpreview_418748523.md b/windows.media.capture/appbroadcastservices_startpreview_418748523.md new file mode 100644 index 0000000000..0158c84d24 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_startpreview_418748523.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastServices.StartPreview(Windows.Foundation.Size) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastServices.StartPreview + +## -description +Starts the app broadcast preview. + +## -params + +## -param desiredSize +An object specifying the size, in pixels, of the app broadcast preview. + +## -returns + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_state.md b/windows.media.capture/appbroadcastservices_state.md new file mode 100644 index 0000000000..e64bfa199e --- /dev/null +++ b/windows.media.capture/appbroadcastservices_state.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastServices.State +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastServices.State + +## -description +Gets the current state of the app broadcast services. + +## -property-value +The current state of the app broadcast services. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastservices_username.md b/windows.media.capture/appbroadcastservices_username.md new file mode 100644 index 0000000000..583f370ff4 --- /dev/null +++ b/windows.media.capture/appbroadcastservices_username.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastServices.UserName +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastServices.UserName + +## -description +Gets the username used for authentication for app broadcast. + +## -property-value +The username used for authentication for app broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastsigninresult.md b/windows.media.capture/appbroadcastsigninresult.md new file mode 100644 index 0000000000..f69c8b2611 --- /dev/null +++ b/windows.media.capture/appbroadcastsigninresult.md @@ -0,0 +1,44 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastSignInResult +-api-type: winrt enum +--- + + + +# AppBroadcastSignInResult + +## -description +Specifies the result of a sign-in operation. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields +### -field Success:0 +The sign-in was successful. + +### -field AuthenticationFailed:1 +The sign-in authentication failed. + +### -field Unauthorized:2 +The authenticated user does not have permission to access to the requested resource. + +### -field ServiceUnavailable:3 +The sign-in service is unavailable. + +### -field Unknown:4 +The sign-in result is unknown. + + +## -remarks +Get the result of a sign-in operation by handling the [AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged](appbroadcastbackgroundservicesignininfo_signinstatechanged.md) event. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastsigninstate.md b/windows.media.capture/appbroadcastsigninstate.md new file mode 100644 index 0000000000..0f7312253e --- /dev/null +++ b/windows.media.capture/appbroadcastsigninstate.md @@ -0,0 +1,51 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastSignInState +-api-type: winrt enum +--- + + + +# AppBroadcastSignInState + +## -description +Specifies the current sign-in state for a broadcast app. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields +### -field NotSignedIn:0 +The user is not signed in. + +### -field MicrosoftSignInInProgress:1 +A sign-in operation with the Microsoft service is in progress. + +### -field MicrosoftSignInComplete:2 +A sign-in operation with the Microsoft service is complete. + +### -field OAuthSignInInProgress:3 +A sign-in operation with the broadcast provider service is in progress. + +### -field OAuthSignInComplete:4 +A sign-in operation with the broadcast provider service is complete. + + +## -remarks +Get the current sign-in state by handling the [AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged](appbroadcastbackgroundservicesignininfo_signinstatechanged.md) event. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings + + + + + + + diff --git a/windows.media.capture/appbroadcastsigninstatechangedeventargs.md b/windows.media.capture/appbroadcastsigninstatechangedeventargs.md new file mode 100644 index 0000000000..3486baa958 --- /dev/null +++ b/windows.media.capture/appbroadcastsigninstatechangedeventargs.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastSignInStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastSignInStateChangedEventArgs + +## -description +Provides data for the [AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged](appbroadcastbackgroundservicesignininfo_signinstatechanged.md) event. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by handling the [AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged](appbroadcastbackgroundservicesignininfo_signinstatechanged.md) event. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastsigninstatechangedeventargs_result.md b/windows.media.capture/appbroadcastsigninstatechangedeventargs_result.md new file mode 100644 index 0000000000..0b70007290 --- /dev/null +++ b/windows.media.capture/appbroadcastsigninstatechangedeventargs_result.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastSignInStateChangedEventArgs.Result +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastSignInStateChangedEventArgs.Result + +## -description +Gets the result of the broadcast app sign-in operation associated with the [AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged](appbroadcastbackgroundservicesignininfo_signinstatechanged.md) event. + +## -property-value +The result of the sign-in operation. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastsigninstatechangedeventargs_signinstate.md b/windows.media.capture/appbroadcastsigninstatechangedeventargs_signinstate.md new file mode 100644 index 0000000000..e6e569ce5a --- /dev/null +++ b/windows.media.capture/appbroadcastsigninstatechangedeventargs_signinstate.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastSignInStateChangedEventArgs.SignInState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastSignInStateChangedEventArgs.SignInState + +## -description +Gets the current broadcast app sign-in state after the [AppBroadcastBackgroundServiceSignInInfo.SignInStateChanged](appbroadcastbackgroundservicesignininfo_signinstatechanged.md) is raised. + +## -property-value +The current sign in state. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate.md b/windows.media.capture/appbroadcaststate.md new file mode 100644 index 0000000000..406c96edf5 --- /dev/null +++ b/windows.media.capture/appbroadcaststate.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastState +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastState + +## -description +Represents and manages the state of an app broadcast. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_authenticationresult.md b/windows.media.capture/appbroadcaststate_authenticationresult.md new file mode 100644 index 0000000000..5395fad5b7 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_authenticationresult.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.AuthenticationResult +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.AuthenticationResult + +## -description +Gets the authentication result of the app broadcast state. + +## -property-value +The authentication result of the app broadcast state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_cameracaptureerror.md b/windows.media.capture/appbroadcaststate_cameracaptureerror.md new file mode 100644 index 0000000000..af34b428e3 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_cameracaptureerror.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.CameraCaptureError +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.CameraCaptureError + +## -description +Gets the camera capture error associated with the app broadcast state. + +## -property-value +The camera capture error associated with the app broadcast state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_cameracapturestate.md b/windows.media.capture/appbroadcaststate_cameracapturestate.md new file mode 100644 index 0000000000..3c8e601dbe --- /dev/null +++ b/windows.media.capture/appbroadcaststate_cameracapturestate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.CameraCaptureState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.CameraCaptureState + +## -description +Gets the camera capture state. + +## -property-value +The camera capture state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_cameracapturestatechanged.md b/windows.media.capture/appbroadcaststate_cameracapturestatechanged.md new file mode 100644 index 0000000000..169a08280d --- /dev/null +++ b/windows.media.capture/appbroadcaststate_cameracapturestatechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastState.CameraCaptureStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastState.CameraCaptureStateChanged + +## -description +Occurs when the camera capture state changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_capturetargetclosed.md b/windows.media.capture/appbroadcaststate_capturetargetclosed.md new file mode 100644 index 0000000000..2e7ba3be6a --- /dev/null +++ b/windows.media.capture/appbroadcaststate_capturetargetclosed.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastState.CaptureTargetClosed +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastState.CaptureTargetClosed + +## -description +Occurs when the capture target is closed. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_encodedvideosize.md b/windows.media.capture/appbroadcaststate_encodedvideosize.md new file mode 100644 index 0000000000..5aa4f1c842 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_encodedvideosize.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.EncodedVideoSize +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.EncodedVideoSize + +## -description +Gets the encoded video size of the app broadcast. + +## -property-value +The encoded video size of the app broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_iscapturetargetrunning.md b/windows.media.capture/appbroadcaststate_iscapturetargetrunning.md new file mode 100644 index 0000000000..97626109cc --- /dev/null +++ b/windows.media.capture/appbroadcaststate_iscapturetargetrunning.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.IsCaptureTargetRunning +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.IsCaptureTargetRunning + +## -description +Gets a value indicating if the capture target is currently running. + +## -property-value +True if the capture target is currently running; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_microphonecaptureerror.md b/windows.media.capture/appbroadcaststate_microphonecaptureerror.md new file mode 100644 index 0000000000..275f4b8fe6 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_microphonecaptureerror.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.MicrophoneCaptureError +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.MicrophoneCaptureError + +## -description +Gets the microphone capture error associated with the app broadcast state. + +## -property-value +The microphone capture error associated with the app broadcast state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_microphonecapturestate.md b/windows.media.capture/appbroadcaststate_microphonecapturestate.md new file mode 100644 index 0000000000..a7675a2641 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_microphonecapturestate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.MicrophoneCaptureState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.MicrophoneCaptureState + +## -description +Gets the microphone capture state. + +## -property-value +The microphone capture state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_microphonecapturestatechanged.md b/windows.media.capture/appbroadcaststate_microphonecapturestatechanged.md new file mode 100644 index 0000000000..d215f75e0f --- /dev/null +++ b/windows.media.capture/appbroadcaststate_microphonecapturestatechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastState.MicrophoneCaptureStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastState.MicrophoneCaptureStateChanged + +## -description +Occurs when the microphone capture state changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_oauthcallbackuri.md b/windows.media.capture/appbroadcaststate_oauthcallbackuri.md new file mode 100644 index 0000000000..315e3c10e8 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_oauthcallbackuri.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.OAuthCallbackUri +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.OAuthCallbackUri + +## -description +Gets the OAuth callback URI associated with the app broadcast state. + +## -property-value +The OAuth callback URI. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_oauthrequesturi.md b/windows.media.capture/appbroadcaststate_oauthrequesturi.md new file mode 100644 index 0000000000..e7a262be90 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_oauthrequesturi.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.OAuthRequestUri +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.OAuthRequestUri + +## -description +Gets the OAuth request URI associated with the app broadcast state. + +## -property-value +The OAuth request URI. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_pluginstate.md b/windows.media.capture/appbroadcaststate_pluginstate.md new file mode 100644 index 0000000000..20cc3ee652 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_pluginstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.PlugInState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.PlugInState + +## -description +Gets the state of the plugin associated with the app broadcast state. + +## -property-value +The state of the plugin associated with the app broadcast state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_pluginstatechanged.md b/windows.media.capture/appbroadcaststate_pluginstatechanged.md new file mode 100644 index 0000000000..00e6e8b9a5 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_pluginstatechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastState.PlugInStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastState.PlugInStateChanged + +## -description +Occurs when the state of the plugin associated with the app broadcast state changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_restartcameracapture_474554349.md b/windows.media.capture/appbroadcaststate_restartcameracapture_474554349.md new file mode 100644 index 0000000000..78208c6827 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_restartcameracapture_474554349.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastState.RestartCameraCapture +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastState.RestartCameraCapture + +## -description +Restarts camera capture for the app broadcast. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_restartmicrophonecapture_1039055963.md b/windows.media.capture/appbroadcaststate_restartmicrophonecapture_1039055963.md new file mode 100644 index 0000000000..9706edc973 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_restartmicrophonecapture_1039055963.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastState.RestartMicrophoneCapture +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastState.RestartMicrophoneCapture + +## -description +Restarts microphone capture for the app broadcast. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_shouldcapturecamera.md b/windows.media.capture/appbroadcaststate_shouldcapturecamera.md new file mode 100644 index 0000000000..e144a6bf86 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_shouldcapturecamera.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.ShouldCaptureCamera +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.ShouldCaptureCamera + +## -description +Gets or sets a value specifying whether the camera should be captured for the app broadcast. + +## -property-value +A value specifying whether the camera should be captured for the app broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_shouldcapturemicrophone.md b/windows.media.capture/appbroadcaststate_shouldcapturemicrophone.md new file mode 100644 index 0000000000..abe3380259 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_shouldcapturemicrophone.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.ShouldCaptureMicrophone +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.ShouldCaptureMicrophone + +## -description +Gets or sets a value specifying whether the microphone should be captured for the app broadcast. + +## -property-value +A value specifying whether the microphone should be captured for the app broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_signinstate.md b/windows.media.capture/appbroadcaststate_signinstate.md new file mode 100644 index 0000000000..d86870188a --- /dev/null +++ b/windows.media.capture/appbroadcaststate_signinstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.SignInState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.SignInState + +## -description +Gets or sets a value specifying the sign-in state of the app broadcast. + +## -property-value +A value specifying the sign-in state of the app broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_streamstate.md b/windows.media.capture/appbroadcaststate_streamstate.md new file mode 100644 index 0000000000..c5711c5ed0 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_streamstate.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.StreamState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.StreamState + +## -description +Gets a value specifying the state of the app broadcast stream. + +## -property-value +A value specifying the state of the app broadcast stream. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_streamstatechanged.md b/windows.media.capture/appbroadcaststate_streamstatechanged.md new file mode 100644 index 0000000000..9889dd2806 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_streamstatechanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastState.StreamStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastState.StreamStateChanged + +## -description +Occurs when the stream state of the app broadcast changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_terminationreason.md b/windows.media.capture/appbroadcaststate_terminationreason.md new file mode 100644 index 0000000000..0324c73f66 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_terminationreason.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.TerminationReason +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.TerminationReason + +## -description +Gets a value specifying the reason that the app broadcast was terminated. + +## -property-value +A value specifying the reason that the app broadcast was terminated. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_terminationreasonpluginspecific.md b/windows.media.capture/appbroadcaststate_terminationreasonpluginspecific.md new file mode 100644 index 0000000000..8d351375eb --- /dev/null +++ b/windows.media.capture/appbroadcaststate_terminationreasonpluginspecific.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.TerminationReasonPlugInSpecific +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.TerminationReasonPlugInSpecific + +## -description +Gets a value indicating the plug-in-specified reason that app broadcast was terminated. + +## -property-value +A value indicating the plug-in-specified reason that app broadcast was terminated. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_viewercount.md b/windows.media.capture/appbroadcaststate_viewercount.md new file mode 100644 index 0000000000..f03805d634 --- /dev/null +++ b/windows.media.capture/appbroadcaststate_viewercount.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastState.ViewerCount +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastState.ViewerCount + +## -description +Gets the viewer count of the app broadcast. + +## -property-value +The viewer count of the app broadcast. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststate_viewercountchanged.md b/windows.media.capture/appbroadcaststate_viewercountchanged.md new file mode 100644 index 0000000000..c92fcd53ee --- /dev/null +++ b/windows.media.capture/appbroadcaststate_viewercountchanged.md @@ -0,0 +1,25 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastState.ViewerCountChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastState.ViewerCountChanged + +## -description +Occurs when the viewer count of the app broadcast changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioframe.md b/windows.media.capture/appbroadcaststreamaudioframe.md new file mode 100644 index 0000000000..ef29308650 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioframe.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastStreamAudioFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioFrame + +## -description +Represents a frame of audio samples in a broadcast stream. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by calling [AppBroadcastStreamReader.TryGetNextAudioFrame](appbroadcaststreamreader_trygetnextaudioframe.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioframe_audiobuffer.md b/windows.media.capture/appbroadcaststreamaudioframe_audiobuffer.md new file mode 100644 index 0000000000..955d95c149 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioframe_audiobuffer.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamAudioFrame.AudioBuffer +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioFrame.AudioBuffer + +## -description +Gets the buffer containing the audio samples for the broadcast audio frame. + +## -property-value +The buffer containing the audio samples for the broadcast audio frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioframe_audioheader.md b/windows.media.capture/appbroadcaststreamaudioframe_audioheader.md new file mode 100644 index 0000000000..3eaf2ca591 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioframe_audioheader.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamAudioFrame.AudioHeader +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioFrame.AudioHeader + +## -description +Gets an object that contains metadata about the associated broadcast audio frame. + +## -property-value +An object that contains metadata about the associated broadcast audio frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioheader.md b/windows.media.capture/appbroadcaststreamaudioheader.md new file mode 100644 index 0000000000..f918e478fa --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioheader.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastStreamAudioHeader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioHeader + +## -description +Provides metadata about a broadcast audio frame. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by accessing the [AudioHeader](appbroadcaststreamaudioframe_audioheader.md) property of an [AppBroadcastStreamAudioFrame](appbroadcaststreamaudioframe.md) object obtained from a call to [AppBroadcastStreamReader.TryGetNextAudioFrame](appbroadcaststreamreader_trygetnextaudioframe.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioheader_absolutetimestamp.md b/windows.media.capture/appbroadcaststreamaudioheader_absolutetimestamp.md new file mode 100644 index 0000000000..f2bdd3a571 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioheader_absolutetimestamp.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamAudioHeader.AbsoluteTimestamp +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioHeader.AbsoluteTimestamp + +## -description +Gets a time stamp indicating the system time at which the audio frame was captured. + +## -property-value +A time stamp indicating the system time at which the audio frame was captured. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioheader_duration.md b/windows.media.capture/appbroadcaststreamaudioheader_duration.md new file mode 100644 index 0000000000..02fb96330f --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioheader_duration.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamAudioHeader.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioHeader.Duration + +## -description +Gets a value indicating the duration of the audio frame. + +## -property-value +The duration of the audio frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioheader_frameid.md b/windows.media.capture/appbroadcaststreamaudioheader_frameid.md new file mode 100644 index 0000000000..e2e02c6c4d --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioheader_frameid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamAudioHeader.FrameId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioHeader.FrameId + +## -description +Gets a value that identifies the audio frame. + +## -property-value +A value that identifies the audio frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioheader_hasdiscontinuity.md b/windows.media.capture/appbroadcaststreamaudioheader_hasdiscontinuity.md new file mode 100644 index 0000000000..637738d110 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioheader_hasdiscontinuity.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamAudioHeader.HasDiscontinuity +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioHeader.HasDiscontinuity + +## -description +Gets a value indicating whether the audio frame contains a discontinuity in the audio stream. + +## -property-value +True if the audio frame contains a discontinuity; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamaudioheader_relativetimestamp.md b/windows.media.capture/appbroadcaststreamaudioheader_relativetimestamp.md new file mode 100644 index 0000000000..e693dde7a5 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamaudioheader_relativetimestamp.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamAudioHeader.RelativeTimestamp +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamAudioHeader.RelativeTimestamp + +## -description +Gets a time stamp indicating the relative time within the audio stream at which the audio frame was captured. + +## -property-value +A time stamp indicating the relative time within the audio stream at which the audio frame was captured. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader.md b/windows.media.capture/appbroadcaststreamreader.md new file mode 100644 index 0000000000..ddedd5b9c6 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastStreamReader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader + +## -description +Provides methods and events for obtaining audio and video frames from an app broadcast stream. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by accessing the [AppBroadcastBackgroundServiceStreamInfo.BroadcastStreamReader](appbroadcastbackgroundservicestreaminfo_broadcaststreamreader.md) + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_audioaacsequence.md b/windows.media.capture/appbroadcaststreamreader_audioaacsequence.md new file mode 100644 index 0000000000..a0df74944f --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_audioaacsequence.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamReader.AudioAacSequence +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.AudioAacSequence + +## -description +Gets a buffer containing the sequence header for the AAC audio stream. + +## -property-value +A buffer containing the sequence header for the AAC audio stream. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_audiobitrate.md b/windows.media.capture/appbroadcaststreamreader_audiobitrate.md new file mode 100644 index 0000000000..91e85f2e24 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_audiobitrate.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamReader.AudioBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.AudioBitrate + +## -description +Gets the bitrate of the audio stream associated with the [AppBroadcastStreamReader](appbroadcaststreamreader.md), in bits per second. + +## -property-value +The bitrate of the audio stream, in bits per second. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_audiochannels.md b/windows.media.capture/appbroadcaststreamreader_audiochannels.md new file mode 100644 index 0000000000..0887a513f2 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_audiochannels.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamReader.AudioChannels +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.AudioChannels + +## -description +Gets the number of channels in the audio stream associated with the [AppBroadcastStreamReader](appbroadcaststreamreader.md). + +## -property-value +The number of channels in the audio stream. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_audioframearrived.md b/windows.media.capture/appbroadcaststreamreader_audioframearrived.md new file mode 100644 index 0000000000..28d14bba95 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_audioframearrived.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastStreamReader.AudioFrameArrived +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.AudioFrameArrived + +## -description +Raised when a new audio frame from the broadcast stream arrives. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_audiosamplerate.md b/windows.media.capture/appbroadcaststreamreader_audiosamplerate.md new file mode 100644 index 0000000000..fb143f968f --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_audiosamplerate.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamReader.AudioSampleRate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.AudioSampleRate + +## -description +Gets the sample rate of the audio stream associated with the [AppBroadcastStreamReader](appbroadcaststreamreader.md). + +## -property-value +The sample rate of the audio stream + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_trygetnextaudioframe_1561983342.md b/windows.media.capture/appbroadcaststreamreader_trygetnextaudioframe_1561983342.md new file mode 100644 index 0000000000..c5f744f85d --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_trygetnextaudioframe_1561983342.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastStreamReader.TryGetNextAudioFrame +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.TryGetNextAudioFrame + +## -description +Attempts to obtain an [AppBroadcastStreamAudioFrame](appbroadcaststreamaudioframe.md) object representing the latest audio frame from the broadcast stream. + +## -returns +If successful, the latest audio frame from the broadcast stream; otherwise, null. + +## -remarks +In order to avoid unnecessary copying of frame data, this method returns a reference to frame data stored in a circular buffer. After acquiring a frame, you should make a copy of frame data and release the buffer as quickly as possible. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_trygetnextvideoframe_1410796427.md b/windows.media.capture/appbroadcaststreamreader_trygetnextvideoframe_1410796427.md new file mode 100644 index 0000000000..f9ad281736 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_trygetnextvideoframe_1410796427.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Media.Capture.AppBroadcastStreamReader.TryGetNextVideoFrame +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.TryGetNextVideoFrame + +## -description +Attempts to obtain an [AppBroadcastStreamVideoFrame](appbroadcaststreamvideoframe.md) object representing the latest video frame from the broadcast stream. + +## -returns +If successful, the latest video frame from the broadcast stream; otherwise, null. + +## -remarks +In order to avoid unnecessary copying of frame data, this method returns a reference to frame data stored in a circular buffer. After acquiring a frame, you should make a copy of frame data and release the buffer as quickly as possible. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_videobitrate.md b/windows.media.capture/appbroadcaststreamreader_videobitrate.md new file mode 100644 index 0000000000..fdd2e44207 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_videobitrate.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamReader.VideoBitrate +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.VideoBitrate + +## -description +Gets the bitrate of the video stream associated with the [AppBroadcastStreamReader](appbroadcaststreamreader.md), in bits per second. + +## -property-value +The bitrate of the video stream, in bits per second. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_videoframearrived.md b/windows.media.capture/appbroadcaststreamreader_videoframearrived.md new file mode 100644 index 0000000000..e69c5407e9 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_videoframearrived.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Media.Capture.AppBroadcastStreamReader.VideoFrameArrived +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.VideoFrameArrived + +## -description +Raised when a new video frame from the broadcast stream arrives. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_videoheight.md b/windows.media.capture/appbroadcaststreamreader_videoheight.md new file mode 100644 index 0000000000..a03923899c --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_videoheight.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamReader.VideoHeight +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.VideoHeight + +## -description +Gets the height of the frames in the video stream associated with the [AppBroadcastStreamReader](appbroadcaststreamreader.md). + +## -property-value +The height of the frames in the video stream + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamreader_videowidth.md b/windows.media.capture/appbroadcaststreamreader_videowidth.md new file mode 100644 index 0000000000..7ed6f2a9e3 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamreader_videowidth.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamReader.VideoWidth +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamReader.VideoWidth + +## -description +Gets the width of the frames in the video stream associated with the [AppBroadcastStreamReader](appbroadcaststreamreader.md). + +## -property-value +The width of the frames in the video stream + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamstate.md b/windows.media.capture/appbroadcaststreamstate.md new file mode 100644 index 0000000000..2fd9cc7be2 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamstate.md @@ -0,0 +1,51 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastStreamState +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppBroadcastStreamState + +## -description +Specifies the state of an app broadcast stream. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields + +## -field Terminated:4 +The app broadcast stream was terminated. + +## -field StreamReady:1 +The app broadcast stream is ready. + +## -field Started:2 +The app broadast stream has been started. + +## -field Paused:3 +The app broadcast stream has been paused. + +## -field Initializing:0 +The app broadcast stream is initializing. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamstatechangedeventargs.md b/windows.media.capture/appbroadcaststreamstatechangedeventargs.md new file mode 100644 index 0000000000..6bd1980819 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamstatechangedeventargs.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastStreamStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastStreamStateChangedEventArgs + +## -description +Provides data for the [AppBroadcastState.StreamStateChanged](./appbroadcaststate_streamstatechanged.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamstatechangedeventargs_streamstate.md b/windows.media.capture/appbroadcaststreamstatechangedeventargs_streamstate.md new file mode 100644 index 0000000000..e1577ee9c2 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamstatechangedeventargs_streamstate.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamStateChangedEventArgs.StreamState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamStateChangedEventArgs.StreamState + +## -description +Gets the new state of the app broadcast stream. + +## -property-value + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoframe.md b/windows.media.capture/appbroadcaststreamvideoframe.md new file mode 100644 index 0000000000..dafeda9e39 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoframe.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastStreamVideoFrame +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoFrame + +## -description +Represents a video frame in a broadcast stream. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by calling [AppBroadcastStreamReader.TryGetNextVideoFrame](appbroadcaststreamreader_trygetnextvideoframe.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoframe_videobuffer.md b/windows.media.capture/appbroadcaststreamvideoframe_videobuffer.md new file mode 100644 index 0000000000..a18c40f8f4 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoframe_videobuffer.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoFrame.VideoBuffer +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoFrame.VideoBuffer + +## -description +Gets the buffer containing the image data for the broadcast audio frame. + +## -property-value +The buffer containing the image data for the broadcast audio frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoframe_videoheader.md b/windows.media.capture/appbroadcaststreamvideoframe_videoheader.md new file mode 100644 index 0000000000..a7defd296f --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoframe_videoheader.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoFrame.VideoHeader +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoFrame.VideoHeader + +## -description +Gets an object that contains metadata about the associated broadcast video frame. + +## -property-value +An object that contains metadata about the associated broadcast video frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoheader.md b/windows.media.capture/appbroadcaststreamvideoheader.md new file mode 100644 index 0000000000..6fa866daa2 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoheader.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastStreamVideoHeader +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoHeader + +## -description +Provides metadata about a broadcast video frame. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by accessing the [VideoHeader](appbroadcaststreamvideoframe_videoheader.md) property of an [AppBroadcastStreamVideoFrame](appbroadcaststreamvideoframe.md) object obtained from a call to [AppBroadcastStreamReader.TryGetNextVideoFrame](appbroadcaststreamreader_trygetnextvideoframe.md). + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoheader_absolutetimestamp.md b/windows.media.capture/appbroadcaststreamvideoheader_absolutetimestamp.md new file mode 100644 index 0000000000..a590ad678f --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoheader_absolutetimestamp.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoHeader.AbsoluteTimestamp +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoHeader.AbsoluteTimestamp + +## -description +Gets a time stamp indicating the system time at which the video frame was captured. + +## -property-value +A time stamp indicating the system time at which the audio frame was captured. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoheader_duration.md b/windows.media.capture/appbroadcaststreamvideoheader_duration.md new file mode 100644 index 0000000000..d5b254adf5 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoheader_duration.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoHeader.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoHeader.Duration + +## -description +Gets a value indicating the duration of the video frame. + +## -property-value +The duration of the video frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoheader_frameid.md b/windows.media.capture/appbroadcaststreamvideoheader_frameid.md new file mode 100644 index 0000000000..7b73338fd1 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoheader_frameid.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoHeader.FrameId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoHeader.FrameId + +## -description +Gets a value that identifies the video frame. + +## -property-value +A value that identifies the video frame. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoheader_hasdiscontinuity.md b/windows.media.capture/appbroadcaststreamvideoheader_hasdiscontinuity.md new file mode 100644 index 0000000000..ae6936c993 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoheader_hasdiscontinuity.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoHeader.HasDiscontinuity +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoHeader.HasDiscontinuity + +## -description +Gets a value indicating whether the video frame contains a discontinuity in the video stream. + +## -property-value +True if the video frame contains a discontinuity; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoheader_iskeyframe.md b/windows.media.capture/appbroadcaststreamvideoheader_iskeyframe.md new file mode 100644 index 0000000000..803731be56 --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoheader_iskeyframe.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoHeader.IsKeyFrame +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoHeader.IsKeyFrame + +## -description +Gets a value indicating whether the video frame is a key frame within the broadcast video stream. + +## -property-value +True is the video frame is a key frame; otherwise, false. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcaststreamvideoheader_relativetimestamp.md b/windows.media.capture/appbroadcaststreamvideoheader_relativetimestamp.md new file mode 100644 index 0000000000..832e1c1bae --- /dev/null +++ b/windows.media.capture/appbroadcaststreamvideoheader_relativetimestamp.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastStreamVideoHeader.RelativeTimestamp +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastStreamVideoHeader.RelativeTimestamp + +## -description +Gets a time stamp indicating the relative time within the video stream at which the video frame was captured. + +## -property-value +The relative time within the video stream at which the video frame was captured. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastterminationreason.md b/windows.media.capture/appbroadcastterminationreason.md new file mode 100644 index 0000000000..7ab4c01856 --- /dev/null +++ b/windows.media.capture/appbroadcastterminationreason.md @@ -0,0 +1,71 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastTerminationReason +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppBroadcastTerminationReason + +## -description +Specifies the reason that an app broadcast was terminated. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -enum-fields + +## -field UnsupportedFormat:7 +The app broadcast was terminated because it uses an unsupported format. + +## -field ServiceUnavailable:5 +The app broadcast was terminated because the service was unavailable. + +## -field ServiceError:4 +The app broadcast was terminated because there was a service error. + +## -field ServiceAbort:3 +The app broadcast was terminated because the service aborted the broadcast. + +## -field NormalTermination:0 +The app broadcast was terminated because it was terminated normally. + +## -field NoNetworkConnectivity:2 +The app broadcast was terminated because there is no network connectivity. + +## -field LostConnectionToService:1 +The app broadcast was terminated because the connection to the service was lost. + +## -field InternalError:6 +The app broadcast was terminated because of an internal error. + +## -field BackgroundTaskUnresponsive:9 +The app broadcast was terminated because the app broadcast background task was unresponsive. + +## -field BackgroundTaskTerminated:8 +The app broadcast was terminated because the app broadcast background task was terminated. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcasttriggerdetails.md b/windows.media.capture/appbroadcasttriggerdetails.md new file mode 100644 index 0000000000..7ee4e64457 --- /dev/null +++ b/windows.media.capture/appbroadcasttriggerdetails.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastTriggerDetails +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastTriggerDetails + +## -description +Provides details associated with a broadcast app background task. + +> [!NOTE] +> This API requires the **appBroadcast** and **appBroadcastSettings** capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. + +## -remarks +Get an instance of this class by casting the [TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property of the [IBackgroundTaskInstance](../windows.applicationmodel.background/ibackgroundtaskinstance.md) passed into your background task's [Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcasttriggerdetails_backgroundservice.md b/windows.media.capture/appbroadcasttriggerdetails_backgroundservice.md new file mode 100644 index 0000000000..3e3bb8aefe --- /dev/null +++ b/windows.media.capture/appbroadcasttriggerdetails_backgroundservice.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastTriggerDetails.BackgroundService +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastTriggerDetails.BackgroundService + +## -description +Gets an object that provides an interface between the broadcasting UWP app and the system-hosted broadcast service. + +## -property-value +An object that provides an interface between the broadcasting UWP app and the system-hosted broadcast service. + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastvideoencodingbitratemode.md b/windows.media.capture/appbroadcastvideoencodingbitratemode.md new file mode 100644 index 0000000000..e377b354bc --- /dev/null +++ b/windows.media.capture/appbroadcastvideoencodingbitratemode.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastVideoEncodingBitrateMode +-api-type: winrt enum +--- + + + +# AppBroadcastVideoEncodingBitrateMode + +## -description +Specifies the mode for setting the bitrate for broadcast video encoding. + +## -enum-fields +### -field Custom:0 +The bitrate specified with the [AppBroadcastProviderSettings.CustomVideoEncodingBitrate](appbroadcastprovidersettings_customvideoencodingbitrate.md) property is used. + +### -field Auto:1 +The bitrate is set automatically by the system. + + +## -remarks +This enumeration is used by the [AppBroadcastProviderSettings.VideoEncodingBitrateMode](appbroadcastprovidersettings_videoencodingbitratemode.md) property. + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastvideoencodingresolutionmode.md b/windows.media.capture/appbroadcastvideoencodingresolutionmode.md new file mode 100644 index 0000000000..a95dadd5b7 --- /dev/null +++ b/windows.media.capture/appbroadcastvideoencodingresolutionmode.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastVideoEncodingResolutionMode +-api-type: winrt enum +--- + + + +# AppBroadcastVideoEncodingResolutionMode + +## -description +Specifies the mode for setting the resolution for broadcast video encoding. + +## -enum-fields +### -field Custom:0 +The resolution specified with the [AppBroadcastProviderSettings.CustomVideoEncodingHeight](appbroadcastprovidersettings_customvideoencodingheight.md) and [CustomVideoEncodingBitrate](appbroadcastprovidersettings_customvideoencodingbitrate.md) properties is used. + +### -field Auto:1 +The resolution is set automatically by the system. + + +## -remarks + +## -examples + +## -see-also + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastviewercountchangedeventargs.md b/windows.media.capture/appbroadcastviewercountchangedeventargs.md new file mode 100644 index 0000000000..6cdaf16aa8 --- /dev/null +++ b/windows.media.capture/appbroadcastviewercountchangedeventargs.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.Media.Capture.AppBroadcastViewerCountChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppBroadcastViewerCountChangedEventArgs + +## -description +Provides data for the [AppBroadcastViewerCountChanged](./appbroadcaststate_viewercountchanged.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appbroadcastviewercountchangedeventargs_viewercount.md b/windows.media.capture/appbroadcastviewercountchangedeventargs_viewercount.md new file mode 100644 index 0000000000..67d5219fae --- /dev/null +++ b/windows.media.capture/appbroadcastviewercountchangedeventargs_viewercount.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.Media.Capture.AppBroadcastViewerCountChangedEventArgs.ViewerCount +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppBroadcastViewerCountChangedEventArgs.ViewerCount + +## -description +Gets the new viewer count. + +## -property-value +The new viewer count. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appBroadcast +appBroadcastSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys.md b/windows.media.capture/appcapturealternateshortcutkeys.md index da46f1a138..6f2d0d7669 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys.md +++ b/windows.media.capture/appcapturealternateshortcutkeys.md @@ -1,23 +1,23 @@ ---- --api-id: T:Windows.Media.Capture.AppCaptureAlternateShortcutKeys --api-type: winrt class ---- - - - -# Windows.Media.Capture.AppCaptureAlternateShortcutKeys - -## -description -Defines alternate shortcut keys for app capture. - -> [!NOTE] -> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. - -## -remarks -Get an instance of this class with the [AlternateShortcutKeys](appcapturesettings_alternateshortcutkeys.md) property. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Media.Capture.AppCaptureAlternateShortcutKeys +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys + +## -description +Defines alternate shortcut keys for app capture. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks +Get an instance of this class with the [AlternateShortcutKeys](appcapturesettings_alternateshortcutkeys.md) property. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md index b0eb59d7f6..b875b5376b 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokey.md @@ -23,3 +23,7 @@ The save historical video shortcut key. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md index 2ee30f9b75..f6864b2729 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_savehistoricalvideokeymodifiers.md @@ -23,3 +23,7 @@ The save historical video shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md index 4a00db87d9..dd066f449f 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkey.md @@ -1,25 +1,25 @@ ---- --api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey --api-type: winrt property ---- - - - -# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey - -## -description -Gets or sets the take screenshot shortcut key. - -> [!NOTE] -> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. - -## -property-value -The take screenshot shortcut key. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureAlternateShortcutKeys.TakeScreenshotKey + +## -description +Gets or sets the take screenshot shortcut key. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +The take screenshot shortcut key. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md index 7c2a19ef8f..6aaebb62a9 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_takescreenshotkeymodifiers.md @@ -23,3 +23,7 @@ The take screenshot shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md index 160396b291..cf358405ed 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkey.md @@ -23,3 +23,7 @@ The toggle broadcast shortcut key. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md index a0768a7f08..fa3a3d653f 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglebroadcastkeymodifiers.md @@ -23,3 +23,7 @@ The toggle broadcast shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md index c315a368d0..8ec6d63bef 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekey.md @@ -23,3 +23,7 @@ The toggle camera capture shortcut key. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md index 491f67e880..85798f7e15 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglecameracapturekeymodifiers.md @@ -23,3 +23,7 @@ The toggle camera capture shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md index ad990c7ef9..2fb88a9737 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkey.md @@ -23,3 +23,7 @@ The toggle game bar shortcut key. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md index 22be90525f..bf252b0d77 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglegamebarkeymodifiers.md @@ -23,3 +23,4 @@ The toggle game bar shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md index 10b039dd88..db78d6ff44 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekey.md @@ -23,3 +23,7 @@ The toggle microphone capture shortcut key. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md index 358acaa1a1..1b5b7f9df6 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglemicrophonecapturekeymodifiers.md @@ -23,3 +23,7 @@ The toggle microphone capture shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md index 6d6272ad08..f3f197b078 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkey.md @@ -23,3 +23,7 @@ The toggle recoding indicator shortcut key. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md index 29efb80f71..8b9a4b8ad0 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingindicatorkeymodifiers.md @@ -23,3 +23,7 @@ The toggle recording indicator shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md index fd15b3ee89..6abe82ec45 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkey.md @@ -23,3 +23,7 @@ The toggle recording shortcut key. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md index dbf3d4dcf4..4c12ac211e 100644 --- a/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md +++ b/windows.media.capture/appcapturealternateshortcutkeys_togglerecordingkeymodifiers.md @@ -23,3 +23,7 @@ The toggle recording shortcut key modifiers. ## -examples ## -see-also +[AppCaptureAlternateShortcutKeys](appcapturealternateshortcutkeys.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturedurationgeneratedeventargs.md b/windows.media.capture/appcapturedurationgeneratedeventargs.md new file mode 100644 index 0000000000..5063c09e2d --- /dev/null +++ b/windows.media.capture/appcapturedurationgeneratedeventargs.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureDurationGeneratedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureDurationGeneratedEventArgs + +## -description +Provides data for the [AppCaptureRecordOperation.DurationGenerated](./appcapturerecordoperation_durationgenerated.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturedurationgeneratedeventargs_duration.md b/windows.media.capture/appcapturedurationgeneratedeventargs_duration.md new file mode 100644 index 0000000000..af9b36baa9 --- /dev/null +++ b/windows.media.capture/appcapturedurationgeneratedeventargs_duration.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureDurationGeneratedEventArgs.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureDurationGeneratedEventArgs.Duration + +## -description +Gets the duration associated with the event. + +## -property-value +The duration associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturefilegeneratedeventargs.md b/windows.media.capture/appcapturefilegeneratedeventargs.md new file mode 100644 index 0000000000..2246f09a0b --- /dev/null +++ b/windows.media.capture/appcapturefilegeneratedeventargs.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureFileGeneratedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureFileGeneratedEventArgs + +## -description +Provides data for the [AppCaptureRecordOperation.FileGenerated](./appcapturerecordoperation_filegenerated.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturefilegeneratedeventargs_file.md b/windows.media.capture/appcapturefilegeneratedeventargs_file.md new file mode 100644 index 0000000000..19b9d8ee4d --- /dev/null +++ b/windows.media.capture/appcapturefilegeneratedeventargs_file.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureFileGeneratedEventArgs.File +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureFileGeneratedEventArgs.File + +## -description +Gets the file associated with the event. + +## -property-value +The file associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturehistoricalbufferlengthunit.md b/windows.media.capture/appcapturehistoricalbufferlengthunit.md index 699127dfd7..4aab5bd1e2 100644 --- a/windows.media.capture/appcapturehistoricalbufferlengthunit.md +++ b/windows.media.capture/appcapturehistoricalbufferlengthunit.md @@ -24,4 +24,7 @@ Seconds ## -examples -## -see-also \ No newline at end of file +## -see-also + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturemanager.md b/windows.media.capture/appcapturemanager.md index e8a96655f6..e7e6e31c9f 100644 --- a/windows.media.capture/appcapturemanager.md +++ b/windows.media.capture/appcapturemanager.md @@ -21,3 +21,7 @@ Provides access to app capture settings. ## -examples ## -see-also +[Object](https://msdn.microsoft.com/library/system.object.aspx) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturemanager_applysettings_1739846005.md b/windows.media.capture/appcapturemanager_applysettings_1739846005.md index b8524cd73a..0eaac1cb08 100644 --- a/windows.media.capture/appcapturemanager_applysettings_1739846005.md +++ b/windows.media.capture/appcapturemanager_applysettings_1739846005.md @@ -24,7 +24,7 @@ The settings to apply. ## -examples ## -see-also - +[AppCaptureManager](appcapturemanager.md) ## -capabilities -appCaptureSettings \ No newline at end of file +appCaptureSettings diff --git a/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md b/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md index 938f24d102..b19a5e0be8 100644 --- a/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md +++ b/windows.media.capture/appcapturemanager_getcurrentsettings_1587076637.md @@ -23,7 +23,7 @@ The current app capture settings. ## -examples ## -see-also - +[AppCaptureManager](appcapturemanager.md) ## -capabilities -appCaptureSettings \ No newline at end of file +appCaptureSettings diff --git a/windows.media.capture/appcapturemicrophonecapturestate.md b/windows.media.capture/appcapturemicrophonecapturestate.md new file mode 100644 index 0000000000..b6be4958ec --- /dev/null +++ b/windows.media.capture/appcapturemicrophonecapturestate.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureMicrophoneCaptureState +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppCaptureMicrophoneCaptureState + +## -description +Specifies the state of microphone capture for app capture. + +## -enum-fields + +## -field Stopped:0 +Microphone capture is stopped. + +## -field Started:1 +Microphone capture has been started. + +## -field Failed:2 +Microphone capture has failed. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs.md b/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs.md new file mode 100644 index 0000000000..f0b3d8e799 --- /dev/null +++ b/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureMicrophoneCaptureStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureMicrophoneCaptureStateChangedEventArgs + +## -description +Provides data for the [AppCaptureState.MicrophoneCaptureStateChanged](./appcapturestate_microphonecapturestatechanged.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs_errorcode.md b/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs_errorcode.md new file mode 100644 index 0000000000..24c3d48ca6 --- /dev/null +++ b/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs_errorcode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureMicrophoneCaptureStateChangedEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureMicrophoneCaptureStateChangedEventArgs.ErrorCode + +## -description +Gets the error code associated with the event. + +## -property-value +The error code associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs_state.md b/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs_state.md new file mode 100644 index 0000000000..8a735c57d5 --- /dev/null +++ b/windows.media.capture/appcapturemicrophonecapturestatechangedeventargs_state.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureMicrophoneCaptureStateChangedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureMicrophoneCaptureStateChangedEventArgs.State + +## -description +Gets the new state of microphone capture for app capture. + +## -property-value +The new state of microphone capture for app capture. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordingstate.md b/windows.media.capture/appcapturerecordingstate.md new file mode 100644 index 0000000000..acdc87bd13 --- /dev/null +++ b/windows.media.capture/appcapturerecordingstate.md @@ -0,0 +1,42 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureRecordingState +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.AppCaptureRecordingState + +## -description +Specifies the state of an app capture recording. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -enum-fields + +## -field InProgress:0 +The app capture recording is in progress. + +## -field Failed:2 +The app capture recording failed. + +## -field Completed:1 +The app capture recording has completed. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordingstatechangedeventargs.md b/windows.media.capture/appcapturerecordingstatechangedeventargs.md new file mode 100644 index 0000000000..25bef2ff3b --- /dev/null +++ b/windows.media.capture/appcapturerecordingstatechangedeventargs.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureRecordingStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureRecordingStateChangedEventArgs + +## -description +Provides data for the [AppCaptureRecordOperation.StateChanged](./appcapturerecordoperation_statechanged.md) event. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordingstatechangedeventargs_errorcode.md b/windows.media.capture/appcapturerecordingstatechangedeventargs_errorcode.md new file mode 100644 index 0000000000..0131e820c3 --- /dev/null +++ b/windows.media.capture/appcapturerecordingstatechangedeventargs_errorcode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureRecordingStateChangedEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureRecordingStateChangedEventArgs.ErrorCode + +## -description +Gets the error code associated with the event. + +## -property-value +The error code associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordingstatechangedeventargs_state.md b/windows.media.capture/appcapturerecordingstatechangedeventargs_state.md new file mode 100644 index 0000000000..5dda5e63fc --- /dev/null +++ b/windows.media.capture/appcapturerecordingstatechangedeventargs_state.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureRecordingStateChangedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureRecordingStateChangedEventArgs.State + +## -description +Gets the new state of the app capture recording operation. + +## -property-value +The new state of the app capture recording operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation.md b/windows.media.capture/appcapturerecordoperation.md new file mode 100644 index 0000000000..ed9e2e5ea2 --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureRecordOperation +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation + +## -description +Represents an app capture record operation. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_duration.md b/windows.media.capture/appcapturerecordoperation_duration.md new file mode 100644 index 0000000000..32ad713045 --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_duration.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureRecordOperation.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.Duration + +## -description +Gets the duration of the recording operation. + +## -property-value +The duration of the recording operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_durationgenerated.md b/windows.media.capture/appcapturerecordoperation_durationgenerated.md new file mode 100644 index 0000000000..54e1956db1 --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_durationgenerated.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.AppCaptureRecordOperation.DurationGenerated +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.DurationGenerated + +## -description +Occurs when the recording state changes due to the duration of the recording operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_errorcode.md b/windows.media.capture/appcapturerecordoperation_errorcode.md new file mode 100644 index 0000000000..f306f41664 --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_errorcode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureRecordOperation.ErrorCode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.ErrorCode + +## -description +Gets the error code associated with the recording operation. + +## -property-value +The error code associated with the recording operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_file.md b/windows.media.capture/appcapturerecordoperation_file.md new file mode 100644 index 0000000000..f6882d34db --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_file.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureRecordOperation.File +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.File + +## -description +Gets the file associated with the recording operation. + +## -property-value +The file associated with the recording operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_filegenerated.md b/windows.media.capture/appcapturerecordoperation_filegenerated.md new file mode 100644 index 0000000000..399863f08f --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_filegenerated.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.AppCaptureRecordOperation.FileGenerated +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.FileGenerated + +## -description +Occurs when the recording state changes due to the file associated with the recording operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_isfiletruncated.md b/windows.media.capture/appcapturerecordoperation_isfiletruncated.md new file mode 100644 index 0000000000..aa5fb9d211 --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_isfiletruncated.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureRecordOperation.IsFileTruncated +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.IsFileTruncated + +## -description +Gets a value indicating whether the file associated with the recording operation is truncated. + +## -property-value +True if the file is truncated; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_state.md b/windows.media.capture/appcapturerecordoperation_state.md new file mode 100644 index 0000000000..1370f4fdad --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_state.md @@ -0,0 +1,30 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureRecordOperation.State +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.State + +## -description +Gets a value specifying the current state of the app capture record operation. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +A value specifying the current state of the app capture record operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_statechanged.md b/windows.media.capture/appcapturerecordoperation_statechanged.md new file mode 100644 index 0000000000..515cf96817 --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_statechanged.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.AppCaptureRecordOperation.StateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.StateChanged + +## -description +Occurs when the state of the app capture record operation changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturerecordoperation_stoprecording_78947023.md b/windows.media.capture/appcapturerecordoperation_stoprecording_78947023.md new file mode 100644 index 0000000000..4011c0654d --- /dev/null +++ b/windows.media.capture/appcapturerecordoperation_stoprecording_78947023.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureRecordOperation.StopRecording +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureRecordOperation.StopRecording + +## -description +Stops the app capture record operation. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcaptureservices.md b/windows.media.capture/appcaptureservices.md new file mode 100644 index 0000000000..0ab16b9dc7 --- /dev/null +++ b/windows.media.capture/appcaptureservices.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureServices +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureServices + +## -description +Manages the state of app captures. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcaptureservices_cancapture.md b/windows.media.capture/appcaptureservices_cancapture.md new file mode 100644 index 0000000000..dec30cf096 --- /dev/null +++ b/windows.media.capture/appcaptureservices_cancapture.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureServices.CanCapture +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureServices.CanCapture + +## -description +Gets a value specifying whether app capture can be performed. + +## -property-value + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcaptureservices_record_792815795.md b/windows.media.capture/appcaptureservices_record_792815795.md new file mode 100644 index 0000000000..943d0ec143 --- /dev/null +++ b/windows.media.capture/appcaptureservices_record_792815795.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureServices.Record +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureServices.Record + +## -description +Initiates an app capture record operation. + +## -params + +## -returns +An object representing the record operation. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcaptureservices_recordtimespan_311351116.md b/windows.media.capture/appcaptureservices_recordtimespan_311351116.md new file mode 100644 index 0000000000..40ed934e83 --- /dev/null +++ b/windows.media.capture/appcaptureservices_recordtimespan_311351116.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureServices.RecordTimeSpan(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureServices.RecordTimeSpan + +## -description +Initiates an app capture record operation beginning at the specified time, for the specified duration. + +## -params + +## -param startTime +The time at which the app capture record operation is initiated. + +## -param duration +The duration of the app capture record operation. + +## -returns + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcaptureservices_state.md b/windows.media.capture/appcaptureservices_state.md new file mode 100644 index 0000000000..771adbc4f8 --- /dev/null +++ b/windows.media.capture/appcaptureservices_state.md @@ -0,0 +1,30 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureServices.State +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureServices.State + +## -description +Gets a value specifying the current state of the app capture services. + +> [!NOTE] +> This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime. + +## -property-value +A value specifying the current state of the app capture services. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings.md b/windows.media.capture/appcapturesettings.md index 9e0d625fea..ea55b53dbd 100644 --- a/windows.media.capture/appcapturesettings.md +++ b/windows.media.capture/appcapturesettings.md @@ -21,3 +21,7 @@ Represents app capture settings. ## -examples ## -see-also +[Object](https://msdn.microsoft.com/library/system.object.aspx) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_alternateshortcutkeys.md b/windows.media.capture/appcapturesettings_alternateshortcutkeys.md index 72f7af80e7..13f0f59e98 100644 --- a/windows.media.capture/appcapturesettings_alternateshortcutkeys.md +++ b/windows.media.capture/appcapturesettings_alternateshortcutkeys.md @@ -23,3 +23,7 @@ The alternate shortcut key settings. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md b/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md index 974bfca4c7..e33feb5ba0 100644 --- a/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md +++ b/windows.media.capture/appcapturesettings_appcapturedestinationfolder.md @@ -23,3 +23,7 @@ The app capture destination folder. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_audioencodingbitrate.md b/windows.media.capture/appcapturesettings_audioencodingbitrate.md index 3b3d15fbde..5e44d4c9fa 100644 --- a/windows.media.capture/appcapturesettings_audioencodingbitrate.md +++ b/windows.media.capture/appcapturesettings_audioencodingbitrate.md @@ -23,3 +23,7 @@ The audio encoding bitrate. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md b/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md index bd305435f1..0c78e49ed6 100644 --- a/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md +++ b/windows.media.capture/appcapturesettings_customvideoencodingbitrate.md @@ -23,3 +23,7 @@ The custom video encoding bitrate. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_customvideoencodingheight.md b/windows.media.capture/appcapturesettings_customvideoencodingheight.md index 2a57bf3842..6b159e42e3 100644 --- a/windows.media.capture/appcapturesettings_customvideoencodingheight.md +++ b/windows.media.capture/appcapturesettings_customvideoencodingheight.md @@ -23,3 +23,7 @@ The custom video encoding height. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_customvideoencodingwidth.md b/windows.media.capture/appcapturesettings_customvideoencodingwidth.md index 0a675413e3..5c747d46bb 100644 --- a/windows.media.capture/appcapturesettings_customvideoencodingwidth.md +++ b/windows.media.capture/appcapturesettings_customvideoencodingwidth.md @@ -23,3 +23,7 @@ The custom video encoding width. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_hashardwareencoder.md b/windows.media.capture/appcapturesettings_hashardwareencoder.md index 2e8539f1ed..802045c0ab 100644 --- a/windows.media.capture/appcapturesettings_hashardwareencoder.md +++ b/windows.media.capture/appcapturesettings_hashardwareencoder.md @@ -23,3 +23,7 @@ True if the device has a hardware encoder; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_historicalbufferlength.md b/windows.media.capture/appcapturesettings_historicalbufferlength.md index 3a1e0ba698..09269e5ba1 100644 --- a/windows.media.capture/appcapturesettings_historicalbufferlength.md +++ b/windows.media.capture/appcapturesettings_historicalbufferlength.md @@ -23,3 +23,7 @@ The historical buffer length. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md b/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md index a87dcb91a0..eb4d2c2b59 100644 --- a/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md +++ b/windows.media.capture/appcapturesettings_historicalbufferlengthunit.md @@ -23,3 +23,7 @@ The units of the historical buffer length. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_isappcaptureenabled.md b/windows.media.capture/appcapturesettings_isappcaptureenabled.md index 1f7cd4e36b..6eeb7cf24f 100644 --- a/windows.media.capture/appcapturesettings_isappcaptureenabled.md +++ b/windows.media.capture/appcapturesettings_isappcaptureenabled.md @@ -23,3 +23,7 @@ True if app capture is enabled; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md b/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md index eaf8a353cb..ce7b990fd3 100644 --- a/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md +++ b/windows.media.capture/appcapturesettings_isaudiocaptureenabled.md @@ -20,3 +20,7 @@ True if audio capture is enabled; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_iscpuconstrained.md b/windows.media.capture/appcapturesettings_iscpuconstrained.md index 891b9cee39..a3f2aef143 100644 --- a/windows.media.capture/appcapturesettings_iscpuconstrained.md +++ b/windows.media.capture/appcapturesettings_iscpuconstrained.md @@ -23,3 +23,7 @@ True if app capture is CPU-constrained; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_iscursorimagecaptureenabled.md b/windows.media.capture/appcapturesettings_iscursorimagecaptureenabled.md new file mode 100644 index 0000000000..3af8832039 --- /dev/null +++ b/windows.media.capture/appcapturesettings_iscursorimagecaptureenabled.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsCursorImageCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsCursorImageCaptureEnabled + +## -description +Gets a value indicating whether the cursor image is captured. + +## -property-value +True if the cursor image is captured; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_isdisabledbypolicy.md b/windows.media.capture/appcapturesettings_isdisabledbypolicy.md index 6ea9005495..ab89baccac 100644 --- a/windows.media.capture/appcapturesettings_isdisabledbypolicy.md +++ b/windows.media.capture/appcapturesettings_isdisabledbypolicy.md @@ -23,3 +23,7 @@ True if app capture is disabled by policy; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_isechocancellationenabled.md b/windows.media.capture/appcapturesettings_isechocancellationenabled.md new file mode 100644 index 0000000000..990e61b01e --- /dev/null +++ b/windows.media.capture/appcapturesettings_isechocancellationenabled.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureSettings.IsEchoCancellationEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureSettings.IsEchoCancellationEnabled + +## -description +Gets a value indicating whether echo cancellation is enabled for app capture. + +## -property-value +True if echo cancellation is enabled for app capture; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_isgpuconstrained.md b/windows.media.capture/appcapturesettings_isgpuconstrained.md index 3aeaeecd30..ca055fb0d3 100644 --- a/windows.media.capture/appcapturesettings_isgpuconstrained.md +++ b/windows.media.capture/appcapturesettings_isgpuconstrained.md @@ -23,3 +23,7 @@ True if app capture is GPU-constrained; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md b/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md index dd021aaed9..b83a0d4b2e 100644 --- a/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md +++ b/windows.media.capture/appcapturesettings_ishistoricalcaptureenabled.md @@ -23,3 +23,7 @@ True if historical capture is enabled; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md b/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md index 7cb69bd203..f5a25fd39d 100644 --- a/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md +++ b/windows.media.capture/appcapturesettings_ishistoricalcaptureonbatteryallowed.md @@ -23,3 +23,7 @@ True if historical capture is allowed while the device is on battery power; othe ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md b/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md index 8beac81884..05c9b5dd44 100644 --- a/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md +++ b/windows.media.capture/appcapturesettings_ishistoricalcaptureonwirelessdisplayallowed.md @@ -23,3 +23,7 @@ True if historical capture is allowed on wireless displays; otherwise, true. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_ismemoryconstrained.md b/windows.media.capture/appcapturesettings_ismemoryconstrained.md index a6a8292dff..bac6735209 100644 --- a/windows.media.capture/appcapturesettings_ismemoryconstrained.md +++ b/windows.media.capture/appcapturesettings_ismemoryconstrained.md @@ -23,3 +23,7 @@ True if the device is memory-constrained; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md index 3f1accb16d..38ed724c6e 100644 --- a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md +++ b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabled.md @@ -23,3 +23,7 @@ True if microphone capture is enabled; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md index c02c2f7d3c..041260b6c4 100644 --- a/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md +++ b/windows.media.capture/appcapturesettings_ismicrophonecaptureenabledbydefault.md @@ -23,3 +23,7 @@ True if microphone capture is enabled by default; otherwise, false. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_maximumrecordlength.md b/windows.media.capture/appcapturesettings_maximumrecordlength.md index 631a4cfd1e..a723c66030 100644 --- a/windows.media.capture/appcapturesettings_maximumrecordlength.md +++ b/windows.media.capture/appcapturesettings_maximumrecordlength.md @@ -23,3 +23,7 @@ The maximum recording length. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_microphonegain.md b/windows.media.capture/appcapturesettings_microphonegain.md index a29e63fc72..a030d06179 100644 --- a/windows.media.capture/appcapturesettings_microphonegain.md +++ b/windows.media.capture/appcapturesettings_microphonegain.md @@ -23,3 +23,7 @@ The gain applied to the microphone audio. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md b/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md index 129efbb036..11c976ff49 100644 --- a/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md +++ b/windows.media.capture/appcapturesettings_screenshotdestinationfolder.md @@ -23,3 +23,7 @@ The screenshot destination folder. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_systemaudiogain.md b/windows.media.capture/appcapturesettings_systemaudiogain.md index 22990b694b..a1cf024584 100644 --- a/windows.media.capture/appcapturesettings_systemaudiogain.md +++ b/windows.media.capture/appcapturesettings_systemaudiogain.md @@ -23,3 +23,7 @@ The gain applied to the system audio. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_videoencodingbitratemode.md b/windows.media.capture/appcapturesettings_videoencodingbitratemode.md index f443d0f3db..387d432210 100644 --- a/windows.media.capture/appcapturesettings_videoencodingbitratemode.md +++ b/windows.media.capture/appcapturesettings_videoencodingbitratemode.md @@ -23,3 +23,7 @@ The video encoding bitrate. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_videoencodingframeratemode.md b/windows.media.capture/appcapturesettings_videoencodingframeratemode.md index 34736714b4..a82bde7d20 100644 --- a/windows.media.capture/appcapturesettings_videoencodingframeratemode.md +++ b/windows.media.capture/appcapturesettings_videoencodingframeratemode.md @@ -23,3 +23,7 @@ The video encoding frame rate mode. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md b/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md index 084e10bf2d..c86396c3d5 100644 --- a/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md +++ b/windows.media.capture/appcapturesettings_videoencodingresolutionmode.md @@ -20,3 +20,7 @@ The video encoding resolution mode. ## -examples ## -see-also +[AppCaptureSettings](appcapturesettings.md) + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate.md b/windows.media.capture/appcapturestate.md new file mode 100644 index 0000000000..204d13ef51 --- /dev/null +++ b/windows.media.capture/appcapturestate.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.AppCaptureState +-api-type: winrt class +--- + + + +# Windows.Media.Capture.AppCaptureState + +## -description +Represents the state of app capture. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_capturetargetclosed.md b/windows.media.capture/appcapturestate_capturetargetclosed.md new file mode 100644 index 0000000000..ca4def3fa8 --- /dev/null +++ b/windows.media.capture/appcapturestate_capturetargetclosed.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.AppCaptureState.CaptureTargetClosed +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppCaptureState.CaptureTargetClosed + +## -description +Occurs when the capture target is closed. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_ishistoricalcaptureenabled.md b/windows.media.capture/appcapturestate_ishistoricalcaptureenabled.md new file mode 100644 index 0000000000..a869238152 --- /dev/null +++ b/windows.media.capture/appcapturestate_ishistoricalcaptureenabled.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureState.IsHistoricalCaptureEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureState.IsHistoricalCaptureEnabled + +## -description +Gets a value specifying whether historical app capture is enabled. + +## -property-value +True if the historical app capture is enabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_istargetrunning.md b/windows.media.capture/appcapturestate_istargetrunning.md new file mode 100644 index 0000000000..d7e6df7c9d --- /dev/null +++ b/windows.media.capture/appcapturestate_istargetrunning.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureState.IsTargetRunning +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureState.IsTargetRunning + +## -description +Gets a value indicating whether the app capture target is currently running. + +## -property-value +True if the app capture target is currently running; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_microphonecaptureerror.md b/windows.media.capture/appcapturestate_microphonecaptureerror.md new file mode 100644 index 0000000000..eefb7c3787 --- /dev/null +++ b/windows.media.capture/appcapturestate_microphonecaptureerror.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureState.MicrophoneCaptureError +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureState.MicrophoneCaptureError + +## -description +Gets an error code associated with microphone capture for app capture. + +## -property-value +An error code associated with microphone capture for app capture. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_microphonecapturestate.md b/windows.media.capture/appcapturestate_microphonecapturestate.md new file mode 100644 index 0000000000..7da68f5b39 --- /dev/null +++ b/windows.media.capture/appcapturestate_microphonecapturestate.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureState.MicrophoneCaptureState +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureState.MicrophoneCaptureState + +## -description +Gets the current microphone capture state. + +## -property-value +The current microphone capture state. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_microphonecapturestatechanged.md b/windows.media.capture/appcapturestate_microphonecapturestatechanged.md new file mode 100644 index 0000000000..f4ec94ba22 --- /dev/null +++ b/windows.media.capture/appcapturestate_microphonecapturestatechanged.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.AppCaptureState.MicrophoneCaptureStateChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.AppCaptureState.MicrophoneCaptureStateChanged + +## -description +Occurs when the state of microphone capture for app capture changes. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_restartmicrophonecapture_1039055963.md b/windows.media.capture/appcapturestate_restartmicrophonecapture_1039055963.md new file mode 100644 index 0000000000..e049737c67 --- /dev/null +++ b/windows.media.capture/appcapturestate_restartmicrophonecapture_1039055963.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Media.Capture.AppCaptureState.RestartMicrophoneCapture +-api-type: winrt method +--- + + + +# Windows.Media.Capture.AppCaptureState.RestartMicrophoneCapture + +## -description +Restarts microphone capture for app capture. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturestate_shouldcapturemicrophone.md b/windows.media.capture/appcapturestate_shouldcapturemicrophone.md new file mode 100644 index 0000000000..340209d656 --- /dev/null +++ b/windows.media.capture/appcapturestate_shouldcapturemicrophone.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.AppCaptureState.ShouldCaptureMicrophone +-api-type: winrt property +--- + + + +# Windows.Media.Capture.AppCaptureState.ShouldCaptureMicrophone + +## -description +Gets a value specifying whether the microphone should be captured. + +## -property-value +True if the microphone should be captured; otherwise, false. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturevideoencodingbitratemode.md b/windows.media.capture/appcapturevideoencodingbitratemode.md index f8cc8f46df..a6ae53bced 100644 --- a/windows.media.capture/appcapturevideoencodingbitratemode.md +++ b/windows.media.capture/appcapturevideoencodingbitratemode.md @@ -27,4 +27,7 @@ Standard bitrate. ## -examples -## -see-also \ No newline at end of file +## -see-also + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturevideoencodingframeratemode.md b/windows.media.capture/appcapturevideoencodingframeratemode.md index 81a69dfd2c..126f18e64a 100644 --- a/windows.media.capture/appcapturevideoencodingframeratemode.md +++ b/windows.media.capture/appcapturevideoencodingframeratemode.md @@ -24,4 +24,7 @@ Video is encoded with a high frame rate. ## -examples -## -see-also \ No newline at end of file +## -see-also + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/appcapturevideoencodingresolutionmode.md b/windows.media.capture/appcapturevideoencodingresolutionmode.md index eb876db579..cb3a44b51e 100644 --- a/windows.media.capture/appcapturevideoencodingresolutionmode.md +++ b/windows.media.capture/appcapturevideoencodingresolutionmode.md @@ -27,4 +27,7 @@ Standard resolution. ## -examples -## -see-also \ No newline at end of file +## -see-also + +## -capabilities +appCaptureSettings \ No newline at end of file diff --git a/windows.media.capture/cameracaptureui.md b/windows.media.capture/cameracaptureui.md index cdfbbecb2b..cf872864d1 100644 --- a/windows.media.capture/cameracaptureui.md +++ b/windows.media.capture/cameracaptureui.md @@ -39,13 +39,6 @@ This code shows how to use the **CameraCaptureUI** class to take a picture. The ## -see-also [Audio, video, and camera](http://msdn.microsoft.com/library/0fc12d26-f1cf-4da7-b5a7-735a5074b74a), [Capture photos and video with Windows built-in camera UI](https://msdn.microsoft.com/windows/uwp/audio-video-camera/capture-photos-and-video-with-cameracaptureui) -## -capabilities -webcam, microphone - -[!code-csharp[CameraCaptureUI_JavaScript] (../windows.media.capture/code/CameraCaptureUI/js/js/capturephoto.js#CameraCaptureUI_JavaScript)] - -## -see-also -[Audio, video, and camera](http://msdn.microsoft.com/library/0fc12d26-f1cf-4da7-b5a7-735a5074b74a), [Capture photos and video with Windows built-in camera UI](https://msdn.microsoft.com/windows/uwp/audio-video-camera/capture-photos-and-video-with-cameracaptureui) ## -capabilities webcam, microphone \ No newline at end of file diff --git a/windows.media.capture/foregroundactivationargument.md b/windows.media.capture/foregroundactivationargument.md new file mode 100644 index 0000000000..4eeb4a93f9 --- /dev/null +++ b/windows.media.capture/foregroundactivationargument.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Media.Capture.ForegroundActivationArgument +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.ForegroundActivationArgument + +## -description +Specifies the reason that an app broadcast plugin was activated in the foreground. + +## -enum-fields + +## -field SignInRequired:0 +The app broadcast plugin was activated in the foreground because sign-in is required. + +## -field MoreSettings:1 +The app broadcast plugin was activated in the foreground to enable the user to change plugin-specific settings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/gamebarcommand.md b/windows.media.capture/gamebarcommand.md new file mode 100644 index 0000000000..631d12ca11 --- /dev/null +++ b/windows.media.capture/gamebarcommand.md @@ -0,0 +1,83 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarCommand +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.GameBarCommand + +## -description +Specifies the set of Game Bar commands. + +## -enum-fields + +## -field ToggleStartStopRecord:2 +Toggle start/stop record. + +## -field ToggleStartStopBroadcast:10 +Toggle start/stop broadcast. + +## -field ToggleRecordingIndicator:13 +Toggle the recording indicator. + +## -field ToggleMicrophoneCapture:11 +Toggle microphone capture. + +## -field ToggleCameraCapture:12 +Toggle camera capture. + +## -field TakeScreenshot:5 +Take a screenshot. + +## -field StopRecord:4 +Stop recording. + +## -field StopBroadcast:7 +Stop broadcasting. + +## -field StartRecord:3 +Start recording. + +## -field StartBroadcast:6 +Start broadcasting. + +## -field ResumeBroadcast:9 +Resume broadcasting. + +## -field RecordHistoricalBuffer:1 +Record the historical buffer. + +## -field PauseBroadcast:8 +Pause broadcasting. + +## -field OpenGameBar:0 +Open the Game Bar. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarcommandorigin.md b/windows.media.capture/gamebarcommandorigin.md new file mode 100644 index 0000000000..09a649f4e1 --- /dev/null +++ b/windows.media.capture/gamebarcommandorigin.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarCommandOrigin +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.GameBarCommandOrigin + +## -description +Specifies the origin of a Game Bar command. + +## -enum-fields + +## -field ShortcutKey:0 +The Game Bar command originated from a shortcut key. + +## -field Cortana:1 +The Game Bar command originated from Cortana. + +## -field AppCommand:2 +The Game Bar command originated from an app-initiated command. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices.md b/windows.media.capture/gamebarservices.md new file mode 100644 index 0000000000..a2d9369cfc --- /dev/null +++ b/windows.media.capture/gamebarservices.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarServices +-api-type: winrt class +--- + + + +# Windows.Media.Capture.GameBarServices + +## -description +Manages the state of the Game Bar. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_appbroadcastservices.md b/windows.media.capture/gamebarservices_appbroadcastservices.md new file mode 100644 index 0000000000..955fbc87e8 --- /dev/null +++ b/windows.media.capture/gamebarservices_appbroadcastservices.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServices.AppBroadcastServices +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServices.AppBroadcastServices + +## -description +Gets an object that manages app broadcasts. + +## -property-value +An object that manages app broadcasts. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_appcaptureservices.md b/windows.media.capture/gamebarservices_appcaptureservices.md new file mode 100644 index 0000000000..c664969e35 --- /dev/null +++ b/windows.media.capture/gamebarservices_appcaptureservices.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServices.AppCaptureServices +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServices.AppCaptureServices + +## -description +Gets an object that manages app capture. + +## -property-value +An object that manages app capture. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_commandreceived.md b/windows.media.capture/gamebarservices_commandreceived.md new file mode 100644 index 0000000000..cd92d56090 --- /dev/null +++ b/windows.media.capture/gamebarservices_commandreceived.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.GameBarServices.CommandReceived +-api-type: winrt event +--- + + + +# Windows.Media.Capture.GameBarServices.CommandReceived + +## -description +Occurs when a Game Bar command is received. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_disablecapture_1880055380.md b/windows.media.capture/gamebarservices_disablecapture_1880055380.md new file mode 100644 index 0000000000..b9aaccff41 --- /dev/null +++ b/windows.media.capture/gamebarservices_disablecapture_1880055380.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Media.Capture.GameBarServices.DisableCapture +-api-type: winrt method +--- + + + +# Windows.Media.Capture.GameBarServices.DisableCapture + +## -description +Disables app capture. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_enablecapture_462205974.md b/windows.media.capture/gamebarservices_enablecapture_462205974.md new file mode 100644 index 0000000000..ea5f3de3f8 --- /dev/null +++ b/windows.media.capture/gamebarservices_enablecapture_462205974.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Media.Capture.GameBarServices.EnableCapture +-api-type: winrt method +--- + + + +# Windows.Media.Capture.GameBarServices.EnableCapture + +## -description +Enables app capture. + +## -params + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_sessionid.md b/windows.media.capture/gamebarservices_sessionid.md new file mode 100644 index 0000000000..e13da1123b --- /dev/null +++ b/windows.media.capture/gamebarservices_sessionid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServices.SessionId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServices.SessionId + +## -description +Gets a unique identifier for the Game Bar session. + +## -property-value +A unique identifier for the Game Bar session. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_targetcapturepolicy.md b/windows.media.capture/gamebarservices_targetcapturepolicy.md new file mode 100644 index 0000000000..e39ed831f1 --- /dev/null +++ b/windows.media.capture/gamebarservices_targetcapturepolicy.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServices.TargetCapturePolicy +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServices.TargetCapturePolicy + +## -description +Gets the policy for app capture of a target. + +## -property-value +The policy for app capture of a target. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservices_targetinfo.md b/windows.media.capture/gamebarservices_targetinfo.md new file mode 100644 index 0000000000..28b309e91c --- /dev/null +++ b/windows.media.capture/gamebarservices_targetinfo.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServices.TargetInfo +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServices.TargetInfo + +## -description +Gets an object that provides metadata for an app capture target. + +## -property-value +An object that provides metadata for an app capture target. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicescommandeventargs.md b/windows.media.capture/gamebarservicescommandeventargs.md new file mode 100644 index 0000000000..9e9c46d1f1 --- /dev/null +++ b/windows.media.capture/gamebarservicescommandeventargs.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarServicesCommandEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.GameBarServicesCommandEventArgs + +## -description +Provides data for the [GameBarServices.CommandReceived](./gamebarservices_commandreceived.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicescommandeventargs_command.md b/windows.media.capture/gamebarservicescommandeventargs_command.md new file mode 100644 index 0000000000..a2f8a4db3a --- /dev/null +++ b/windows.media.capture/gamebarservicescommandeventargs_command.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServicesCommandEventArgs.Command +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServicesCommandEventArgs.Command + +## -description +Gets a value specifying the Game Bar command associated with the event. + +## -property-value +A value specifying the Game Bar command associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicescommandeventargs_origin.md b/windows.media.capture/gamebarservicescommandeventargs_origin.md new file mode 100644 index 0000000000..f70e8aef31 --- /dev/null +++ b/windows.media.capture/gamebarservicescommandeventargs_origin.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServicesCommandEventArgs.Origin +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServicesCommandEventArgs.Origin + +## -description +Gets a value specifying the origin of the Game Bar command. + +## -property-value +A value specifying the origin of the Game Bar command. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicesdisplaymode.md b/windows.media.capture/gamebarservicesdisplaymode.md new file mode 100644 index 0000000000..c622cf765c --- /dev/null +++ b/windows.media.capture/gamebarservicesdisplaymode.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarServicesDisplayMode +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.GameBarServicesDisplayMode + +## -description +Specifies the display mode for the Game Bar. + +## -enum-fields + +## -field Windowed:0 +Windowed display mode. + +## -field FullScreenExclusive:1 +Full-screen exclusive mode. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicesmanager.md b/windows.media.capture/gamebarservicesmanager.md new file mode 100644 index 0000000000..42e26e0176 --- /dev/null +++ b/windows.media.capture/gamebarservicesmanager.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarServicesManager +-api-type: winrt class +--- + + + +# Windows.Media.Capture.GameBarServicesManager + +## -description +Manages the Game Bar services. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicesmanager_gamebarservicescreated.md b/windows.media.capture/gamebarservicesmanager_gamebarservicescreated.md new file mode 100644 index 0000000000..c309447a04 --- /dev/null +++ b/windows.media.capture/gamebarservicesmanager_gamebarservicescreated.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Media.Capture.GameBarServicesManager.GameBarServicesCreated +-api-type: winrt event +--- + + + +# Windows.Media.Capture.GameBarServicesManager.GameBarServicesCreated + +## -description +Occurs when the [GameBarServices](./gamebarservices.md) object is created. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicesmanager_getdefault_846721868.md b/windows.media.capture/gamebarservicesmanager_getdefault_846721868.md new file mode 100644 index 0000000000..1f92c6a450 --- /dev/null +++ b/windows.media.capture/gamebarservicesmanager_getdefault_846721868.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Media.Capture.GameBarServicesManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.Media.Capture.GameBarServicesManager.GetDefault + +## -description +Gets the default instance of the [GameBarServiceManager](./gamebarservicesmanager.md) class. + +## -params + +## -returns +The default instance of the [GameBarServiceManager](./gamebarservicesmanager.md) class. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicesmanagergamebarservicescreatedeventargs.md b/windows.media.capture/gamebarservicesmanagergamebarservicescreatedeventargs.md new file mode 100644 index 0000000000..cacedd2e84 --- /dev/null +++ b/windows.media.capture/gamebarservicesmanagergamebarservicescreatedeventargs.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarServicesManagerGameBarServicesCreatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.GameBarServicesManagerGameBarServicesCreatedEventArgs + +## -description +Provides data for the [GameBarServicesManager.GameBarServicesCreated](./gamebarservicesmanager_gamebarservicescreated.md) event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicesmanagergamebarservicescreatedeventargs_gamebarservices.md b/windows.media.capture/gamebarservicesmanagergamebarservicescreatedeventargs_gamebarservices.md new file mode 100644 index 0000000000..d22786b71c --- /dev/null +++ b/windows.media.capture/gamebarservicesmanagergamebarservicescreatedeventargs_gamebarservices.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServicesManagerGameBarServicesCreatedEventArgs.GameBarServices +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServicesManagerGameBarServicesCreatedEventArgs.GameBarServices + +## -description +Gets the [GameBarServices](./gamebarservices.md) associated with the event. + +## -property-value +The [GameBarServices](./gamebarservices.md) associated with the event. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicestargetinfo.md b/windows.media.capture/gamebarservicestargetinfo.md new file mode 100644 index 0000000000..93856f1ebc --- /dev/null +++ b/windows.media.capture/gamebarservicestargetinfo.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarServicesTargetInfo +-api-type: winrt class +--- + + + +# Windows.Media.Capture.GameBarServicesTargetInfo + +## -description +Provides metadata about a Game Bar services target. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicestargetinfo_appid.md b/windows.media.capture/gamebarservicestargetinfo_appid.md new file mode 100644 index 0000000000..e9a6c0beeb --- /dev/null +++ b/windows.media.capture/gamebarservicestargetinfo_appid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServicesTargetInfo.AppId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServicesTargetInfo.AppId + +## -description +Gets the unique identifier of the Game Bar services target app. + +## -property-value +The unique identifier of the Game Bar services target app. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicestargetinfo_displaymode.md b/windows.media.capture/gamebarservicestargetinfo_displaymode.md new file mode 100644 index 0000000000..26442f9a2a --- /dev/null +++ b/windows.media.capture/gamebarservicestargetinfo_displaymode.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServicesTargetInfo.DisplayMode +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServicesTargetInfo.DisplayMode + +## -description +Gets a value indicating the display mode of the Game Bar services target app. + +## -property-value +A value indicating the display mode of the Game Bar services target app. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicestargetinfo_displayname.md b/windows.media.capture/gamebarservicestargetinfo_displayname.md new file mode 100644 index 0000000000..656084c211 --- /dev/null +++ b/windows.media.capture/gamebarservicestargetinfo_displayname.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServicesTargetInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServicesTargetInfo.DisplayName + +## -description +Gets the display name of the Game Bar services target app. + +## -property-value +The display name of the Game Bar services target app. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebarservicestargetinfo_titleid.md b/windows.media.capture/gamebarservicestargetinfo_titleid.md new file mode 100644 index 0000000000..ce78b5a618 --- /dev/null +++ b/windows.media.capture/gamebarservicestargetinfo_titleid.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Media.Capture.GameBarServicesTargetInfo.TitleId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.GameBarServicesTargetInfo.TitleId + +## -description +Gets the unique identifier of the Game Bar services target title. + +## -property-value +The unique identifier of the Game Bar services target title. + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/gamebartargetcapturepolicy.md b/windows.media.capture/gamebartargetcapturepolicy.md new file mode 100644 index 0000000000..5ee3824fe1 --- /dev/null +++ b/windows.media.capture/gamebartargetcapturepolicy.md @@ -0,0 +1,41 @@ +--- +-api-id: T:Windows.Media.Capture.GameBarTargetCapturePolicy +-api-type: winrt enumeration +--- + + + +# Windows.Media.Capture.GameBarTargetCapturePolicy + +## -description + +## -enum-fields + +## -field ProhibitedBySystem:3 + +## -field ProhibitedByPublisher:4 + +## -field NotEnabled:2 + +## -field EnabledByUser:1 + +## -field EnabledBySystem:0 + +## -remarks + +## -see-also + +## -examples + + + +## -capabilities +gameBarServices \ No newline at end of file diff --git a/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md b/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md index babb2a6390..ceb03b4b72 100644 --- a/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md +++ b/windows.media.capture/lowlagphotocapture_finishasync_1182664592.md @@ -18,7 +18,7 @@ Object that is used to control the asynchronous operation. ## -remarks ## -examples -Here is an example that shows how to setup and take low lag photos. It displays the captured photo and thumbnail in [Image](XREF:TODO:wwa.Image_object) objects. The XAML creates a simple UI with a two [Image](XREF:TODO:wwa.Image_object) objects and some [Button](../windows.ui.xaml.controls/button.md) objects to interact with the [MediaCapture](mediacapture.md) element. In code, there is a method to initialize the [MediaCapture](mediacapture.md) object, a method to initialize the [LowLagPhotoCapture](lowlagphotocapture.md) object, a method to take the photo and display it, and a method to shutdown the [LowLagPhotoCapture](lowlagphotocapture.md). +Here is an example that shows how to setup and take low lag photos. It displays the captured photo and thumbnail in [Image](XREF:TODO:wwa.Image_object) objects. The XAML creates a simple UI with a two [Image](../windows.ui.xaml.controls/image.md) objects and some [Button](../windows.ui.xaml.controls/button.md) objects to interact with the [MediaCapture](mediacapture.md) element. In code, there is a method to initialize the [MediaCapture](mediacapture.md) object, a method to initialize the [LowLagPhotoCapture](lowlagphotocapture.md) object, a method to take the photo and display it, and a method to shutdown the [LowLagPhotoCapture](lowlagphotocapture.md). diff --git a/windows.media.capture/mediacapture.md b/windows.media.capture/mediacapture.md index d4680de456..c9830988f8 100644 --- a/windows.media.capture/mediacapture.md +++ b/windows.media.capture/mediacapture.md @@ -56,7 +56,7 @@ The following code sample shows how to create and initialize a **MediaCapture** -[!code-csharp[MediaCaptureVideo_InitMCobject](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetMediaCaptureVideo_InitMCobjectCS)] +[!code-csharp[MediaCaptureVideo_InitMCobject](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetMediaCaptureVideo_InitMCobject)] [!code-js[MediaCaptureVideo_InitMCobject](../windows.media.capture/code/MediaCaptureVideo/javascript/default.js#SnippetMediaCaptureVideo_InitMCobject)] @@ -69,9 +69,7 @@ The following code sample shows how to create and initialize a **MediaCapture** ## -see-also [Camera](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/camera), [Basic photo, video, and audio capture with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/basic-photo-video-and-audio-capture-with-mediacapture), [Media capture sample](http://go.microsoft.com/fwlink/p/?linkid=241428), [Camera capture UI sample](http://go.microsoft.com/fwlink/p/?linkid=249441), [Camera options UI sample](http://go.microsoft.com/fwlink/p/?linkid=228588 ), [Device enumeration sample](http://go.microsoft.com/fwlink/p/?linkid=231541 ), [Real-Time communication sample](http://go.microsoft.com/fwlink/p/?linkid=245973), [Media extension sample](http://go.microsoft.com/fwlink/p/?linkid=241427), [Hands-on labs for ](http://go.microsoft.com/fwlink/p/?LinkId=263947), [Supported audio and video formats](http://msdn.microsoft.com/library/6037c242-f39c-49bf-b206-c3b6a3e30165), [Real-time communication sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620600) -## -capabilities -webcam, microphone -kid=245973), [Media extension sample](http://go.microsoft.com/fwlink/p/?linkid=241427), [Hands-on labs for ](http://go.microsoft.com/fwlink/p/?LinkId=263947), [Supported audio and video formats](http://msdn.microsoft.com/library/6037c242-f39c-49bf-b206-c3b6a3e30165), [Real-time communication sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620600) + ## -capabilities -webcam, microphone \ No newline at end of file +webcam, microphone diff --git a/windows.media.capture/mediacapture_capturedeviceexclusivecontrolstatuschanged.md b/windows.media.capture/mediacapture_capturedeviceexclusivecontrolstatuschanged.md new file mode 100644 index 0000000000..fe25e7db51 --- /dev/null +++ b/windows.media.capture/mediacapture_capturedeviceexclusivecontrolstatuschanged.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Media.Capture.MediaCapture.CaptureDeviceExclusiveControlStatusChanged +-api-type: winrt event +--- + + + +# Windows.Media.Capture.MediaCapture.CaptureDeviceExclusiveControlStatusChanged + +## -description +Occurs when the exclusive control status of the capture device changes. + +## -remarks +When an app has exclusive control of the capture device, it can modify the settings of the device. An app that does not have exclusive control of the capture device can still capture media, but it can't change the capture settings. Request exclusive control by setting the [MediaCaptureInitializationSettings.SharingMode](mediacaptureinitializationsettings_sharingmode.md) property to **ExclusiveControl** before passing the structure into [InitializeAsync](mediacapture_initializeasync_315323248.md). The call to **InitializeAsync** will fail if you request exclusive control when another app already has exclusive access to the device. In this case, you can listen for **CaptureDeviceExclusiveControlStatusChanged**, and if the value of [MediaCaptureDeviceExclusiveControlStatusChangedEventArgs.Status](mediacapturedeviceexclusivecontrolstatuschangedeventargs_status.md) is **ExclusiveControlAvailable**, then you can attempt to reinitialize the **MediaCapture** with exclusive control. + +If the **CaptureDeviceExclusiveControlStatusChanged** event is raised and the value of **MediaCaptureDeviceExclusiveControlStatusChangedEventArgs.Status** is **SharedReadOnlyAvailable**, then another app has acquired exclusive control of the device. In this case, you may want to update your UI to alert the user that another app may adjust the capture device settings. + +## -see-also + +## -examples + diff --git a/windows.media.capture/mediacapture_createmultisourceframereaderasync_1316837028.md b/windows.media.capture/mediacapture_createmultisourceframereaderasync_1316837028.md new file mode 100644 index 0000000000..bf9758d303 --- /dev/null +++ b/windows.media.capture/mediacapture_createmultisourceframereaderasync_1316837028.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Capture.MediaCapture.CreateMultiSourceFrameReaderAsync(Windows.Foundation.Collections.IIterable{Windows.Media.Capture.Frames.MediaFrameSource}) +-api-type: winrt method +--- + + + +# Windows.Media.Capture.MediaCapture.CreateMultiSourceFrameReaderAsync + +## -description +Creates a [MultiSourceMediaFrameReader](../windows.media.capture.frames/multisourcemediaframereader.md) that is used to acquire time-correlated frames from one or more [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) objects. + +## -params + +## -param inputSources +A [IIterable](../windows.foundation.collections/iiterable_1.md) list of [MediaFrameSource](../windows.media.capture.frames/mediaframesource.md) objects to be used by the frame reader. + +## -returns +An asynchronous operation that returns a [MultiSourceMediaFrameReader](../windows.media.capture.frames/multisourcemediaframereader.md) upon successful completion. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/mediacapture_setencoderproperty_1595136570.md b/windows.media.capture/mediacapture_setencoderproperty_1595136570.md index 284b2d2752..590b2ac413 100644 --- a/windows.media.capture/mediacapture_setencoderproperty_1595136570.md +++ b/windows.media.capture/mediacapture_setencoderproperty_1595136570.md @@ -33,7 +33,7 @@ For non-H.264 cameras, when you call [SetEncoderProperty](mediacapture_setencode If you call [SetEncoderProperty](mediacapture_setencoderproperty.md) after you issue a call to start recording or previewing and before you get the record or preview started completion callback, you will receive an **MF_E_INVALIDREQUEST** error since the property cannot be applied to static nor dynamic settings. -To rotate the preview stream, use the **GUID** defined by [MF_MT_VIDEO_ROTATION](XREF:TODO:mf.mf_mt_video_rotation). For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). +To rotate the preview stream, use the **GUID** defined as [MF_MT_VIDEO_ROTATION](https://msdn.microsoft.com/en-us/library/windows/desktop/hh162880.aspx). For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). ## -examples diff --git a/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md b/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md index bec5dbe9d6..bcba399e34 100644 --- a/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md +++ b/windows.media.capture/mediacapture_setencodingpropertiesasync_1218555455.md @@ -28,7 +28,7 @@ Object that is used to control the asynchronous operation. ## -remarks This method sets the encoding properties of the encoder that processes the data before it’s passed on to a [CaptureElement](../windows.ui.xaml.controls/captureelement.md) to be displayed, written out to a [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) or [StorageFile](../windows.storage/storagefile.md), or delivered to a custom media sink. This method does not change the configuration of the source of the data, which is the camera device. It is possible to set the encoding properties to a resolution that is not natively supported by the camera. In this case, the **MediaCapture** pipeline will use an encoder to perform the conversion to the requested format. Note that this conversion does consume system resources and can result in poor performance or even errors, especially on devices that with limited or no graphics acceleration. For typical scenarios, it is recommended that you choose a resolution supported by the camera that is closest to your desired resolution. You can get a list of a capture device's supported resolutions by calling [VideoDeviceController.GetAvailableMediaStreamProperties](../windows.media.devices/videodevicecontroller_getavailablemediastreamproperties.md). For more information, see [Set format, resolution, and frame rate for MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/set-media-encoding-properties) and the [Camera Resolution Sample](http://go.microsoft.com/fwlink/p/?LinkId=624252). -To rotate the record or preview stream, use the **GUID** defined by [MF_MT_VIDEO_ROTATION](XREF:TODO:mf.mf_mt_video_rotation) to add metadata to the stream. Note that this rotation is performed by the consumer of the stream, such as the **CaptureElement** or a video player app, while the actual pixels in the stream still retain their original orientation. For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). +To rotate the record or preview stream, use the **GUID** defined by [MF_MT_VIDEO_ROTATION](https://msdn.microsoft.com/en-us/library/windows/desktop/hh162880.aspx) to add metadata to the stream. Note that this rotation is performed by the consumer of the stream, such as the **CaptureElement** or a video player app, while the actual pixels in the stream still retain their original orientation. For how-to guidance on handling orientation when using the camera, see [Handle device orientation with MediaCapture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/handle-device-orientation-with-mediacapture). To modify the properties of the capture device, use [VideoDeviceController.SetMediaStreamPropertiesAsync](../windows.media.devices/videodevicecontroller_setmediastreampropertiesasync.md). diff --git a/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md b/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md index ddf4ed547d..3ae46d890d 100644 --- a/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md +++ b/windows.media.capture/mediacapture_setpreviewmirroring_1236148878.md @@ -20,7 +20,7 @@ True to enable mirroring; false to disable mirroring. ## -remarks Horizontal mirroring is useful for video conferencing or video chat applications, because the users typically want to see a reflected image of themselves. The non-mirrored view can look strange, because we are used to seeing ourselves in a mirror. -To mirror the preview video, apps should instead use the following method. Windows app using JavaScript should use the [msHorizontalMirror](XREF:TODO:ie.HTMLVideoElement_msHorizontalMirror) property of the [video](XREF:TODO:wwa.HTMLVideoObject) object. Windows Store app using C++, C#, or Visual Basic should use the [FlowDirection](../windows.ui.xaml/flowdirection.md) property on the [CaptureElement](../windows.ui.xaml.controls/captureelement.md). +To mirror the preview video, apps should instead use the following method. Windows app using JavaScript should use the [msHorizontalMirror](https://msdn.microsoft.com/en-us/library/windows/apps/hh465967.aspx) property of the [video](https://msdn.microsoft.com/en-us/library/windows/apps/hh465962.aspx) object. Windows Store app using C++, C#, or Visual Basic should use the [FlowDirection](../windows.ui.xaml/flowdirection.md) property on the [CaptureElement](../windows.ui.xaml.controls/captureelement.md). [SetPreviewMirroring](mediacapture_setpreviewmirroring.md) can potentially be used as a performance optimization on some devices diff --git a/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md b/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md index d4c4bbd8fe..98dbcb8773 100644 --- a/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md +++ b/windows.media.capture/mediacapture_startpreviewtocustomsinkasync_1216748550.md @@ -23,7 +23,7 @@ The media extension for the custom media sink. An object that is used to control the asynchronous operation. ## -remarks -When you call **StartPreviewToCustomSinkAsync**, the system will call the custom sink’s [IMFMediaTypeHandler::IsMediaTypeSupported](XREF:TODO:mf.imfmediatypehandler_ismediatypesupported) method, passing in the native media type of the capture device. This check is performed in an effort to avoid unnecessary video conversion. If the custom sink returns S_OK from **IsMediaTypeSupported** when this check is made, then the preview stream will use the native media type instead of the type specified by the *encodingProfile* parameter. +When you call **StartPreviewToCustomSinkAsync**, the system will call the custom sink’s [IMFMediaTypeHandler::IsMediaTypeSupported](https://msdn.microsoft.com/en-us/library/windows/desktop/bb970559.aspx) method, passing in the native media type of the capture device. This check is performed in an effort to avoid unnecessary video conversion. If the custom sink returns S_OK from **IsMediaTypeSupported** when this check is made, then the preview stream will use the native media type instead of the type specified by the *encodingProfile* parameter. ## -examples diff --git a/windows.media.capture/mediacapture_thermalstatuschanged.md b/windows.media.capture/mediacapture_thermalstatuschanged.md index 480a167daf..fa98257573 100644 --- a/windows.media.capture/mediacapture_thermalstatuschanged.md +++ b/windows.media.capture/mediacapture_thermalstatuschanged.md @@ -13,7 +13,7 @@ public event Windows.Foundation.TypedEventHandler ThermalStatusChanged + +# Windows.Media.Capture.MediaCaptureDeviceExclusiveControlStatus + +## -description +Specifies the exclusive control status of the media capture device. Exclusive control is required to modify the settings of the capture device, but is not required to obtain media frames from the device. + +## -enum-fields + +## -field SharedReadOnlyAvailable:1 +Another app has exclusive control of the capture device, so the current app can't obtain exclusive control. + +## -field ExclusiveControlAvailable:0 +The current app can initialize the capture device with exclusive control. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs.md b/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs.md new file mode 100644 index 0000000000..9cb7efaf2d --- /dev/null +++ b/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Capture.MediaCaptureDeviceExclusiveControlStatusChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Capture.MediaCaptureDeviceExclusiveControlStatusChangedEventArgs + +## -description +Provides data for the [MediaCapture.CaptureDeviceExclusiveControlStatusChanged](mediacapture_capturedeviceexclusivecontrolstatuschanged.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs_deviceid.md b/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs_deviceid.md new file mode 100644 index 0000000000..2f4087a423 --- /dev/null +++ b/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs_deviceid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Capture.MediaCaptureDeviceExclusiveControlStatusChangedEventArgs.DeviceId +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureDeviceExclusiveControlStatusChangedEventArgs.DeviceId + +## -description +Gets the device ID for the capture device for which exlusive control status has changed. + +## -property-value +The device ID for the capture device for which exlusive control status has changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs_status.md b/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs_status.md new file mode 100644 index 0000000000..97cf33f68c --- /dev/null +++ b/windows.media.capture/mediacapturedeviceexclusivecontrolstatuschangedeventargs_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Capture.MediaCaptureDeviceExclusiveControlStatusChangedEventArgs.Status +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureDeviceExclusiveControlStatusChangedEventArgs.Status + +## -description +Gets a value indicating whether exclusive control of the capture device specified with the [DeviceID](mediacapturedeviceexclusivecontrolstatuschangedeventargs_deviceid.md) property is available to the current app. + +## -property-value +A value indicating whether exclusive control of the device is available or if the device can only be accessed in shared mode. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.capture/mediacaptureinitializationsettings.md b/windows.media.capture/mediacaptureinitializationsettings.md index 0eee3fb0a8..ca2fd97858 100644 --- a/windows.media.capture/mediacaptureinitializationsettings.md +++ b/windows.media.capture/mediacaptureinitializationsettings.md @@ -20,7 +20,7 @@ The following example initializes the **MediaCaptureInitializationSettings**. Ca -[!code-csharp[MediaCaptureVideo_InitSettings](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetMediaCaptureVideo_InitSettingsCS)] +[!code-csharp[MediaCaptureVideo_InitSettings](../windows.media.capture/code/MediaCaptureVideo/csharp/MainPage.xaml.cs#SnippetMediaCaptureVideo_InitSettings)] [!code-js[MediaCaptureVideo_InitSettings](../windows.media.capture/code/MediaCaptureVideo/javascript/default.js#SnippetMediaCaptureVideo_InitSettings)] @@ -29,3 +29,5 @@ The following example initializes the **MediaCaptureInitializationSettings**. Ca ## -capabilities webcam, microphone +-capabilities +webcam, microphone diff --git a/windows.media.capture/mediacaptureinitializationsettings_alwaysplaysystemshuttersound.md b/windows.media.capture/mediacaptureinitializationsettings_alwaysplaysystemshuttersound.md new file mode 100644 index 0000000000..3d2ad1ab46 --- /dev/null +++ b/windows.media.capture/mediacaptureinitializationsettings_alwaysplaysystemshuttersound.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Capture.MediaCaptureInitializationSettings.AlwaysPlaySystemShutterSound +-api-type: winrt property +--- + + + +# Windows.Media.Capture.MediaCaptureInitializationSettings.AlwaysPlaySystemShutterSound + +## -description +Gets a value indicating whether the system should always play a shutter sound when a photo is captured. + +## -property-value +True if the system should always play a shutter sound; otherwise, false. + +## -remarks +Some regions require that the system play a shutter sound whenever a photo is captured. Setting this value to true will cause the system to always play the shutter sound, whether or not is required by the current region. Setting this value to false will not suppress the system shutter sound when it is required. + +## -see-also + +## -examples + diff --git a/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md b/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md index 523004e3fe..5c09ce0903 100644 --- a/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md +++ b/windows.media.capture/mediacaptureinitializationsettings_sourcegroup.md @@ -10,7 +10,7 @@ public Windows.Media.Capture.Frames.MediaFrameSourceGroup SourceGroup { get; se # Windows.Media.Capture.MediaCaptureInitializationSettings.SourceGroup ## -description -Gets or sets the [MediaFrameSourceGroup](XREF:TODO:a23582f7-27c5-46bc-9767-4e2bfc57be3e.mediaframesourcegroup) with which the [MediaCapture](mediacapture.md) should be initialized. This property defines a set of media frame sources that can be used simultaneously. +Gets or sets the [MediaFrameSourceGroup](../windows.media.capture.frames/mediaframesourcegroup.md) with which the [MediaCapture](mediacapture.md) should be initialized. This property defines a set of media frame sources that can be used simultaneously. ## -property-value The [MediaFrameSourceGroup](../windows.media.capture.frames/mediaframesourcegroup.md) with which the [MediaCapture](mediacapture.md) should be initialized. diff --git a/windows.media.casting/castingdevice.md b/windows.media.casting/castingdevice.md index 6d17cd8f9f..9c904cc82d 100644 --- a/windows.media.casting/castingdevice.md +++ b/windows.media.casting/castingdevice.md @@ -13,7 +13,7 @@ public class CastingDevice : Windows.Media.Casting.ICastingDevice Represents a physical device that is capable of supporting casting connections and rendering media content sent to it. ## -remarks -Get an instance of this class by accessing the [ICastingConnection.Device](icastingconnection_device.md) or [VastingDeviceSelectedEventArgs.SelectedCastingDevice](castingdeviceselectedeventargs_selectedcastingdevice.md) property. +Get an instance of this class by accessing the [CastingConnection.Device](castingconnection_device.md) or [VastingDeviceSelectedEventArgs.SelectedCastingDevice](castingdeviceselectedeventargs_selectedcastingdevice.md) property. ## -examples diff --git a/windows.media.contentrestrictions/ratedcontentdescription_ratings.md b/windows.media.contentrestrictions/ratedcontentdescription_ratings.md index 931e5e66b8..3755432e3d 100644 --- a/windows.media.contentrestrictions/ratedcontentdescription_ratings.md +++ b/windows.media.contentrestrictions/ratedcontentdescription_ratings.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Ratings --api-type: winrt property ---- - - - -# Windows.Media.ContentRestrictions.RatedContentDescription.Ratings - -## -description -Provides all existing third-party and Windows Store age ratings for a piece of content. - - - -## -property-value -Specifies the age rating, for a piece of content. - -## -remarks -If a piece of content doesn’t have neither a third-party rating nor a Store age rating, the app must pass NULL as the rating. If NULL rating is provided, the [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. - -Family Safety uses the [ContentRestrictionBrowsePolicy.GeographicRegion](contentrestrictionsbrowsepolicy_geographicregion.md) and [RatedContentDescription.Category](ratedcontentdescription_category.md) properties, to determine the appropriate rating system for a piece of content. If contain a rating value in this rating system, then it’s used as the content rating. If don’t contain value in this rating system, the Store age rating value is used. If it’s not available, the content is considered Not rated, for the Family Safety content settings region, and [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. For more info, see [Using content ratings](XREF:TODO:m_media.using_content_ratings). - -## -examples - -## -see-also -[Using content ratings](XREF:TODO:m_media.using_content_ratings), [Store age ratings](XREF:TODO:m_media.store_age_ratings) \ No newline at end of file +--- +-api-id: P:Windows.Media.ContentRestrictions.RatedContentDescription.Ratings +-api-type: winrt property +--- + + + +# Windows.Media.ContentRestrictions.RatedContentDescription.Ratings + +## -description +Provides all existing third-party and Windows Store age ratings for a piece of content. + + + +## -property-value +Specifies the age rating, for a piece of content. + +## -remarks +If a piece of content doesn’t have neither a third-party rating nor a Store age rating, the app must pass NULL as the rating. If NULL rating is provided, the [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. + +Family Safety uses the [ContentRestrictionBrowsePolicy.GeographicRegion](contentrestrictionsbrowsepolicy_geographicregion.md) and [RatedContentDescription.Category](ratedcontentdescription_category.md) properties, to determine the appropriate rating system for a piece of content. If contain a rating value in this rating system, then it’s used as the content rating. If don’t contain value in this rating system, the Store age rating value is used. If it’s not available, the content is considered Not rated, for the Family Safety content settings region, and [RequestContentAccessAsync](ratedcontentrestrictions_requestcontentaccessasync.md) method will display a **Content blocked by Family Safety** dialog, with options to request a parental override. For more info, see [Using content ratings](http://msdn.microsoft.com/library/1e647a84-21e3-47bf-b034-c280612729a7). + +## -examples + +## -see-also +[Using content ratings](http://msdn.microsoft.com/library/1e647a84-21e3-47bf-b034-c280612729a7), [Store age ratings](http://msdn.microsoft.com/library/4819f0ae-2090-4954-b495-2dfbf6cd2de9) \ No newline at end of file diff --git a/windows.media.core.preview/soundlevelbroker.md b/windows.media.core.preview/soundlevelbroker.md new file mode 100644 index 0000000000..2a836473be --- /dev/null +++ b/windows.media.core.preview/soundlevelbroker.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Core.Preview.SoundLevelBroker +-api-type: winrt class +--- + + + +# Windows.Media.Core.Preview.SoundLevelBroker + +## -description +Provides information about how the app's current sound level is affected by system policy. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core.preview/soundlevelbroker_soundlevel.md b/windows.media.core.preview/soundlevelbroker_soundlevel.md new file mode 100644 index 0000000000..8f59e7ba26 --- /dev/null +++ b/windows.media.core.preview/soundlevelbroker_soundlevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.Preview.SoundLevelBroker.SoundLevel +-api-type: winrt property +--- + + + +# Windows.Media.Core.Preview.SoundLevelBroker.SoundLevel + +## -description +Gets the current sound level of the app. + +## -property-value +The current sound level of the app. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core.preview/soundlevelbroker_soundlevelchanged.md b/windows.media.core.preview/soundlevelbroker_soundlevelchanged.md new file mode 100644 index 0000000000..3d48ebe6c2 --- /dev/null +++ b/windows.media.core.preview/soundlevelbroker_soundlevelchanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Media.Core.Preview.SoundLevelBroker.SoundLevelChanged +-api-type: winrt event +--- + + + +# Windows.Media.Core.Preview.SoundLevelBroker.SoundLevelChanged + +## -description +Occurs when the system policy changes the sound level of the app. + +## -remarks +In the handler for this event, check the **SoundLevelBroker.SoundLevel** property to get the new sound level. + +## -see-also + +## -examples + diff --git a/windows.media.core.preview/windows_media_core_preview.md b/windows.media.core.preview/windows_media_core_preview.md new file mode 100644 index 0000000000..83533ec266 --- /dev/null +++ b/windows.media.core.preview/windows_media_core_preview.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.Media.Core.Preview +-api-type: winrt namespace +--- + + + +# Windows.Media.Core.Preview + +## -description +Provides media APIs that may be deprecated in future releases. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/audiodecoderdegradationreason.md b/windows.media.core/audiodecoderdegradationreason.md index 51d0806ec5..b61eea932e 100644 --- a/windows.media.core/audiodecoderdegradationreason.md +++ b/windows.media.core/audiodecoderdegradationreason.md @@ -20,9 +20,12 @@ No reason is specified or no audio degradation has been applied to the track. The audio track was degraded due to a licensing requirement. +### -field SpatialAudioNotSupported:2 + + ## -remarks Get the **AudioDecoderDegradation** value for an audio track by checking the [DegradationReason](audiotracksupportinfo_degradationreason.md) property of the track's [SupportInfo](audiotrack_supportinfo.md) property. ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.media.core/chaptercue.md b/windows.media.core/chaptercue.md new file mode 100644 index 0000000000..175065095f --- /dev/null +++ b/windows.media.core/chaptercue.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Core.ChapterCue +-api-type: winrt class +--- + + + +# Windows.Media.Core.ChapterCue + +## -description +Represents a chapter cue that can be included in a [TimedMetadataTrack](timedmetadatatrack.md). + +## -remarks +A **ChapterCue** can be added to a [TimedMetadataTrack](timedmetadatatrack.md) with the [AddCue](timedmetadatatrack_addcue.md) method. When the cue's start time is reached, the [CueEntered](timedmetadatatrack_cueentered.md) event is raised and you can use the [MediaCueEventArgs](mediacueeventargs.md) passed into the handler to get a copy of the **ChapterCue**. + +## -see-also + +## -examples + diff --git a/windows.media.core/chaptercue_chaptercue_1221375020.md b/windows.media.core/chaptercue_chaptercue_1221375020.md new file mode 100644 index 0000000000..369af68ea1 --- /dev/null +++ b/windows.media.core/chaptercue_chaptercue_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Media.Core.ChapterCue.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.ChapterCue.ChapterCue + +## -description +Initializes a new instance of the **ChapterCue** class. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/chaptercue_duration.md b/windows.media.core/chaptercue_duration.md new file mode 100644 index 0000000000..f4e75aac17 --- /dev/null +++ b/windows.media.core/chaptercue_duration.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.ChapterCue.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.ChapterCue.Duration + +## -description +Gets or sets a value that specifies the duration of the chapter associated with the cue. + +## -property-value +A value that specifies the duration of the chapter. + +## -remarks +At the end of a cue's duration, the [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) event is raised. + +## -see-also + +## -examples + diff --git a/windows.media.core/chaptercue_id.md b/windows.media.core/chaptercue_id.md new file mode 100644 index 0000000000..3c26bda5ae --- /dev/null +++ b/windows.media.core/chaptercue_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.ChapterCue.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.ChapterCue.Id + +## -description +Gets the identifier for the timed metadata track. + +## -property-value +The identifier for the timed metadata track. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/chaptercue_starttime.md b/windows.media.core/chaptercue_starttime.md new file mode 100644 index 0000000000..a6463990d7 --- /dev/null +++ b/windows.media.core/chaptercue_starttime.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.ChapterCue.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.ChapterCue.StartTime + +## -description +Gets the start time of the cue. + +## -property-value +The start time of the cue. + +## -remarks +When a cue's start time is reached, the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) event is raised. + +## -see-also + +## -examples + diff --git a/windows.media.core/chaptercue_title.md b/windows.media.core/chaptercue_title.md new file mode 100644 index 0000000000..e9d9fc587c --- /dev/null +++ b/windows.media.core/chaptercue_title.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.ChapterCue.Title +-api-type: winrt property +--- + + + +# Windows.Media.Core.ChapterCue.Title + +## -description +Gets the title of the chapter associated with the cue. + +## -property-value +The title of the chapter + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codeccategory.md b/windows.media.core/codeccategory.md new file mode 100644 index 0000000000..d0d4afa50c --- /dev/null +++ b/windows.media.core/codeccategory.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Core.CodecCategory +-api-type: winrt enum +--- + + + +# Windows.Media.Core.CodecCategory + +## -description +Specifies the category of a codec. + +## -enum-fields +### -field Encoder:0 +The codec is an encoder. + +### -field Decoder:1 +The codec is a decoder. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecinfo.md b/windows.media.core/codecinfo.md new file mode 100644 index 0000000000..4df5879e0b --- /dev/null +++ b/windows.media.core/codecinfo.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Core.CodecInfo +-api-type: winrt class +--- + + + +# Windows.Media.Core.CodecInfo + +## -description +Provides information about a media codec that is installed on the system. + +## -remarks +Get an instance of this class by calling [CodecQuery.FindAllAsync](./codecquery_findallasync_1027997915.md), which returns a list of all installed codecs that meet the specified criteria. + +## -see-also + +## -examples + diff --git a/windows.media.core/codecinfo_category.md b/windows.media.core/codecinfo_category.md new file mode 100644 index 0000000000..c95afe0919 --- /dev/null +++ b/windows.media.core/codecinfo_category.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecInfo.Category +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecInfo.Category + +## -description +Gets a value that specifies whether the codec is an encoder or a decoder. + +## -property-value +A value that specifies whether the codec is an encoder or a decoder. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecinfo_displayname.md b/windows.media.core/codecinfo_displayname.md new file mode 100644 index 0000000000..b722fc52e0 --- /dev/null +++ b/windows.media.core/codecinfo_displayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecInfo.DisplayName + +## -description +Gets the friendly display name for the codec. + +## -property-value +The friendly display name for the codec. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecinfo_istrusted.md b/windows.media.core/codecinfo_istrusted.md new file mode 100644 index 0000000000..e5199c7a44 --- /dev/null +++ b/windows.media.core/codecinfo_istrusted.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecInfo.IsTrusted +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecInfo.IsTrusted + +## -description +Gets a value that indicates whether the codec runs in your app's process space rather than in a separate app service. + +## -property-value +True if the codec is runs in the app process space; false if the codec runs in a separate app service. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecinfo_kind.md b/windows.media.core/codecinfo_kind.md new file mode 100644 index 0000000000..e2526dca91 --- /dev/null +++ b/windows.media.core/codecinfo_kind.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecInfo.Kind +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecInfo.Kind + +## -description +Gets a value specifying whether the codec operates on audio or video data. + +## -property-value +A value specifying whether the codec operates on audio or video data. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecinfo_subtypes.md b/windows.media.core/codecinfo_subtypes.md new file mode 100644 index 0000000000..e300f3ffdb --- /dev/null +++ b/windows.media.core/codecinfo_subtypes.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Media.Core.CodecInfo.Subtypes +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecInfo.Subtypes + +## -description +Gets a read-only list of values that specify the media subtypes supported by the codec. + +## -property-value +A read-only list of values that specify the media subtypes supported by the codec. + +## -remarks +Each value in the list returned by this method is string representation of a GUID that identifies a media subtype that is supported by the codec. For a listing of media subtype GUIDs, see [Audio Subtype GUIDs](https://msdn.microsoft.com/library/windows/desktop/aa372553(v=vs.85).aspx) or [Video Subtyp GUIDs](https://msdn.microsoft.com/library/windows/desktop/aa370819(v=vs.85).aspx). The [CodecSubtypes](./codecsubtypes.md) class provides properties for most supported media subtypes that return the string representation of the subtype GUID to make it easy to compare against the **Subtypes** property of a **CodecInfo** object to see if a codec supports a particular subtype. + +## -see-also +[CodecSubtypes](./codecsubtypes.md) + +## -examples + diff --git a/windows.media.core/codeckind.md b/windows.media.core/codeckind.md new file mode 100644 index 0000000000..aefc42b229 --- /dev/null +++ b/windows.media.core/codeckind.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Media.Core.CodecKind +-api-type: winrt enumeration +--- + + + +# Windows.Media.Core.CodecKind + +## -description +Specifies whether a codec operates on audio or video data. + +## -enum-fields + +## -field Video:1 +The codec operates on video data. + +## -field Audio:0 +The codec operates on audio data. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecquery.md b/windows.media.core/codecquery.md new file mode 100644 index 0000000000..350ea7b308 --- /dev/null +++ b/windows.media.core/codecquery.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Core.CodecQuery +-api-type: winrt class +--- + + + +# Windows.Media.Core.CodecQuery + +## -description +Provides the [FindAllAsync](./codecquery_findallasync_1027997915.md) method which allows you to enumerate all media codecs installed on the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecquery_codecquery_1221375020.md b/windows.media.core/codecquery_codecquery_1221375020.md new file mode 100644 index 0000000000..9ed3ee92f1 --- /dev/null +++ b/windows.media.core/codecquery_codecquery_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Media.Core.CodecQuery.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.CodecQuery.CodecQuery + +## -description +Initializes a new instance of the **CodecQuery** class. + +## -params + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecquery_findallasync_1027997915.md b/windows.media.core/codecquery_findallasync_1027997915.md new file mode 100644 index 0000000000..dcbc8ab609 --- /dev/null +++ b/windows.media.core/codecquery_findallasync_1027997915.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Media.Core.CodecQuery.FindAllAsync(Windows.Media.Core.CodecKind,Windows.Media.Core.CodecCategory,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.CodecQuery.FindAllAsync + +## -description +Returns a read-only list of all media codecs installed on the system that meet the specified requirements. + +## -params + +## -param kind +A value that specifies whether the method should return codecs that operate on video or audio data. + +## -param category +A value that specifies whether the method should return codecs that are encoders or decoders. + +## -param subType +A value specifying the media encoding subtype that all returned codecs must support. This value can be a string representation of one of the subtype GUIDs listed in [Audio Subtype GUIDs](https://msdn.microsoft.com/library/windows/desktop/aa372553(v=vs.85).aspx) or [Video Subtyp GUIDs](https://msdn.microsoft.com/library/windows/desktop/aa370819(v=vs.85).aspx). The [CodecSubtypes](./codecsubtypes.md) class provides properties for most supported media subtypes that return the string representation of the subtype GUID. You can also specify a FOURCC code for this parameter. For more information, see [FOURCC Codes](https://msdn.microsoft.com/library/windows/desktop/dd375802(v=vs.85).aspx). To specify that all codecs of the specified *kind* and *category* should be returned, regardless of what media subtypes are supported, specify an empty string ("") or null for this parameter. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes.md b/windows.media.core/codecsubtypes.md new file mode 100644 index 0000000000..c865bd44a4 --- /dev/null +++ b/windows.media.core/codecsubtypes.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Core.CodecSubtypes +-api-type: winrt class +--- + + + +# Windows.Media.Core.CodecSubtypes + +## -description +Provides properties for most supported media subtypes that return the string representation of the GUID for the subtype. Use these property values to filter a query performed with [CodecQuery.FindAllAsync](codecquery_findallasync_1027997915.md). You can also compare the values returned by these properties to the values in the [Subtypes](./codecinfo_subtypes.md) collection of a [CodecInfo](codecinfo.md) object to determine if a codec supports a particular media subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformataac.md b/windows.media.core/codecsubtypes_audioformataac.md new file mode 100644 index 0000000000..ad725ae68e --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformataac.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatAac +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatAac + +## -description +Gets the string representation of the GUID for the Advanced Audio Coding (AAC) audio subtype. + +## -property-value +The string representation of the GUID for the Advanced Audio Coding (AAC) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatadts.md b/windows.media.core/codecsubtypes_audioformatadts.md new file mode 100644 index 0000000000..783de8fbb9 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatadts.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatAdts +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatAdts + +## -description +Gets the string representation of the GUID for the Audio Data Transport Stream (ADTS) audio subtype. + +## -property-value +Tne string representation of the GUID for the Audio Data Transport Stream (ADTS) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatalac.md b/windows.media.core/codecsubtypes_audioformatalac.md new file mode 100644 index 0000000000..ab7765b1ca --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatalac.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatAlac +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatAlac + +## -description +Gets the string representation of the GUID for the Apple Lossless Audio Codec (ALAC) audio subtype. + +## -property-value +The string representation of the GUID for the Apple Lossless Audio Codec (ALAC) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatamrnb.md b/windows.media.core/codecsubtypes_audioformatamrnb.md new file mode 100644 index 0000000000..cc2b26f1ff --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatamrnb.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatAmrNB +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatAmrNB + +## -description +Gets the string representation of the GUID for the Adaptive Multi-Rate (AMR-NB) audio subtype. + +## -property-value +The string representation of the GUID for the Adaptive Multi-Rate (AMR-NB) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatamrwb.md b/windows.media.core/codecsubtypes_audioformatamrwb.md new file mode 100644 index 0000000000..ca99d35f4a --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatamrwb.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatAmrWB +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatAmrWB + +## -description +Gets the string representation of the GUID for the Adaptive Multi-Rate Wideband (AMR-WB) audio subtype. + +## -property-value +The string representation of the GUID for the Adaptive Multi-Rate Wideband (AMR-WB) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatamrwp.md b/windows.media.core/codecsubtypes_audioformatamrwp.md new file mode 100644 index 0000000000..b1a8c12830 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatamrwp.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatAmrWP +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatAmrWP + +## -description +Gets the string representation of the GUID for the Adaptive Multi-Rate (AMR-WP) audio subtype. + +## -property-value +The string representation of the GUID for the Adaptive Multi-Rate (AMR-WP) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatdolbyac3.md b/windows.media.core/codecsubtypes_audioformatdolbyac3.md new file mode 100644 index 0000000000..48e52878df --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatdolbyac3.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatDolbyAC3 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatDolbyAC3 + +## -description +Gets the string representation of the GUID for the Dolby Digital Audio Coding 3 (AC-3) audio subtype. + +## -property-value +The string representation of the GUID for the Dolby Digital Audio Coding 3 (AC-3) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatdolbyac3spdif.md b/windows.media.core/codecsubtypes_audioformatdolbyac3spdif.md new file mode 100644 index 0000000000..886aff521b --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatdolbyac3spdif.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatDolbyAC3Spdif +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatDolbyAC3Spdif + +## -description +Gets the string representation of the GUID for the Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF) audio subtype. + +## -property-value +The string representation of the GUID for the Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatdolbyddplus.md b/windows.media.core/codecsubtypes_audioformatdolbyddplus.md new file mode 100644 index 0000000000..8d41acdea6 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatdolbyddplus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatDolbyDDPlus +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatDolbyDDPlus + +## -description +Gets the string representation of the GUID for the Dolby Digital Plus (DD Plus) audio subtype. + +## -property-value +The string representation of the GUID for the Dolby Digital Plus (DD Plus) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatdrm.md b/windows.media.core/codecsubtypes_audioformatdrm.md new file mode 100644 index 0000000000..601ad76b8b --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatdrm.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatDrm +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatDrm + +## -description +Gets the string representation of the GUID for the encrypted audio data used with secure audio path audio subtype. + +## -property-value +The string representation of the GUID for the encrypted audio data used with secure audio path audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatdts.md b/windows.media.core/codecsubtypes_audioformatdts.md new file mode 100644 index 0000000000..fc301ed9e8 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatdts.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatDts +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatDts + +## -description +Gets the string representation of the GUID for the Digital Theater Systems (DTS) audio subtype. + +## -property-value +The string representation of the GUID for the Digital Theater Systems (DTS) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatflac.md b/windows.media.core/codecsubtypes_audioformatflac.md new file mode 100644 index 0000000000..b88ae84f69 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatflac.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatFlac +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatFlac + +## -description +Gets the string representation of the GUID for the Free Lossless Audio Codec (FLAC) audio subtype. + +## -property-value +The string representation of the GUID for the Free Lossless Audio Codec (FLAC) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatfloat.md b/windows.media.core/codecsubtypes_audioformatfloat.md new file mode 100644 index 0000000000..4854aaaaa2 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatfloat.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatFloat +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatFloat + +## -description +Gets the string representation of the GUID for the uncompressed IEEE floating-point audio subtype. + +## -property-value +The string representation of the GUID for the uncompressed IEEE floating-point audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatmp3.md b/windows.media.core/codecsubtypes_audioformatmp3.md new file mode 100644 index 0000000000..c6125cb7db --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatmp3.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatMP3 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatMP3 + +## -description +Gets the string representation of the GUID for the MPEG Audio Layer-3 (MP3) audio subtype. + +## -property-value +The string representation of the GUID for the MPEG Audio Layer-3 (MP3) audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatmpeg.md b/windows.media.core/codecsubtypes_audioformatmpeg.md new file mode 100644 index 0000000000..6eb7042ac4 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatmpeg.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatMPeg +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatMPeg + +## -description +Gets the string representation of the GUID for the MPEG-1 audio subtype. + +## -property-value +The string representation of the GUID for the MPEG-1 audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatmsp1.md b/windows.media.core/codecsubtypes_audioformatmsp1.md new file mode 100644 index 0000000000..1303177287 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatmsp1.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatMsp1 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatMsp1 + +## -description +Gets the string representation of the GUID for the Windows Media Audio 9 Voice codec audio subtype. + +## -property-value +The string representation of the GUID for the Windows Media Audio 9 Voice codec audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatopus.md b/windows.media.core/codecsubtypes_audioformatopus.md new file mode 100644 index 0000000000..f8a5b44df9 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatopus.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatOpus +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatOpus + +## -description +Gets the string representation of the GUID for the Opus audio subtype. + +## -property-value +The string representation of the GUID for the Opus audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatpcm.md b/windows.media.core/codecsubtypes_audioformatpcm.md new file mode 100644 index 0000000000..bc4f53d3e1 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatpcm.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatPcm +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatPcm + +## -description +Gets the string representation of the GUID for the uncompressed PCM audio subtype. + +## -property-value +The string representation of the GUID for the uncompressed PCM audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatwmaspdif.md b/windows.media.core/codecsubtypes_audioformatwmaspdif.md new file mode 100644 index 0000000000..ef1a24f448 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatwmaspdif.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatWmaSpdif +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatWmaSpdif + +## -description +Gets the string representation of the GUID for the Windows Media Audio 9 Professional codec over S/PDIF audio subtype. + +## -property-value +The string representation of the GUID for the Windows Media Audio 9 Professional codec over S/PDIF audio subtype. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatwmaudiolossless.md b/windows.media.core/codecsubtypes_audioformatwmaudiolossless.md new file mode 100644 index 0000000000..b0586ac583 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatwmaudiolossless.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatWMAudioLossless +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatWMAudioLossless + +## -description +Gets the string representation of the GUID for the Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 audio subtype. + +## -property-value +The string representation of the GUID for the Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 Lossless codec audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatwmaudiov8.md b/windows.media.core/codecsubtypes_audioformatwmaudiov8.md new file mode 100644 index 0000000000..3c8d9f7834 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatwmaudiov8.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatWMAudioV8 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatWMAudioV8 + +## -description +Gets the string representation of the GUID for the Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec audio subtype. + +## -property-value +The string representation of the GUID for the Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_audioformatwmaudiov9.md b/windows.media.core/codecsubtypes_audioformatwmaudiov9.md new file mode 100644 index 0000000000..4a65b73d68 --- /dev/null +++ b/windows.media.core/codecsubtypes_audioformatwmaudiov9.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.AudioFormatWMAudioV9 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.AudioFormatWMAudioV9 + +## -description +Gets the string representation of the GUID for the Windows Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec audio subtype. + +## -property-value +The string representation of the GUID for the Windows Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec audio subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformat420o.md b/windows.media.core/codecsubtypes_videoformat420o.md new file mode 100644 index 0000000000..107b1a07cf --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformat420o.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormat420O +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormat420O + +## -description +Gets the string representation of the GUID for the 8-bit per channel planar YUV 4:2:0 video subtype. + +## -property-value +The string representation of the GUID for the 8-bit per channel planar YUV 4:2:0 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatdv25.md b/windows.media.core/codecsubtypes_videoformatdv25.md new file mode 100644 index 0000000000..ee48ca4ed0 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatdv25.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatDV25 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatDV25 + +## -description +Gets the string representation of the GUID for the DVCPRO 25 (525-60 or 625-50) video subtype. + +## -property-value +The string representation of the GUID for the DVCPRO 25 (525-60 or 625-50) video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatdv50.md b/windows.media.core/codecsubtypes_videoformatdv50.md new file mode 100644 index 0000000000..56296ab28b --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatdv50.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatDV50 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatDV50 + +## -description +Gets the string representation of the GUID for the DVCPRO 50 (525-60 or 625-50) video subtype. + +## -property-value +The string representation of the GUID for the DVCPRO 50 (525-60 or 625-50) video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatdvc.md b/windows.media.core/codecsubtypes_videoformatdvc.md new file mode 100644 index 0000000000..7993225685 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatdvc.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatDvc +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatDvc + +## -description +Gets the string representation of the GUID for the DVC/DV Video video subtype. + +## -property-value +The string representation of the GUID for the DVC/DV Video video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatdvh1.md b/windows.media.core/codecsubtypes_videoformatdvh1.md new file mode 100644 index 0000000000..fdc1b3e8bd --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatdvh1.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatDvh1 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatDvh1 + +## -description +Gets the string representation of the GUID for the DVCPRO 100 (1080/60i, 1080/50i, or 720/60P) video subtype. + +## -property-value +The string representation of the GUID for the DVCPRO 100 (1080/60i, 1080/50i, or 720/60P) video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatdvhd.md b/windows.media.core/codecsubtypes_videoformatdvhd.md new file mode 100644 index 0000000000..441ccf0d56 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatdvhd.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatDvhD +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatDvhD + +## -description +Gets the string representation of the GUID for the HD-DVCR (1125-60 or 1250-50) video subtype. + +## -property-value +The string representation of the GUID for the HD-DVCR (1125-60 or 1250-50) video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatdvsd.md b/windows.media.core/codecsubtypes_videoformatdvsd.md new file mode 100644 index 0000000000..d7e518e675 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatdvsd.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatDvsd +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatDvsd + +## -description +Gets the string representation of the GUID for the SDL-DVCR (525-60 or 625-50) video subtype. + +## -property-value +The string representation of the GUID for the SDL-DVCR (525-60 or 625-50) video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatdvsl.md b/windows.media.core/codecsubtypes_videoformatdvsl.md new file mode 100644 index 0000000000..d2972cb7a5 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatdvsl.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatDvsl +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatDvsl + +## -description +Gets the string representation of the GUID for the SD-DVCR (525-60 or 625-50) video subtype. + +## -property-value +The string representation of the GUID for the SD-DVCR (525-60 or 625-50) video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformath263.md b/windows.media.core/codecsubtypes_videoformath263.md new file mode 100644 index 0000000000..bb1d863089 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformath263.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatH263 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatH263 + +## -description +Gets the string representation of the GUID for the H.263 video subtype. + +## -property-value +The string representation of the GUID for the H.263 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformath264.md b/windows.media.core/codecsubtypes_videoformath264.md new file mode 100644 index 0000000000..a6397da702 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformath264.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatH264 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatH264 + +## -description +Gets the string representation of the GUID for the H.264 video subtype. + +## -property-value +The string representation of the GUID for the H.264 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformath264es.md b/windows.media.core/codecsubtypes_videoformath264es.md new file mode 100644 index 0000000000..6010337f60 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformath264es.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatH264ES +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatH264ES + +## -description +Gets the string representation of the GUID for the H.264 elementary stream video subtype. + +## -property-value +The string representation of the GUID for the H.264 elementary stream video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformath265.md b/windows.media.core/codecsubtypes_videoformath265.md new file mode 100644 index 0000000000..17c89fddb4 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformath265.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatH265 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatH265 + +## -description +Gets the string representation of the GUID for the H.265 video subtype. + +## -property-value +The string representation of the GUID for the H.265 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformathevc.md b/windows.media.core/codecsubtypes_videoformathevc.md new file mode 100644 index 0000000000..565837c445 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformathevc.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatHevc +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatHevc + +## -description +Gets the string representation of the GUID for the High Efficiency Video Coding (HEVC) Main profile and Main Still Picture profile video subtype. + +## -property-value +The string representation of the GUID for the High Efficiency Video Coding (HEVC) Main profile and Main Still Picture profile video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformathevces.md b/windows.media.core/codecsubtypes_videoformathevces.md new file mode 100644 index 0000000000..27947595b7 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformathevces.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatHevcES +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatHevcES + +## -description +Gets the string representation of the GUID for the High Efficiency Video Coding Elementary Stream (HEVC-ES) profile video subtype. + +## -property-value +The string representation of the GUID for the High Efficiency Video Coding Elementary Stream (HEVC-ES) profile video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatm4s2.md b/windows.media.core/codecsubtypes_videoformatm4s2.md new file mode 100644 index 0000000000..755a72160d --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatm4s2.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatM4S2 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatM4S2 + +## -description +Gets the string representation of the GUID for the MPEG-4 part 2 video subtype. + +## -property-value +The string representation of the GUID for the MPEG-4 part 2 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmjpg.md b/windows.media.core/codecsubtypes_videoformatmjpg.md new file mode 100644 index 0000000000..af39c2935e --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmjpg.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMjpg +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMjpg + +## -description +Gets the string representation of the GUID for the Motion JPEG video subtype. + +## -property-value +The string representation of the GUID for the Motion JPEG video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmp43.md b/windows.media.core/codecsubtypes_videoformatmp43.md new file mode 100644 index 0000000000..97b4e19b76 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmp43.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMP43 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMP43 + +## -description +Gets the string representation of the GUID for the Microsoft MPEG 4 codec version 3 video subtype. + +## -property-value +The string representation of the GUID for the Microsoft MPEG 4 codec version 3 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmp4s.md b/windows.media.core/codecsubtypes_videoformatmp4s.md new file mode 100644 index 0000000000..d22031bdce --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmp4s.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMP4S +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMP4S + +## -description +Gets the string representation of the GUID for the ISO MPEG 4 codec version 1 video subtype. + +## -property-value +The string representation of the GUID for the ISO MPEG 4 codec version 1 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmp4v.md b/windows.media.core/codecsubtypes_videoformatmp4v.md new file mode 100644 index 0000000000..ad5679503a --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmp4v.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMP4V +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMP4V + +## -description +Gets the string representation of the GUID for the MPEG-4 part 2 video subtype. + +## -property-value +The string representation of the GUID for the MPEG-4 part 2 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmpeg2.md b/windows.media.core/codecsubtypes_videoformatmpeg2.md new file mode 100644 index 0000000000..57f2b29d48 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmpeg2.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMpeg2 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMpeg2 + +## -description +Gets the string representation of the GUID for the MPEG-2 video subtype. + +## -property-value +The string representation of the GUID for the MPEG-2 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmpg1.md b/windows.media.core/codecsubtypes_videoformatmpg1.md new file mode 100644 index 0000000000..7e84ae0cdc --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmpg1.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMpg1 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMpg1 + +## -description +Gets the string representation of the GUID for the MPEG-1 video subtype. + +## -property-value +The string representation of the GUID for the MPEG-1 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmss1.md b/windows.media.core/codecsubtypes_videoformatmss1.md new file mode 100644 index 0000000000..d978529185 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmss1.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMss1 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMss1 + +## -description +Gets the string representation of the GUID for the Windows Media Screen codec version 1 video subtype. + +## -property-value +The string representation of the GUID for the Windows Media Screen codec version 1 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatmss2.md b/windows.media.core/codecsubtypes_videoformatmss2.md new file mode 100644 index 0000000000..58052308ae --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatmss2.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatMss2 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatMss2 + +## -description +Gets the string representation of the GUID for the Windows Media Video 9 Screen codec video subtype. + +## -property-value +The string representation of the GUID for the Windows Media Video 9 Screen codec video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatvp80.md b/windows.media.core/codecsubtypes_videoformatvp80.md new file mode 100644 index 0000000000..83ad0528e9 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatvp80.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatVP80 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatVP80 + +## -description +Gets the string representation of the GUID for the VP8 video subtype. + +## -property-value +The string representation of the GUID for the VP8 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatvp90.md b/windows.media.core/codecsubtypes_videoformatvp90.md new file mode 100644 index 0000000000..3152e3117e --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatvp90.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatVP90 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatVP90 + +## -description +Gets the string representation of the GUID for the VP9 video subtype. + +## -property-value +The string representation of the GUID for the VP9 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatwmv1.md b/windows.media.core/codecsubtypes_videoformatwmv1.md new file mode 100644 index 0000000000..330fb591b0 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatwmv1.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatWmv1 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatWmv1 + +## -description +Gets the string representation of the GUID for the Windows Media Video codec version 7 video subtype. + +## -property-value +The string representation of the GUID for the Windows Media Video codec version 7 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatwmv2.md b/windows.media.core/codecsubtypes_videoformatwmv2.md new file mode 100644 index 0000000000..c17c58a7d3 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatwmv2.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatWmv2 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatWmv2 + +## -description +Gets the string representation of the GUID for the Windows Media Video 8 video subtype. + +## -property-value +The string representation of the GUID for the Windows Media Video 8 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatwmv3.md b/windows.media.core/codecsubtypes_videoformatwmv3.md new file mode 100644 index 0000000000..f331ca9c93 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatwmv3.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatWmv3 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatWmv3 + +## -description +Gets the string representation of the GUID for the Windows Media Video 9 video subtype. + +## -property-value +The string representation of the GUID for the Windows Media Video 9 video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/codecsubtypes_videoformatwvc1.md b/windows.media.core/codecsubtypes_videoformatwvc1.md new file mode 100644 index 0000000000..337eaa49c5 --- /dev/null +++ b/windows.media.core/codecsubtypes_videoformatwvc1.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.CodecSubtypes.VideoFormatWvc1 +-api-type: winrt property +--- + + + +# Windows.Media.Core.CodecSubtypes.VideoFormatWvc1 + +## -description +Gets the string representation of the GUID for the SMPTE 421M (VC-1). video subtype. + +## -property-value +The string representation of the GUID for the SMPTE 421M (VC-1). video subtype. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/datacue_properties.md b/windows.media.core/datacue_properties.md new file mode 100644 index 0000000000..9aecd5da74 --- /dev/null +++ b/windows.media.core/datacue_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.DataCue.Properties +-api-type: winrt property +--- + + + +# Windows.Media.Core.DataCue.Properties + +## -description +Gets the collection of custom properties associated with the data cue. + +## -property-value +The collection of custom properties associated with the data cue. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue.md b/windows.media.core/imagecue.md new file mode 100644 index 0000000000..6ed50b930e --- /dev/null +++ b/windows.media.core/imagecue.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Core.ImageCue +-api-type: winrt class +--- + + + +# Windows.Media.Core.ImageCue + +## -description +Represents a image cue that can be included in a [TimedMetadataTrack](timedmetadatatrack.md). + +## -remarks +An **ImageCue** can be added to a [TimedMetadataTrack](timedmetadatatrack.md) with the [AddCue](timedmetadatatrack_addcue.md) method. When the cue's start time is reached, the [CueEntered](timedmetadatatrack_cueentered.md) event is raised and you can use the [MediaCueEventArgs](mediacueeventargs.md) passed into the handler to get a copy of the **ImageCue**. + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue_duration.md b/windows.media.core/imagecue_duration.md new file mode 100644 index 0000000000..ff91c4ec34 --- /dev/null +++ b/windows.media.core/imagecue_duration.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.ImageCue.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.ImageCue.Duration + +## -description +Gets or sets the duration of the cue. + +## -property-value +The duration of the cue. + +## -remarks +At the end of a cue's duration, the [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) event is raised. + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue_extent.md b/windows.media.core/imagecue_extent.md new file mode 100644 index 0000000000..1875adaa13 --- /dev/null +++ b/windows.media.core/imagecue_extent.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.ImageCue.Extent +-api-type: winrt property +--- + + + +# Windows.Media.Core.ImageCue.Extent + +## -description +Gets or sets the extent of the **ImageCue**, which is the rendered size of the assoociated image either in pixels or in percentage of available space. + +## -property-value +The extent of the **ImageCue** + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue_id.md b/windows.media.core/imagecue_id.md new file mode 100644 index 0000000000..e8e4bf1a6d --- /dev/null +++ b/windows.media.core/imagecue_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.ImageCue.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.ImageCue.Id + +## -description +Gets the identifier for the timed metadata track. + +## -property-value +The identifier for the timed metadata track. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue_imagecue_1221375020.md b/windows.media.core/imagecue_imagecue_1221375020.md new file mode 100644 index 0000000000..5fcdcc4518 --- /dev/null +++ b/windows.media.core/imagecue_imagecue_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Media.Core.ImageCue.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.ImageCue.ImageCue + +## -description +Initializes a new instance of the **ImageCue** class. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue_position.md b/windows.media.core/imagecue_position.md new file mode 100644 index 0000000000..f9c210fdbe --- /dev/null +++ b/windows.media.core/imagecue_position.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.ImageCue.Position +-api-type: winrt property +--- + + + +# Windows.Media.Core.ImageCue.Position + +## -description +Gets or sets the position of the image associated with the **ImageCue**, relative to the top left corner of the video frame. + +## -property-value +The position of the image associated with the **ImageCue** + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue_softwarebitmap.md b/windows.media.core/imagecue_softwarebitmap.md new file mode 100644 index 0000000000..7d0a266b30 --- /dev/null +++ b/windows.media.core/imagecue_softwarebitmap.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.ImageCue.SoftwareBitmap +-api-type: winrt property +--- + + + +# Windows.Media.Core.ImageCue.SoftwareBitmap + +## -description +Gets or sets the image associated with the image cue. + +## -property-value +The image associated with the image cue. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/imagecue_starttime.md b/windows.media.core/imagecue_starttime.md new file mode 100644 index 0000000000..6156f4ad0b --- /dev/null +++ b/windows.media.core/imagecue_starttime.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.ImageCue.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.ImageCue.StartTime + +## -description +Gets the start time of the cue. + +## -property-value +The start time of the cue. + +## -remarks +When a cue's start time is reached, the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) event is raised. + +## -see-also + +## -examples + diff --git a/windows.media.core/imediasource.md b/windows.media.core/imediasource.md index 7c31b0ddb8..d75219e737 100644 --- a/windows.media.core/imediasource.md +++ b/windows.media.core/imediasource.md @@ -15,7 +15,7 @@ Represents a media source that delivers media samples to a media pipeline. ## -remarks The [IMediaSource](imediasource.md) interface is implemented by the [MediaStreamSource](mediastreamsource.md) runtime class and can also be implemented by other runtime classes. -Runtime classes that implement this interface must also implement the [IMFGetService](XREF:TODO:mf.imfgetservice) interface and must support returning an [IMFMediaSource](XREF:TODO:mf.imfmediasource) or an [IMFMediaSourceExtension](XREF:TODO:mf.imfmediasourceextension) interface when [IMFGetService.GetService](XREF:TODO:mf.imfgetservice_getservice) method is invoked for the MF_MEDIASOURCE_SERVICE service. +Runtime classes that implement this interface must also implement the [IMFGetService](https://msdn.microsoft.com/en-us/library/windows/desktop/ms694261.aspx) interface and must support returning an [IMFMediaSource](https://msdn.microsoft.com/en-us/library/windows/desktop/ms700189.aspx) or an [IMFMediaSourceExtension](https://msdn.microsoft.com/en-us/library/windows/desktop/dn280726.aspx) interface when [IMFGetService.GetService](https://msdn.microsoft.com/en-us/library/windows/desktop/ms696978.aspx) method is invoked for the MF_MEDIASOURCE_SERVICE service. ## -examples diff --git a/windows.media.core/itimedmetadatatrackprovider.md b/windows.media.core/itimedmetadatatrackprovider.md new file mode 100644 index 0000000000..123e40eef5 --- /dev/null +++ b/windows.media.core/itimedmetadatatrackprovider.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Core.ITimedMetadataTrackProvider +-api-type: winrt interface +--- + + + +# Windows.Media.Core.ITimedMetadataTrackProvider + +## -description +Defines the interface implemented by a custom stream that provides metadata tracks. + +## -remarks +Streams implement this interface to provide metadata tracks when passed into [MediaSource.CreateFromStream](mediasource_createfromstream_983868770.md). + +## -see-also + +## -examples + diff --git a/windows.media.core/itimedmetadatatrackprovider_timedmetadatatracks.md b/windows.media.core/itimedmetadatatrackprovider_timedmetadatatracks.md new file mode 100644 index 0000000000..0c37bb2478 --- /dev/null +++ b/windows.media.core/itimedmetadatatrackprovider_timedmetadatatracks.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.ITimedMetadataTrackProvider.TimedMetadataTracks +-api-type: winrt property +--- + + + +# Windows.Media.Core.ITimedMetadataTrackProvider.TimedMetadataTracks + +## -description +Gets the list of timed metadata tracks provided by the object that implements this interface. + +## -property-value +The list of timed metadata tracks provided by the object that implements this interface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/mediabindingeventargs_setadaptivemediasource_1241144499.md b/windows.media.core/mediabindingeventargs_setadaptivemediasource_1241144499.md new file mode 100644 index 0000000000..e69d2385d4 --- /dev/null +++ b/windows.media.core/mediabindingeventargs_setadaptivemediasource_1241144499.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetAdaptiveMediaSource(Windows.Media.Streaming.Adaptive.AdaptiveMediaSource) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.SetAdaptiveMediaSource + +## -description +Binds an adaptive media source to the [MediaSource](mediasource.md) associated with the event. + +## -params + +## -param mediaSource +The [AdaptiveMediaSource](../windows.media.streaming.adaptive./adaptivemediasource.md) representing the media content. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/mediabindingeventargs_setstoragefile_1382784359.md b/windows.media.core/mediabindingeventargs_setstoragefile_1382784359.md new file mode 100644 index 0000000000..e8f695030e --- /dev/null +++ b/windows.media.core/mediabindingeventargs_setstoragefile_1382784359.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetStorageFile(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.SetStorageFile + +## -description + +## -params +Binds a storage file to the [MediaSource](mediasource.md) associated with the event. + +## -param file +The [StorageFile](../windows.storage/storagefile.md) containing media content. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/mediabindingeventargs_setstream_1882746634.md b/windows.media.core/mediabindingeventargs_setstream_1882746634.md index 2872793e29..86b2f83ae1 100644 --- a/windows.media.core/mediabindingeventargs_setstream_1882746634.md +++ b/windows.media.core/mediabindingeventargs_setstream_1882746634.md @@ -1,26 +1,26 @@ ---- --api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetStream(Windows.Storage.Streams.IRandomAccessStream,System.String) --api-type: winrt method ---- - - - -# Windows.Media.Core.MediaBindingEventArgs.SetStream - -## -description -Sets the media content to be bound to the [MediaSource](mediasource.md). - -## -parameters -### -param stream -A stream containing the media content. - -### -param contentType -A string specifying the content type of the media content. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Media.Core.MediaBindingEventArgs.SetStream(Windows.Storage.Streams.IRandomAccessStream,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaBindingEventArgs.SetStream + +## -description +Sets the media content to be bound to the [MediaSource](mediasource.md). + +## -parameters +### -param stream +A stream containing the media content. + +### -param contentType +A string specifying the content type of the media content. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md b/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md index ecdafd6016..4316125b42 100644 --- a/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md +++ b/windows.media.core/mediabindingeventargs_setstreamreference_1856037815.md @@ -10,7 +10,7 @@ public void SetStreamReference(Windows.Storage.Streams.IRandomAccessStreamRefere # Windows.Media.Core.MediaBindingEventArgs.SetStreamReference ## -description -Sets the media content to be bound to the [MediaSource](mediasource.md). +Binds a media content stream reference to the [MediaSource](mediasource.md) associated with the event. ## -parameters ### -param stream @@ -24,3 +24,4 @@ A string specifying the content type of the media content. ## -examples ## -see-also +[MediaBindingEventArgs](mediabindingeventargs.md) \ No newline at end of file diff --git a/windows.media.core/mediasource_adaptivemediasource.md b/windows.media.core/mediasource_adaptivemediasource.md new file mode 100644 index 0000000000..d13e56e5c8 --- /dev/null +++ b/windows.media.core/mediasource_adaptivemediasource.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.MediaSource.AdaptiveMediaSource +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.AdaptiveMediaSource + +## -description +Gets the [AdaptiveMediaSource](../windows.media.streaming.adaptive./adaptivemediasource.md) associated with the **MediaSource**. + +## -property-value +The [AdaptiveMediaSource](../windows.media.streaming.adaptive./adaptivemediasource.md) associated with the **MediaSource**. + +## -remarks +If the **MediaSource** does not have an associated **AdaptiveMediaSource**, this property value is null. + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasource_mediastreamsource.md b/windows.media.core/mediasource_mediastreamsource.md new file mode 100644 index 0000000000..29eb07a979 --- /dev/null +++ b/windows.media.core/mediasource_mediastreamsource.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.MediaSource.MediaStreamSource +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.MediaStreamSource + +## -description +Gets the [MediaStreamSource](mediastreamsource.md) associated with the **MediaSource**. + +## -property-value +The [MediaStreamSource](mediastreamsource.md) associated with the **MediaSource**. + +## -remarks +If the **MediaSource** does not have an associated **MediaStreamSource**, this property value is null. + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasource_msestreamsource.md b/windows.media.core/mediasource_msestreamsource.md new file mode 100644 index 0000000000..6c89bcb6cb --- /dev/null +++ b/windows.media.core/mediasource_msestreamsource.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.MediaSource.MseStreamSource +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.MseStreamSource + +## -description +Gets the [MseStreamSource](msestreamsource.md) associated with the **MediaSource**. + +## -property-value +The [MseStreamSource](msestreamsource.md) associated with the **MediaSource**. + +## -remarks +If the **MediaSource** does not have an associated **MseStreamSource**, this property value is null. + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasource_openasync_171309613.md b/windows.media.core/mediasource_openasync_171309613.md new file mode 100644 index 0000000000..672d822e0d --- /dev/null +++ b/windows.media.core/mediasource_openasync_171309613.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Media.Core.MediaSource.OpenAsync +-api-type: winrt method +--- + + + +# Windows.Media.Core.MediaSource.OpenAsync + +## -description +opens the backing data source for the **MediaSource** and reads the metadata and track information. + +## -parameters + +## -returns +An asynchronous action. + +## -remarks +This method can be called to preload the associated media for performance reasons or to verify that the media loads successfully. + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasource_uri.md b/windows.media.core/mediasource_uri.md new file mode 100644 index 0000000000..c6119add9c --- /dev/null +++ b/windows.media.core/mediasource_uri.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.MediaSource.Uri +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaSource.Uri + +## -description +Gets the URI associated with the **MediaSource**. + +## -property-value +The URI associated with the **MediaSource**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/mediasourceerror.md b/windows.media.core/mediasourceerror.md index fe84eaf6f9..002dc52969 100644 --- a/windows.media.core/mediasourceerror.md +++ b/windows.media.core/mediasourceerror.md @@ -13,10 +13,7 @@ public class MediaSourceError : Windows.Media.Core.IMediaSourceError Represents an error that occurred with a [MediaSource](mediasource.md). ## -remarks -Get an instance of this class by accessing one of the following properties: -+ [MediaSourceOpenCompletedEventArgs.Error](mediasourceopencompletedeventargs_error.md) -+ [TimedMetadataTrackErrorEventArgs.Error](timedmetadatatrackerroreventargs_error.md) -+ [TimedTextSourceResolveResultEventArgs.Error](timedtextsourceresolveresulteventargs_error.md) +Get an instance of this class by accessing the [MediaSourceOpenCompletedEventArgs.Error](mediasourceopenoperationcompletedeventargs_error.md) property. ## -examples diff --git a/windows.media.core/mediastreamsample_extendedproperties.md b/windows.media.core/mediastreamsample_extendedproperties.md index 60a2fe42ef..031a2845d1 100644 --- a/windows.media.core/mediastreamsample_extendedproperties.md +++ b/windows.media.core/mediastreamsample_extendedproperties.md @@ -16,7 +16,7 @@ Gets the extended property set which enables getting and setting properties on t The extended properties map. ## -remarks -The [ExtendedProperties](mediastreamsample_extendedproperties.md) is used for less common properties which are not directly accessible on the [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object. The properties are accessed through their GUID values. For example, the video stride property is accessed through the GUID value “0x644b4e48, 0x1e02, 0x4516, 0xb0, 0xeb, 0xc0, 0x1c, 0xa9, 0xd4, 0x9a, 0xc6”, which is the GUID for [MF_MT_DEFAULT_STRIDE](XREF:TODO:mf.mf_mt_default_stride_attribute). +The [ExtendedProperties](mediastreamsample_extendedproperties.md) is used for less common properties which are not directly accessible on the [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object. The properties are accessed through their GUID values. For example, the video stride property is accessed through the GUID value “0x644b4e48, 0x1e02, 0x4516, 0xb0, 0xeb, 0xc0, 0x1c, 0xa9, 0xd4, 0x9a, 0xc6”, which is the GUID for [MF_MT_DEFAULT_STRIDE](https://msdn.microsoft.com/en-us/library/windows/desktop/ms698965.aspx). ## -examples diff --git a/windows.media.core/mediastreamsamplepropertyset.md b/windows.media.core/mediastreamsamplepropertyset.md index d8a0417840..eb6653ec0a 100644 --- a/windows.media.core/mediastreamsamplepropertyset.md +++ b/windows.media.core/mediastreamsamplepropertyset.md @@ -19,7 +19,7 @@ See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=3090 ### Enumerating the collection in C# or Microsoft Visual Basic -You can iterate through a [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object in C# or Microsoft Visual Basic. In many cases, such as using **foreach** syntax, the compiler does this casting for you and you won't need to cast to `IEnumerable` explicitly. If you do need to cast explicitly, for example if you want to call [GetEnumerator](XREF:TODO:M:System.Collections.Generic.IEnumerable`1.GetEnumerator), cast the collection object to [IEnumerable<T>](XREF:TODO:T:System.Collections.Generic.IEnumerable`1) with a [KeyValuePair](XREF:TODO:T:System.Collections.Generic.KeyValuePair`2) of [Guid](https://msdn.microsoft.com/library/system.guid.aspx) and [Object](https://msdn.microsoft.com/library/system.object.aspx) as the constraint. +You can iterate through a [MediaStreamSamplePropertySet](mediastreamsamplepropertyset.md) object in C# or Microsoft Visual Basic. In many cases, such as using **foreach** syntax, the compiler does this casting for you and you won't need to cast to `IEnumerable` explicitly. If you do need to cast explicitly, for example if you want to call [GetEnumerator](https://msdn.microsoft.com/en-us/library/system.collections.ienumerable.getenumerator.aspx), cast the collection object to [IEnumerable<T>](https://msdn.microsoft.com/en-us/library/system.collections.ienumerable.aspx) with a [KeyValuePair](https://msdn.microsoft.com/en-us/library/5tbh8a42.aspx) of [Guid](https://msdn.microsoft.com/library/system.guid.aspx) and [Object](https://msdn.microsoft.com/library/system.object.aspx) as the constraint. diff --git a/windows.media.core/mediastreamsource.md b/windows.media.core/mediastreamsource.md index a036fc4d21..1de6305826 100644 --- a/windows.media.core/mediastreamsource.md +++ b/windows.media.core/mediastreamsource.md @@ -19,7 +19,7 @@ See the [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=3090 The [MediaStreamSource](mediastreamsource.md)API are very similar to the Microsoft SilverlightAPI of the same name. -[MediaStreamSource](mediastreamsource.md) can be used with [audio](XREF:TODO:wwa.HTMLAudioObject) and [video](XREF:TODO:wwa.HTMLVideoObject) objects in Windows app using JavaScript, [MediaElement](../windows.ui.xaml.controls/mediaelement.md) objects in Windows Store app using C++, C#, or Visual Basic, and the [MediaTranscoder](../windows.media.transcoding/mediatranscoder.md). +[MediaStreamSource](mediastreamsource.md) can be used with [audio](https://msdn.microsoft.com/en-us/library/windows/apps/hh441227.aspx) and [video](https://msdn.microsoft.com/en-us/library/windows/apps/hh465962.aspx) objects in Windows app using JavaScript, [MediaElement](../windows.ui.xaml.controls/mediaelement.md) objects in Windows Store app using C++, C#, or Visual Basic, and the [MediaTranscoder](../windows.media.transcoding/mediatranscoder.md). The [MediaStreamSource Sample](http://go.microsoft.com/fwlink/p/?LinkID=309021) demonstrates how to use the [MediaStreamSource](mediastreamsource.md).Here are some of the main [MediaStreamSource](mediastreamsource.md)API. The order outlines the basic flow of how [MediaStreamSource](mediastreamsource.md) functions. You'll notice that the [MediaStreamSource](mediastreamsource.md) sends request objects to the app through event arguments. These request objects enable the app to interact with the [MediaStreamSource](mediastreamsource.md) and pass data back to it. diff --git a/windows.media.core/mediastreamsource_maxsupportedplaybackrate.md b/windows.media.core/mediastreamsource_maxsupportedplaybackrate.md new file mode 100644 index 0000000000..7327b46c68 --- /dev/null +++ b/windows.media.core/mediastreamsource_maxsupportedplaybackrate.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.MediaStreamSource.MaxSupportedPlaybackRate +-api-type: winrt property +--- + + + +# Windows.Media.Core.MediaStreamSource.MaxSupportedPlaybackRate + +## -description +Gets the maxiumum supported playback rate for the **MediaStreamSource**. + +## -property-value +The maxiumum supported playback rate for the **MediaStreamSource**. + +## -remarks +This value is expressed as a ratio of the maximum playrate to the normal playback rate, so 1.0 indicates normal speed and 2.0 indicates double the normal speed. + +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue.md b/windows.media.core/speechcue.md new file mode 100644 index 0000000000..c73c056713 --- /dev/null +++ b/windows.media.core/speechcue.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Media.Core.SpeechCue +-api-type: winrt class +--- + + + +# Windows.Media.Core.SpeechCue + +## -description +Represents a speech cue that can be included in a [TimedMetadataTrack](timedmetadatatrack.md). This cue can be used to receive events based on metadata included in a text-to-speech (TTS) stream, such as word boundaries, sentence boundaries, and Speech Sythesis Markup Language (SSML) bookmarks. + +## -remarks +A **SpeechCue** can be added to a [TimedMetadataTrack](timedmetadatatrack.md) with the [AddCue](timedmetadatatrack_addcue.md) method. When the cue's start time is reached, the [CueEntered](timedmetadatatrack_cueentered.md) event is raised and you can use the [MediaCueEventArgs](mediacueeventargs.md) passed into the handler to get a copy of the **SpeechCue**. + +The [SpeechSynthesizer](./windows.media.speechsynthesis/speechsynthesizer.md) class generates metadata that uses the following values for the [TimedMetataTrack.DispatchType](timedmetadatatrack_dispatchtype.md) in order to identify the type of speech metadata included in a track. + + + + + + +
DispatchTypeDescription
SpeechBookmarkThe metadata track contains SSML bookmarks
SpeechSentenceThe metadata track contains word boundaries
SpeechWordThe metadata track contains sentence boundaries
+ +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue_duration.md b/windows.media.core/speechcue_duration.md new file mode 100644 index 0000000000..d8542d3be5 --- /dev/null +++ b/windows.media.core/speechcue_duration.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.SpeechCue.Duration +-api-type: winrt property +--- + + + +# Windows.Media.Core.SpeechCue.Duration + +## -description +Gets or sets the duration of the cue. + +## -property-value +The duration of the cue. + +## -remarks +At the end of a cue's duration, the [TimedMetadataTrack.CueExited](timedmetadatatrack_cueexited.md) event is raised. + +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue_endpositionininput.md b/windows.media.core/speechcue_endpositionininput.md new file mode 100644 index 0000000000..4c0c6eb52a --- /dev/null +++ b/windows.media.core/speechcue_endpositionininput.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Core.SpeechCue.EndPositionInInput +-api-type: winrt property +--- + + + +# Windows.Media.Core.SpeechCue.EndPositionInInput + +## -description +Gets or sets the offset into the string contained in the [Text](speechcue_text.md) property of the last character in the word or sentence associated with the cue. + +## -property-value +The offset into the string contained in the [Text](speechcue_text.md) property of the last character in the word or sentence associated with the cue. + +## -remarks +This value is exclusive of any surrounding or inline formatting of the string. + +This value is null for SSML bookmarks. + +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue_id.md b/windows.media.core/speechcue_id.md new file mode 100644 index 0000000000..6b0fdfac78 --- /dev/null +++ b/windows.media.core/speechcue_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.SpeechCue.Id +-api-type: winrt property +--- + + + +# Windows.Media.Core.SpeechCue.Id + +## -description +Gets the identifier for the timed metadata track + +## -property-value +The identifier for the timed metadata track + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue_speechcue_1221375020.md b/windows.media.core/speechcue_speechcue_1221375020.md new file mode 100644 index 0000000000..a9d629d382 --- /dev/null +++ b/windows.media.core/speechcue_speechcue_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Media.Core.SpeechCue.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Core.SpeechCue.SpeechCue + +## -description +Initializes a new instance of the **SpeechCue** class. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue_startpositionininput.md b/windows.media.core/speechcue_startpositionininput.md new file mode 100644 index 0000000000..b3adc40edf --- /dev/null +++ b/windows.media.core/speechcue_startpositionininput.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Core.SpeechCue.StartPositionInInput +-api-type: winrt property +--- + + + +# Windows.Media.Core.SpeechCue.StartPositionInInput + +## -description +Gets or sets the offset into the string contained in the [Text](speechcue_text.md) property of the first character in the word or sentence associated with the cue. + +## -property-value +The offset into the string contained in the [Text](speechcue_text.md) property of the first character in the word or sentence associated with the cue. + +## -remarks +This value is exclusive of any surrounding or inline formatting of the string. + +This value is null for SSML bookmarks. + +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue_starttime.md b/windows.media.core/speechcue_starttime.md new file mode 100644 index 0000000000..8ed3f6ddac --- /dev/null +++ b/windows.media.core/speechcue_starttime.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Core.SpeechCue.StartTime +-api-type: winrt property +--- + + + +# Windows.Media.Core.SpeechCue.StartTime + +## -description +Gets the start time of the cue. + +## -property-value +The start time of the cue. + +## -remarks +When a cue's start time is reached, the [TimedMetadataTrack.CueEntered](timedmetadatatrack_cueentered.md) event is raised. + +## -see-also + +## -examples + diff --git a/windows.media.core/speechcue_text.md b/windows.media.core/speechcue_text.md new file mode 100644 index 0000000000..65399bb4f4 --- /dev/null +++ b/windows.media.core/speechcue_text.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.SpeechCue.Text +-api-type: winrt property +--- + + + +# Windows.Media.Core.SpeechCue.Text + +## -description +Gets or sets the text associated with the speech cue. + +## -property-value +The text associated with the speech cue. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedmetadatakind.md b/windows.media.core/timedmetadatakind.md index a696894fb2..8822f1bcad 100644 --- a/windows.media.core/timedmetadatakind.md +++ b/windows.media.core/timedmetadatakind.md @@ -31,9 +31,15 @@ The metadata contains description text. ### -field Subtitle:5 The metadata contains subtitle text. +### -field ImageSubtitle:6 +The metadata contains images to be used as subtitles. + +### -field Speech:7 +The metadata contains speech metadata, such as word boundaries, sentence boundaries, and Speech Sythesis Markup Language (SSML) bookmarks. ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also + diff --git a/windows.media.core/timedmetadatatrackerror.md b/windows.media.core/timedmetadatatrackerror.md index c4f0380b07..3a5977cf3a 100644 --- a/windows.media.core/timedmetadatatrackerror.md +++ b/windows.media.core/timedmetadatatrackerror.md @@ -13,7 +13,7 @@ public class TimedMetadataTrackError : Windows.Media.Core.ITimedMetadataTrackErr Provides information about an error that occurred with a timed metadata track. ## -remarks -Get an instance of this class by accessing the [TimedMetadataTrackErrorEventArgs.Error](timedmetadatatrackerroreventargs_error.md) property. +Get an instance of this class by accessing the [TimedTextSourceResolveResultEventArgs.Error](timedtextsourceresolveresulteventargs_error.md) property. ## -examples diff --git a/windows.media.core/timedmetadatatrackerror_errorcode.md b/windows.media.core/timedmetadatatrackerror_errorcode.md index 58ebdaeabb..1bdbb46c81 100644 --- a/windows.media.core/timedmetadatatrackerror_errorcode.md +++ b/windows.media.core/timedmetadatatrackerror_errorcode.md @@ -16,7 +16,7 @@ Gets the error code associated with the timed metadata track error. The error code associated with the timed metadata track error. ## -remarks -This value provides high-level information about the error that occurred with the timed metadata track. To get the low-level exception associated with the error, call [TimedMetadataTrackError.Propagate](timedmetadatatrackerror_propagate.md) which will cause the underlying exception to be raised. +This value provides high-level information about the error that occurred with the timed metadata track. ## -examples diff --git a/windows.media.core/timedtextfontstyle.md b/windows.media.core/timedtextfontstyle.md new file mode 100644 index 0000000000..ef0502fb9c --- /dev/null +++ b/windows.media.core/timedtextfontstyle.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Media.Core.TimedTextFontStyle +-api-type: winrt enum +--- + + + +# Windows.Media.Core.TimedTextFontStyle + +## -description +Specifies the font styles that can be used for the display timed text. + +## -enum-fields +### -field Oblique:1 +The timed text uses oblique font style. + +### -field Normal:0 +The timed text uses normal font style. + +### -field Italic:2 +The timed text uses italic font style. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextsource_createfromstreamwithindex_1926656390.md b/windows.media.core/timedtextsource_createfromstreamwithindex_1926656390.md new file mode 100644 index 0000000000..57d0366e7d --- /dev/null +++ b/windows.media.core/timedtextsource_createfromstreamwithindex_1926656390.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromStreamWithIndex(Windows.Storage.Streams.IRandomAccessStream,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromStreamWithIndex + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) that uses image-based subtitles from the provided image and index streams. + +## -parameters + +### -param stream +A stream containing the image data for image-based subtitles. + +### -param indexStream +A stream containing the index data for image-based subtitles. + +## -returns +The new timed text source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextsource_createfromstreamwithindex_349279494.md b/windows.media.core/timedtextsource_createfromstreamwithindex_349279494.md new file mode 100644 index 0000000000..df1c60c514 --- /dev/null +++ b/windows.media.core/timedtextsource_createfromstreamwithindex_349279494.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromStreamWithIndex(Windows.Storage.Streams.IRandomAccessStream,Windows.Storage.Streams.IRandomAccessStream,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromStreamWithIndex + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) that uses image-based subtitles from the provided image and index streams and sets the default language. + +## -parameters + +### -param stream +A stream containing the image data for image-based subtitles. + +### -param indexStream +A stream containing the index data for image-based subtitles. + +### -param defaultLanguage +A string indicating the default language for the timed text source. + +## -returns +The new timed text source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextsource_createfromuriwithindex_1052488262.md b/windows.media.core/timedtextsource_createfromuriwithindex_1052488262.md new file mode 100644 index 0000000000..fa30f0d51b --- /dev/null +++ b/windows.media.core/timedtextsource_createfromuriwithindex_1052488262.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromUriWithIndex(Windows.Foundation.Uri,Windows.Foundation.Uri,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromUriWithIndex + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) that uses image-based subtitles from the provided image and index URIs and sets the default language. + +## -parameters + +### -param uri +The URI of the image data from which the timed text source is created. + +### -param indexUri +The URI of the index data from which the timed text source is created. + +### -param defaultLanguage +A string indicating the default language for the timed text source. + +## -returns +The new timed text source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextsource_createfromuriwithindex_1488737990.md b/windows.media.core/timedtextsource_createfromuriwithindex_1488737990.md new file mode 100644 index 0000000000..5e53011b25 --- /dev/null +++ b/windows.media.core/timedtextsource_createfromuriwithindex_1488737990.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Core.TimedTextSource.CreateFromUriWithIndex(Windows.Foundation.Uri,Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Media.Core.TimedTextSource.CreateFromUriWithIndex + +## -description +Creates a new instance of [TimedTextSource](timedtextsource.md) that uses image-based subtitles from the provided image and index URIs. + +## -parameters + +### -param uri +The URI of the image data from which the timed text source is created. + +### -param indexUri +The URI of the index data from which the timed text source is created. + +## -returns +The new timed text source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextstyle_fontstyle.md b/windows.media.core/timedtextstyle_fontstyle.md new file mode 100644 index 0000000000..65c38694e1 --- /dev/null +++ b/windows.media.core/timedtextstyle_fontstyle.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.FontStyle +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.FontStyle + +## -description +Gets or sets a value that specifies the font style of timed text. + +## -property-value +A value that specifies the font style of timed text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextstyle_islinethroughenabled.md b/windows.media.core/timedtextstyle_islinethroughenabled.md new file mode 100644 index 0000000000..e8f2878bc4 --- /dev/null +++ b/windows.media.core/timedtextstyle_islinethroughenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.IsLineThroughEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.IsLineThroughEnabled + +## -description +Gets or sets a value indicating whether strikethrough text is enabled for the timed text. + +## -property-value +True if strikethrough text is enabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextstyle_isoverlineenabled.md b/windows.media.core/timedtextstyle_isoverlineenabled.md new file mode 100644 index 0000000000..5a9cce010d --- /dev/null +++ b/windows.media.core/timedtextstyle_isoverlineenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.IsOverlineEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.IsOverlineEnabled + +## -description +Gets or sets a value indicating whether overline text is enabled for the timed text. + +## -property-value +True if overline text is enabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.core/timedtextstyle_isunderlineenabled.md b/windows.media.core/timedtextstyle_isunderlineenabled.md new file mode 100644 index 0000000000..389d35e7fc --- /dev/null +++ b/windows.media.core/timedtextstyle_isunderlineenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Core.TimedTextStyle.IsUnderlineEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Core.TimedTextStyle.IsUnderlineEnabled + +## -description +Gets or sets a value indicating whether underline text is enabled for the timed text. + +## -property-value +True if underline text is enabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodule.md b/windows.media.devices/audiodevicemodule.md new file mode 100644 index 0000000000..f5769f9b77 --- /dev/null +++ b/windows.media.devices/audiodevicemodule.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Devices.AudioDeviceModule +-api-type: winrt class +--- + + + +# Windows.Media.Devices.AudioDeviceModule + +## -description +Represents a single audio device module, which may be a hardware effect processing unit or any other audio configuration module defined by an audio driver. + +## -remarks +Get an instance of this class by calling [AudioDeviceModulesManager.FindAll](audiodevicemodulesmanager_findall_1149612203.md) or [AudioDeviceModulesManager.FindAllById](audiodevicemodulesmanager_findallbyid_1077023214.md). + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodule_classid.md b/windows.media.devices/audiodevicemodule_classid.md new file mode 100644 index 0000000000..20e52514c5 --- /dev/null +++ b/windows.media.devices/audiodevicemodule_classid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.AudioDeviceModule.ClassId +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceModule.ClassId + +## -description +Gets the GUID identifier of the module, which is defined by the audio device module owner. + +## -property-value +The GUID identifier of the module + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodule_displayname.md b/windows.media.devices/audiodevicemodule_displayname.md new file mode 100644 index 0000000000..c623135a54 --- /dev/null +++ b/windows.media.devices/audiodevicemodule_displayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.AudioDeviceModule.DisplayName +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceModule.DisplayName + +## -description +Gets the friendly name of the audio device module for display in UI. + +## -property-value +The friendly name of the audio device module. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodule_instanceid.md b/windows.media.devices/audiodevicemodule_instanceid.md new file mode 100644 index 0000000000..e5ace8305e --- /dev/null +++ b/windows.media.devices/audiodevicemodule_instanceid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.AudioDeviceModule.InstanceId +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceModule.InstanceId + +## -description +Gets an identifier, defined by the driver developer, that disambiguates between multiple instances of the same module class in the driver topology. + +## -property-value +An identifier that disambiguates between multiple instances of the same module class in the driver topology. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodule_majorversion.md b/windows.media.devices/audiodevicemodule_majorversion.md new file mode 100644 index 0000000000..b83c9f23fe --- /dev/null +++ b/windows.media.devices/audiodevicemodule_majorversion.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.AudioDeviceModule.MajorVersion +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceModule.MajorVersion + +## -description +Gets the major version of the audio device module. + +## -property-value +The major version of the audio device module. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodule_minorversion.md b/windows.media.devices/audiodevicemodule_minorversion.md new file mode 100644 index 0000000000..6c1177231d --- /dev/null +++ b/windows.media.devices/audiodevicemodule_minorversion.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.AudioDeviceModule.MinorVersion +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceModule.MinorVersion + +## -description +Gets the minor version of the audio device module. + +## -property-value +The minor version of the audio device module. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodule_sendcommandasync_78202797.md b/windows.media.devices/audiodevicemodule_sendcommandasync_78202797.md new file mode 100644 index 0000000000..73e3f1542c --- /dev/null +++ b/windows.media.devices/audiodevicemodule_sendcommandasync_78202797.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Devices.AudioDeviceModule.SendCommandAsync(Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AudioDeviceModule.SendCommandAsync + +## -description +Asynchronously sends data to the audio device module and receives the result. + +## -parameters + +### -param Command +A buffer containing the command data to send to the audio device module. + +## -returns +An asynchronous operation the returns a [ModuleCommandResult](modulecommandresult.md) upon successful completion. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulenotificationeventargs.md b/windows.media.devices/audiodevicemodulenotificationeventargs.md new file mode 100644 index 0000000000..9f6fc87d56 --- /dev/null +++ b/windows.media.devices/audiodevicemodulenotificationeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Devices.AudioDeviceModuleNotificationEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Devices.AudioDeviceModuleNotificationEventArgs + +## -description +Provides data for the [AudioDeviceModulesManager.ModuleNotificationReceived](audiodevicemodulesmanager_modulenotificationreceived.md) event which is raised when audio device module changes occur. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulenotificationeventargs_module.md b/windows.media.devices/audiodevicemodulenotificationeventargs_module.md new file mode 100644 index 0000000000..27daaaa319 --- /dev/null +++ b/windows.media.devices/audiodevicemodulenotificationeventargs_module.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.AudioDeviceModuleNotificationEventArgs.Module +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceModuleNotificationEventArgs.Module + +## -description +Gets the audio device module that triggered the change event. + +## -property-value +The audio device module that triggered the change event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulenotificationeventargs_notificationdata.md b/windows.media.devices/audiodevicemodulenotificationeventargs_notificationdata.md new file mode 100644 index 0000000000..f8b68ba297 --- /dev/null +++ b/windows.media.devices/audiodevicemodulenotificationeventargs_notificationdata.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Media.Devices.AudioDeviceModuleNotificationEventArgs.NotificationData +-api-type: winrt property +--- + + + +# Windows.Media.Devices.AudioDeviceModuleNotificationEventArgs.NotificationData + +## -description +Gets a buffer containing data that identifies the change that occurred in the module. This data is defined by the module developer. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulesmanager.md b/windows.media.devices/audiodevicemodulesmanager.md new file mode 100644 index 0000000000..5df9eda477 --- /dev/null +++ b/windows.media.devices/audiodevicemodulesmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Devices.AudioDeviceModulesManager +-api-type: winrt class +--- + + + +# Windows.Media.Devices.AudioDeviceModulesManager + +## -description +Manages the collections of audio device modules for a audio device pin instance or for a particular audio endpoint. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulesmanager_audiodevicemodulesmanager_290278668.md b/windows.media.devices/audiodevicemodulesmanager_audiodevicemodulesmanager_290278668.md new file mode 100644 index 0000000000..f24a579c1c --- /dev/null +++ b/windows.media.devices/audiodevicemodulesmanager_audiodevicemodulesmanager_290278668.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Devices.AudioDeviceModulesManager.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AudioDeviceModulesManager.AudioDeviceModulesManager + +## -description +Gets an instance of the **AudioDeviceModulesManager** class for the specified audio device ID. + +## -parameters + +### -param deviceId +The identifier of the audio device for which the **AudioDeviceModulesManager** is retrieved. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulesmanager_findall_1149612203.md b/windows.media.devices/audiodevicemodulesmanager_findall_1149612203.md new file mode 100644 index 0000000000..4c94594e9d --- /dev/null +++ b/windows.media.devices/audiodevicemodulesmanager_findall_1149612203.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Devices.AudioDeviceModulesManager.FindAll +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AudioDeviceModulesManager.FindAll + +## -description +Retreives a list of all audio device modules associated with the audio device for which the **AudioDeviceModulesManager** was initialized. + +## -parameters + +## -returns +A list of all audio device modules. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulesmanager_findallbyid_1077023214.md b/windows.media.devices/audiodevicemodulesmanager_findallbyid_1077023214.md new file mode 100644 index 0000000000..66209f6262 --- /dev/null +++ b/windows.media.devices/audiodevicemodulesmanager_findallbyid_1077023214.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Devices.AudioDeviceModulesManager.FindAllById(System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.AudioDeviceModulesManager.FindAllById + +## -description +Retrieves a list of all audio device modules with the specified ID. Each audio device module in the list will have the same ID, but each will have a different value for the [AudioDeviceModule.InstanceId](audiodevicemodule_instancid.md) property. + +## -parameters + +### -param moduleId +The identifier of the audio device modules to be retrieved. + +## -returns +A list of all audio device modules with the specified ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/audiodevicemodulesmanager_modulenotificationreceived.md b/windows.media.devices/audiodevicemodulesmanager_modulenotificationreceived.md new file mode 100644 index 0000000000..2ec33b7d20 --- /dev/null +++ b/windows.media.devices/audiodevicemodulesmanager_modulenotificationreceived.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.Devices.AudioDeviceModulesManager.ModuleNotificationReceived +-api-type: winrt event +--- + + + +# Windows.Media.Devices.AudioDeviceModulesManager.ModuleNotificationReceived + +## -description +Occurs when a change occurs in one of the audio device modules associated with the audio device for which the **AudioDeviceModulesManager** was initialized. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/exposurecontrol.md b/windows.media.devices/exposurecontrol.md index 0051ac411a..f0f83c0f1f 100644 --- a/windows.media.devices/exposurecontrol.md +++ b/windows.media.devices/exposurecontrol.md @@ -1,31 +1,31 @@ ---- --api-id: T:Windows.Media.Devices.ExposureControl --api-type: winrt class ---- - - - -# Windows.Media.Devices.ExposureControl - -## -description -Provides functionality for controlling the exposure settings on a capture device. - -## -remarks -The [ExposureControl](exposurecontrol.md) gives apps additional control over the exposure settings on a device. - -To set an exposure value, call [SetValueAsync](exposurecontrol_setvalueasync.md). To turn auto exposure on, call [SetAutoAsync](exposurecontrol_setautoasync.md). - -You can find out if a device supports this control by checking [ExposureControl.Supported](exposurecontrol_supported.md). - -If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the exposure value. - -You can access the [ExposureControl](exposurecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). - -For how-to guidance for using the **ExposureControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). - -## -examples - -## -see-also +--- +-api-id: T:Windows.Media.Devices.ExposureControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.ExposureControl + +## -description +Provides functionality for controlling the exposure settings on a capture device. + +## -remarks +The [ExposureControl](exposurecontrol.md) gives apps additional control over the exposure settings on a device. + +To set an exposure value, call [SetValueAsync](exposurecontrol_setvalueasync.md). To turn auto exposure on, call [SetAutoAsync](exposurecontrol_setautoasync.md). + +You can find out if a device supports this control by checking [ExposureControl.Supported](exposurecontrol_supported.md). + +If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoCaptureDevice](http://msdn.microsoft.com/library/afba2768-11a0-4105-a5b1-c48bc961e9ed) to set the exposure value. + +You can access the [ExposureControl](exposurecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +For how-to guidance for using the **ExposureControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/exposurecontrol_supported.md b/windows.media.devices/exposurecontrol_supported.md index 27bc8fa9a4..aba784e15a 100644 --- a/windows.media.devices/exposurecontrol_supported.md +++ b/windows.media.devices/exposurecontrol_supported.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Media.Devices.ExposureControl.Supported --api-type: winrt property ---- - - - -# Windows.Media.Devices.ExposureControl.Supported - -## -description -Gets a value that specifies if the capture device supports the exposure control. - -## -property-value -**true** if the exposure control is supported; otherwise, **false**. - -## -remarks -If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the exposure value. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Media.Devices.ExposureControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ExposureControl.Supported + +## -description +Gets a value that specifies if the capture device supports the exposure control. + +## -property-value +**true** if the exposure control is supported; otherwise, **false**. + +## -remarks +If the device does not support the [ExposureControl](exposurecontrol.md), you can still use the [Exposure](videodevicecontroller_exposure.md) property on the [VideoDeviceController](videodevicecontroller_md) to set the exposure value. + +## -examples + +## -see-also diff --git a/windows.media.devices/focuscontrol.md b/windows.media.devices/focuscontrol.md index 806194d209..7a26daccda 100644 --- a/windows.media.devices/focuscontrol.md +++ b/windows.media.devices/focuscontrol.md @@ -1,31 +1,31 @@ ---- --api-id: T:Windows.Media.Devices.FocusControl --api-type: winrt class ---- - - - -# Windows.Media.Devices.FocusControl - -## -description -Provides functionality for controlling the focus settings on a capture device. - -## -remarks -You can find out if a device supports this control by checking [FocusControl.Supported](focuscontrol_supported.md). - -If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the focus value. - -You can access the [FocusControl](focuscontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). - -The [FocusControl](focuscontrol.md) gives apps additional control over the focus settings on a device. - -You can use one of the [FocusPreset](focuspreset.md) values by calling [SetPresetAsync](focuscontrol_setpresetasync.md). Or call [SetValueAsync](focuscontrol_setvalueasync.md) to set a specific [Value](focuscontrol_value.md) between the [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). - -For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). - -## -examples - -## -see-also +--- +-api-id: T:Windows.Media.Devices.FocusControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.FocusControl + +## -description +Provides functionality for controlling the focus settings on a capture device. + +## -remarks +You can find out if a device supports this control by checking [FocusControl.Supported](focuscontrol_supported.md). + +If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoCaptureDevice](http://msdn.microsoft.com/library/afba2768-11a0-4105-a5b1-c48bc961e9ed) to set the focus value. + +You can access the [FocusControl](focuscontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +The [FocusControl](focuscontrol.md) gives apps additional control over the focus settings on a device. + +You can use one of the [FocusPreset](focuspreset.md) values by calling [SetPresetAsync](focuscontrol_setpresetasync.md). Or call [SetValueAsync](focuscontrol_setvalueasync.md) to set a specific [Value](focuscontrol_value.md) between the [Min](focuscontrol_min.md) and [Max](focuscontrol_max.md). + +For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/focuscontrol_supported.md b/windows.media.devices/focuscontrol_supported.md index e2c544fd60..8df0efdda7 100644 --- a/windows.media.devices/focuscontrol_supported.md +++ b/windows.media.devices/focuscontrol_supported.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Media.Devices.FocusControl.Supported --api-type: winrt property ---- - - - -# Windows.Media.Devices.FocusControl.Supported - -## -description -Gets a value that specifies if the capture device supports the focus control. - -## -property-value -**true** if the capture device supports the [FocusControl](focuscontrol.md); otherwise, **false**. - -## -remarks -If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the focus value. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Media.Devices.FocusControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.FocusControl.Supported + +## -description +Gets a value that specifies if the capture device supports the focus control. + +## -property-value +**true** if the capture device supports the [FocusControl](focuscontrol.md); otherwise, **false**. + +## -remarks +If the device does not support the [FocusControl](focuscontrol.md), you can still use the [Focus](videodevicecontroller_focus.md) property on the [VideoDeviceController](videodevicecontroller_md) to set the focus value. + +## -examples + +## -see-also diff --git a/windows.media.devices/modulecommandresult.md b/windows.media.devices/modulecommandresult.md new file mode 100644 index 0000000000..0d227e9ea6 --- /dev/null +++ b/windows.media.devices/modulecommandresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Devices.ModuleCommandResult +-api-type: winrt class +--- + + + +# Windows.Media.Devices.ModuleCommandResult + +## -description +Represents the result of an audio device module command, executed with a call to [AudioDeviceModule.SendCommand](audiodevicemodule_sendcommandasync_78202797.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/modulecommandresult_result.md b/windows.media.devices/modulecommandresult_result.md new file mode 100644 index 0000000000..018420e1fd --- /dev/null +++ b/windows.media.devices/modulecommandresult_result.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.ModuleCommandResult.Result +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ModuleCommandResult.Result + +## -description +Gets a buffer containing result of the audio device module command, defined by the audio device module developer. + +## -property-value +A buffer containing result of the audio device module command. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/modulecommandresult_status.md b/windows.media.devices/modulecommandresult_status.md new file mode 100644 index 0000000000..2b3ba78d86 --- /dev/null +++ b/windows.media.devices/modulecommandresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.ModuleCommandResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Devices.ModuleCommandResult.Status + +## -description +Gets a value that specifies the status of the audio device module command. + +## -property-value +A value that specifies the status of the audio device module command. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/sendcommandstatus.md b/windows.media.devices/sendcommandstatus.md new file mode 100644 index 0000000000..8680b654cf --- /dev/null +++ b/windows.media.devices/sendcommandstatus.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.Media.Devices.SendCommandStatus +-api-type: winrt enum +--- + + + +# Windows.Media.Devices.SendCommandStatus + +## -description +Specifies the status of the audio device module command, executed with a call to [AudioDeviceModule.SendCommand](audiodevicemodule_sendcommandasync_78202797.md). + + +## -enum-fields +### -field Success:0 +The command was successful. + +### -field DeviceNotAvailable:1 +The command failed because device is not available. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md b/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md index fbc2d358a2..d0c07cc026 100644 --- a/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md +++ b/windows.media.devices/videodevicecontroller_getdeviceproperty_267055185.md @@ -10,12 +10,11 @@ public object GetDeviceProperty(System.String propertyId) # Windows.Media.Devices.VideoDeviceController.GetDeviceProperty ## -description -Gets a property on the camera. You can use this method to query properties that are specific to a particular camera. +Gets the value of the property with the specified ID from the capture device driver. You can use this method to query properties that are specific to a particular camera. ## -parameters ### -param propertyId -The property identifier. - +The identifier of the property for which the value is retrieved. ## -returns The property value. @@ -25,3 +24,4 @@ The property value. ## -examples ## -see-also +[VideoDeviceController](videodevicecontroller.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_getdevicepropertybyextendedid_1175497625.md b/windows.media.devices/videodevicecontroller_getdevicepropertybyextendedid_1175497625.md new file mode 100644 index 0000000000..bd2663a84c --- /dev/null +++ b/windows.media.devices/videodevicecontroller_getdevicepropertybyextendedid_1175497625.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.GetDevicePropertyByExtendedId(System.Byte[],Windows.Foundation.IReference{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.GetDevicePropertyByExtendedId + +## -description +Gets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and specifying the maximum buffer size required to store the result. You can use this method to query properties that are specific to a particular camera. + + +## -params + +## -param extendedPropertyId +A byte array containing the extended identifier data. + +## -param maxPropertyValueSize +The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the [Status](videodevicecontrollergetdevicepropertyresult_status.md) property of the returned [VideoDeviceControllerGetDevicePropertyResult](videodevicecontrollergetdevicepropertyresult.md) object will be **MaxPropertyValueSizeRequired**. If the value supplied is too small to store the result of the operation, the returned **Status** object will be **MaxPropertyValueSizeTooSmall**, which means that you can retry the call with a larger buffer size. + +## -returns +A [VideoDeviceControllerGetDevicePropertyResult](videodevicecontrollergetdevicepropertyresult.md) object containing the status of the operation and, if successful, the returned property value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontroller_getdevicepropertybyid_1525410629.md b/windows.media.devices/videodevicecontroller_getdevicepropertybyid_1525410629.md new file mode 100644 index 0000000000..ba879b046c --- /dev/null +++ b/windows.media.devices/videodevicecontroller_getdevicepropertybyid_1525410629.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.GetDevicePropertyById(System.String,Windows.Foundation.IReference{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.GetDevicePropertyById +Gets the value of the property with the specified ID from the capture device driver, specifying the maximum buffer size required to store the result. You can use this method to query properties that are specific to a particular camera. + +## -description +Gets a the value of the property from the capture device driver with the ID with custom header information. You can use this method to query properties that are specific to a particular camera. + +## -params + +## -param propertyId +The identifier of the property for which the value is retrieved. + +## -param maxPropertyValueSize +The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the [Status](videodevicecontrollergetdevicepropertyresult_status.md) property of the returned [VideoDeviceControllerGetDevicePropertyResult](videodevicecontrollergetdevicepropertyresult.md) object will be **MaxPropertyValueSizeRequired**. If the value supplied is too small to store the result of the operation, the returned **Status** object will be **MaxPropertyValueSizeTooSmall**, which means that you can retry the call with a larger buffer size. + +## -returns +A [VideoDeviceControllerGetDevicePropertyResult](videodevicecontrollergetdevicepropertyresult.md) object containing the status of the operation and, if successful, the returned property value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontroller_id.md b/windows.media.devices/videodevicecontroller_id.md new file mode 100644 index 0000000000..277c255c1d --- /dev/null +++ b/windows.media.devices/videodevicecontroller_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.VideoDeviceController.Id +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceController.Id + +## -description +Gets a string containing the identifier for the video device controller. + +## -property-value +The identifier for the video device controller. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md b/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md index f485acfc6d..8a8e2dcc27 100644 --- a/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md +++ b/windows.media.devices/videodevicecontroller_setdeviceproperty_1247702267.md @@ -10,12 +10,11 @@ public void SetDeviceProperty(System.String propertyId, System.Object propertyVa # Windows.Media.Devices.VideoDeviceController.SetDeviceProperty ## -description -Sets a property on the device. You can use this method to set properties that are specific to a particular device. +Sets the value of the property with the specified ID on the capture device driver. You can use this method to set properties that are specific to a particular camera. ## -parameters ### -param propertyId -The property identifier. - +The identifier of the property for which the value is set. ### -param propertyValue The new value of the property. @@ -25,3 +24,4 @@ The new value of the property. ## -examples ## -see-also +[VideoDeviceController](videodevicecontroller.md) \ No newline at end of file diff --git a/windows.media.devices/videodevicecontroller_setdevicepropertybyextendedid_955303823.md b/windows.media.devices/videodevicecontroller_setdevicepropertybyextendedid_955303823.md new file mode 100644 index 0000000000..0972f3ba39 --- /dev/null +++ b/windows.media.devices/videodevicecontroller_setdevicepropertybyextendedid_955303823.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.SetDevicePropertyByExtendedId(System.Byte[],System.Byte[]) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.SetDevicePropertyByExtendedId + +## -description +Sets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and and providing the value as a byte array. + +## -params + +## -param extendedPropertyId +A byte array containing the extended identifier data. + +## -param propertyValue +A byte array containing the data to be assigned to the specified property. + +## -returns +A [VideoDeviceControllerSetDevicePropertyStatus](videodevicecontrollersetdevicepropertystatus.md) object describing the status of the operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontroller_setdevicepropertybyid_308279321.md b/windows.media.devices/videodevicecontroller_setdevicepropertybyid_308279321.md new file mode 100644 index 0000000000..eee2f36fc3 --- /dev/null +++ b/windows.media.devices/videodevicecontroller_setdevicepropertybyid_308279321.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.Media.Devices.VideoDeviceController.SetDevicePropertyById(System.String,System.Object) +-api-type: winrt method +--- + + + +# Windows.Media.Devices.VideoDeviceController.SetDevicePropertyById + +## -description +Sets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and and providing the value as an object. + +## -params + +## -param propertyId +A byte array containing the extended identifier data. + +## -param propertyValue +An object representing the data to be assigned to the specified property. + +## -returns +A [VideoDeviceControllerSetDevicePropertyStatus](videodevicecontrollersetdevicepropertystatus.md) object describing the status of the operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontrollergetdevicepropertyresult.md b/windows.media.devices/videodevicecontrollergetdevicepropertyresult.md new file mode 100644 index 0000000000..d0e285f66f --- /dev/null +++ b/windows.media.devices/videodevicecontrollergetdevicepropertyresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyResult +-api-type: winrt class +--- + + + +# Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyResult + +## -description +Represents the result of an operation to get the value of a video device controller driver property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontrollergetdevicepropertyresult_status.md b/windows.media.devices/videodevicecontrollergetdevicepropertyresult_status.md new file mode 100644 index 0000000000..e4fe9776e9 --- /dev/null +++ b/windows.media.devices/videodevicecontrollergetdevicepropertyresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyResult.Status + +## -description +Gets a value that specifies the status of an operation to get the value of a video device controller driver property. + +## -property-value +A value specifythat specifies the status of an operation to get the value of a video device controller driver property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontrollergetdevicepropertyresult_value.md b/windows.media.devices/videodevicecontrollergetdevicepropertyresult_value.md new file mode 100644 index 0000000000..73cbd2396a --- /dev/null +++ b/windows.media.devices/videodevicecontrollergetdevicepropertyresult_value.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyResult.Value +-api-type: winrt property +--- + + + +# Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyResult.Value + +## -description +Gets an object representing the result value of an operation to get the value of a video device controller driver property. + +## -property-value +An object representing the result value of an operation to get the value of a video device controller driver property. If the value of [Status](videodevicecontrollergetdevicepropertyresult_status.md) is not **Success**, this value will be null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontrollergetdevicepropertystatus.md b/windows.media.devices/videodevicecontrollergetdevicepropertystatus.md new file mode 100644 index 0000000000..619c852d57 --- /dev/null +++ b/windows.media.devices/videodevicecontrollergetdevicepropertystatus.md @@ -0,0 +1,51 @@ +--- +-api-id: T:Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyStatus +-api-type: winrt enumeration +--- + + + +# Windows.Media.Devices.VideoDeviceControllerGetDevicePropertyStatus + +## -description +Specifies the status of an operation to get the value of a video device controller driver property. + +## -enum-fields + +## -field UnknownFailure:1 +The operation failed due to an unknown failure. + +## -field Success:0 +The operation completed successfully. + +## -field NotSupported:3 +The operation failed because the specified property is not supported by the device. + +## -field MaxPropertyValueSizeTooSmall:5 +The operation failed because the specified maximum property value size is too small for the property value. You can retry the operation with a larger maximum property value size. + +## -field MaxPropertyValueSizeRequired:6 +The operation failed because a maximum property value size is required for the specified property. + +## -field DeviceNotAvailable:4 +The operation failed because the device is not available. + +## -field BufferTooSmall:2 +The operation failed because the buffer containing the extended ID data for the property was smaller than expected by the device driver. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/videodevicecontrollersetdevicepropertystatus.md b/windows.media.devices/videodevicecontrollersetdevicepropertystatus.md new file mode 100644 index 0000000000..3c822d7364 --- /dev/null +++ b/windows.media.devices/videodevicecontrollersetdevicepropertystatus.md @@ -0,0 +1,48 @@ +--- +-api-id: T:Windows.Media.Devices.VideoDeviceControllerSetDevicePropertyStatus +-api-type: winrt enumeration +--- + + + +# Windows.Media.Devices.VideoDeviceControllerSetDevicePropertyStatus + +## -description +Specifies the status of an operation to set the value of a video device controller driver property. + + +## -enum-fields + +## -field UnknownFailure:1 +The operation failed due to an unknown failure. + +## -field Success:0 +The operation completed successfully. + +## -field NotSupported:2 +The operation failed because the specified property is not supported by the device. + +## -field NotInControl:5 +The operation failed because the app does not have exclusive control of the video capture device and is therefore not currently permitted to change the device settings. For more information, see [MediaCaptureInitializationSettings.SharingMode](../windows.media.capture/mediacaptureinitializationsettings_sharingmode.md). + +## -field InvalidValue:3 +The operation failed because the specified property value is invalid. + +## -field DeviceNotAvailable:4 +The operation failed because the device is not available. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.devices/whitebalancecontrol.md b/windows.media.devices/whitebalancecontrol.md index bb0e001f06..f882016703 100644 --- a/windows.media.devices/whitebalancecontrol.md +++ b/windows.media.devices/whitebalancecontrol.md @@ -1,31 +1,31 @@ ---- --api-id: T:Windows.Media.Devices.WhiteBalanceControl --api-type: winrt class ---- - - - -# Windows.Media.Devices.WhiteBalanceControl - -## -description -Provides functionality for controlling the white balance settings on a capture device. - -## -remarks -The [WhiteBalanceControl](whitebalancecontrol.md) gives apps additional control over the white balance settings on a device. You can use one of the [ColorTemperaturePreset](colortemperaturepreset.md) values by calling [SetPresetAsync](whitebalancecontrol_setpresetasync.md). Or call [SetValueAsync](whitebalancecontrol_setvalueasync.md) to set a specific [Value](whitebalancecontrol_value.md) between the [Min](whitebalancecontrol_min.md) and [Max ](whitebalancecontrol_max.md). - -You can find out if a device supports this control by checking [WhiteBalanceControl.Supported](whitebalancecontrol_supported.md). - -If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the value for the white balance color temperature. - -You can access the [WhiteBalanceControl](whitebalancecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). - -White balance is specified as a color temperature in degrees Kelvin. - -For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). - -## -examples - -## -see-also +--- +-api-id: T:Windows.Media.Devices.WhiteBalanceControl +-api-type: winrt class +--- + + + +# Windows.Media.Devices.WhiteBalanceControl + +## -description +Provides functionality for controlling the white balance settings on a capture device. + +## -remarks +The [WhiteBalanceControl](whitebalancecontrol.md) gives apps additional control over the white balance settings on a device. You can use one of the [ColorTemperaturePreset](colortemperaturepreset.md) values by calling [SetPresetAsync](whitebalancecontrol_setpresetasync.md). Or call [SetValueAsync](whitebalancecontrol_setvalueasync.md) to set a specific [Value](whitebalancecontrol_value.md) between the [Min](whitebalancecontrol_min.md) and [Max ](whitebalancecontrol_max.md). + +You can find out if a device supports this control by checking [WhiteBalanceControl.Supported](whitebalancecontrol_supported.md). + +If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoCaptureDevice](http://msdn.microsoft.com/library/afba2768-11a0-4105-a5b1-c48bc961e9ed) to set the value for the white balance color temperature. + +You can access the [WhiteBalanceControl](whitebalancecontrol.md) for the capture device through [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md). + +White balance is specified as a color temperature in degrees Kelvin. + +For how-to guidance for using the **FocusControl**, see [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture). + +## -examples + +## -see-also [MediaCapture.VideoDeviceController](../windows.media.capture/mediacapture_videodevicecontroller.md), [Manual camera controls for photo and video capture](https://msdn.microsoft.com/en-us/windows/uwp/audio-video-camera/capture-device-controls-for-photo-and-video-capture) \ No newline at end of file diff --git a/windows.media.devices/whitebalancecontrol_supported.md b/windows.media.devices/whitebalancecontrol_supported.md index 4bb1b70763..b6f7dc0295 100644 --- a/windows.media.devices/whitebalancecontrol_supported.md +++ b/windows.media.devices/whitebalancecontrol_supported.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Media.Devices.WhiteBalanceControl.Supported --api-type: winrt property ---- - - - -# Windows.Media.Devices.WhiteBalanceControl.Supported - -## -description -Gets a value that specifies if the capture device supports the white balance control. - -## -property-value -**true** if the capture device supports the white balance control; otherwise, **false**. - -## -remarks -If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoCaptureDevice](XREF:TODO:wp_media_capture.audiovideocapturedevice) to set the white balance color temperature. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Media.Devices.WhiteBalanceControl.Supported +-api-type: winrt property +--- + + + +# Windows.Media.Devices.WhiteBalanceControl.Supported + +## -description +Gets a value that specifies if the capture device supports the white balance control. + +## -property-value +**true** if the capture device supports the white balance control; otherwise, **false**. + +## -remarks +If the device does not support the [WhiteBalanceControl](whitebalancecontrol.md), you can still use the [WhiteBalance](videodevicecontroller_whitebalance.md) on the [VideoDeviceController](videodevicecontroller_md) to set the white balance color temperature. + +## -examples + +## -see-also diff --git a/windows.media.import/photoimportfinditemsresult_additemsindaterangetoselection_411791789.md b/windows.media.import/photoimportfinditemsresult_additemsindaterangetoselection_411791789.md new file mode 100644 index 0000000000..81883f5418 --- /dev/null +++ b/windows.media.import/photoimportfinditemsresult_additemsindaterangetoselection_411791789.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Import.PhotoImportFindItemsResult.AddItemsInDateRangeToSelection(Windows.Foundation.DateTime,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.Import.PhotoImportFindItemsResult.AddItemsInDateRangeToSelection + +## -description +Adds all items in the specified date range to the current selection. + +## -parameters + +### -param rangeStart +The start of the date range. + +### -param rangeLength +The length of the date range. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.import/photoimportsession_rememberdeselecteditems.md b/windows.media.import/photoimportsession_rememberdeselecteditems.md new file mode 100644 index 0000000000..4a746afd45 --- /dev/null +++ b/windows.media.import/photoimportsession_rememberdeselecteditems.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.RememberDeselectedItems +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.RememberDeselectedItems + +## -description +Gets a value indicating whether the deselected items for the session should be remembered. + +## -property-value +True if the deselected items for the session should be remembered; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.import/photoimportsession_subfolderdateformat.md b/windows.media.import/photoimportsession_subfolderdateformat.md new file mode 100644 index 0000000000..f501168d3e --- /dev/null +++ b/windows.media.import/photoimportsession_subfolderdateformat.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Import.PhotoImportSession.SubfolderDateFormat +-api-type: winrt property +--- + + + +# Windows.Media.Import.PhotoImportSession.SubfolderDateFormat + +## -description +Gets or sets a value indicating the date format used by the session for subfolders. + +## -property-value +A value indicating the date format used by the session for subfolders. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/audioencodingproperties_createalac_587015051.md b/windows.media.mediaproperties/audioencodingproperties_createalac_587015051.md new file mode 100644 index 0000000000..ca7f9dccaf --- /dev/null +++ b/windows.media.mediaproperties/audioencodingproperties_createalac_587015051.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateAlac(System.UInt32,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.CreateAlac + +## -description +Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Apple Lossless Audio Codec (ALAC) audio. + +## -params + +## -param sampleRate +The audio sampling rate. + +## -param channelCount +The number of audio channels. + +## -param bitsPerSample +The number of bits per sample. + +## -returns +The audio encoding properties. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/audioencodingproperties_createflac_1569094276.md b/windows.media.mediaproperties/audioencodingproperties_createflac_1569094276.md new file mode 100644 index 0000000000..2925340a2a --- /dev/null +++ b/windows.media.mediaproperties/audioencodingproperties_createflac_1569094276.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Media.MediaProperties.AudioEncodingProperties.CreateFlac(System.UInt32,System.UInt32,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.CreateFlac + +## -description +Creates an instance of [AudioEncodingProperties](audioencodingproperties.md) for Free Lossless Audio Codec (FLAC) audio. + +## -params + +## -param sampleRate +The audio sampling rate. + +## -param channelCount +The number of audio channels. + +## -param bitsPerSample +The number of bits per sample. + +## -returns +The audio encoding properties. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/audioencodingproperties_isspatial.md b/windows.media.mediaproperties/audioencodingproperties_isspatial.md new file mode 100644 index 0000000000..8acc855347 --- /dev/null +++ b/windows.media.mediaproperties/audioencodingproperties_isspatial.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Media.MediaProperties.AudioEncodingProperties.IsSpatial +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.AudioEncodingProperties.IsSpatial +Gets a value indicating whether the audio is encoded with spatial audio information. +## -description + +## -property-value +True if the audio is encoded with spatial audio information; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingprofile_createalac_1291295910.md b/windows.media.mediaproperties/mediaencodingprofile_createalac_1291295910.md new file mode 100644 index 0000000000..5984fcf976 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingprofile_createalac_1291295910.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateAlac(Windows.Media.MediaProperties.AudioEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateAlac + +## -description +Creates an instance of [MediaEncodingProfile](mediaencodingprofile.md) for Apple Lossless Audio Codec (ALAC) audio. + +## -params + +## -param quality +The ecoding quality. + +## -returns +The media encoding profile. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingprofile_createflac_864863663.md b/windows.media.mediaproperties/mediaencodingprofile_createflac_864863663.md new file mode 100644 index 0000000000..dfd2fc8f51 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingprofile_createflac_864863663.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateFlac(Windows.Media.MediaProperties.AudioEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateFlac + +## -description +Creates an instance of [MediaEncodingProfile](mediaencodingprofile.md) for Free Lossless Audio Codec (FLAC) audio. + +## -params + +## -param quality +The ecoding quality. + +## -returns +The media encoding profile. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingprofile_createhevc_1247203123.md b/windows.media.mediaproperties/mediaencodingprofile_createhevc_1247203123.md new file mode 100644 index 0000000000..8d34f72c63 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingprofile_createhevc_1247203123.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.MediaProperties.MediaEncodingProfile.CreateHevc(Windows.Media.MediaProperties.VideoEncodingQuality) +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.MediaEncodingProfile.CreateHevc + +## -description +Creates an instance of [MediaEncodingProfile](mediaencodingprofile.md) for High Efficiency Video Coding (HEVC) video, also known as H.265 video. + +## -params + +## -param quality +The video quality. + +## -returns +The media encoding profile. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_alac.md b/windows.media.mediaproperties/mediaencodingsubtypes_alac.md new file mode 100644 index 0000000000..7f97353900 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingsubtypes_alac.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Alac +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Alac + +## -description +Gets the name for Apple Lossless Audio Codec (ALAC) audio encoding. + +## -property-value +The name for Dolby Digital audio (AC-3) for Apple Lossless Audio Codec (ALAC) audio. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_d16.md b/windows.media.mediaproperties/mediaencodingsubtypes_d16.md new file mode 100644 index 0000000000..f937e4851c --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingsubtypes_d16.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.D16 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.D16 + +## -description +Gets the name for 16-bit z-buffer depth image encoding. + +## -property-value +The name for 16-bit z-buffer depth image encoding. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_flac.md b/windows.media.mediaproperties/mediaencodingsubtypes_flac.md new file mode 100644 index 0000000000..89288d35f3 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingsubtypes_flac.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Flac +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Flac + +## -description +Gets the name for Free Lossless Audio Codec (FLAC) audio encoding. + +## -property-value +The name for Free Lossless Audio Codec (FLAC) audio encoding. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_l16.md b/windows.media.mediaproperties/mediaencodingsubtypes_l16.md new file mode 100644 index 0000000000..65ca49f7c4 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingsubtypes_l16.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.L16 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.L16 + +## -description +Gets the name for 16-bit luminance-only image encoding. + +## -property-value +The name for 16-bit luminance-only image encoding. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_l8.md b/windows.media.mediaproperties/mediaencodingsubtypes_l8.md new file mode 100644 index 0000000000..84fbd46d6a --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingsubtypes_l8.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.L8 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.L8 + +## -description +Gets the name for 8-bit luminance-only image encoding. + +## -property-value +The name for 8-bit luminance-only image encoding. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/mediaencodingsubtypes_vp9.md b/windows.media.mediaproperties/mediaencodingsubtypes_vp9.md new file mode 100644 index 0000000000..a924f6ba69 --- /dev/null +++ b/windows.media.mediaproperties/mediaencodingsubtypes_vp9.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaProperties.MediaEncodingSubtypes.Vp9 +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.MediaEncodingSubtypes.Vp9 + +## -description +Gets the name for VP9 video encoding. + +## -property-value +The name for VP9 video encoding. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/sphericalvideoframeformat.md b/windows.media.mediaproperties/sphericalvideoframeformat.md new file mode 100644 index 0000000000..63990744b0 --- /dev/null +++ b/windows.media.mediaproperties/sphericalvideoframeformat.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.Media.MediaProperties.SphericalVideoFrameFormat +-api-type: winrt enumeration +--- + + + +# Windows.Media.MediaProperties.SphericalVideoFrameFormat + +## -description +Specifies the format of a spherical video frame. + +## -enum-fields + +## -field Unsupported:1 +The video frame uses an unsupported spherical video format. + +## -field None:0 +The video frame does not use a spherical video format. + +## -field Equirectangular:2 +The video frame uses equirectangular format for spherical video. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md b/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md index 06b633fe6a..d64e4ee78a 100644 --- a/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md +++ b/windows.media.mediaproperties/videoencodingproperties_createh264_510168634.md @@ -1,22 +1,22 @@ ---- --api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 --api-type: winrt method ---- - - - -# Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 - -## -description -Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a H.263 video. - -## -returns -The video encoding properties. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.CreateH264 + +## -description +Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for a H.263 video. + +## -returns +The video encoding properties. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.media.mediaproperties/videoencodingproperties_createhevc_561607174.md b/windows.media.mediaproperties/videoencodingproperties_createhevc_561607174.md new file mode 100644 index 0000000000..09dc7ae1d9 --- /dev/null +++ b/windows.media.mediaproperties/videoencodingproperties_createhevc_561607174.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.MediaProperties.VideoEncodingProperties.CreateHevc +-api-type: winrt method +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.CreateHevc + +## -description +Creates an instance of [VideoEncodingProperties](videoencodingproperties.md) for High Efficiency Video Coding (HEVC). + +## -params + +## -returns +The video encoding properties. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/videoencodingproperties_sphericalvideoframeformat.md b/windows.media.mediaproperties/videoencodingproperties_sphericalvideoframeformat.md new file mode 100644 index 0000000000..bad7c363c2 --- /dev/null +++ b/windows.media.mediaproperties/videoencodingproperties_sphericalvideoframeformat.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaProperties.VideoEncodingProperties.SphericalVideoFrameFormat +-api-type: winrt property +--- + + + +# Windows.Media.MediaProperties.VideoEncodingProperties.SphericalVideoFrameFormat + +## -description +Gets a value that specifies the spherical video format of a video frame. + +## -property-value +The spherical video format of a video frame. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.mediaproperties/videoencodingquality.md b/windows.media.mediaproperties/videoencodingquality.md index b07cc2815d..1afba33a94 100644 --- a/windows.media.mediaproperties/videoencodingquality.md +++ b/windows.media.mediaproperties/videoencodingquality.md @@ -38,8 +38,15 @@ Vga format. Qvga format. +### -field Uhd2160p:8 + + +### -field Uhd4320p:9 + + ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also + diff --git a/windows.media.playback/autoloadeddisplaypropertykind.md b/windows.media.playback/autoloadeddisplaypropertykind.md new file mode 100644 index 0000000000..c0cd9c9650 --- /dev/null +++ b/windows.media.playback/autoloadeddisplaypropertykind.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Media.Playback.AutoLoadedDisplayPropertyKind +-api-type: winrt enumeration +--- + + + +# Windows.Media.Playback.AutoLoadedDisplayPropertyKind + +## -description +Specifies the kinds of metadata that can be automatically displayed for a [MediaPlaybackItem](mediaplaybackitem.md). Set the type of data you want to be automatically loaded by assigning one of these values to the [AutoLoadedDisplayProperties](mediaplaybackitem_autoloadeddisplayproperties.md) properties. + +## -enum-fields + +## -field Video:3 +Metadata should be automatically displayed for video content. + +## -field None:0 +No metadata should be automatically displayed. + +## -field MusicOrVideo:1 +Metadata should be automatically displayed for music or video content. + +## -field Music:2 +Metadata should be automatically displayed for music content. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/currentmediaplaybackitemchangedeventargs_reason.md b/windows.media.playback/currentmediaplaybackitemchangedeventargs_reason.md new file mode 100644 index 0000000000..5ce0cf42d8 --- /dev/null +++ b/windows.media.playback/currentmediaplaybackitemchangedeventargs_reason.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.Media.Playback.CurrentMediaPlaybackItemChangedEventArgs.Reason + +## -description +Gets the reason why the current [MediaPlaybackItem](mediaplaybackitem.md) in a [MediaPlaybackList](mediaplaybacklist.md) changed, such as if the previous item completed playback successfully or if there was an error playing back the previous item. + +## -property-value +The reason why the current [MediaPlaybackItem](mediaplaybackitem.md) in a [MediaPlaybackList](mediaplaybacklist.md) changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybackaudiotracklist.md b/windows.media.playback/mediaplaybackaudiotracklist.md index b6d5fe53f8..a26c8407a0 100644 --- a/windows.media.playback/mediaplaybackaudiotracklist.md +++ b/windows.media.playback/mediaplaybackaudiotracklist.md @@ -15,7 +15,7 @@ Represents a read-only list of [AudioTrack](../windows.media.core/audiotrack.md) ## -remarks Get an instance of this class by accessing the [AudioTracks](mediaplaybackitem_audiotracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [AudioTracksChanged](mediaplaybackitem_audiotrackschanged.md) event. -This class provides access to the list of [AudioTrack](../windows.media.core/audiotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemResolved](mediaplaybacklist_itemresolved.md) event is raised, you can select one of the audio tracks in the track list for playback. +This class provides access to the list of [AudioTrack](../windows.media.core/audiotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemOpened](mediaplaybacklist_itemopened.md) event is raised, you can select one of the audio tracks in the track list for playback. Note that this class does not represent a playlist of audio tracks that are played sequentially. To play a sequential list of tracks, use [MediaPlaybackList](mediaplaybacklist.md). diff --git a/windows.media.playback/mediaplaybackitem_autoloadeddisplayproperties.md b/windows.media.playback/mediaplaybackitem_autoloadeddisplayproperties.md new file mode 100644 index 0000000000..0502fad6fe --- /dev/null +++ b/windows.media.playback/mediaplaybackitem_autoloadeddisplayproperties.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.AutoLoadedDisplayProperties +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.AutoLoadedDisplayProperties + +## -description +Gets or sets a value that specifies for which types of media content, if any, the system should automatically load metadata to display in the System Media Transport Controls. + +## -property-value +A value that specifies for which types of media content the system should automatically load and display metadata. + +## -remarks +You can programmatically provide metadata for media items, instead of having the system dynamically load the metadata in the content, by calling [GetDisplayProperties](mediaplaybackitem_getdisplayproperties_103236454.md), setting the data of the returned [MediaItemDisplayProperties] (mediaitemdisplayproperties.md), and then calling [ApplyDisplayProperties](mediaplaybackitem_applydisplayproperties_1634192028.md). For more information, see [Media items, playlists, and tracks](https://msdn.microsoft.com/windows/uwp/audio-video-camera/media-playback-with-mediasource#set-display-properties-used-by-the-system-media-transport-controls). + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybackitem_isdisabledinplaybacklist.md b/windows.media.playback/mediaplaybackitem_isdisabledinplaybacklist.md new file mode 100644 index 0000000000..c55ca0579b --- /dev/null +++ b/windows.media.playback/mediaplaybackitem_isdisabledinplaybacklist.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.IsDisabledInPlaybackList +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.IsDisabledInPlaybackList + +## -description +Gets or sets a value that specifies whether a [MediaPlaybackItem](mediaplaybackitem.md) is disabled in a [MediaPlaybackList](mediaplaybacklist.md). + +## -property-value +True if the media playback item is disabled in the playback list; otherwise, false. + +## -remarks +A example scenario for using this property is when network connectivity is lost, your app can check the [TotalDownloadProgress](mediaplaybackitem_totaldownloadprogress.md) property to see which items in the playback list have completed downloading. For items that have not completed, set **IsDisabledInPlaybackList** to true so that the item won't be played in the list. + +Note that after playback of an item has begun, setting the **IsDisabledInPlaybackList** property has no effect. + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybackitem_totaldownloadprogress.md b/windows.media.playback/mediaplaybackitem_totaldownloadprogress.md new file mode 100644 index 0000000000..717a49cea0 --- /dev/null +++ b/windows.media.playback/mediaplaybackitem_totaldownloadprogress.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackItem.TotalDownloadProgress +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackItem.TotalDownloadProgress + +## -description +Gets a value that indicates the proportion of the data for the **MediaPlaybackItem** that is currently downloaded. + +## -property-value +A value, between 0 and 1.0, that indicates the total download progress of the **MediaPlaybackItem** where 0 means that none of the data has been downloaded and 1.0 means that all of the data has been downloaded. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybackitemchangedreason.md b/windows.media.playback/mediaplaybackitemchangedreason.md new file mode 100644 index 0000000000..84323dccfa --- /dev/null +++ b/windows.media.playback/mediaplaybackitemchangedreason.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackItemChangedReason +-api-type: winrt enumeration +--- + + + +# Windows.Media.Playback.MediaPlaybackItemChangedReason + +## -description +Specifies the reason why the current [MediaPlaybackItem](mediaplaybackitem.md) in a [MediaPlaybackList](mediaplaybacklist.md) changed. Check for the reason by accessing the [Reason](currentmediaplaybackitemchangedeventargs_reason.md) property of the [CurrentMediaPlaybackItemChangedEventArgs](currentmediaplaybackitemchangedeventargs.md) object passed into the [MediaPlaybackList.CurrentItemChanged](mediaplaybacklist_currentitemchanged.md) event. + +## -enum-fields + +## -field InitialItem:0 +The current item is the first item in the playback list. + +## -field Error:2 +The current item changed because there was an error playing back the previous item in the list. + +## -field EndOfStream:1 +The current item changed because the previous item in the list played successfully to the end of its media stream. + +## -field AppRequested:3 +The current item changed because the app initiated the change. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybackitemerror.md b/windows.media.playback/mediaplaybackitemerror.md index ce20852185..43be0a5861 100644 --- a/windows.media.playback/mediaplaybackitemerror.md +++ b/windows.media.playback/mediaplaybackitemerror.md @@ -13,7 +13,7 @@ public class MediaPlaybackItemError : Windows.Media.Playback.IMediaPlaybackItemE Represents an error that occurred trying to resolve a [MediaPlaybackItem](mediaplaybackitem.md). ## -remarks -The [ErrorCode](mediaplaybackitemerror_errorcode.md) property provides high-level information about the error that occurred resolving the playback item. The [Propagate](mediaplaybackitemerror_propagate.md) method propagates the underlying exception that caused the error. +The [ErrorCode](mediaplaybackitemerror_errorcode.md) property provides high-level information about the error that occurred resolving the playback item. The [ExtendedError](mediaplaybackitemerror_extendederror.md) method propagates the underlying exception that caused the error. ## -examples diff --git a/windows.media.playback/mediaplaybackitemerror_errorcode.md b/windows.media.playback/mediaplaybackitemerror_errorcode.md index e90e09a180..d8058e3d1c 100644 --- a/windows.media.playback/mediaplaybackitemerror_errorcode.md +++ b/windows.media.playback/mediaplaybackitemerror_errorcode.md @@ -16,7 +16,7 @@ Gets the error code associated with the playback item error. The error code associated with the playback item error. ## -remarks -This value provides high-level information about the error that occurred resolving the playback item. To get the low-level exception associated with the error, call [MediaPlaybackItemError.Propagate](mediaplaybackitemerror_propagate.md) which will cause the underlying exception to be raised. +This value provides high-level information about the error that occurred resolving the playback item. ## -examples diff --git a/windows.media.playback/mediaplaybacklist_maxplayeditemstokeepopen.md b/windows.media.playback/mediaplaybacklist_maxplayeditemstokeepopen.md new file mode 100644 index 0000000000..21dabd09e0 --- /dev/null +++ b/windows.media.playback/mediaplaybacklist_maxplayeditemstokeepopen.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackList.MaxPlayedItemsToKeepOpen +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackList.MaxPlayedItemsToKeepOpen + +## -description +Gets or sets a value that specifies the number of [MediaPlaybackItem](mediaplaybackitem.md) objects that should be kept open after they have been played. + +## -property-value +A value that specifies the number of [MediaPlaybackItem](mediaplaybackitem.md) objects that should be kept open after they have been played. + +## -remarks +Set this value to cause the system to keep the specified number of media playback items open after they have been played so that, if the users navigates backwards through the playback list, the open items can be played immediately without needing to be reopened. The trade off is that the more items that are kept open, the more memory is used by your app, which is especially important to consider with background media playback, where resources are more limited than for a foreground app. + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_bufferedrangeschanged.md b/windows.media.playback/mediaplaybacksession_bufferedrangeschanged.md new file mode 100644 index 0000000000..3fc80aebf6 --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_bufferedrangeschanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.BufferedRangesChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.BufferedRangesChanged + +## -description +Occurs when the set of time ranges for which data is buffered changes. + +## -remarks +Get the current set of buffered time ranges by calling [GetBufferedRanges](mediaplaybacksession_getbufferedranges_977901416.md). + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_getbufferedranges_977901416.md b/windows.media.playback/mediaplaybacksession_getbufferedranges_977901416.md new file mode 100644 index 0000000000..f76b2f56e4 --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_getbufferedranges_977901416.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackSession.GetBufferedRanges +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.GetBufferedRanges + +## -description +Retrieves a read-only list of time ranges for which data is buffered and playback can begin immediately. + +## -parameters + +## -returns +A read-only list of time ranges. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_getplayedranges_31993417.md b/windows.media.playback/mediaplaybacksession_getplayedranges_31993417.md new file mode 100644 index 0000000000..24faf61189 --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_getplayedranges_31993417.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackSession.GetPlayedRanges +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.GetPlayedRanges + +## -description +Retrieves a read-only list of time ranges for which content has been played back. + +## -parameters + +## -returns +A read-only list of time ranges. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_getseekableranges_2031292234.md b/windows.media.playback/mediaplaybacksession_getseekableranges_2031292234.md new file mode 100644 index 0000000000..0cf0807391 --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_getseekableranges_2031292234.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackSession.GetSeekableRanges +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.GetSeekableRanges + +## -description +Retrieves a read-only list of time ranges in which the playack position can be seeked to. For live streaming, these ranges represent the times ranges for which data is still available. + +## -parameters + +## -returns +A read-only list of time ranges. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_ismirroring.md b/windows.media.playback/mediaplaybacksession_ismirroring.md new file mode 100644 index 0000000000..dfecea4b8f --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_ismirroring.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.IsMirroring +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.IsMirroring + +## -description +Gets or sets a value indicating whether the content of the media playback session is currently being mirrored horizontally. + +## -property-value +True if the content of the media playback session is currently being mirrored horizontally; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_issupportedplaybackraterange_1941141152.md b/windows.media.playback/mediaplaybacksession_issupportedplaybackraterange_1941141152.md new file mode 100644 index 0000000000..1ff440345c --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_issupportedplaybackraterange_1941141152.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Media.Playback.MediaPlaybackSession.IsSupportedPlaybackRateRange(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.IsSupportedPlaybackRateRange + +## -description +Gets a value indicating whether the specified range of playback rates is supported. + +## -parameters + +### -param rate1 +The lower bound of the playback rate range for which support is queried. + +### -param rate2 +The upper bound of the playback rate range for which support is queried. + +## -returns +True if the playback range is supported; otherwise, false. + +## -remarks +Playback rates are expressed as a ratio of the specified rate to the normal playback rate, so 2.0 is twice as fast as normal and .5 is half as fast as normal. You can use this method to see if slow motion playback is supported by testing the range (0, 1), or you can see if reverse playback is supported by testing the range (-1, 0). You can also test to see if a specific rate is supported by using the same value for both bounds, such as (2, 2) for double-speed playback or (4, 4) for four times the normal playback speed. + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_playedrangeschanged.md b/windows.media.playback/mediaplaybacksession_playedrangeschanged.md new file mode 100644 index 0000000000..ee4e4a251c --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_playedrangeschanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.PlayedRangesChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.PlayedRangesChanged + +## -description +Occurs when the set of time ranges that have been played changes. + +## -remarks +Get the current set of buffered time ranges by calling [GetPlayedRanges](mediaplaybacksession_getplayedranges_31993417.md). + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_seekablerangeschanged.md b/windows.media.playback/mediaplaybacksession_seekablerangeschanged.md new file mode 100644 index 0000000000..2fbfe003fa --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_seekablerangeschanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.SeekableRangesChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.SeekableRangesChanged + +## -description +Occurs when the set of time ranges that can be seeked to changes. + +## -remarks +Get the current set of seekable time ranges by calling [GetSeekableRanges](mediaplaybacksession_getseekableranges_2031292234.md). + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_sphericalvideoprojection.md b/windows.media.playback/mediaplaybacksession_sphericalvideoprojection.md new file mode 100644 index 0000000000..3b3e2d1b2b --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_sphericalvideoprojection.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSession.SphericalVideoProjection +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.SphericalVideoProjection + +## -description +Gets an object that manages the spherical video projection settings used by the media playback session. + +## -property-value +An object that manages the spherical video projection settings used by the media playback session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksession_supportedplaybackrateschanged.md b/windows.media.playback/mediaplaybacksession_supportedplaybackrateschanged.md new file mode 100644 index 0000000000..650e4bf487 --- /dev/null +++ b/windows.media.playback/mediaplaybacksession_supportedplaybackrateschanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Media.Playback.MediaPlaybackSession.SupportedPlaybackRatesChanged +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlaybackSession.SupportedPlaybackRatesChanged + +## -description +Occurs when the set of playback rates supported by the media playback session changes. + +## -remarks +Query whether a range of playback rates is supported by calling [IsSupportedPlaybackRateRange](mediaplaybacksession_issupportedplaybackraterange_1941141152.md). + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksphericalvideoprojection.md b/windows.media.playback/mediaplaybacksphericalvideoprojection.md new file mode 100644 index 0000000000..3e785b64be --- /dev/null +++ b/windows.media.playback/mediaplaybacksphericalvideoprojection.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Playback.MediaPlaybackSphericalVideoProjection +-api-type: winrt class +--- + + + +# Windows.Media.Playback.MediaPlaybackSphericalVideoProjection + +## -description +Manages the spherical video projection settings for a [MediaPlaybackSession](mediaplaybacksession.md). + +## -remarks +Get an instance of this class by acessing the [MediaPlaybackSession.SphericalVideoProjection](mediaplaybacksession_sphericalvideoprojection.md) property. + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksphericalvideoprojection_frameformat.md b/windows.media.playback/mediaplaybacksphericalvideoprojection_frameformat.md new file mode 100644 index 0000000000..6cd00a1e8a --- /dev/null +++ b/windows.media.playback/mediaplaybacksphericalvideoprojection_frameformat.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.FrameFormat +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.FrameFormat + +## -description +Gets or sets a value that specifies the frame format used for spherical video projection. + +## -property-value +A value that specifies the frame format used for spherical video projection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksphericalvideoprojection_horizontalfieldofviewindegrees.md b/windows.media.playback/mediaplaybacksphericalvideoprojection_horizontalfieldofviewindegrees.md new file mode 100644 index 0000000000..2e9f57e553 --- /dev/null +++ b/windows.media.playback/mediaplaybacksphericalvideoprojection_horizontalfieldofviewindegrees.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.HorizontalFieldOfViewInDegrees +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.HorizontalFieldOfViewInDegrees + +## -description +Gets or sets the horizontal field of view, expressed in degrees, used for spherical video projection. + +## -property-value +The horizontal field of view, expressed in degrees + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksphericalvideoprojection_isenabled.md b/windows.media.playback/mediaplaybacksphericalvideoprojection_isenabled.md new file mode 100644 index 0000000000..6698f9506f --- /dev/null +++ b/windows.media.playback/mediaplaybacksphericalvideoprojection_isenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.IsEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.IsEnabled + +## -description +Gets or sets a value indicating whether spherical video projection is enabled. + +## -property-value +True if spherical video projection is enabled. Otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksphericalvideoprojection_projectionmode.md b/windows.media.playback/mediaplaybacksphericalvideoprojection_projectionmode.md new file mode 100644 index 0000000000..0049db3293 --- /dev/null +++ b/windows.media.playback/mediaplaybacksphericalvideoprojection_projectionmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.ProjectionMode +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.ProjectionMode + +## -description +Gets or sets a value that specifies the projection mode used for spherical video. + +## -property-value +A value that specifies the projection mode used for spherical video. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybacksphericalvideoprojection_vieworientation.md b/windows.media.playback/mediaplaybacksphericalvideoprojection_vieworientation.md new file mode 100644 index 0000000000..e79beb70be --- /dev/null +++ b/windows.media.playback/mediaplaybacksphericalvideoprojection_vieworientation.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.ViewOrientation +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlaybackSphericalVideoProjection.ViewOrientation + +## -description +Gets or sets a quaternion that specifies the current view orientation used to project spherical video. + +## -property-value +The current view orientation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplaybackvideotracklist.md b/windows.media.playback/mediaplaybackvideotracklist.md index 16ed8afe5b..73f3a285b1 100644 --- a/windows.media.playback/mediaplaybackvideotracklist.md +++ b/windows.media.playback/mediaplaybackvideotracklist.md @@ -15,7 +15,7 @@ Represents a read-only list of [VideoTrack](../windows.media.core/videotrack.md) ## -remarks Get an instance of this class by accessing the [VideoTracks](mediaplaybackitem_videotracks.md) property of a [MediaPlaybackItem](mediaplaybackitem.md). To be notified when the list of tracks changes, handle the [VideoTracksChanged](mediaplaybackitem_videotrackschanged.md) event. -This class provides access to the list of [VideoTrack](../windows.media.core/videotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemResolved](mediaplaybacklist_itemresolved.md) event is raised, you can select one of the video tracks in the track list for playback. +This class provides access to the list of [VideoTrack](../windows.media.core/videotrack.md) objects that are associated with a [MediaPlaybackItem](mediaplaybackitem.md). When the media item is opened by a component and the [ItemOpened](mediaplaybacklist_itemopened.md) event is raised, you can select one of the video tracks in the track list for playback. Note that this class does not represent a playlist of video tracks that are played sequentially. To play a sequential list of tracks, use [MediaPlaybackList](mediaplaybacklist.md). diff --git a/windows.media.playback/mediaplayer_copyframetostereoscopicvideosurfaces_929445157.md b/windows.media.playback/mediaplayer_copyframetostereoscopicvideosurfaces_929445157.md new file mode 100644 index 0000000000..10db36396c --- /dev/null +++ b/windows.media.playback/mediaplayer_copyframetostereoscopicvideosurfaces_929445157.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.CopyFrameToStereoscopicVideoSurfaces(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface,Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.CopyFrameToStereoscopicVideoSurfaces + +## -description +Copies the video frame currently displayed by the **MediaPlayer** to the two provided **IDirect3DSurface** objects which represent the left eye and right eye content of a stereoscopic video frame. + +## -parameters + +### -param destinationLeftEye +The surface to which the left eye content is copied. + +### -param destinationRightEye +The surface to which the right eye content is copied. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplayer_copyframetovideosurface_313890589.md b/windows.media.playback/mediaplayer_copyframetovideosurface_313890589.md new file mode 100644 index 0000000000..0ab03e8e6c --- /dev/null +++ b/windows.media.playback/mediaplayer_copyframetovideosurface_313890589.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.CopyFrameToVideoSurface(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.CopyFrameToVideoSurface + +## -description +Copies the current video frame from the **MediaPlayer** to the provided **IDirect3DSurface**. + +## -parameters + +### -param destination +The **IDirect3DSurface** to which the video frame is copied. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplayer_copyframetovideosurface_937988329.md b/windows.media.playback/mediaplayer_copyframetovideosurface_937988329.md new file mode 100644 index 0000000000..1f758dc4be --- /dev/null +++ b/windows.media.playback/mediaplayer_copyframetovideosurface_937988329.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Media.Playback.MediaPlayer.CopyFrameToVideoSurface(Windows.Graphics.DirectX.Direct3D11.IDirect3DSurface,Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.Media.Playback.MediaPlayer.CopyFrameToVideoSurface + +## -description +Copies the current video frame from the **MediaPlayer** to the specified target rectangle within the provided **IDirect3DSurface**. + +## -parameters + +### -param destination +The **IDirect3DSurface** to which the video frame is copied. + +### -param targetRectangle +The target rectangle within the **IDirect3DSurface** to which the video frame is copied. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplayer_isvideoframeserverenabled.md b/windows.media.playback/mediaplayer_isvideoframeserverenabled.md new file mode 100644 index 0000000000..e90fb81c9c --- /dev/null +++ b/windows.media.playback/mediaplayer_isvideoframeserverenabled.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Playback.MediaPlayer.IsVideoFrameServerEnabled +-api-type: winrt property +--- + + + +# Windows.Media.Playback.MediaPlayer.IsVideoFrameServerEnabled + +## -description +Gets a value indicating whether video frame server mode is enabled for the **MediaPlayer** instance. +## -property-value +True if video frame server mode is enabled; otherwise, false. + +## -remarks +When frame server mode is enabled, the media player does not render video content. Instead, your app should register for the [VideoFrameAvailable](mediaplayer_videoframeavailable.md) event and call [CopyFrameToVideoSurface](mediaplayer_copyframetovideosurface_313890589.md) when the event is raised to get the video frame data. + + +## -see-also + +## -examples + diff --git a/windows.media.playback/mediaplayer_videoframeavailable.md b/windows.media.playback/mediaplayer_videoframeavailable.md new file mode 100644 index 0000000000..519d4acfb2 --- /dev/null +++ b/windows.media.playback/mediaplayer_videoframeavailable.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Media.Playback.MediaPlayer.VideoFrameAvailable +-api-type: winrt event +--- + + + +# Windows.Media.Playback.MediaPlayer.VideoFrameAvailable + +## -description +Occurs when [IsVideoFrameServerEnabled](mediaplayer_isvideoframeserverenabled.md) is set to true and a new video frame is available for processing. + +## -remarks +In the handler for this event, call [CopyFrameToVideoSurface](mediaplayer_copyframetovideosurface_313890589.md) to get the video frame data. + +## -see-also + +## -examples + diff --git a/windows.media.playback/sphericalvideoprojectionmode.md b/windows.media.playback/sphericalvideoprojectionmode.md new file mode 100644 index 0000000000..1e43dbf4ab --- /dev/null +++ b/windows.media.playback/sphericalvideoprojectionmode.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Media.Playback.SphericalVideoProjectionMode +-api-type: winrt enum +--- + + + +# Windows.Media.Playback.SphericalVideoProjectionMode + +## -description +Specifies the spherical projection mode used for rendering video. + +## -enum-fields +### -field Spherical:0 +The video is rendered using spherical projection. + +### -field Flat:1 +The video is rendered flat with no spherical projection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.playto/currenttimechangerequestedeventargs.md b/windows.media.playto/currenttimechangerequestedeventargs.md index 8a924fc25b..3fcb7a4ba0 100644 --- a/windows.media.playto/currenttimechangerequestedeventargs.md +++ b/windows.media.playto/currenttimechangerequestedeventargs.md @@ -27,3 +27,4 @@ For an example of creating a software Play To receiver, see [Media casting](http ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/mutechangerequestedeventargs.md b/windows.media.playto/mutechangerequestedeventargs.md index 61c3840e3e..5c248c2f0c 100644 --- a/windows.media.playto/mutechangerequestedeventargs.md +++ b/windows.media.playto/mutechangerequestedeventargs.md @@ -27,3 +27,4 @@ For an example of creating a software Play To receiver, see [Media casting](http ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playbackratechangerequestedeventargs.md b/windows.media.playto/playbackratechangerequestedeventargs.md index 8a42edbf23..66313277ef 100644 --- a/windows.media.playto/playbackratechangerequestedeventargs.md +++ b/windows.media.playto/playbackratechangerequestedeventargs.md @@ -27,3 +27,4 @@ For an example of creating a software Play To receiver, see [Media casting](http ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoconnection.md b/windows.media.playto/playtoconnection.md index 5b37f0c869..6e7db2d127 100644 --- a/windows.media.playto/playtoconnection.md +++ b/windows.media.playto/playtoconnection.md @@ -13,7 +13,7 @@ public class PlayToConnection : Windows.Media.PlayTo.IPlayToConnection Provides information about a Play To connection. ## -remarks -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -26,3 +26,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoconnectionstatechangedeventargs.md b/windows.media.playto/playtoconnectionstatechangedeventargs.md index 54ff7bb43c..b4c153b472 100644 --- a/windows.media.playto/playtoconnectionstatechangedeventargs.md +++ b/windows.media.playto/playtoconnectionstatechangedeventargs.md @@ -13,7 +13,7 @@ public class PlayToConnectionStateChangedEventArgs : Windows.Media.PlayTo.IPlayT Provides information about the [StateChanged](playtoconnection_statechanged.md) event. ## -remarks -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -26,3 +26,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoconnectiontransferredeventargs.md b/windows.media.playto/playtoconnectiontransferredeventargs.md index 24efd8bb72..ecf00eda62 100644 --- a/windows.media.playto/playtoconnectiontransferredeventargs.md +++ b/windows.media.playto/playtoconnectiontransferredeventargs.md @@ -13,7 +13,7 @@ public class PlayToConnectionTransferredEventArgs : Windows.Media.PlayTo.IPlayTo Provides information about the [Transferred](playtoconnection_transferred.md) event. ## -remarks -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -26,3 +26,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtomanager.md b/windows.media.playto/playtomanager.md index 44836f1a1b..af443c28cc 100644 --- a/windows.media.playto/playtomanager.md +++ b/windows.media.playto/playtomanager.md @@ -20,7 +20,7 @@ In Play To, video starts from the current position. If you want to start the vid PlayTo apps will not be suspended as long as video or music is playing on the Play To receiver or images are continuously sent to the Play To receiver. Apps have approximately 10 seconds to send a new image after the current one is displayed and approximately 10 seconds to send the next audio or video after the current one has ended. -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -33,3 +33,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver.md b/windows.media.playto/playtoreceiver.md index 6ada7f7bc1..1cf25a4dbb 100644 --- a/windows.media.playto/playtoreceiver.md +++ b/windows.media.playto/playtoreceiver.md @@ -47,3 +47,5 @@ PlayTo apps will not be suspended as long as video or music is playing on the Pl ## -capabilities privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_currenttimechangerequested.md b/windows.media.playto/playtoreceiver_currenttimechangerequested.md index 9fead6ba73..d9a939d909 100644 --- a/windows.media.playto/playtoreceiver_currenttimechangerequested.md +++ b/windows.media.playto/playtoreceiver_currenttimechangerequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.CurrentTimeChangeRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.CurrentTimeChangeRequested - -## -description -Occurs when the time location of the playback has changed. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[CurrentTimeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetCurrentTimeChangeRequested)] - -[!code-js[CurrentTimeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetCurrentTimeChangeRequested)] - -[!code-vb[CurrentTimeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetCurrentTimeChangeRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.CurrentTimeChangeRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.CurrentTimeChangeRequested + +## -description +Occurs when the time location of the playback has changed. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[CurrentTimeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetCurrentTimeChangeRequested)] + +[!code-js[CurrentTimeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetCurrentTimeChangeRequested)] + +[!code-vb[CurrentTimeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetCurrentTimeChangeRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_mutechangerequested.md b/windows.media.playto/playtoreceiver_mutechangerequested.md index fa1fa88d3a..5ac8cf9c23 100644 --- a/windows.media.playto/playtoreceiver_mutechangerequested.md +++ b/windows.media.playto/playtoreceiver_mutechangerequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.MuteChangeRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.MuteChangeRequested - -## -description -Occurs when the audio has been muted or unmuted. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[MuteChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetMuteChangeRequested)] - -[!code-js[MuteChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetMuteChangeRequested)] - -[!code-vb[MuteChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetMuteChangeRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.MuteChangeRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.MuteChangeRequested + +## -description +Occurs when the audio has been muted or unmuted. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[MuteChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetMuteChangeRequested)] + +[!code-js[MuteChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetMuteChangeRequested)] + +[!code-vb[MuteChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetMuteChangeRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_notifydurationchange_1632513681.md b/windows.media.playto/playtoreceiver_notifydurationchange_1632513681.md index 550f4cbe80..832cf53190 100644 --- a/windows.media.playto/playtoreceiver_notifydurationchange_1632513681.md +++ b/windows.media.playto/playtoreceiver_notifydurationchange_1632513681.md @@ -1,36 +1,38 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyDurationChange(Windows.Foundation.TimeSpan) --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyDurationChange - -## -description -Notifies the Play To receiver that the duration of the audio or video playback has changed. - -## -parameters -### -param duration -The new duration of the audio or video media. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyDurationChange)] - -[!code-js[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyDurationChange)] - -[!code-vb[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyDurationChange)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyDurationChange(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyDurationChange + +## -description +Notifies the Play To receiver that the duration of the audio or video playback has changed. + +## -parameters +### -param duration +The new duration of the audio or video media. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyDurationChange)] + +[!code-js[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyDurationChange)] + +[!code-vb[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyDurationChange)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifyended_887919507.md b/windows.media.playto/playtoreceiver_notifyended_887919507.md index 5cf1666e57..fae145dfd0 100644 --- a/windows.media.playto/playtoreceiver_notifyended_887919507.md +++ b/windows.media.playto/playtoreceiver_notifyended_887919507.md @@ -1,32 +1,34 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyEnded --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyEnded - -## -description -Notifies the Play To receiver that the audio or video playback has ended. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyEnded](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyEnded)] - -[!code-js[NotifyEnded](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyEnded)] - -[!code-vb[NotifyEnded](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyEnded)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyEnded +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyEnded + +## -description +Notifies the Play To receiver that the audio or video playback has ended. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyEnded](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyEnded)] + +[!code-js[NotifyEnded](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyEnded)] + +[!code-vb[NotifyEnded](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyEnded)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifyerror_1157154443.md b/windows.media.playto/playtoreceiver_notifyerror_1157154443.md index 058edd4d95..6a463c7227 100644 --- a/windows.media.playto/playtoreceiver_notifyerror_1157154443.md +++ b/windows.media.playto/playtoreceiver_notifyerror_1157154443.md @@ -1,29 +1,30 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyError --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyError - -## -description -Notifies the Play To receiver that an error has occurred in displaying or playing the media. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] - -[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] - -[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyError +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyError + +## -description +Notifies the Play To receiver that an error has occurred in displaying or playing the media. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] + +[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] + +[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_notifyloadedmetadata_50414725.md b/windows.media.playto/playtoreceiver_notifyloadedmetadata_50414725.md index 78c1e32d47..d5304bd50b 100644 --- a/windows.media.playto/playtoreceiver_notifyloadedmetadata_50414725.md +++ b/windows.media.playto/playtoreceiver_notifyloadedmetadata_50414725.md @@ -1,32 +1,34 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyLoadedMetadata --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyLoadedMetadata - -## -description -Notifies the Play To receiver that metadata for the media has finished loading. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyDurationChange)] - -[!code-js[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyDurationChange)] - -[!code-vb[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyDurationChange)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyLoadedMetadata +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyLoadedMetadata + +## -description +Notifies the Play To receiver that metadata for the media has finished loading. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyDurationChange)] + +[!code-js[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyDurationChange)] + +[!code-vb[NotifyDurationChange](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyDurationChange)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifypaused_1175515486.md b/windows.media.playto/playtoreceiver_notifypaused_1175515486.md index 4a816a5370..22b5140d72 100644 --- a/windows.media.playto/playtoreceiver_notifypaused_1175515486.md +++ b/windows.media.playto/playtoreceiver_notifypaused_1175515486.md @@ -1,32 +1,34 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyPaused --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyPaused - -## -description -Notifies the Play To receiver that the audio or video playback has been paused. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] - -[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] - -[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyPaused +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyPaused + +## -description +Notifies the Play To receiver that the audio or video playback has been paused. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] + +[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] + +[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifyplaying_1675840659.md b/windows.media.playto/playtoreceiver_notifyplaying_1675840659.md index 0cd8030df7..c102dfc4f4 100644 --- a/windows.media.playto/playtoreceiver_notifyplaying_1675840659.md +++ b/windows.media.playto/playtoreceiver_notifyplaying_1675840659.md @@ -1,32 +1,34 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyPlaying --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyPlaying - -## -description -Notifies the Play To receiver that the audio or video playback has started. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] - -[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] - -[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyPlaying +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyPlaying + +## -description +Notifies the Play To receiver that the audio or video playback has started. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] + +[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] + +[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifyratechange_1422145476.md b/windows.media.playto/playtoreceiver_notifyratechange_1422145476.md index 162742ece1..f3578a135c 100644 --- a/windows.media.playto/playtoreceiver_notifyratechange_1422145476.md +++ b/windows.media.playto/playtoreceiver_notifyratechange_1422145476.md @@ -1,36 +1,38 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyRateChange(System.Double) --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyRateChange - -## -description -Notifies the Play To receiver that the rate of the audio or video playback has changed. - -## -parameters -### -param rate -The new value of the playback rate. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyRateChange](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyRateChange)] - -[!code-js[NotifyRateChange](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyRateChange)] - -[!code-vb[NotifyRateChange](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyRateChange)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyRateChange(System.Double) +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyRateChange + +## -description +Notifies the Play To receiver that the rate of the audio or video playback has changed. + +## -parameters +### -param rate +The new value of the playback rate. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyRateChange](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyRateChange)] + +[!code-js[NotifyRateChange](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyRateChange)] + +[!code-vb[NotifyRateChange](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyRateChange)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifyseeked_1986074253.md b/windows.media.playto/playtoreceiver_notifyseeked_1986074253.md index 9a9a869fbb..66d04d6246 100644 --- a/windows.media.playto/playtoreceiver_notifyseeked_1986074253.md +++ b/windows.media.playto/playtoreceiver_notifyseeked_1986074253.md @@ -1,32 +1,34 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifySeeked --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifySeeked - -## -description -Notifies the Play To receiver that the audio or video playback element has started at a new playback location. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifySeek)] - -[!code-js[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifySeek)] - -[!code-vb[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifySeek)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifySeeked +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifySeeked + +## -description +Notifies the Play To receiver that the audio or video playback element has started at a new playback location. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifySeek)] + +[!code-js[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifySeek)] + +[!code-vb[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifySeek)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifyseeking_930196462.md b/windows.media.playto/playtoreceiver_notifyseeking_930196462.md index 4be2f3f2cc..5ebb7e44b9 100644 --- a/windows.media.playto/playtoreceiver_notifyseeking_930196462.md +++ b/windows.media.playto/playtoreceiver_notifyseeking_930196462.md @@ -1,32 +1,34 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifySeeking --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifySeeking - -## -description -Notifies the Play To receiver that the audio or video playback element is seeking a new playback location. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifySeek)] - -[!code-js[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifySeek)] - -[!code-vb[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifySeek)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifySeeking +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifySeeking + +## -description +Notifies the Play To receiver that the audio or video playback element is seeking a new playback location. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifySeek)] + +[!code-js[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifySeek)] + +[!code-vb[NotifySeek](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifySeek)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifystopped_1831716120.md b/windows.media.playto/playtoreceiver_notifystopped_1831716120.md index b2257904d0..8258c8ead3 100644 --- a/windows.media.playto/playtoreceiver_notifystopped_1831716120.md +++ b/windows.media.playto/playtoreceiver_notifystopped_1831716120.md @@ -1,29 +1,30 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyStopped --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyStopped - -## -description -Notifies the Play To receiver that the audio or video playback has stopped. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] - -[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] - -[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyStopped +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyStopped + +## -description +Notifies the Play To receiver that the audio or video playback has stopped. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyPlayPauseStopError)] + +[!code-js[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyPlayPauseStopError)] + +[!code-vb[NotifyPlayPauseStopError](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyPlayPauseStopError)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_notifytimeupdate_1370613405.md b/windows.media.playto/playtoreceiver_notifytimeupdate_1370613405.md index ce2295dc42..d870e74782 100644 --- a/windows.media.playto/playtoreceiver_notifytimeupdate_1370613405.md +++ b/windows.media.playto/playtoreceiver_notifytimeupdate_1370613405.md @@ -1,36 +1,38 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyTimeUpdate(Windows.Foundation.TimeSpan) --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyTimeUpdate - -## -description -Notifies the Play To receiver that the time location of the audio or video playback has changed. - -## -parameters -### -param currentTime -The new time location of the playback. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetTimeUpdateRequested)] - -[!code-js[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetTimeUpdateRequested)] - -[!code-vb[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetTimeUpdateRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyTimeUpdate(Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyTimeUpdate + +## -description +Notifies the Play To receiver that the time location of the audio or video playback has changed. + +## -parameters +### -param currentTime +The new time location of the playback. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetTimeUpdateRequested)] + +[!code-js[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetTimeUpdateRequested)] + +[!code-vb[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetTimeUpdateRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_notifyvolumechange_378380103.md b/windows.media.playto/playtoreceiver_notifyvolumechange_378380103.md index 40f6019852..dc8debccc8 100644 --- a/windows.media.playto/playtoreceiver_notifyvolumechange_378380103.md +++ b/windows.media.playto/playtoreceiver_notifyvolumechange_378380103.md @@ -1,39 +1,41 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyVolumeChange(System.Double,System.Boolean) --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.NotifyVolumeChange - -## -description -Notifies the Play To receiver that the volume of the audio or video playback has changed. - -## -parameters -### -param volume -The new value for the volume. - -### -param mute -True if the volume was muted; otherwise false. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[NotifyVolumeChanged](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyVolumeChanged)] - -[!code-js[NotifyVolumeChanged](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyVolumeChanged)] - -[!code-vb[NotifyVolumeChanged](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyVolumeChanged)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) - -## -capabilities -privateNetworkClientServer +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.NotifyVolumeChange(System.Double,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.NotifyVolumeChange + +## -description +Notifies the Play To receiver that the volume of the audio or video playback has changed. + +## -parameters +### -param volume +The new value for the volume. + +### -param mute +True if the volume was muted; otherwise false. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[NotifyVolumeChanged](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetNotifyVolumeChanged)] + +[!code-js[NotifyVolumeChanged](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetNotifyVolumeChanged)] + +[!code-vb[NotifyVolumeChanged](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetNotifyVolumeChanged)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) + +## -capabilities +privateNetworkClientServer +ities +privateNetworkClientServer diff --git a/windows.media.playto/playtoreceiver_pauserequested.md b/windows.media.playto/playtoreceiver_pauserequested.md index 207174ae6d..cd852effb7 100644 --- a/windows.media.playto/playtoreceiver_pauserequested.md +++ b/windows.media.playto/playtoreceiver_pauserequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.PauseRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.PauseRequested - -## -description -Occurs when audio or video playback has been paused. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[PauseRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetPauseRequested)] - -[!code-js[PauseRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetPauseRequested)] - -[!code-vb[PauseRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetPauseRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.PauseRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.PauseRequested + +## -description +Occurs when audio or video playback has been paused. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[PauseRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetPauseRequested)] + +[!code-js[PauseRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetPauseRequested)] + +[!code-vb[PauseRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetPauseRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_playbackratechangerequested.md b/windows.media.playto/playtoreceiver_playbackratechangerequested.md index 152f726061..98cd6f351b 100644 --- a/windows.media.playto/playtoreceiver_playbackratechangerequested.md +++ b/windows.media.playto/playtoreceiver_playbackratechangerequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.PlaybackRateChangeRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.PlaybackRateChangeRequested - -## -description -Occurs when the rate of audio or video playback has changed. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[PlaybackRateChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetPlaybackRateChangeRequested)] - -[!code-js[PlaybackRateChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetPlaybackRateChangeRequested)] - -[!code-vb[PlaybackRateChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetPlaybackRateChangeRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.PlaybackRateChangeRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.PlaybackRateChangeRequested + +## -description +Occurs when the rate of audio or video playback has changed. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[PlaybackRateChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetPlaybackRateChangeRequested)] + +[!code-js[PlaybackRateChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetPlaybackRateChangeRequested)] + +[!code-vb[PlaybackRateChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetPlaybackRateChangeRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_playrequested.md b/windows.media.playto/playtoreceiver_playrequested.md index 09f876e7ab..5b04a51141 100644 --- a/windows.media.playto/playtoreceiver_playrequested.md +++ b/windows.media.playto/playtoreceiver_playrequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.PlayRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.PlayRequested - -## -description -Occurs when audio or video playback starts. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[PlayRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetPlayRequested)] - -[!code-js[PlayRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetPlayRequested)] - -[!code-vb[PlayRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetPlayRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.PlayRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.PlayRequested + +## -description +Occurs when audio or video playback starts. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[PlayRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetPlayRequested)] + +[!code-js[PlayRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetPlayRequested)] + +[!code-vb[PlayRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetPlayRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_sourcechangerequested.md b/windows.media.playto/playtoreceiver_sourcechangerequested.md index 55b0286dbf..369d096844 100644 --- a/windows.media.playto/playtoreceiver_sourcechangerequested.md +++ b/windows.media.playto/playtoreceiver_sourcechangerequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.SourceChangeRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.SourceChangeRequested - -## -description -Occurs when the source media for the Play To receiver have changed. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[SourceChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetSourceChangeRequested)] - -[!code-js[SourceChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetSourceChangeRequested)] - -[!code-vb[SourceChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetSourceChangeRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.SourceChangeRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.SourceChangeRequested + +## -description +Occurs when the source media for the Play To receiver have changed. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[SourceChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetSourceChangeRequested)] + +[!code-js[SourceChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetSourceChangeRequested)] + +[!code-vb[SourceChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetSourceChangeRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_startasync_1931900819.md b/windows.media.playto/playtoreceiver_startasync_1931900819.md index 7ecf6ec0df..977481b7c1 100644 --- a/windows.media.playto/playtoreceiver_startasync_1931900819.md +++ b/windows.media.playto/playtoreceiver_startasync_1931900819.md @@ -1,32 +1,33 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.StartAsync --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.StartAsync - -## -description -Start receiving Play To commands. - -## -returns -An asynchronous handler that's called when the start operation is complete. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[StartAsync](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetStartAsync)] - -[!code-js[StartAsync](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetStartAsync)] - -[!code-vb[StartAsync](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetStartAsync)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.StartAsync +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.StartAsync + +## -description +Start receiving Play To commands. + +## -returns +An asynchronous handler that's called when the start operation is complete. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[StartAsync](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetStartAsync)] + +[!code-js[StartAsync](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetStartAsync)] + +[!code-vb[StartAsync](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetStartAsync)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_stopasync_1648475005.md b/windows.media.playto/playtoreceiver_stopasync_1648475005.md index 81105e1feb..b38ad63752 100644 --- a/windows.media.playto/playtoreceiver_stopasync_1648475005.md +++ b/windows.media.playto/playtoreceiver_stopasync_1648475005.md @@ -1,32 +1,33 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToReceiver.StopAsync --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.StopAsync - -## -description -Stop receiving Play To commands. - -## -returns -An asynchronous handler that's called when the stop operation is complete. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[StopAsync](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetStopAsync)] - -[!code-js[StopAsync](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetStopAsync)] - -[!code-vb[StopAsync](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetStopAsync)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: M:Windows.Media.PlayTo.PlayToReceiver.StopAsync +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.StopAsync + +## -description +Stop receiving Play To commands. + +## -returns +An asynchronous handler that's called when the stop operation is complete. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[StopAsync](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetStopAsync)] + +[!code-js[StopAsync](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetStopAsync)] + +[!code-vb[StopAsync](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetStopAsync)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_stoprequested.md b/windows.media.playto/playtoreceiver_stoprequested.md index b75b293692..fa13972a6b 100644 --- a/windows.media.playto/playtoreceiver_stoprequested.md +++ b/windows.media.playto/playtoreceiver_stoprequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.StopRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.StopRequested - -## -description -Occurs when a request has been made for the Play To receiver to stop playing the streamed media. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[StopRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetStopRequested)] - -[!code-js[StopRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetStopRequested)] - -[!code-vb[StopRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetStopRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.StopRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.StopRequested + +## -description +Occurs when a request has been made for the Play To receiver to stop playing the streamed media. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[StopRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetStopRequested)] + +[!code-js[StopRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetStopRequested)] + +[!code-vb[StopRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetStopRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_timeupdaterequested.md b/windows.media.playto/playtoreceiver_timeupdaterequested.md index 7627e08600..776b5ece00 100644 --- a/windows.media.playto/playtoreceiver_timeupdaterequested.md +++ b/windows.media.playto/playtoreceiver_timeupdaterequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.TimeUpdateRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.TimeUpdateRequested - -## -description -Occurs when the current playback position has changed. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetTimeUpdateRequested)] - -[!code-js[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetTimeUpdateRequested)] - -[!code-vb[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetTimeUpdateRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.TimeUpdateRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.TimeUpdateRequested + +## -description +Occurs when the current playback position has changed. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetTimeUpdateRequested)] + +[!code-js[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetTimeUpdateRequested)] + +[!code-vb[TimeUpdateRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetTimeUpdateRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtoreceiver_volumechangerequested.md b/windows.media.playto/playtoreceiver_volumechangerequested.md index 5867d9ad3e..16e0de301d 100644 --- a/windows.media.playto/playtoreceiver_volumechangerequested.md +++ b/windows.media.playto/playtoreceiver_volumechangerequested.md @@ -1,29 +1,30 @@ ---- --api-id: E:Windows.Media.PlayTo.PlayToReceiver.VolumeChangeRequested --api-type: winrt event ---- - - - -# Windows.Media.PlayTo.PlayToReceiver.VolumeChangeRequested - -## -description -Occurs when the volume for the source audio or video has changed. - -## -remarks -For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - - - -[!code-csharp[VolumeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetVolumeChangeRequested)] - -[!code-js[VolumeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetVolumeChangeRequested)] - -[!code-vb[VolumeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetVolumeChangeRequested)] - -## -examples - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: E:Windows.Media.PlayTo.PlayToReceiver.VolumeChangeRequested +-api-type: winrt event +--- + + + +# Windows.Media.PlayTo.PlayToReceiver.VolumeChangeRequested + +## -description +Occurs when the volume for the source audio or video has changed. + +## -remarks +For an example of creating a software Play To receiver, see [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + + + +[!code-csharp[VolumeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/csharp/MainPage.xaml.cs#SnippetVolumeChangeRequested)] + +[!code-js[VolumeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/javascript/default.js#SnippetVolumeChangeRequested)] + +[!code-vb[VolumeChangeRequested](../windows.media.playto/code/PlayTo_Receiver1/vbnet/MainPage.xaml.vb#SnippetVolumeChangeRequested)] + +## -examples + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosource.md b/windows.media.playto/playtosource.md index fb20e87d85..e9b19fea40 100644 --- a/windows.media.playto/playtosource.md +++ b/windows.media.playto/playtosource.md @@ -19,13 +19,13 @@ For an example of using the [PlayToSource](playtosource.md) class, see [Streamin ## -examples -[!code-csharp[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetSlideShow_CS)] +[!code-csharp[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetSlideShow)] [!code-js[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/javascript/default.js#SnippetSlideShow)] -[!code-vb[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/vbnet/MainPage.xaml.vb#SnippetSlideShow_CS)] +[!code-vb[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/vbnet/MainPage.xaml.vb#SnippetSlideShow)] -[!code-csharp[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetPlayToContract_CS)] +[!code-csharp[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetPlayToContract)] [!code-js[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/javascript/default.js#SnippetPlayToContract)] @@ -33,3 +33,4 @@ For an example of using the [PlayToSource](playtosource.md) class, see [Streamin ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +edia Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosource_next.md b/windows.media.playto/playtosource_next.md index fe15d8d2d2..d3f681fa12 100644 --- a/windows.media.playto/playtosource_next.md +++ b/windows.media.playto/playtosource_next.md @@ -1,32 +1,33 @@ ---- --api-id: P:Windows.Media.PlayTo.PlayToSource.Next --api-type: winrt property ---- - - - -# Windows.Media.PlayTo.PlayToSource.Next - -## -description -Gets or sets the next Play To source element. - -## -property-value -The next Play To source element. - -## -remarks -For an example of using the [Next](playtosource_next.md) property, see [Streaming a slide show using Play To -(JavaScript)](http://msdn.microsoft.com/library/780cb5f5-4ee5-4294-ad60-5be54107838a) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - -## -examples - - -[!code-csharp[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetPlayToContract_CS)] - -[!code-js[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/javascript/default.js#SnippetPlayToContract)] - -[!code-vb[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/vbnet/MainPage.xaml.vb#SnippetPlayToContract_CS)] - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: P:Windows.Media.PlayTo.PlayToSource.Next +-api-type: winrt property +--- + + + +# Windows.Media.PlayTo.PlayToSource.Next + +## -description +Gets or sets the next Play To source element. + +## -property-value +The next Play To source element. + +## -remarks +For an example of using the [Next](playtosource_next.md) property, see [Streaming a slide show using Play To +(JavaScript)](http://msdn.microsoft.com/library/780cb5f5-4ee5-4294-ad60-5be54107838a) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + +## -examples + + +[!code-csharp[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetPlayToContract)] + +[!code-js[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/javascript/default.js#SnippetPlayToContract)] + +[!code-vb[PlayToContract](../windows.media.playto/code/PlayTo_SlideShow1/vbnet/MainPage.xaml.vb#SnippetPlayToContract)] + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosource_playnext_1668020201.md b/windows.media.playto/playtosource_playnext_1668020201.md index 87b705ef3d..e49849cadd 100644 --- a/windows.media.playto/playtosource_playnext_1668020201.md +++ b/windows.media.playto/playtosource_playnext_1668020201.md @@ -1,31 +1,32 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToSource.PlayNext --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToSource.PlayNext - -## -description -Connects the next Play To source element to the Play To target. - -## -remarks -You can use the [PlayNext](playtosource_playnext.md) method to stop streaming the current Play To source media to the target and then start streaming the Play To source identified by the [Next](playtosource_next.md) property to the Play To target. - -For an example of using the [Next](playtosource_next.md) property, see [Streaming a slide show using Play To -(JavaScript)](http://msdn.microsoft.com/library/780cb5f5-4ee5-4294-ad60-5be54107838a) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). - -## -examples - - -[!code-csharp[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetSlideShow_CS)] - -[!code-js[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/javascript/default.js#SnippetSlideShow)] - -[!code-vb[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/vbnet/MainPage.xaml.vb#SnippetSlideShow_CS)] - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: M:Windows.Media.PlayTo.PlayToSource.PlayNext +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToSource.PlayNext + +## -description +Connects the next Play To source element to the Play To target. + +## -remarks +You can use the [PlayNext](playtosource_playnext.md) method to stop streaming the current Play To source media to the target and then start streaming the Play To source identified by the [Next](playtosource_next.md) property to the Play To target. + +For an example of using the [Next](playtosource_next.md) property, see [Streaming a slide show using Play To +(JavaScript)](http://msdn.microsoft.com/library/780cb5f5-4ee5-4294-ad60-5be54107838a) or [Media casting](http://msdn.microsoft.com/library/40b97e0c-eb1b-40c2-a022-1ab95dfb085e). + +## -examples + + +[!code-csharp[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/csharp/MainPage.xaml.cs#SnippetSlideShow)] + +[!code-js[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/javascript/default.js#SnippetSlideShow)] + +[!code-vb[SlideShow](../windows.media.playto/code/PlayTo_SlideShow1/vbnet/MainPage.xaml.vb#SnippetSlideShow)] + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosourcedeferral.md b/windows.media.playto/playtosourcedeferral.md index 313b742892..338cbfa6b6 100644 --- a/windows.media.playto/playtosourcedeferral.md +++ b/windows.media.playto/playtosourcedeferral.md @@ -19,7 +19,7 @@ You can use a deferral when you want to make an asynchronous call to retrieve th To create a deferral, call the [GetDeferral](playtosourcerequest_getdeferral.md) method to instruct the [PlayToManager](playtomanager.md) class to wait to receive a source media element to stream to the Play To target. After you've supplied the source media element to the [SetSource](playtosourcerequest_setsource.md) method, call the [Complete](playtosourcedeferral_complete.md) method to end the deferral. If you create a deferral and the wait time exceeds the [Deadline](playtosourcerequest_deadline.md) property, Play To will continue without a source element from your app. -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -32,3 +32,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosourcerequest.md b/windows.media.playto/playtosourcerequest.md index 270376354e..b8335adc33 100644 --- a/windows.media.playto/playtosourcerequest.md +++ b/windows.media.playto/playtosourcerequest.md @@ -17,7 +17,7 @@ The [PlayToSourceRequest](playtosourcerequest.md) class represents a user reques You can use the [GetDeferral](playtosourcerequest_getdeferral.md) method to create a deferral for when you want to make an asynchronous call to retrieve the media element to stream. Play To will then wait for you to supply the media element until you mark the deferral as complete. -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -30,3 +30,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosourcerequest_getdeferral_254836512.md b/windows.media.playto/playtosourcerequest_getdeferral_254836512.md index cc835ef0eb..d0a608bb17 100644 --- a/windows.media.playto/playtosourcerequest_getdeferral_254836512.md +++ b/windows.media.playto/playtosourcerequest_getdeferral_254836512.md @@ -1,37 +1,38 @@ ---- --api-id: M:Windows.Media.PlayTo.PlayToSourceRequest.GetDeferral --api-type: winrt method ---- - - - -# Windows.Media.PlayTo.PlayToSourceRequest.GetDeferral - -## -description -Defers connecting a media source to a Play To target. - -## -returns -A deferral object that you can use to identify when the deferral is complete. - -## -remarks -You can use a deferral when you want to make an asynchronous call to retrieve the media element to stream. Play To will then wait for you to supply the media element until you mark the deferral as complete. - - - -To create a deferral, call the [GetDeferral](playtosourcerequest_getdeferral.md) method to instruct the [PlayToManager](playtomanager.md) class to wait to receive a source media element to stream to the Play To target. After you have supplied the source media element to the [SetSource](playtosourcerequest_setsource.md) method, call the [Complete](playtosourcedeferral_complete.md) method to end the deferral. If you create a deferral and the wait time exceeds the [Deadline](playtosourcerequest_deadline.md) property, Play To will continue without a source element from your app. - -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). - -## -examples - - -[!code-csharp[Deferral](../windows.media.playto/code/PlayTo_Reference/csharp/MainPage.xaml.cs#SnippetDeferral)] - -[!code-js[Deferral](../windows.media.playto/code/PlayTo_Reference/javascript/default.js#SnippetDeferral)] - -[!code-vb[Deferral](../windows.media.playto/code/PlayTo_Reference/vbnet/MainPage.xaml.vb#SnippetDeferral)] - -## -see-also -[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +--- +-api-id: M:Windows.Media.PlayTo.PlayToSourceRequest.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Media.PlayTo.PlayToSourceRequest.GetDeferral + +## -description +Defers connecting a media source to a Play To target. + +## -returns +A deferral object that you can use to identify when the deferral is complete. + +## -remarks +You can use a deferral when you want to make an asynchronous call to retrieve the media element to stream. Play To will then wait for you to supply the media element until you mark the deferral as complete. + + + +To create a deferral, call the [GetDeferral](playtosourcerequest_getdeferral.md) method to instruct the [PlayToManager](playtomanager.md) class to wait to receive a source media element to stream to the Play To target. After you have supplied the source media element to the [SetSource](playtosourcerequest_setsource.md) method, call the [Complete](playtosourcedeferral_complete.md) method to end the deferral. If you create a deferral and the wait time exceeds the [Deadline](playtosourcerequest_deadline.md) property, Play To will continue without a source element from your app. + +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). + +## -examples + + +[!code-csharp[Deferral](../windows.media.playto/code/PlayTo_Reference/csharp/MainPage.xaml.cs#SnippetDeferral)] + +[!code-js[Deferral](../windows.media.playto/code/PlayTo_Reference/javascript/default.js#SnippetDeferral)] + +[!code-vb[Deferral](../windows.media.playto/code/PlayTo_Reference/vbnet/MainPage.xaml.vb#SnippetDeferral)] + +## -see-also +[Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosourcerequestedeventargs.md b/windows.media.playto/playtosourcerequestedeventargs.md index 78e3f892a5..26d073cd2c 100644 --- a/windows.media.playto/playtosourcerequestedeventargs.md +++ b/windows.media.playto/playtosourcerequestedeventargs.md @@ -16,7 +16,7 @@ Provides information about the [SourceRequested](playtomanager_sourcerequested.m You use the [SourceRequest](playtosourcerequestedeventargs_sourcerequest.md) property of the class to pass media from your application to Play To during the [SourceRequested](playtomanager_sourcerequested.md) event. -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -29,3 +29,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [SourceRequested](playtomanager_sourcerequested.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/playtosourceselectedeventargs.md b/windows.media.playto/playtosourceselectedeventargs.md index 8c44baf997..09e7241bcc 100644 --- a/windows.media.playto/playtosourceselectedeventargs.md +++ b/windows.media.playto/playtosourceselectedeventargs.md @@ -13,7 +13,7 @@ public class PlayToSourceSelectedEventArgs : Windows.Media.PlayTo.IPlayToSourceS Provides information about the [SourceSelected](playtomanager_sourceselected.md) event. ## -remarks -For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](XREF:TODO:m_playto.using_playto_in_applications) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). +For an example of how to use Play To in an application, see [Quickstart: Using Play To in applications (JavaScript)](http://msdn.microsoft.com/library/90ee116a-ee6d-4e1d-8b91-8f7f4f958b9c) or [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). ## -examples @@ -26,3 +26,4 @@ For an example of how to use Play To in an application, see [Quickstart: Using P ## -see-also [SourceSelected](playtomanager_sourceselected.md), [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/sourcechangerequestedeventargs.md b/windows.media.playto/sourcechangerequestedeventargs.md index 1633553116..0101becc3a 100644 --- a/windows.media.playto/sourcechangerequestedeventargs.md +++ b/windows.media.playto/sourcechangerequestedeventargs.md @@ -27,3 +27,4 @@ For an example of creating a software Play To receiver, see [Media casting](http ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/volumechangerequestedeventargs.md b/windows.media.playto/volumechangerequestedeventargs.md index 3a137d0051..eb9cffe7f0 100644 --- a/windows.media.playto/volumechangerequestedeventargs.md +++ b/windows.media.playto/volumechangerequestedeventargs.md @@ -27,3 +27,4 @@ For an example of creating a software Play To receiver, see [Media casting](http ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.playto/windows_media_playto.md b/windows.media.playto/windows_media_playto.md index b362953b04..ee6f601eea 100644 --- a/windows.media.playto/windows_media_playto.md +++ b/windows.media.playto/windows_media_playto.md @@ -25,6 +25,7 @@ When a user selects a Play To target from the **Devices** charm, Play To fires For an example of how to use Play To in an application, see [PlayReady DRM](http://msdn.microsoft.com/library/dd8ffa8c-dff0-41e3-8f7a-345c5a248fc2). + ## -examples @@ -34,5 +35,7 @@ For an example of how to use Play To in an application, see [PlayReady DRM](htt [!code-vb[SourceRequested](../windows.media.playto/code/PlayTo_Reference/vbnet/MainPage.xaml.vb#SnippetSourceRequested)] + ## -see-also [Play To sample](http://go.microsoft.com/fwlink/p/?linkid=245166), [PlayToReceiver sample](http://go.microsoft.com/fwlink/p/?linkid=245167), [Media Server sample](http://go.microsoft.com/fwlink/p/?linkid=245168) +soft.com/fwlink/p/?linkid=245168) diff --git a/windows.media.protection.playready/iplayreadylicensesession2.md b/windows.media.protection.playready/iplayreadylicensesession2.md new file mode 100644 index 0000000000..e12481b1f1 --- /dev/null +++ b/windows.media.protection.playready/iplayreadylicensesession2.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Protection.PlayReady.IPlayReadyLicenseSession2 +-api-type: winrt interface +--- + + + +# Windows.Media.Protection.PlayReady.IPlayReadyLicenseSession2 + +## -description +Provides the ability to enumerate in-memory-only PlayReady licenses in addition to persisted licenses. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/iplayreadylicensesession2_createlicenseiterable_1020951124.md b/windows.media.protection.playready/iplayreadylicensesession2_createlicenseiterable_1020951124.md new file mode 100644 index 0000000000..ac5bfa0508 --- /dev/null +++ b/windows.media.protection.playready/iplayreadylicensesession2_createlicenseiterable_1020951124.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Media.Protection.PlayReady.IPlayReadyLicenseSession2.CreateLicenseIterable(Windows.Media.Protection.PlayReady.PlayReadyContentHeader,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Protection.PlayReady.IPlayReadyLicenseSession2.CreateLicenseIterable + +## -description +Creates a [PlayReadyLicense](playready.md) object iterator that supports in-memory-only PlayReady licenses in addition to persisted licenses. + +## -parameters + +### -param contentHeader +The content header used to locate associated licenses. + +### -param fullyEvaluated +Indicates whether evaluated license chains should be enumerated or if all licenses (including those that are unusable) should be enumerated. Set this parameter to true if evaluated license chains should be enumerated. Set this parameter to false if all licenses should be enumerated. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadylicense_expiresinrealtime.md b/windows.media.protection.playready/playreadylicense_expiresinrealtime.md new file mode 100644 index 0000000000..1811df495b --- /dev/null +++ b/windows.media.protection.playready/playreadylicense_expiresinrealtime.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Protection.PlayReady.PlayReadyLicense.ExpiresInRealTime +-api-type: winrt property +--- + + + +# Windows.Media.Protection.PlayReady.PlayReadyLicense.ExpiresInRealTime + +## -description +Gets a value that indicates if the license can expire in the middle of playback or if only expires when attempting a fresh playback. + +## -property-value +True if the license can expire in the middle of playback; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadylicense_inmemoryonly.md b/windows.media.protection.playready/playreadylicense_inmemoryonly.md new file mode 100644 index 0000000000..3ebfed6b08 --- /dev/null +++ b/windows.media.protection.playready/playreadylicense_inmemoryonly.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Protection.PlayReady.PlayReadyLicense.InMemoryOnly +-api-type: winrt property +--- + + + +# Windows.Media.Protection.PlayReady.PlayReadyLicense.InMemoryOnly + +## -description +Gets a value that indicates if the license is in-memory-only. + +## -property-value +True if the license is in-memory-only; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadylicense_securestopid.md b/windows.media.protection.playready/playreadylicense_securestopid.md new file mode 100644 index 0000000000..ea45eb61f0 --- /dev/null +++ b/windows.media.protection.playready/playreadylicense_securestopid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Protection.PlayReady.PlayReadyLicense.SecureStopId +-api-type: winrt property +--- + + + +# Windows.Media.Protection.PlayReady.PlayReadyLicense.SecureStopId + +## -description +Gets the unique identifier of the certificate for the service that handles the server-side of the SecureStop protocol. + +## -property-value +The unique identifier of the certificate for the service that handles the server-side of the SecureStop protocol. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadylicense_securitylevel.md b/windows.media.protection.playready/playreadylicense_securitylevel.md new file mode 100644 index 0000000000..c14b05fb37 --- /dev/null +++ b/windows.media.protection.playready/playreadylicense_securitylevel.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Protection.PlayReady.PlayReadyLicense.SecurityLevel +-api-type: winrt property +--- + + + +# Windows.Media.Protection.PlayReady.PlayReadyLicense.SecurityLevel + +## -description +Gets a value that indicates the security level of the license. + +## -property-value +A value that indicates the security level of the license. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadylicenseacquisitionservicerequest_createlicenseiterable_1020951124.md b/windows.media.protection.playready/playreadylicenseacquisitionservicerequest_createlicenseiterable_1020951124.md new file mode 100644 index 0000000000..8ae3d20b46 --- /dev/null +++ b/windows.media.protection.playready/playreadylicenseacquisitionservicerequest_createlicenseiterable_1020951124.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Media.Protection.PlayReady.PlayReadyLicenseAcquisitionServiceRequest.CreateLicenseIterable(Windows.Media.Protection.PlayReady.PlayReadyContentHeader,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Protection.PlayReady.PlayReadyLicenseAcquisitionServiceRequest.CreateLicenseIterable + +## -description +Creates a PlayReadyLicense class iterator that supports in-memory-only PlayReady licenses in addition to persisted licenses. + +## -parameters + +### -param contentHeader +The content header used to locate associated licenses. + +### -param fullyEvaluated +Indicates whether evaluated license chains should be enumerated or if all licenses (including those that are unusable) should be enumerated. Set this parameter to true if evaluated license chains should be enumerated. Set this parameter to false if all licenses should be enumerated. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadylicenseacquisitionservicerequest_sessionid.md b/windows.media.protection.playready/playreadylicenseacquisitionservicerequest_sessionid.md new file mode 100644 index 0000000000..38e987aa96 --- /dev/null +++ b/windows.media.protection.playready/playreadylicenseacquisitionservicerequest_sessionid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Protection.PlayReady.PlayReadyLicenseAcquisitionServiceRequest.SessionId +-api-type: winrt property +--- + + + +# Windows.Media.Protection.PlayReady.PlayReadyLicenseAcquisitionServiceRequest.SessionId + +## -description +Gets a unique identifier for the PlayReady license acquisition operation. + +## -property-value +A unique identifier for the PlayReady license acquisition operation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection.playready/playreadylicensesession_createlicenseiterable_1020951124.md b/windows.media.protection.playready/playreadylicensesession_createlicenseiterable_1020951124.md new file mode 100644 index 0000000000..d5dfdf4716 --- /dev/null +++ b/windows.media.protection.playready/playreadylicensesession_createlicenseiterable_1020951124.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Media.Protection.PlayReady.PlayReadyLicenseSession.CreateLicenseIterable(Windows.Media.Protection.PlayReady.PlayReadyContentHeader,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Media.Protection.PlayReady.PlayReadyLicenseSession.CreateLicenseIterable + +## -description +Creates a PlayReadyLicense class iterator that supports in-memory-only PlayReady licenses in addition to persisted licenses. + +## -parameters + +### -param contentHeader +The content header used to locate associated licenses. + +### -param fullyEvaluated +Indicates whether evaluated license chains should be enumerated or if all licenses (including those that are unusable) should be enumerated. Set this parameter to true if evaluated license chains should be enumerated. Set this parameter to false if all licenses should be enumerated. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection/protectioncapabilities.md b/windows.media.protection/protectioncapabilities.md new file mode 100644 index 0000000000..78b46e74c3 --- /dev/null +++ b/windows.media.protection/protectioncapabilities.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.Protection.ProtectionCapabilities +-api-type: winrt class +--- + + + +# Windows.Media.Protection.ProtectionCapabilities + +## -description +Provides a mechanism for apps to query for hardware DRM capabilities. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection/protectioncapabilities_istypesupported_2024884020.md b/windows.media.protection/protectioncapabilities_istypesupported_2024884020.md new file mode 100644 index 0000000000..bea4d0dba9 --- /dev/null +++ b/windows.media.protection/protectioncapabilities_istypesupported_2024884020.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Media.Protection.ProtectionCapabilities.IsTypeSupported(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Media.Protection.ProtectionCapabilities.IsTypeSupported + +## -description +Gets a value that indicates whether the specified hardware DRM capabilities are likely supported, are possibly supported, or are unsupported. + +## -parameters + +### -param type +A string representing the capabilities for which support is queried. + +### -param keySystem +A string specifying the key system to which the query applies. + +## -returns +A value indicating if the queried capabilities are likely supported, are possibly supported, or are unsupported. + +## -remarks +If the value returned from this method is [ProtectionCapabilityResult.Maybe](protectioncapabilityresult.md), the requested capabilities may be supported, but the supported status is not yet known by the system. In this case, the app may want to query again through polling or in response to UI events. + +## -see-also + +## -examples + diff --git a/windows.media.protection/protectioncapabilities_protectioncapabilities_1221375020.md b/windows.media.protection/protectioncapabilities_protectioncapabilities_1221375020.md new file mode 100644 index 0000000000..a4ba9c867d --- /dev/null +++ b/windows.media.protection/protectioncapabilities_protectioncapabilities_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Media.Protection.ProtectionCapabilities.#ctor +-api-type: winrt method +--- + + + +# Windows.Media.Protection.ProtectionCapabilities.ProtectionCapabilities + +## -description +Initializes a new instance of the **ProtectionCapabilities** class. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.protection/protectioncapabilityresult.md b/windows.media.protection/protectioncapabilityresult.md new file mode 100644 index 0000000000..8a3650f17d --- /dev/null +++ b/windows.media.protection/protectioncapabilityresult.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Media.Protection.ProtectionCapabilityResult +-api-type: winrt enum +--- + + + +# Windows.Media.Protection.ProtectionCapabilityResult + +## -description +Specifies the result of a query for hardware DRM capability support using [IsTypeSupported](protectioncapabilities_istypesupported_2024884020.md). + + +## -enum-fields +### -field Probably:2 +The queried capabilities are probably supported. + +### -field NotSupported:0 +The queried capabilities are not supported. + +### -field Maybe:1 +The queried capabilities may be supported, but the support status is not known. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.speechrecognition/voicecommandmanager.md b/windows.media.speechrecognition/voicecommandmanager.md index cbb7534029..b01d959c65 100644 --- a/windows.media.speechrecognition/voicecommandmanager.md +++ b/windows.media.speechrecognition/voicecommandmanager.md @@ -16,7 +16,6 @@ public class VoiceCommandManager A static class that enables installing command sets from a [](voice_command_elements_and_attributes.md) file, and getting installed command sets. ## -remarks - ## -examples diff --git a/windows.media.speechsynthesis/speechsynthesisstream_markers.md b/windows.media.speechsynthesis/speechsynthesisstream_markers.md index a028b54fa3..d4c7eae920 100644 --- a/windows.media.speechsynthesis/speechsynthesisstream_markers.md +++ b/windows.media.speechsynthesis/speechsynthesisstream_markers.md @@ -10,7 +10,7 @@ public Windows.Foundation.Collections.IVectorView Ma # Windows.Media.SpeechSynthesis.SpeechSynthesisStream.Markers ## -description -Gets the collection of timeline markers associated with [SpeechSynthesisStream](speechsynthesisstream.md). +Gets the collection of timeline markers associated with the [SpeechSynthesisStream](speechsynthesisstream.md). ## -property-value When this method completes successfully, it returns a collection of [IMediaMarker](../windows.media/imediamarker.md) objects that represent the timeline markers in the stream. diff --git a/windows.media.speechsynthesis/speechsynthesisstream_timedmetadatatracks.md b/windows.media.speechsynthesis/speechsynthesisstream_timedmetadatatracks.md new file mode 100644 index 0000000000..deee6ab5ac --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesisstream_timedmetadatatracks.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.SpeechSynthesis.SpeechSynthesisStream.TimedMetadataTracks +-api-type: winrt property +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesisStream.TimedMetadataTracks + +## -description +Gets the collection of optional word and sentence boundaries in the speech synthesis stream as specified by the [SpeechSynthesizer.Options](speechsynthesizer_options.md) property. + +## -property-value +A collection of [TimedMetadataTrack](../windows.media.core/timedmetadatatrack.md) objects. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.speechsynthesis/speechsynthesizer_options.md b/windows.media.speechsynthesis/speechsynthesizer_options.md new file mode 100644 index 0000000000..b98831de64 --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesizer_options.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.SpeechSynthesis.SpeechSynthesizer.Options +-api-type: winrt property +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesizer.Options + +## -description +Gets a reference to the collection of options that can be set on the SpeechSynthesizer object. + +## -property-value +The speech synthesizer options. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.speechsynthesis/speechsynthesizeroptions.md b/windows.media.speechsynthesis/speechsynthesizeroptions.md new file mode 100644 index 0000000000..15f66515a4 --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesizeroptions.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions +-api-type: winrt class +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions + +## -description +Provides access to various speech synthesizer options. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.speechsynthesis/speechsynthesizeroptions_includesentenceboundarymetadata.md b/windows.media.speechsynthesis/speechsynthesizeroptions_includesentenceboundarymetadata.md new file mode 100644 index 0000000000..ffbb3f44c5 --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesizeroptions_includesentenceboundarymetadata.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.IncludeSentenceBoundaryMetadata +-api-type: winrt property +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.IncludeSentenceBoundaryMetadata + +## -description +Gets or sets whether sentence boundary metadata is added to a [SpeechSynthesisStream](speechsynthesisstream.md) object. + +## -property-value +**true** if sentence boundaries are marked. Otherwise, **false**. + +## -remarks + +## -see-also +[IncludeWordBoundaryMetadata](speechsynthesizeroptions_includewordboundarymetadata.md) +[SpeechSynthesisStream.TimedMetadataTracks](speechsynthesisstream_timedmetadatatracks.md) + +## -examples + diff --git a/windows.media.speechsynthesis/speechsynthesizeroptions_includewordboundarymetadata.md b/windows.media.speechsynthesis/speechsynthesizeroptions_includewordboundarymetadata.md new file mode 100644 index 0000000000..c9dc7aff3e --- /dev/null +++ b/windows.media.speechsynthesis/speechsynthesizeroptions_includewordboundarymetadata.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.IncludeWordBoundaryMetadata +-api-type: winrt property +--- + + + +# Windows.Media.SpeechSynthesis.SpeechSynthesizerOptions.IncludeWordBoundaryMetadata + +## -description +Gets or sets whether word boundary metadata is added to a [SpeechSynthesisStream](speechsynthesisstream.md) object. + +## -property-value +**true** if word boundaries are marked. Otherwise, **false**. + +## -remarks + +## -see-also +[IncludeSentenceBoundaryMetadata](speechsynthesizeroptions_includesentenceboundarymetadata.md) +[SpeechSynthesisStream.TimedMetadataTracks](speechsynthesisstream_timedmetadatatracks.md) + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasource_close_811482585.md b/windows.media.streaming.adaptive/adaptivemediasource_close_811482585.md new file mode 100644 index 0000000000..ed045ccd51 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasource_close_811482585.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.Close +-api-type: winrt method +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.Close + +## -description +Closes the adaptive media source and frees up associated resources. + +## -params + +## -remarks +Call this method wehn you are done with the adaptive media source, such as when switching to a different media source, to ensure that the resources are cleaned up and that network operations for this adaptive media source are stopped. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasource_desiredliveoffset.md b/windows.media.streaming.adaptive/adaptivemediasource_desiredliveoffset.md index 8ccd84aa2b..f37191a706 100644 --- a/windows.media.streaming.adaptive/adaptivemediasource_desiredliveoffset.md +++ b/windows.media.streaming.adaptive/adaptivemediasource_desiredliveoffset.md @@ -10,13 +10,14 @@ public Windows.Foundation.TimeSpan DesiredLiveOffset { get; set; } # Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.DesiredLiveOffset ## -description -Gets or sets the desired starting offset for the live playback of the media source. +Gets or sets the desired offset of live playback from the end of the known media content that has been downloaded. ## -property-value -The desired starting offset for the live playback of the streaming media. +The desired offset for the live playback of the streaming media. This value must be greater than [MinLiveOffset](adaptivemediasource_minliveoffset.md). If the specified value is less than the minimum value, it is automatically clamped to the allowed range. ## -remarks ## -examples ## -see-also +[AdaptiveMediaSource](adaptivemediasource.md) \ No newline at end of file diff --git a/windows.media.streaming.adaptive/adaptivemediasource_desiredseekablewindowsize.md b/windows.media.streaming.adaptive/adaptivemediasource_desiredseekablewindowsize.md new file mode 100644 index 0000000000..69b93feaa2 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasource_desiredseekablewindowsize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.DesiredSeekableWindowSize +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.DesiredSeekableWindowSize + +## -description +Gets or sets the requested maximum size of the time window within which the user can seek within the streaming media. + +## -property-value +The requested maximum size of the time window in which the user can seek within the streaming media. This value must be between zero and the value of [MaxSeekableWindowSize](adaptivemediasource_maxseekablewindowsize.md). If the specified value is greater than the maximum value, the system automatically clamps to the allowed range, but when you retrieve the property it will return the unclamped value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasource_diagnostics.md b/windows.media.streaming.adaptive/adaptivemediasource_diagnostics.md new file mode 100644 index 0000000000..05df961963 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasource_diagnostics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.Diagnostics +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.Diagnostics + +## -description +Gets an object that provides an event that is raised when diagnostic information about the adaptive media source is available. + +## -property-value +An object that provides an event that is raised when diagnostic information about the adaptive media source is available. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasource_getcorrelatedtimes_1896702992.md b/windows.media.streaming.adaptive/adaptivemediasource_getcorrelatedtimes_1896702992.md new file mode 100644 index 0000000000..1fed5c72a0 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasource_getcorrelatedtimes_1896702992.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.GetCorrelatedTimes +-api-type: winrt method +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.GetCorrelatedTimes + +## -description +Gets an object that provides timing information that is correlated between timestamps in the media or date/time information from the manifest with the presentation clock timeline. + +## -params + +## -returns +An object that provides correlated timing information for the adaptive media source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasource_maxseekablewindowsize.md b/windows.media.streaming.adaptive/adaptivemediasource_maxseekablewindowsize.md new file mode 100644 index 0000000000..f204cc5e1d --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasource_maxseekablewindowsize.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.MaxSeekableWindowSize +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.MaxSeekableWindowSize + +## -description +Gets the maximum time window time window within which the user can seek within the streaming media. + +## -property-value +The maximum time window time window within which the user can seek within the streaming media. + +## -remarks +This time window is calculated by taking the total duration of media that has been downloaded and subtracting the value of the [DesiredLiveOffset](adaptivemediasource_desiredliveoffset.md) property. This value is specified by the media content. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasource_minliveoffset.md b/windows.media.streaming.adaptive/adaptivemediasource_minliveoffset.md new file mode 100644 index 0000000000..c832bdf8ca --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasource_minliveoffset.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.MinLiveOffset +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSource.MinLiveOffset + +## -description +Gets the minimum offset of live playback from the end of the known media content that has been downloaded. + +## -property-value +The minimum offset of live playback from the end of the known media content that has been downloaded. + +## -remarks +This property specifies the minimum value to which the [DesiredLiveOffset](adaptivemediasource_desiredliveoffset) property can be set. This value is specified by the media content or platform. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes.md b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes.md new file mode 100644 index 0000000000..60daa2e5df --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes +-api-type: winrt class +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes + +## -description +Represents time stamps that are correlated between the playback position of the media player with time stamps embedded in the media stream or included in the manifest file. + +## -remarks +Get an instance of this class by calling [AdaptiveMediaSource.GetCorrelatedTimes](adaptivemediasource_getcorrelatedtimes_1896702992.md). Depending on the current state of the system and the media, any of these three values may be null at any given time. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_position.md b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_position.md new file mode 100644 index 0000000000..95d0c99e94 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_position.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes.Position +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes.Position + +## -description +Gets a timespan representing the current playback position of the media player that is playing the content. + +## -property-value +A timespan representing the current playback position of the media player that is playing the content. + +## -remarks +The position value is a snapshot made when [AdaptiveMediaSource.GetCorrelatedTimes](adaptivemediasource_getcorrelatedtimes_1896702992.md) is called. So if the presentation clock is advancing, the value of this property may be slightly offset from the current presentation time. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_presentationtimestamp.md b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_presentationtimestamp.md new file mode 100644 index 0000000000..809934d9a3 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_presentationtimestamp.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes.PresentationTimeStamp +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes.PresentationTimeStamp + +## -description +Gets a timespan representing the presentation timestamp embedded in the streaming media. + +## -property-value +A timespan representing the presentation timestamp embedded in the streaming media. + +## -remarks +This property will be null before the system has begun downloading media segments. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_programdatetime.md b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_programdatetime.md new file mode 100644 index 0000000000..46e332522b --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcecorrelatedtimes_programdatetime.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes.ProgramDateTime +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCorrelatedTimes.ProgramDateTime + +## -description +Gets a [DateTime](https://docs.microsoft.com/en-us/uwp/api/windows.foundation.datetime) structure representing a time specified in the manifest file for the streaming media. + +## -property-value +A structure representing a time specified in the manifest file for the streaming media. + +## -remarks +For Http Live Streaming (HLS), this value is only present if the playlist contains the EXT-X-PROGRAM-DATE-TIME tags. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcecreationresult_extendederror.md b/windows.media.streaming.adaptive/adaptivemediasourcecreationresult_extendederror.md new file mode 100644 index 0000000000..9b27918f9c --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcecreationresult_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCreationResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCreationResult.ExtendedError + +## -description +Gets the extended error code associated with the creation of a [AdaptiveMediaSource](adaptivemediasource.md) object. + +## -property-value +The extended error code associated with the creation of a [AdaptiveMediaSource](adaptivemediasource.md) object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcecreationresult_status.md b/windows.media.streaming.adaptive/adaptivemediasourcecreationresult_status.md index 63fca09c96..b5dd351651 100644 --- a/windows.media.streaming.adaptive/adaptivemediasourcecreationresult_status.md +++ b/windows.media.streaming.adaptive/adaptivemediasourcecreationresult_status.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCreationResult.Status --api-type: winrt property ---- - - - -# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCreationResult.Status - -## -description -Gets the status of an attempt to create a [AdaptiveMediaSource](adaptivemediasource.md) object. - -## -property-value -A [AdaptiveMediaSourceCreationStatus](adaptivemediasourcecreationstatus.md)-typed value that specifies the result of an attempt to create a [AdaptiveMediaSource](adaptivemediasource.md) object. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCreationResult.Status +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceCreationResult.Status + +## -description +Gets the status of an attempt to create a [AdaptiveMediaSource](adaptivemediasource.md) object. + +## -property-value +A [AdaptiveMediaSourceCreationStatus](adaptivemediasourcecreationstatus.md)-typed value that specifies the result of an attempt to create a [AdaptiveMediaSource](adaptivemediasource.md) object. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs.md new file mode 100644 index 0000000000..ac48595b31 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs + +## -description +Provides data for the [DiagnosticAvailable](adaptivemediasourcediagnostics_diagnosticavailable.md) event which is raised when diagnostic information for the adaptive media source becomes available. + +## -remarks +The information provided by this event is not intended to be used to modify runtime behavior, but is instead provided for telemetry collection. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_bitrate.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_bitrate.md new file mode 100644 index 0000000000..0332149969 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_bitrate.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.Bitrate +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.Bitrate + +## -description +Gets the bitrate of the web request to which the diagnostic information applies. + +## -property-value +The bitrate of the web request to which the diagnostic information applies. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_diagnostictype.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_diagnostictype.md new file mode 100644 index 0000000000..007477c2eb --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_diagnostictype.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.DiagnosticType +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.DiagnosticType + +## -description +Gets a value indicating the type of diagnostic that is associated with the event. + +## -property-value +A value indicating the type of diagnostic that is associated with the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_position.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_position.md new file mode 100644 index 0000000000..a2010906c2 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_position.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.Position + +## -description +Gets the presentation playback position associated with the event. + +## -property-value +The presentation playback position associated with the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_requestid.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_requestid.md new file mode 100644 index 0000000000..d35e546920 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_requestid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.RequestId +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.RequestId + +## -description +Gets a locally-unique identifier for the web request associated with the event. + +## -property-value +A locally-unique identifier for the web request associated with the event. + +## -remarks +This value can be used to correlate the web request associated with this event to other events, including [DownloadRequested](adaptivemediasource_downloadrequested.md), [DownloadCompleted](adaptivemediasource_downloadcompleted.md), and [DownloadFailed](adaptivemediasource_downloadfailed.md). + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcebyterangelength.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcebyterangelength.md new file mode 100644 index 0000000000..3bf239bc39 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcebyterangelength.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceByteRangeLength +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceByteRangeLength + +## -description +Gets the resource byte range length of the web request to which the diagnostic information applies. + +## -property-value +The resource byte range length of the web request to which the diagnostic information applies. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcebyterangeoffset.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcebyterangeoffset.md new file mode 100644 index 0000000000..4209d161dc --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcebyterangeoffset.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceByteRangeOffset +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceByteRangeOffset + +## -description +Gets the resource byte range offset of the web request to which the diagnostic information applies. + +## -property-value +The resource byte range offset of the web request to which the diagnostic information applies. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcetype.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcetype.md new file mode 100644 index 0000000000..fede1348c9 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourcetype.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceType +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceType + +## -description +Gets the resource type of the web request to which the diagnostic information applies. + + +## -property-value +The resource type of the web request to which the diagnostic information applies. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourceuri.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourceuri.md new file mode 100644 index 0000000000..b2da40bed0 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_resourceuri.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceUri +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.ResourceUri + +## -description +Gets the resource URI of the web request to which the diagnostic information applies. + +## -property-value +The resource URI of the web request to which the diagnostic information applies. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_segmentid.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_segmentid.md new file mode 100644 index 0000000000..34e908a648 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnosticavailableeventargs_segmentid.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.SegmentId +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticAvailableEventArgs.SegmentId + +## -description +Gets the segment ID of the media segment to which the diagnostic information applies. + + +## -property-value +The segment ID of the media segment to which the diagnostic information applies. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnostics.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnostics.md new file mode 100644 index 0000000000..429df38da6 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnostics.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnostics +-api-type: winrt class +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnostics + +## -description +Provides an event that is raised when diagnostic information about the adaptive media source is available. + +## -remarks +Get an instance of this class by accessing the [Diagnostics](adaptivemediasource_diagnostics.md) property of an [AdaptiveMediaSource](adaptivemediasource.md). + +The diagnostics provided by this class are not intended to be used to change the behavior of an app at runtime. Instead, these are provided to enable telemetry collection. + +## -see-also +[AdaptiveMediaSource](adaptivemediasource.md) +[Diagnostics](adaptivemediasource_diagnostics.md) + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnostics_diagnosticavailable.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnostics_diagnosticavailable.md new file mode 100644 index 0000000000..8445f06ad3 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnostics_diagnosticavailable.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnostics.DiagnosticAvailable +-api-type: winrt event +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnostics.DiagnosticAvailable + +## -description +Occurs when diagnostic information about the adaptive media source is available. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcediagnostictype.md b/windows.media.streaming.adaptive/adaptivemediasourcediagnostictype.md new file mode 100644 index 0000000000..e363fbbf5c --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcediagnostictype.md @@ -0,0 +1,57 @@ +--- +-api-id: T:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticType +-api-type: winrt enumeration +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDiagnosticType + +## -description +Specifies the type of diagnostic event that is associated with a [AdaptiveMediaSourceDiagnostics.DiagnosticAvailable](adaptivemediasourcediagnostics_diagnosticavailable.md). + +## -enum-fields + +## -field ResourceTimedOut:5 +The [AdaptiveMediaSource](adaptivemediasource.md) was unable to fully download a particular resource in the allotted amount of time.  The download may be attempted again, or the **AdaptiveMediaSource** may switch to another bitrate to continue filling the buffer at the current download position. + +## -field ResourceParsingError:6 +The [AdaptiveMediaSource](adaptivemediasource.md) encountered an error while parsing a segment or key.  This can indicate corruption on the CDN or an invalid decryption key. + +## -field ResourceNotFound:4 +The AdaptiveMediaSource got a resource not found error when downloading a particular resource. This may indicate a problem with the content manifest or an issue with the CDN. + +## -field MediaSegmentSkipped:3 +The [AdaptiveMediaSource](adaptivemediasource.md) skipped an entire media segment across all bitrates.  This could happen due to corruption on the CDN or missing resources. This will typically result in a gap in playback and video/audio artifacts. + +## -field ManifestUnchangedUponReload:0 +During playback of live content, the new manifest is identical to the last one downloaded.  For HLS where the manifest is updated continuously to add new segments to the end of the playlist, this may indicate a stall in the server or encoding process. + +## -field ManifestSignaledEndOfLiveEventUponReload:2 +During the playback of live content, the previous manifest did not specify a duration or contain an end of list indicator, and the new updated manifest does specify a duration or end of list indicator.  This means that a live presentation will end after the remaining media segments are downloaded and played. + +## -field ManifestMismatchUponReload:1 +During playback of live content, the new manifest represents a different presentation than the previously downloaded manifest. +This will also result in a playback error event for the associated [MediaElement](https://msdn.microsoft.com/library/windows/apps/windows.ui.xaml.controls.mediaelement.aspx) or [MediaPlayer](https://msdn.microsoft.com/library/windows/apps/windows.media.playback.mediaplayer.aspx). + +## -field BitrateDisabled:7 +The [AdaptiveMediaSource](adaptivemediasource.md) will not attempt to download any more segments for a particular bitrate.   +This can occur if the web server returns a 410 – Gone response when downloading a manifest update for a particular bitrate if the server implements server side congestion control. It can also occur if the AdaptiveMediaSource is unable to download either the initialization segment or decryption key for a particular bitrate. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadbitratechangedeventargs_reason.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadbitratechangedeventargs_reason.md new file mode 100644 index 0000000000..fb737ce618 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadbitratechangedeventargs_reason.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadBitrateChangedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadBitrateChangedEventArgs.Reason + +## -description +Gets a value specifying the reason that the download bitrate changed. + +## -property-value +A value specifying the reason that the download bitrate changed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadbitratechangedreason.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadbitratechangedreason.md new file mode 100644 index 0000000000..83666c2ffe --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadbitratechangedreason.md @@ -0,0 +1,51 @@ +--- +-api-id: T:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadBitrateChangedReason +-api-type: winrt enumeration +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadBitrateChangedReason + +## -description +Specifies the reason that the download bitrate changed. This value is used for the [AdaptiveMediaSource.DownloadBitrateChanged](adaptivemediasource_downloadbitratechanged.md) event. + +## -enum-fields + +## -field TrackSelectionChanged:4 +The bitrate changed as a result of a track selection change.  The system may switch to a lower bitrate temporarily in order to refill the buffer for the new track and resume playback faster. + +## -field SufficientInboundBitsPerSecond:0 +The estimated [InboundBitsPerSecond](adaptivemediasource_inboundbitspersecond.md) was large enough to allow switching to a higher bitrate. + +## -field PositionChanged:3 +The bitrate changed as a result of seeking to a new position.  The system may switch to a lower bitrate temporarily in order to refill the buffer and resume playback faster. + +## -field LowBufferLevel:2 +The amount of data buffered ahead of the playback position dropped enough that a change in download bitrate was required in order to avoid stalling playback while rebuffering. + +## -field InsufficientInboundBitsPerSecond:1 +The estimated [InboundBitsPerSecond](adaptivemediasource_inboundbitspersecond.md) dropped, which required switching to a lower bitrate to avoid stalls in playback. + +## -field ErrorInPreviousBitrate:6 +The bitrate changed as a result of an error occurring with the previously selected bitrate.  If there is a missing resource, or corruption is detected, or a download times out, the system may switch to a different bitrate in order to fill the buffer at the current download position to avoid gaps in playback. The conditions that caused an error in the previous bitrate will also generate other events that can be observed, such as [DownloadFailed](adaptivemediasource_downloadfailed.md) or the [AdaptiveMediaSourceDiagnostics.DiagnosticAvailable](adaptivemediasourcediagnostics_diagnosticavailable) event. + +## -field DesiredBitratesChanged:5 +The bitrate changed as a result of the app changing one of the properties on the [AdaptiveMediaSource](adaptivemediasource.md) such as the [DesiredMinBitrate](adaptivemediasource_desiredminbitrate.md), [DesiredMaxBitrate](adaptivemediasource_desiredmaxbitrate.md), or [InitialBitrate](adaptivemediasource_initialbitrate.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_position.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_position.md new file mode 100644 index 0000000000..236ceeaa4d --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_position.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadCompletedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadCompletedEventArgs.Position + +## -description +Gets a time span representing the position within the timeline of the media segment to which the event applies. + +## -property-value +A time span representing the position within the timeline of the media segment to which the event applies. + +## -remarks +Because this event occurs when content is buffering, the position of the event in the timeline may be up to several minutes ahead of the current playback position. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_requestid.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_requestid.md new file mode 100644 index 0000000000..e3173f1321 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_requestid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadCompletedEventArgs.RequestId +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadCompletedEventArgs.RequestId + +## -description +Gets a locally-unique identifier for the web request associated with the event. + +## -property-value +A locally-unique identifier for the web request associated with the event. + +## -remarks +This value can be used to correlate the web request associated with this event to other events, including [DownloadRequested](adaptivemediasource_downloadrequested.md), [DownloadFailed](adaptivemediasource_downloadfailed.md), and [DiagnosticAvailable](adaptivemediasourcediagnostics_diagnosticavailable.md). + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_statistics.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_statistics.md new file mode 100644 index 0000000000..15a524acb6 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadcompletedeventargs_statistics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadCompletedEventArgs.Statistics +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadCompletedEventArgs.Statistics + +## -description +Gets an object that provides download statistics associated with the event. + +## -property-value +An object that provides download statistics associated with the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_extendederror.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_extendederror.md new file mode 100644 index 0000000000..504d90813a --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.ExtendedError + +## -description +Gets the extended error code associate with the event. + +## -property-value +The extended error code associate with the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_position.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_position.md new file mode 100644 index 0000000000..2a60441de6 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_position.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.Position + +## -description +Gets a time span representing the position within the timeline of the media segment to which the event applies. + +## -property-value +A time span representing the position within the timeline of the media segment to which the event applies. + +## -remarks +Because this event occurs when content is buffering, the position of the event in the timeline may be up to several minutes ahead of the current playback position. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_requestid.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_requestid.md new file mode 100644 index 0000000000..397aafbeaf --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_requestid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.RequestId +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.RequestId + +## -description +Gets a locally-unique identifier for the web request associated with the event. + +## -property-value +A locally-unique identifier for the web request associated with the event. + +## -remarks +This value can be used to correlate the web request associated with this event to other events, including [DownloadRequested](adaptivemediasource_downloadrequested.md), [DownloadCompleted](adaptivemediasource_downloadcompleted.md), and [DiagnosticAvailable](adaptivemediasourcediagnostics_diagnosticavailable.md). + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_statistics.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_statistics.md new file mode 100644 index 0000000000..30690d0324 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadfailedeventargs_statistics.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.Statistics +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadFailedEventArgs.Statistics + +## -description +Gets an object that provides download statistics associated with the event. + +## -property-value +An object that provides download statistics associated with the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadrequestedeventargs_position.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadrequestedeventargs_position.md new file mode 100644 index 0000000000..92b5ae0dfa --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadrequestedeventargs_position.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadRequestedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadRequestedEventArgs.Position + +## -description +Gets a time span representing the position within the timeline of the media segment to which the event applies. + +## -property-value +A time span representing the position within the timeline of the media segment to which the event applies. + +## -remarks +Because this event occurs when content is buffering, the position of the event in the timeline may be up to several minutes ahead of the current playback position. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadrequestedeventargs_requestid.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadrequestedeventargs_requestid.md new file mode 100644 index 0000000000..4bfbafb4c5 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadrequestedeventargs_requestid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadRequestedEventArgs.RequestId +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadRequestedEventArgs.RequestId + +## -description +Gets a locally-unique identifier for the web request associated with the event. + +## -property-value +A locally-unique identifier for the web request associated with the event. + +## -remarks +This value can be used to correlate the web request associated with this event to other events, including [DownloadFailed](adaptivemediasource_downloadfailed.md), [DownloadCompleted](adaptivemediasource_downloadcompleted.md), and [DiagnosticAvailable](adaptivemediasourcediagnostics_diagnosticavailable.md). + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics.md new file mode 100644 index 0000000000..d0552278bf --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics +-api-type: winrt class +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics + +## -description +Represents a set of download statistics associated with the [AdaptiveMediaSource.DownloadFailed](adaptivemediasource_downloadfailed.md) and [AdaptiveMediaSource.DownloadCompleted](adaptivemediasource_downloadcompleted.md) events. + +## -remarks +These values are provided to enable telemetry collection and are not intended to be used to adjust app behavior at runtime. + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_contentbytesreceivedcount.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_contentbytesreceivedcount.md new file mode 100644 index 0000000000..936662ab21 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_contentbytesreceivedcount.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.ContentBytesReceivedCount +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.ContentBytesReceivedCount + +## -description +Gets the count of bytes that have been received at the time of the event. + +## -property-value +The count of bytes that have been received at the time of the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetofirstbytereceived.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetofirstbytereceived.md new file mode 100644 index 0000000000..1e126fa9e1 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetofirstbytereceived.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.TimeToFirstByteReceived +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.TimeToFirstByteReceived + +## -description +Gets the time window between when the system makes the asyncronous http request for the content and when the first block of data has been read from the http stream. + +## -property-value +The time window between when the system makes the asyncronous http request for the content and when the first block of data has been read from the http stream. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetoheadersreceived.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetoheadersreceived.md new file mode 100644 index 0000000000..d8da05bc93 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetoheadersreceived.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.TimeToHeadersReceived +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.TimeToHeadersReceived + +## -description +Gets the time window between when the system makes the asyncronous http request for the content and when the operation completes, when the http headers have been received. + +## -property-value +The time window between when the system makes the asyncronous http request for the content and when the operation completes, when the http headers have been received. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetolastbytereceived.md b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetolastbytereceived.md new file mode 100644 index 0000000000..d97f5ea6d6 --- /dev/null +++ b/windows.media.streaming.adaptive/adaptivemediasourcedownloadstatistics_timetolastbytereceived.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.TimeToLastByteReceived +-api-type: winrt property +--- + + + +# Windows.Media.Streaming.Adaptive.AdaptiveMediaSourceDownloadStatistics.TimeToLastByteReceived + +## -description +Gets the time window between when the system makes the asyncronous http request for the content and when the last block of data has been read from the http stream. + +## -property-value +The time window between when the system makes the asyncronous http request for the content and when the last block of data has been read from the http stream. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media/mediaextensionmanager_registermediaextensionforappservice_909514784.md b/windows.media/mediaextensionmanager_registermediaextensionforappservice_909514784.md new file mode 100644 index 0000000000..56bf813049 --- /dev/null +++ b/windows.media/mediaextensionmanager_registermediaextensionforappservice_909514784.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.Media.MediaExtensionManager.RegisterMediaExtensionForAppService(Windows.Media.IMediaExtension,Windows.ApplicationModel.AppService.AppServiceConnection) +-api-type: winrt method +--- + + + +# Windows.Media.MediaExtensionManager.RegisterMediaExtensionForAppService + +## -description +Registers a media extension that provides a background task that decodes media. + +## -params + +## -param extension +An object that implements [IMediaExtension](../windows.media/imediaextension.md). + +## -param connection +An [AppServiceConnection](../windows.applicationmodel.appservice/appserviceconnection.md) object that represents an endpoint connection for an app service. + +## -remarks +Call this method from within the [Run](../windows.applicationmodel.background/ibackgroundtask_run.md) method of a Windows Runtime Component that exposes your media extension. + +Get an instance of [AppServiceConnection](../windows.applicationmodel.appservice/appserviceconnection.md) by casting the [TriggerDetails](../windows.applicationmodel.background/ibackgroundtaskinstance_triggerdetails.md) property of the [IBackgroundTaskInstance](../windows.applicationmodel.background/ibackgroundtaskinstance.md) passed into the **Run** method to an [AppServiceTriggerDetails](../windows.applicationmodel.appservice/appservicetriggerdetails.md) object and then accessing the [AppServiceConnection](../windows.applicationmodel.appservice/appservicetriggerdetails_appserviceconnection.md) property. + +In order for your background task to receive an [AppServiceTriggerDetails](../windows.applicationmodel.appservice/appservicetriggerdetails.md) object, you must register it as an app service in you app manifest file. For more information, see [Create and consume an app service](https://msdn.microsoft.com/windows/uwp/launch-resume/how-to-create-and-consume-an-app-service). + +## -see-also + +## -examples + diff --git a/windows.media/mediatimelinecontroller_duration.md b/windows.media/mediatimelinecontroller_duration.md new file mode 100644 index 0000000000..ed5cf4b573 --- /dev/null +++ b/windows.media/mediatimelinecontroller_duration.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Media.MediaTimelineController.Duration +-api-type: winrt property +--- + + + +# Windows.Media.MediaTimelineController.Duration + +## -description +Gets a value indicating the duration of the timeline. After the specified time span has elapsed, the timeline clock will no longer progress. + +## -property-value +A value indicating the duration of the timeline. + +## -remarks +The [Ended](mediatimelinecontroller_ended.md) event is raised when the timeline controller reaches the end of the **Duration** time window. + +## -see-also + +## -examples + diff --git a/windows.media/mediatimelinecontroller_ended.md b/windows.media/mediatimelinecontroller_ended.md new file mode 100644 index 0000000000..dbc1faf062 --- /dev/null +++ b/windows.media/mediatimelinecontroller_ended.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.MediaTimelineController.Ended +-api-type: winrt event +--- + + + +# Windows.Media.MediaTimelineController.Ended + +## -description +Occurs when the timeline controller reaches the end of the time window specified by the [Duration](mediatimelinecontroller_duration.md) if [IsLoopingEnabled](mediatimelinecontroller_isloopingenabled) is set to false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media/mediatimelinecontroller_failed.md b/windows.media/mediatimelinecontroller_failed.md new file mode 100644 index 0000000000..9c656b6ef4 --- /dev/null +++ b/windows.media/mediatimelinecontroller_failed.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Media.MediaTimelineController.Failed +-api-type: winrt event +--- + + + +# Windows.Media.MediaTimelineController.Failed + +## -description +Occurs when the timeline controller encounters an internal error and can't continue playback. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media/mediatimelinecontroller_isloopingenabled.md b/windows.media/mediatimelinecontroller_isloopingenabled.md new file mode 100644 index 0000000000..ece6e35a33 --- /dev/null +++ b/windows.media/mediatimelinecontroller_isloopingenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaTimelineController.IsLoopingEnabled +-api-type: winrt property +--- + + + +# Windows.Media.MediaTimelineController.IsLoopingEnabled + +## -description +Gets a value indicating whether the timeline will loop, restarting the clock at zero, when it reaches the end of the time window specified by the [Duration](mediatimelinecontroller_duration.md). + +## -property-value +True if looping is enabled; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media/mediatimelinecontrollerfailedeventargs.md b/windows.media/mediatimelinecontrollerfailedeventargs.md new file mode 100644 index 0000000000..87f3330927 --- /dev/null +++ b/windows.media/mediatimelinecontrollerfailedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Media.MediaTimelineControllerFailedEventArgs +-api-type: winrt class +--- + + + +# Windows.Media.MediaTimelineControllerFailedEventArgs + +## -description +Provides data for the [Failed](mediatimelinecontroller_failed.md) event, which occurs when the timeline controller encounters an error and can't continue playback. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media/mediatimelinecontrollerfailedeventargs_extendederror.md b/windows.media/mediatimelinecontrollerfailedeventargs_extendederror.md new file mode 100644 index 0000000000..8e5aa4a255 --- /dev/null +++ b/windows.media/mediatimelinecontrollerfailedeventargs_extendederror.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Media.MediaTimelineControllerFailedEventArgs.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Media.MediaTimelineControllerFailedEventArgs.ExtendedError + +## -description +Gets the extended error code associated with the event. + +## -property-value +The extended error code associated with the event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.media/mediatimelinecontrollerstate.md b/windows.media/mediatimelinecontrollerstate.md index 5ff373a455..54ab72679a 100644 --- a/windows.media/mediatimelinecontrollerstate.md +++ b/windows.media/mediatimelinecontrollerstate.md @@ -20,8 +20,15 @@ The **MediaTimelineController** is paused. The **MediaTimelineController** is running. +### -field Error:3 + + +### -field Stalled:2 + + ## -remarks ## -examples -## -see-also \ No newline at end of file +## -see-also + diff --git a/windows.media/mediatimerange.md b/windows.media/mediatimerange.md new file mode 100644 index 0000000000..782b4843c4 --- /dev/null +++ b/windows.media/mediatimerange.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Media.MediaTimeRange +-api-type: winrt struct +--- + + + +# Windows.Media.MediaTimeRange + +## -description +Represents a time range within media content. + +## -struct-fields + +### -field End +A time span from the beginning of the media content to the end of the time range. + +### -field Start +A time span from the beginning of the media content to the beginning of the time range. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.connectivity/connectivitymanager_acquireconnectionasync_1960335865.md b/windows.networking.connectivity/connectivitymanager_acquireconnectionasync_1960335865.md index 99f8be9bc4..0501aca663 100644 --- a/windows.networking.connectivity/connectivitymanager_acquireconnectionasync_1960335865.md +++ b/windows.networking.connectivity/connectivitymanager_acquireconnectionasync_1960335865.md @@ -19,7 +19,7 @@ Establishes a connection to a specific access point on a network. The request is ## -parameters -### -param CellularApnContext +### -param cellularApnContext Provides specific details about the APN. ## -returns diff --git a/windows.networking.connectivity/connectivitymanager_addhttproutepolicy_1422666154.md b/windows.networking.connectivity/connectivitymanager_addhttproutepolicy_1422666154.md index 15260d757c..293c238834 100644 --- a/windows.networking.connectivity/connectivitymanager_addhttproutepolicy_1422666154.md +++ b/windows.networking.connectivity/connectivitymanager_addhttproutepolicy_1422666154.md @@ -13,7 +13,7 @@ public void AddHttpRoutePolicy(Windows.Networking.Connectivity.RoutePolicy route Specifies a [RoutePolicy](routepolicy.md) that the Http stack (WinInet) will follow when routing traffic. ## -parameters -### -param RoutePolicy +### -param routePolicy Indicates the policy for traffic routing. ## -remarks diff --git a/windows.networking.connectivity/connectivitymanager_removehttproutepolicy_960581104.md b/windows.networking.connectivity/connectivitymanager_removehttproutepolicy_960581104.md index cec20b7203..ed50b4e76e 100644 --- a/windows.networking.connectivity/connectivitymanager_removehttproutepolicy_960581104.md +++ b/windows.networking.connectivity/connectivitymanager_removehttproutepolicy_960581104.md @@ -13,7 +13,7 @@ public void RemoveHttpRoutePolicy(Windows.Networking.Connectivity.RoutePolicy ro Removes a previously specified [RoutePolicy](routepolicy.md) from the Http stack (WinInet). ## -parameters -### -param RoutePolicy +### -param routePolicy The [RoutePolicy](routepolicy.md) to remove. ## -remarks diff --git a/windows.networking.networkoperators/mobilebroadbandaccount_accountexperienceurl.md b/windows.networking.networkoperators/mobilebroadbandaccount_accountexperienceurl.md new file mode 100644 index 0000000000..1bd5b44e91 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbandaccount_accountexperienceurl.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandAccount.AccountExperienceUrl +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandAccount.AccountExperienceUrl + +## -description +Returns the Account Experience URL associated with the Mobile Broadband account. + +> [!NOTE] +> This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators. + +## -property-value +The URL of the operator’s website used to configure Mobile Broadband. + +## -remarks +An Account Experience URL represents a mobile broadband account and its related information about the network provider. For more information, see [Windows Store mobile broadband apps](https://msdn.microsoft.com/windows/hardware/drivers/mobilebroadband/windows-store-mobile-broadband-apps). + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation.md index b45ef24e8f..8305ab7996 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation.md @@ -20,6 +20,7 @@ For permission to use this API, please reach out to [Network Operators API Permi For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) ## -remarks +If you're trying to get information about a SIM card that uses CMDA, the device information may contain multiple lines. Typically, the first line is for data connection and the second line contains SIM device information. ## -examples diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_cellularclass.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_cellularclass.md index 5ee3e24b7e..730d163c4e 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_cellularclass.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_cellularclass.md @@ -12,13 +12,6 @@ public Windows.Devices.Sms.CellularClass CellularClass { get; } ## -description Gets the cellular technology used by the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The cellular technology used by the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_currentradiostate.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_currentradiostate.md index d7bb6e064d..b5c6f66433 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_currentradiostate.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_currentradiostate.md @@ -12,13 +12,6 @@ public Windows.Networking.NetworkOperators.MobileBroadbandRadioState CurrentRadi ## -description Gets a value indicating the radio state of the device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value A value indicating the radio state of the device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_customdataclass.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_customdataclass.md index 74bfdf9787..0b8a5c9a4c 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_customdataclass.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_customdataclass.md @@ -12,13 +12,6 @@ public string CustomDataClass { get; } ## -description Gets the name of the data class when the [DataClasses](mobilebroadbanddeviceinformation_dataclasses.md) property returns **Custom**. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The name of the data class when the [DataClasses](mobilebroadbanddeviceinformation_dataclasses.md) property returns **Custom**. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_dataclasses.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_dataclasses.md index e382c76d0c..3c7e75cfa5 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_dataclasses.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_dataclasses.md @@ -12,13 +12,6 @@ public Windows.Networking.NetworkOperators.DataClasses DataClasses { get; } ## -description Gets the cellular data services supported by the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The cellular data services supported by the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_deviceid.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_deviceid.md index ef0448e22f..20dbfc5c3a 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_deviceid.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_deviceid.md @@ -12,13 +12,6 @@ public string DeviceId { get; } ## -description Gets the [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of the mobile broadband device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of the mobile broadband device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_devicetype.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_devicetype.md index c4e6cf4a5b..e1ff55b2d2 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_devicetype.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_devicetype.md @@ -12,13 +12,6 @@ public Windows.Networking.NetworkOperators.MobileBroadbandDeviceType DeviceType ## -description Gets a value indicating the type of Mobile Broadband device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value A value indicating the type of Mobile Broadband device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_firmwareinformation.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_firmwareinformation.md index da686e623e..77d7d41715 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_firmwareinformation.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_firmwareinformation.md @@ -12,13 +12,6 @@ public string FirmwareInformation { get; } ## -description Gets the device-specific firmware information for the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The device-specific firmware information for the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_manufacturer.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_manufacturer.md index 93d05a5418..44e97ec372 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_manufacturer.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_manufacturer.md @@ -12,13 +12,6 @@ public string Manufacturer { get; } ## -description Gets the name of the manufacturer of the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The name of the manufacturer of the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_mobileequipmentid.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_mobileequipmentid.md index a2396c354c..ad2fa8dfc7 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_mobileequipmentid.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_mobileequipmentid.md @@ -12,13 +12,6 @@ public string MobileEquipmentId { get; } ## -description Gets the value that uniquely identifies the mobile broadband device to the network provider. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The value that uniquely identifies the mobile broadband device to the network provider. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_model.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_model.md index 70853375ca..12e39dc6fe 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_model.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_model.md @@ -12,13 +12,6 @@ public string Model { get; } ## -description Gets the name of the model of the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The name of the model of the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_networkdevicestatus.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_networkdevicestatus.md index 7050e7d08e..82f0da597a 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_networkdevicestatus.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_networkdevicestatus.md @@ -12,13 +12,6 @@ public Windows.Networking.NetworkOperators.NetworkDeviceStatus NetworkDeviceStat ## -description Gets the readiness status of the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The readiness status of the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simgid1.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simgid1.md new file mode 100644 index 0000000000..b1cb4748bf --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simgid1.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation.SimGid1 +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation.SimGid1 + +## -description +Gets the Group Identifier Level 1 (GID1) of the mobile broadband network device. + +## -property-value +THe string value of the GID1 obtained from the SIM card. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simiccid.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simiccid.md index 4a0250abd6..4bc0a04db0 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simiccid.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simiccid.md @@ -12,13 +12,6 @@ public string SimIccId { get; } ## -description Gets the SIM integrated circuit card identifier (ICCID) for the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The SIM integrated circuit card identifier (ICCID) for the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simpnn.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simpnn.md new file mode 100644 index 0000000000..daae809ed7 --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simpnn.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation.SimPnn +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation.SimPnn + +## -description +Gets the Public Land Mobile Network (PLMN) name for the mobile broadband device. + +## -property-value +The string value of the PLMN obtained from the SIM card. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simspn.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simspn.md new file mode 100644 index 0000000000..fe837c17de --- /dev/null +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_simspn.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation.SimSpn +-api-type: winrt property +--- + + + +# Windows.Networking.NetworkOperators.MobileBroadbandDeviceInformation.SimSpn + +## -description +Gets the Service Provider Name (SPN) for the mobile broadband device. + +## -property-value +The string value of the SPN obtained from the SIM card. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_subscriberid.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_subscriberid.md index d51da2705b..ffd881f568 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_subscriberid.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_subscriberid.md @@ -12,13 +12,6 @@ public string SubscriberId { get; } ## -description Gets the subscriber identifier for the mobile broadband network device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The subscriber identifier for the mobile broadband network device. diff --git a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_telephonenumbers.md b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_telephonenumbers.md index c79fd6e53e..fbefbf0c8f 100644 --- a/windows.networking.networkoperators/mobilebroadbanddeviceinformation_telephonenumbers.md +++ b/windows.networking.networkoperators/mobilebroadbanddeviceinformation_telephonenumbers.md @@ -12,13 +12,6 @@ public Windows.Foundation.Collections.IVectorView TelephoneNumbers { get ## -description Gets the telephone numbers for the mobile broadband device. -> [!NOTE] -> This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators. - -For permission to use this API, please reach out to [Network Operators API Permissions](mailto:netopperm@microsoft.com). - -For technical help with this API, please reach out to [Network Operators API Help](mailto:netophelp@microsoft.com) - ## -property-value The telephone numbers for the mobile broadband device. diff --git a/windows.networking.proximity/connectionrequestedeventargs.md b/windows.networking.proximity/connectionrequestedeventargs.md index ee9ecc1608..918feec5a0 100644 --- a/windows.networking.proximity/connectionrequestedeventargs.md +++ b/windows.networking.proximity/connectionrequestedeventargs.md @@ -28,3 +28,4 @@ Contains properties that are passed to an application with the [ConnectionReques ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/connectionrequestedeventargs_peerinformation.md b/windows.networking.proximity/connectionrequestedeventargs_peerinformation.md index 94a6e354cd..af4154d9e8 100644 --- a/windows.networking.proximity/connectionrequestedeventargs_peerinformation.md +++ b/windows.networking.proximity/connectionrequestedeventargs_peerinformation.md @@ -1,34 +1,35 @@ ---- --api-id: P:Windows.Networking.Proximity.ConnectionRequestedEventArgs.PeerInformation --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.ConnectionRequestedEventArgs.PeerInformation - -## -description -Gets the information for a peer that's requesting a connection. - -## -property-value -The information for a peer that's requesting a connection. - -## -remarks -Pass this reference to the [ConnectAsync](peerfinder_connectasync.md) method to accept the request. - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.ConnectionRequestedEventArgs.PeerInformation +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.ConnectionRequestedEventArgs.PeerInformation + +## -description +Gets the information for a peer that's requesting a connection. + +## -property-value +The information for a peer that's requesting a connection. + +## -remarks +Pass this reference to the [ConnectAsync](peerfinder_connectasync.md) method to accept the request. + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/devicearrivedeventhandler.md b/windows.networking.proximity/devicearrivedeventhandler.md index c8da19ccd0..3caff36143 100644 --- a/windows.networking.proximity/devicearrivedeventhandler.md +++ b/windows.networking.proximity/devicearrivedeventhandler.md @@ -32,3 +32,4 @@ The proximity device that raised the [DeviceArrived](proximitydevice_devicearriv ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/devicedepartedeventhandler.md b/windows.networking.proximity/devicedepartedeventhandler.md index ff46909a90..121d5992f4 100644 --- a/windows.networking.proximity/devicedepartedeventhandler.md +++ b/windows.networking.proximity/devicedepartedeventhandler.md @@ -32,3 +32,4 @@ The proximity device that raised the [DeviceDeparted](proximitydevice_devicedepa ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/messagereceivedhandler.md b/windows.networking.proximity/messagereceivedhandler.md index dc9d9fccc7..7cb9f62022 100644 --- a/windows.networking.proximity/messagereceivedhandler.md +++ b/windows.networking.proximity/messagereceivedhandler.md @@ -35,3 +35,4 @@ The message and related data that were passed to the event handler. ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/messagetransmittedhandler.md b/windows.networking.proximity/messagetransmittedhandler.md index 30d920b978..b913286e89 100644 --- a/windows.networking.proximity/messagetransmittedhandler.md +++ b/windows.networking.proximity/messagetransmittedhandler.md @@ -39,3 +39,4 @@ The [MessageTransmittedHandler](messagetransmittedhandler.md) delegate is called ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/peerdiscoverytypes.md b/windows.networking.proximity/peerdiscoverytypes.md index 05ea389a4f..eba5f89fcb 100644 --- a/windows.networking.proximity/peerdiscoverytypes.md +++ b/windows.networking.proximity/peerdiscoverytypes.md @@ -39,3 +39,4 @@ You can tap to connect to peers by using the [PeerFinder](peerfinder.md) class. ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/peerfinder.md b/windows.networking.proximity/peerfinder.md index 20812a486f..645b1efdab 100644 --- a/windows.networking.proximity/peerfinder.md +++ b/windows.networking.proximity/peerfinder.md @@ -30,3 +30,4 @@ Enables you to discover other instances of your app on nearby devices and create ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_connectasync_380619906.md b/windows.networking.proximity/peerfinder_connectasync_380619906.md index d33d39093e..9eee704a93 100644 --- a/windows.networking.proximity/peerfinder_connectasync_380619906.md +++ b/windows.networking.proximity/peerfinder_connectasync_380619906.md @@ -1,53 +1,54 @@ ---- --api-id: M:Windows.Networking.Proximity.PeerFinder.ConnectAsync(Windows.Networking.Proximity.PeerInformation) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.PeerFinder.ConnectAsync - -## -description -Connects to a peer discovered by a call to the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method. - -## -parameters -### -param peerInformation -A peer information object representing the peer to connect to. - -## -returns -An asynchronous operation for connecting to a remote peer using the supplied [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) object. - -## -remarks -You can obtain an instance of a [PeerInformation](peerinformation.md) object for a peer from a call to the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method, or in a handler for the [ConnectionRequested](peerfinder_connectionrequested.md) event. - -If an app calls the [ConnectAsync](peerfinder_connectasync.md) method to create a connection with a peer, the app will no longer advertise for a connection and will not be found by the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method until the app calls the [Close](../windows.networking.sockets/streamsocket_close.md) method to close the socket connection. - -If you open a socket connection by calling the [ConnectAsync](peerfinder_connectasync.md) method, only one socket connection can be open at a time for the computer. If your app, or another app calls the [ConnectAsync](peerfinder_connectasync.md) method, then the existing socket connection will close. - -An *Access Denied* exception will be thrown if you attempt to call **ConnectAsync** when your app is in the background. - - - -> [!IMPORTANT] -> The Proximity APIs do not provide authentication. You should avoid exchanging sensitive data with these APIs. - -### Windows Phone 8 - -Wi-Fi Direct is not supported on Windows Phone 8. For more information, see [Proximity](XREF:TODO:d3654cbf-7e79-4833-9bd3-f4c926eb7282). - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[FindAllPeersAsync](peerfinder_findallpeersasync.md), [PeerInformation](peerinformation.md), [ConnectionRequested](peerfinder_connectionrequested.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.PeerFinder.ConnectAsync(Windows.Networking.Proximity.PeerInformation) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.PeerFinder.ConnectAsync + +## -description +Connects to a peer discovered by a call to the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method. + +## -parameters +### -param peerInformation +A peer information object representing the peer to connect to. + +## -returns +An asynchronous operation for connecting to a remote peer using the supplied [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) object. + +## -remarks +You can obtain an instance of a [PeerInformation](peerinformation.md) object for a peer from a call to the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method, or in a handler for the [ConnectionRequested](peerfinder_connectionrequested.md) event. + +If an app calls the [ConnectAsync](peerfinder_connectasync.md) method to create a connection with a peer, the app will no longer advertise for a connection and will not be found by the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method until the app calls the [Close](../windows.networking.sockets/streamsocket_close.md) method to close the socket connection. + +If you open a socket connection by calling the [ConnectAsync](peerfinder_connectasync.md) method, only one socket connection can be open at a time for the computer. If your app, or another app calls the [ConnectAsync](peerfinder_connectasync.md) method, then the existing socket connection will close. + +An *Access Denied* exception will be thrown if you attempt to call **ConnectAsync** when your app is in the background. + + + +> [!IMPORTANT] +> The Proximity APIs do not provide authentication. You should avoid exchanging sensitive data with these APIs. + +### Windows Phone 8 + +Wi-Fi Direct is not supported on Windows Phone 8. For more information, see [Proximity](XREF:TODO:d3654cbf-7e79-4833-9bd3-f4c926eb7282). + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[FindAllPeersAsync](peerfinder_findallpeersasync.md), [PeerInformation](peerinformation.md), [ConnectionRequested](peerfinder_connectionrequested.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_connectionrequested.md b/windows.networking.proximity/peerfinder_connectionrequested.md index a005da046e..db20f65f99 100644 --- a/windows.networking.proximity/peerfinder_connectionrequested.md +++ b/windows.networking.proximity/peerfinder_connectionrequested.md @@ -1,36 +1,37 @@ ---- --api-id: E:Windows.Networking.Proximity.PeerFinder.ConnectionRequested --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.PeerFinder.ConnectionRequested - -## -description -Occurs when a remote peer requests a connection using the [ConnectAsync](peerfinder_connectasync.md) method. - -## -remarks -The **ConnectionRequested** event occurs when a remote peer calls the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method, finds the current peer, and passes that peer information to the [ConnectAsync](peerfinder_connectasync.md) method to request a connection. - - - -> [!IMPORTANT] -> The Proximity APIs do not provide authentication. You should avoid exchanging sensitive data with these APIs. - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[FindAllPeersAsync](peerfinder_findallpeersasync.md), [ConnectAsync](peerfinder_connectasync.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: E:Windows.Networking.Proximity.PeerFinder.ConnectionRequested +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.PeerFinder.ConnectionRequested + +## -description +Occurs when a remote peer requests a connection using the [ConnectAsync](peerfinder_connectasync.md) method. + +## -remarks +The **ConnectionRequested** event occurs when a remote peer calls the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method, finds the current peer, and passes that peer information to the [ConnectAsync](peerfinder_connectasync.md) method to request a connection. + + + +> [!IMPORTANT] +> The Proximity APIs do not provide authentication. You should avoid exchanging sensitive data with these APIs. + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[FindAllPeersAsync](peerfinder_findallpeersasync.md), [ConnectAsync](peerfinder_connectasync.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_createwatcher_1506431823.md b/windows.networking.proximity/peerfinder_createwatcher_1506431823.md index 23963c7955..d7aec86edb 100644 --- a/windows.networking.proximity/peerfinder_createwatcher_1506431823.md +++ b/windows.networking.proximity/peerfinder_createwatcher_1506431823.md @@ -1,32 +1,35 @@ ---- --api-id: M:Windows.Networking.Proximity.PeerFinder.CreateWatcher --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.PeerFinder.CreateWatcher - -## -description -Creates a new instance of a [PeerWatcher](peerwatcher.md) object for dynamic discovery of peer apps. - -## -returns -An instance of a [PeerWatcher](peerwatcher.md) object for dynamic discovery of peer apps. - -## -remarks -You must first call the [Start](peerfinder_start.md) method before calling the [CreateWatcher](peerfinder_createwatcher.md) method. - -If you call the [CreateWatcher](peerfinder_createwatcher.md) method multiple times, you will receive a reference to the same [PeerWatcher](peerwatcher.md) instance. - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: M:Windows.Networking.Proximity.PeerFinder.CreateWatcher +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.PeerFinder.CreateWatcher + +## -description +Creates a new instance of a [PeerWatcher](peerwatcher.md) object for dynamic discovery of peer apps. + +## -returns +An instance of a [PeerWatcher](peerwatcher.md) object for dynamic discovery of peer apps. + +## -remarks +You must first call the [Start](peerfinder_start.md) method before calling the [CreateWatcher](peerfinder_createwatcher.md) method. + +If you call the [CreateWatcher](peerfinder_createwatcher.md) method multiple times, you will receive a reference to the same [PeerWatcher](peerwatcher.md) instance. + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +soft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerfinder_discoverydata.md b/windows.networking.proximity/peerfinder_discoverydata.md index 1c550e7bba..63b5d3158f 100644 --- a/windows.networking.proximity/peerfinder_discoverydata.md +++ b/windows.networking.proximity/peerfinder_discoverydata.md @@ -1,30 +1,32 @@ ---- --api-id: P:Windows.Networking.Proximity.PeerFinder.DiscoveryData --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.PeerFinder.DiscoveryData - -## -description -Gets or sets user or device data to include during device discovery. - -## -property-value -User or device data to include during device discovery. Must be less than 32 bytes. - -## -remarks -> Windows Phone Store app: This property is not supported. Setting it has no effect and no data is returned from this property on a phone. - -## -examples - - -[!code-csharp[PeerRole_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole_CS)] - - -[!code-js[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/peerrole.js#SnippetPeerRole)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: P:Windows.Networking.Proximity.PeerFinder.DiscoveryData +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.PeerFinder.DiscoveryData + +## -description +Gets or sets user or device data to include during device discovery. + +## -property-value +User or device data to include during device discovery. Must be less than 32 bytes. + +## -remarks +> Windows Phone Store app: This property is not supported. Setting it has no effect and no data is returned from this property on a phone. + +## -examples + + +[!code-csharp[PeerRole_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole_CS)] + +[!code-csharp[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole)] + +[!code-js[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/peerrole.js#SnippetPeerRole)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +soft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerfinder_displayname.md b/windows.networking.proximity/peerfinder_displayname.md index a929444934..e0cec36c44 100644 --- a/windows.networking.proximity/peerfinder_displayname.md +++ b/windows.networking.proximity/peerfinder_displayname.md @@ -1,41 +1,42 @@ ---- --api-id: P:Windows.Networking.Proximity.PeerFinder.DisplayName --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.PeerFinder.DisplayName - -## -description -Gets or sets the name that identifies your computer to remote peers. - -## -property-value -The name that identifies your computer to remote peers. - -## -remarks -> [!IMPORTANT] -> Always set the [DisplayName](peerfinder_displayname.md) property to a unique value for your app before you call the [Start](peerfinder_start.md) method. - -The **DisplayName** property value is included in the [PeerInformation](peerinformation.md) instance that's created when a remote peer calls the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method and finds your computer. - -If you don't specify a value for the **DisplayName** property, the computer name is used. - -The maximum length of **DisplayName** is 50 characters. - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.PeerFinder.DisplayName +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.PeerFinder.DisplayName + +## -description +Gets or sets the name that identifies your computer to remote peers. + +## -property-value +The name that identifies your computer to remote peers. + +## -remarks +> [!IMPORTANT] +> Always set the [DisplayName](peerfinder_displayname.md) property to a unique value for your app before you call the [Start](peerfinder_start.md) method. + +The **DisplayName** property value is included in the [PeerInformation](peerinformation.md) instance that's created when a remote peer calls the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method and finds your computer. + +If you don't specify a value for the **DisplayName** property, the computer name is used. + +The maximum length of **DisplayName** is 50 characters. + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_findallpeersasync_830195586.md b/windows.networking.proximity/peerfinder_findallpeersasync_830195586.md index d288bb5c0c..9f15faeedb 100644 --- a/windows.networking.proximity/peerfinder_findallpeersasync_830195586.md +++ b/windows.networking.proximity/peerfinder_findallpeersasync_830195586.md @@ -1,46 +1,47 @@ ---- --api-id: M:Windows.Networking.Proximity.PeerFinder.FindAllPeersAsync --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.PeerFinder.FindAllPeersAsync - -## -description -Asynchronously browses for peer devices that are running the same app within wireless range. - -## -returns -The asynchronous operation for browsing for peer devices that are running your app. - -## -remarks -If your app is running on a PC, you can browse for peer PCs that are running your app. Peer discovery in this case takes place over Wi-Fi Direct. If your app is running on a phone, you can browse for peer phones that are running your app. In this case, peer discovery takes place over Bluetooth. Because the transport used for peer discovery differs between PC and phone, your app running on a PC can only find peer PCs and your app running on a phone can only find peer phones. - -When the asynchronous browsing operation finishes successfully, it returns a list of peers that are within wireless range. A peer is a device that has an app running in the foreground with a matching app Id. A peer can also have a matching browse Id that's specified as an alternate identity. For more information, see [AlternateIdentities](peerfinder_alternateidentities.md). - -If an app calls the [ConnectAsync](peerfinder_connectasync.md) method to create a connection with a peer, the app will no longer advertise for a connection and will not be found by the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method until the app calls the [Close](../windows.networking.sockets/streamsocket_close.md) method to close the socket connection. - -You will only find peers where the device is within wireless range and the peer app is running in the foreground. If a peer app is running in the background, proximity does not advertise for peer connections. - -As an alternative to the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method, you can dynamically search for peer apps as they are discovered within range using the [PeerWatcher](peerwatcher.md) object. - -### Windows Phone 8 - -Wi-Fi Direct is not supported on Windows Phone 8. For more information, see [Proximity](XREF:TODO:d3654cbf-7e79-4833-9bd3-f4c926eb7282). - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[AlternateIdentities](peerfinder_alternateidentities.md), [SupportedDiscoveryTypes](peerfinder_supporteddiscoverytypes.md), [PeerWatcher](peerwatcher.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.PeerFinder.FindAllPeersAsync +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.PeerFinder.FindAllPeersAsync + +## -description +Asynchronously browses for peer devices that are running the same app within wireless range. + +## -returns +The asynchronous operation for browsing for peer devices that are running your app. + +## -remarks +If your app is running on a PC, you can browse for peer PCs that are running your app. Peer discovery in this case takes place over Wi-Fi Direct. If your app is running on a phone, you can browse for peer phones that are running your app. In this case, peer discovery takes place over Bluetooth. Because the transport used for peer discovery differs between PC and phone, your app running on a PC can only find peer PCs and your app running on a phone can only find peer phones. + +When the asynchronous browsing operation finishes successfully, it returns a list of peers that are within wireless range. A peer is a device that has an app running in the foreground with a matching app Id. A peer can also have a matching browse Id that's specified as an alternate identity. For more information, see [AlternateIdentities](peerfinder_alternateidentities.md). + +If an app calls the [ConnectAsync](peerfinder_connectasync.md) method to create a connection with a peer, the app will no longer advertise for a connection and will not be found by the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method until the app calls the [Close](../windows.networking.sockets/streamsocket_close.md) method to close the socket connection. + +You will only find peers where the device is within wireless range and the peer app is running in the foreground. If a peer app is running in the background, proximity does not advertise for peer connections. + +As an alternative to the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method, you can dynamically search for peer apps as they are discovered within range using the [PeerWatcher](peerwatcher.md) object. + +### Windows Phone 8 + +Wi-Fi Direct is not supported on Windows Phone 8. For more information, see [Proximity](XREF:TODO:d3654cbf-7e79-4833-9bd3-f4c926eb7282). + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[AlternateIdentities](peerfinder_alternateidentities.md), [SupportedDiscoveryTypes](peerfinder_supporteddiscoverytypes.md), [PeerWatcher](peerwatcher.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_role.md b/windows.networking.proximity/peerfinder_role.md index 439c9a3b5c..6fd0464714 100644 --- a/windows.networking.proximity/peerfinder_role.md +++ b/windows.networking.proximity/peerfinder_role.md @@ -1,35 +1,37 @@ ---- --api-id: P:Windows.Networking.Proximity.PeerFinder.Role --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.PeerFinder.Role - -## -description -Gets or sets the role of the app in peer-to-peer connections. - -## -property-value -The role of the app in peer-to-peer connections. - -## -remarks -The [Role](peerfinder_role.md) property is used in multi-peer app connections to identify whether the peer app is the **Host** or **Client**, or if the peer app is participating in a two-peer connection as a **Peer**. For multi-peer app connections, you must set the [Role](peerfinder_role.md) property before calling the [Start](peerfinder_start.md) method. If the Role property is not set, the default is **Peer**. - -In a multi-peer app scenario, the Role identifies the capability of the apps to connect. A **Host** app can connect to up to five **Client** apps. **Host** apps can only discover apps that advertise as **Client** apps. **Client** apps can only discover apps that advertise as **Host** apps. The **Peer** role identifies a two-app scenario. Therefore, **Peer** apps can only discover other **Peer** apps. The same rules apply for peer apps connected using a tap gesture. For example, apps advertising as **Host** apps can only tap to connect with apps advertising as **Client** apps. - -## -examples - - -[!code-csharp[PeerRole_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole_CS)] - - -[!code-js[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/peerrole.js#SnippetPeerRole)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.PeerFinder.Role +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.PeerFinder.Role + +## -description +Gets or sets the role of the app in peer-to-peer connections. + +## -property-value +The role of the app in peer-to-peer connections. + +## -remarks +The [Role](peerfinder_role.md) property is used in multi-peer app connections to identify whether the peer app is the **Host** or **Client**, or if the peer app is participating in a two-peer connection as a **Peer**. For multi-peer app connections, you must set the [Role](peerfinder_role.md) property before calling the [Start](peerfinder_start.md) method. If the Role property is not set, the default is **Peer**. + +In a multi-peer app scenario, the Role identifies the capability of the apps to connect. A **Host** app can connect to up to five **Client** apps. **Host** apps can only discover apps that advertise as **Client** apps. **Client** apps can only discover apps that advertise as **Host** apps. The **Peer** role identifies a two-app scenario. Therefore, **Peer** apps can only discover other **Peer** apps. The same rules apply for peer apps connected using a tap gesture. For example, apps advertising as **Host** apps can only tap to connect with apps advertising as **Client** apps. + +## -examples + + +[!code-csharp[PeerRole_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole_CS)] + +[!code-csharp[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole)] + +[!code-js[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/peerrole.js#SnippetPeerRole)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_start_1587696324.md b/windows.networking.proximity/peerfinder_start_1587696324.md index 191358b245..e6340198b2 100644 --- a/windows.networking.proximity/peerfinder_start_1587696324.md +++ b/windows.networking.proximity/peerfinder_start_1587696324.md @@ -1,51 +1,52 @@ ---- --api-id: M:Windows.Networking.Proximity.PeerFinder.Start --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.PeerFinder.Start - -## -description -Makes an app discoverable to remote peers. - -## -remarks - -You can call the **Start** method to begin the process of finding a peer app and to make your app discoverable to remote peers that call the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method. A peer is a device that has an app running in the foreground with a matching AppId. A peer can also have a matching Browse Id that's specified as an alternate identity. For more information, see [AlternateIdentities](peerfinder_alternateidentities.md). - -You can connect to only one peer at a time if your app is in the peer or client role. If your app is in the host role, you can connect up to 5 clients at a time. - -When an app is activated by tapping a nearby device, the activation parameters indicate whether the [PeerFinder](peerfinder.md) should be started or if the app was launched with activation arguments. The format of the activation parameters is *"Windows.Networking.Proximity.PeerFinder:StreamSocket Role=<Host|Client>"*. For more information, see the "Activating apps using Proximity" section of [Supporting Proximity and Tapping.](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b) - - - -> [!IMPORTANT] -> Always set the [DisplayName](peerfinder_displayname.md) property to a unique value for your app before you call the [Start](peerfinder_start.md) method. - -### Windows Phone 8 - -Wi-Fi Direct is not supported on Windows Phone 8. For more information, see [Proximity](XREF:TODO:d3654cbf-7e79-4833-9bd3-f4c926eb7282). - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[AlternateIdentities](peerfinder_alternateidentities.md), [Start(String)](peerfinder_start_119778276.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.PeerFinder.Start +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.PeerFinder.Start + +## -description +Makes an app discoverable to remote peers. + +## -remarks + +You can call the **Start** method to begin the process of finding a peer app and to make your app discoverable to remote peers that call the [FindAllPeersAsync](peerfinder_findallpeersasync.md) method. A peer is a device that has an app running in the foreground with a matching AppId. A peer can also have a matching Browse Id that's specified as an alternate identity. For more information, see [AlternateIdentities](peerfinder_alternateidentities.md). + +You can connect to only one peer at a time if your app is in the peer or client role. If your app is in the host role, you can connect up to 5 clients at a time. + +When an app is activated by tapping a nearby device, the activation parameters indicate whether the [PeerFinder](peerfinder.md) should be started or if the app was launched with activation arguments. The format of the activation parameters is *"Windows.Networking.Proximity.PeerFinder:StreamSocket Role=<Host|Client>"*. For more information, see the "Activating apps using Proximity" section of [Supporting Proximity and Tapping.](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b) + + + +> [!IMPORTANT] +> Always set the [DisplayName](peerfinder_displayname.md) property to a unique value for your app before you call the [Start](peerfinder_start.md) method. + +### Windows Phone 8 + +Wi-Fi Direct is not supported on Windows Phone 8. For more information, see [Proximity](XREF:TODO:d3654cbf-7e79-4833-9bd3-f4c926eb7282). + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[AlternateIdentities](peerfinder_alternateidentities.md), [Start(String)](peerfinder_start_119778276.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_stop_1201535524.md b/windows.networking.proximity/peerfinder_stop_1201535524.md index ebc2bdb27e..72c8261cdf 100644 --- a/windows.networking.proximity/peerfinder_stop_1201535524.md +++ b/windows.networking.proximity/peerfinder_stop_1201535524.md @@ -1,31 +1,32 @@ ---- --api-id: M:Windows.Networking.Proximity.PeerFinder.Stop --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.PeerFinder.Stop - -## -description -Stops advertising for a peer connection. - -## -remarks -You can call the [Stop](peerfinder_stop.md) method to stop the [PeerFinder](peerfinder.md) when you no longer want to advertise for or accept new triggered (tapped) or browsed connections. [Stop](peerfinder_stop.md) does not close an existing connection. However, the [Stop](peerfinder_stop.md) method will cancel outstanding calls to the [ConnectAsync](peerfinder_connectasync.md) method and triggered connection requests. The [Stop](peerfinder_stop.md) method does not wait for the cancellation to complete. - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[Start](peerfinder_start.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.PeerFinder.Stop +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.PeerFinder.Stop + +## -description +Stops advertising for a peer connection. + +## -remarks +You can call the [Stop](peerfinder_stop.md) method to stop the [PeerFinder](peerfinder.md) when you no longer want to advertise for or accept new triggered (tapped) or browsed connections. [Stop](peerfinder_stop.md) does not close an existing connection. However, the [Stop](peerfinder_stop.md) method will cancel outstanding calls to the [ConnectAsync](peerfinder_connectasync.md) method and triggered connection requests. The [Stop](peerfinder_stop.md) method does not wait for the cancellation to complete. + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[Start](peerfinder_start.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_supporteddiscoverytypes.md b/windows.networking.proximity/peerfinder_supporteddiscoverytypes.md index f9e66c3fe5..8cb9154ba5 100644 --- a/windows.networking.proximity/peerfinder_supporteddiscoverytypes.md +++ b/windows.networking.proximity/peerfinder_supporteddiscoverytypes.md @@ -1,33 +1,34 @@ ---- --api-id: P:Windows.Networking.Proximity.PeerFinder.SupportedDiscoveryTypes --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.PeerFinder.SupportedDiscoveryTypes - -## -description -Gets a value that indicates which discovery options are available to use with the [PeerFinder](peerfinder.md) class. - -## -property-value -A value that indicates which discovery options are available to use with the [PeerFinder](peerfinder.md) class. - -## -remarks - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.PeerFinder.SupportedDiscoveryTypes +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.PeerFinder.SupportedDiscoveryTypes + +## -description +Gets a value that indicates which discovery options are available to use with the [PeerFinder](peerfinder.md) class. + +## -property-value +A value that indicates which discovery options are available to use with the [PeerFinder](peerfinder.md) class. + +## -remarks + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerfinder_triggeredconnectionstatechanged.md b/windows.networking.proximity/peerfinder_triggeredconnectionstatechanged.md index b55a8e5b49..0de956e447 100644 --- a/windows.networking.proximity/peerfinder_triggeredconnectionstatechanged.md +++ b/windows.networking.proximity/peerfinder_triggeredconnectionstatechanged.md @@ -1,41 +1,42 @@ ---- --api-id: E:Windows.Networking.Proximity.PeerFinder.TriggeredConnectionStateChanged --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.PeerFinder.TriggeredConnectionStateChanged - -## -description -Occurs during a tap gesture from a remote peer. - -## -remarks -You can determine when a peer is available to connect to, and the progress of a connection to a peer, by using the **TriggeredConnectionStateChanged** event. Use the **TriggeredConnectionStateChanged** event to determine when a new peer has been found and to access the connection to that peer after you've finished connecting. - -The **TriggeredConnectionStateChanged** event occurs several times during a tap gesture. You can determine where you are in the connection process by using the [State](triggeredconnectionstatechangedeventargs_state.md) property. - -The first [State](triggeredconnectionstatechangedeventargs_state.md) value in a Proximity connection is **PeerFound**. At this point, you can tell users of your app that the Proximity gesture is complete and they can pull their devices away. - -If the [State](triggeredconnectionstatechangedeventargs_state.md) property returns **Connecting**, you know that your device initiated the tap gesture. If the [State](triggeredconnectionstatechangedeventargs_state.md) property returns **Listening**, you know that the other device initiated the tap gesture. This information is useful in determining which peer should initiate communications when the connection is complete. - -When the [State](triggeredconnectionstatechangedeventargs_state.md) property returns **Completed**, you can access the [Socket](triggeredconnectionstatechangedeventargs_socket.md) property to obtain a reference to a [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) object. You can use this reference to communicate with the peer app. The transport over which this communication takes place on this socket connection will either be Bluetooth, Infrastructure or Wi-Fi Direct. - -> Wi-Fi Direct is not supported for Windows Phone Store app. - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +--- +-api-id: E:Windows.Networking.Proximity.PeerFinder.TriggeredConnectionStateChanged +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.PeerFinder.TriggeredConnectionStateChanged + +## -description +Occurs during a tap gesture from a remote peer. + +## -remarks +You can determine when a peer is available to connect to, and the progress of a connection to a peer, by using the **TriggeredConnectionStateChanged** event. Use the **TriggeredConnectionStateChanged** event to determine when a new peer has been found and to access the connection to that peer after you've finished connecting. + +The **TriggeredConnectionStateChanged** event occurs several times during a tap gesture. You can determine where you are in the connection process by using the [State](triggeredconnectionstatechangedeventargs_state.md) property. + +The first [State](triggeredconnectionstatechangedeventargs_state.md) value in a Proximity connection is **PeerFound**. At this point, you can tell users of your app that the Proximity gesture is complete and they can pull their devices away. + +If the [State](triggeredconnectionstatechangedeventargs_state.md) property returns **Connecting**, you know that your device initiated the tap gesture. If the [State](triggeredconnectionstatechangedeventargs_state.md) property returns **Listening**, you know that the other device initiated the tap gesture. This information is useful in determining which peer should initiate communications when the connection is complete. + +When the [State](triggeredconnectionstatechangedeventargs_state.md) property returns **Completed**, you can access the [Socket](triggeredconnectionstatechangedeventargs_socket.md) property to obtain a reference to a [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) object. You can use this reference to communicate with the peer app. The transport over which this communication takes place on this socket connection will either be Bluetooth, Infrastructure or Wi-Fi Direct. + +> Wi-Fi Direct is not supported for Windows Phone Store app. + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone] +ID_CAP_NETWORKING [Windows Phone] diff --git a/windows.networking.proximity/peerinformation.md b/windows.networking.proximity/peerinformation.md index 89cf774cfb..2f44471927 100644 --- a/windows.networking.proximity/peerinformation.md +++ b/windows.networking.proximity/peerinformation.md @@ -29,3 +29,4 @@ A [PeerInformation](peerinformation.md) instance is created when you call the [F ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/peerinformation_displayname.md b/windows.networking.proximity/peerinformation_displayname.md index 2f9a5c5307..c4d0922e15 100644 --- a/windows.networking.proximity/peerinformation_displayname.md +++ b/windows.networking.proximity/peerinformation_displayname.md @@ -1,33 +1,34 @@ ---- --api-id: P:Windows.Networking.Proximity.PeerInformation.DisplayName --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.PeerInformation.DisplayName - -## -description -Gets the display name of the peer. - -## -property-value -The display name of the peer. - -## -remarks - -## -examples - - -[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] - -[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] - -[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.PeerInformation.DisplayName +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.PeerInformation.DisplayName + +## -description +Gets the display name of the peer. + +## -property-value +The display name of the peer. + +## -remarks + +## -examples + + +[!code-js[FindPeers](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/default.js#SnippetFindPeers)] + +[!code-csharp[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/BlankPage.xaml.cs#SnippetConnect_CS)] + +[!code-vb[Connect_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/vbnet/BlankPage.xaml.vb#SnippetConnect_CS)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/peerrole.md b/windows.networking.proximity/peerrole.md index eb598b8357..959897c865 100644 --- a/windows.networking.proximity/peerrole.md +++ b/windows.networking.proximity/peerrole.md @@ -33,7 +33,10 @@ In a multi-peer app scenario, the Role identifies the capability of the apps to [!code-csharp[PeerRole_CS](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole_CS)] +[!code-csharp[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/csharp/PeerRole.xaml.cs#SnippetPeerRole)] + [!code-js[PeerRole](../windows.networking.proximity/code/Proximity_FindAllPeersAsync1/js/peerrole.js#SnippetPeerRole)] ## -see-also [PeerFinder](peerfinder.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +soft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher.md b/windows.networking.proximity/peerwatcher.md index 28a47635db..aa2c889240 100644 --- a/windows.networking.proximity/peerwatcher.md +++ b/windows.networking.proximity/peerwatcher.md @@ -26,6 +26,7 @@ To create an instance of the [PeerWatcher](peerwatcher.md) class, call the [Peer [!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] [!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] @@ -33,3 +34,4 @@ To create an instance of the [PeerWatcher](peerwatcher.md) class, call the [Peer ## -see-also [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +soft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher_added.md b/windows.networking.proximity/peerwatcher_added.md index cf5090091e..0f518cfd5c 100644 --- a/windows.networking.proximity/peerwatcher_added.md +++ b/windows.networking.proximity/peerwatcher_added.md @@ -1,40 +1,41 @@ ---- --api-id: E:Windows.Networking.Proximity.PeerWatcher.Added --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.PeerWatcher.Added - -## -description -Occurs when a peer app is found within wireless range. - -## -remarks -> > [!IMPORTANT] -> For Windows Phone Store app, calling [PeerFinder.ConnectAsync](peerfinder_connectasync.md) from within an [Added](peerwatcher_added.md) event handler will fail. Instead, call it outside of this event handler, for example, when the user has explicitly chosen to connect to a peer. - -After you start the [PeerWatcher](peerwatcher.md)by calling the [Start](peerfinder_start.md)method, the [Added](peerwatcher_added.md)event is raised for each peer app found within wireless range. The [PeerWatcher](peerwatcher.md)continues scanning for peer apps within range until you call the [Stop](peerwatcher_stop.md)method. Using the [Added](peerwatcher_added.md)event, you can display peer apps to the user as they are found. - - - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -[!code-csharp[_PeerWatcherAdded](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherAdded)] - -[!code-js[_PeerWatcherAdded](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherAdded_JS)] - - - -[!code-js[_PeerWatcherAdded_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherAdded_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: E:Windows.Networking.Proximity.PeerWatcher.Added +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.PeerWatcher.Added + +## -description +Occurs when a peer app is found within wireless range. + +## -remarks +> > [!IMPORTANT] +> For Windows Phone Store app, calling [PeerFinder.ConnectAsync](peerfinder_connectasync.md) from within an [Added](peerwatcher_added.md) event handler will fail. Instead, call it outside of this event handler, for example, when the user has explicitly chosen to connect to a peer. + +After you start the [PeerWatcher](peerwatcher.md)by calling the [Start](peerfinder_start.md)method, the [Added](peerwatcher_added.md)event is raised for each peer app found within wireless range. The [PeerWatcher](peerwatcher.md)continues scanning for peer apps within range until you call the [Stop](peerwatcher_stop.md)method. Using the [Added](peerwatcher_added.md)event, you can display peer apps to the user as they are found. + + + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] + +[!code-csharp[_PeerWatcherAdded](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherAdded)] + +[!code-js[_PeerWatcherAdded](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherAdded)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +[!code-js[_PeerWatcherAdded_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherAdded_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher_enumerationcompleted.md b/windows.networking.proximity/peerwatcher_enumerationcompleted.md index c6f90b3c12..17273333ae 100644 --- a/windows.networking.proximity/peerwatcher_enumerationcompleted.md +++ b/windows.networking.proximity/peerwatcher_enumerationcompleted.md @@ -1,37 +1,41 @@ ---- --api-id: E:Windows.Networking.Proximity.PeerWatcher.EnumerationCompleted --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.PeerWatcher.EnumerationCompleted - -## -description -Occurs after a scan operation is complete and all peer apps within wireless range have been found. - -## -remarks -[EnumerationCompleted](peerwatcher_enumerationcompleted.md) event is raised when an enumeration looking for peer apps within range is complete. - -> > [!IMPORTANT] -> For Windows Phone Store app, calling [PeerFinder.ConnectAsync](peerfinder_connectasync.md) from within an [EnumerationCompleted](peerwatcher_enumerationcompleted.md) event handler will fail. Instead, call it outside of this event handler, for example, when the user has explicitly chosen to connect to a peer. - - - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -[!code-csharp[_PeerWatcherEnumerationCompleted](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherEnumerationCompleted)] - - -[!code-js[_PeerWatcherEnumerationCompleted_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherEnumerationCompleted_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: E:Windows.Networking.Proximity.PeerWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.PeerWatcher.EnumerationCompleted + +## -description +Occurs after a scan operation is complete and all peer apps within wireless range have been found. + +## -remarks +[EnumerationCompleted](peerwatcher_enumerationcompleted.md) event is raised when an enumeration looking for peer apps within range is complete. + +> > [!IMPORTANT] +> For Windows Phone Store app, calling [PeerFinder.ConnectAsync](peerfinder_connectasync.md) from within an [EnumerationCompleted](peerwatcher_enumerationcompleted.md) event handler will fail. Instead, call it outside of this event handler, for example, when the user has explicitly chosen to connect to a peer. + + + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] + +[!code-csharp[_PeerWatcherEnumerationCompleted](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherEnumerationCompleted)] + +[!code-js[_PeerWatcherEnumerationCompleted](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherEnumerationCompleted)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +[!code-js[_PeerWatcherEnumerationCompleted_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherEnumerationCompleted_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher_removed.md b/windows.networking.proximity/peerwatcher_removed.md index 94c56fc615..bfd129bb73 100644 --- a/windows.networking.proximity/peerwatcher_removed.md +++ b/windows.networking.proximity/peerwatcher_removed.md @@ -1,33 +1,38 @@ ---- --api-id: E:Windows.Networking.Proximity.PeerWatcher.Removed --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.PeerWatcher.Removed - -## -description -Occurs when a peer app is no longer within wireless range. - -## -remarks -The [Removed](peerwatcher_removed.md) event is raised when a peer app is removed from the collection of enumerated peer apps. This may happen if a user switches apps or if a device is no longer within range. - - - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -[!code-csharp[_PeerWatcherRemoved](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherRemoved)] - -[!code-js[_PeerWatcherRemoved_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherRemoved_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: E:Windows.Networking.Proximity.PeerWatcher.Removed +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.PeerWatcher.Removed + +## -description +Occurs when a peer app is no longer within wireless range. + +## -remarks +The [Removed](peerwatcher_removed.md) event is raised when a peer app is removed from the collection of enumerated peer apps. This may happen if a user switches apps or if a device is no longer within range. + + + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] + +[!code-csharp[_PeerWatcherRemoved](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherRemoved)] + +[!code-js[_PeerWatcherRemoved](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherRemoved)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +[!code-js[_PeerWatcherRemoved_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherRemoved_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher_start_1587696324.md b/windows.networking.proximity/peerwatcher_start_1587696324.md index 65709279f4..88222d5e98 100644 --- a/windows.networking.proximity/peerwatcher_start_1587696324.md +++ b/windows.networking.proximity/peerwatcher_start_1587696324.md @@ -1,33 +1,36 @@ ---- --api-id: M:Windows.Networking.Proximity.PeerWatcher.Start --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.PeerWatcher.Start - -## -description -Begin dynamically searching for peer apps within wireless range. - -## -remarks -You must register an event handler for [Added](peerwatcher_added.md) event before calling the [Start](peerwatcher_start.md) method. - -You can call the [Stop](peerwatcher_stop.md) method to stop dynamically searching for peer apps within wireless range. - -You can use the [Status](peerwatcher_status.md) property to determine the status of the [PeerWatcher](peerwatcher.md) object. You cannot call the [Start](peerwatcher_start.md) method if the [Status](peerwatcher_status.md) value is **Started**, **EnumerationCompleted**, or **Stopping.** - - - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: M:Windows.Networking.Proximity.PeerWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.PeerWatcher.Start + +## -description +Begin dynamically searching for peer apps within wireless range. + +## -remarks +You must register an event handler for [Added](peerwatcher_added.md) event before calling the [Start](peerwatcher_start.md) method. + +You can call the [Stop](peerwatcher_stop.md) method to stop dynamically searching for peer apps within wireless range. + +You can use the [Status](peerwatcher_status.md) property to determine the status of the [PeerWatcher](peerwatcher.md) object. You cannot call the [Start](peerwatcher_start.md) method if the [Status](peerwatcher_status.md) value is **Started**, **EnumerationCompleted**, or **Stopping.** + + + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +soft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher_stop_1201535524.md b/windows.networking.proximity/peerwatcher_stop_1201535524.md index 0124417069..75a2f56dd6 100644 --- a/windows.networking.proximity/peerwatcher_stop_1201535524.md +++ b/windows.networking.proximity/peerwatcher_stop_1201535524.md @@ -1,32 +1,32 @@ ---- --api-id: M:Windows.Networking.Proximity.PeerWatcher.Stop --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.PeerWatcher.Stop - -## -description -Stop dynamically searching for peer apps within wireless range. - -## -remarks - - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -[!code-csharp[_StopPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StopPeerWatcher)] - - -[!code-js[_StopPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StopPeerWatcher_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: M:Windows.Networking.Proximity.PeerWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.PeerWatcher.Stop + +## -description +Stop dynamically searching for peer apps within wireless range. + +## -remarks + + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +[!code-csharp[_StopPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StopPeerWatcher)] + + +[!code-js[_StopPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StopPeerWatcher_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher_stopped.md b/windows.networking.proximity/peerwatcher_stopped.md index 61ce9a8c6b..e55c50ac61 100644 --- a/windows.networking.proximity/peerwatcher_stopped.md +++ b/windows.networking.proximity/peerwatcher_stopped.md @@ -1,33 +1,38 @@ ---- --api-id: E:Windows.Networking.Proximity.PeerWatcher.Stopped --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.PeerWatcher.Stopped - -## -description -Occurs when the [PeerWatcher](peerwatcher.md) object has been stopped. - -## -remarks -You can call the [Stop](peerwatcher_stop.md) method to stop the [PeerWatcher](peerwatcher.md) object. You can register for the [Stopped](peerwatcher_stopped.md) event to be informed when the [PeerWatcher](peerwatcher.md) has stopped. You must wait for the [Stopped](peerwatcher_stopped.md) event before you can call the [Start](peerwatcher_start.md) method to restart the [PeerWatcher](peerwatcher.md). - - - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -[!code-csharp[_PeerWatcherStopped](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherStopped)] - -[!code-js[_PeerWatcherStopped_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherStopped_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: E:Windows.Networking.Proximity.PeerWatcher.Stopped +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.PeerWatcher.Stopped + +## -description +Occurs when the [PeerWatcher](peerwatcher.md) object has been stopped. + +## -remarks +You can call the [Stop](peerwatcher_stop.md) method to stop the [PeerWatcher](peerwatcher.md) object. You can register for the [Stopped](peerwatcher_stopped.md) event to be informed when the [PeerWatcher](peerwatcher.md) has stopped. You must wait for the [Stopped](peerwatcher_stopped.md) event before you can call the [Start](peerwatcher_start.md) method to restart the [PeerWatcher](peerwatcher.md). + + + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] + +[!code-csharp[_PeerWatcherStopped](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherStopped)] + +[!code-js[_PeerWatcherStopped](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherStopped)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +[!code-js[_PeerWatcherStopped_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherStopped_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/peerwatcher_updated.md b/windows.networking.proximity/peerwatcher_updated.md index a5d548caa0..bcc0847fc8 100644 --- a/windows.networking.proximity/peerwatcher_updated.md +++ b/windows.networking.proximity/peerwatcher_updated.md @@ -1,36 +1,41 @@ ---- --api-id: E:Windows.Networking.Proximity.PeerWatcher.Updated --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.PeerWatcher.Updated - -## -description -Occurs when the [DisplayName](peerinformation_displayname.md) or [DiscoveryData](peerinformation_discoverydata.md) for a peer app within wireless range has changed. - -## -remarks -The [Updated](peerwatcher_updated.md) event is raised when the [DisplayName](peerinformation_displayname.md) or [DiscoveryData](peerinformation_discoverydata.md) for a peer app changes. You can use the [Id](peerinformation_id.md) property to uniquely identify the peer app and update your UI. - -> > [!IMPORTANT] -> For Windows Phone Store app, calling [PeerFinder.ConnectAsync](peerfinder_connectasync.md) from within an [Updated](peerwatcher_updated.md) event handler will fail. Instead, call it outside of this event handler, for example, when the user has explicitly chosen to connect to a peer. - - - - - -[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] - -[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] - -[!code-csharp[_PeerWatcherUpdated](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherUpdated)] - -[!code-js[_PeerWatcherUpdated_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherUpdated_JS)] - -## -examples - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) +--- +-api-id: E:Windows.Networking.Proximity.PeerWatcher.Updated +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.PeerWatcher.Updated + +## -description +Occurs when the [DisplayName](peerinformation_displayname.md) or [DiscoveryData](peerinformation_discoverydata.md) for a peer app within wireless range has changed. + +## -remarks +The [Updated](peerwatcher_updated.md) event is raised when the [DisplayName](peerinformation_displayname.md) or [DiscoveryData](peerinformation_discoverydata.md) for a peer app changes. You can use the [Id](peerinformation_id.md) property to uniquely identify the peer app and update your UI. + +> > [!IMPORTANT] +> For Windows Phone Store app, calling [PeerFinder.ConnectAsync](peerfinder_connectasync.md) from within an [Updated](peerwatcher_updated.md) event handler will fail. Instead, call it outside of this event handler, for example, when the user has explicitly chosen to connect to a peer. + + + + + +[!code-csharp[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_StartPeerWatcher)] + +[!code-js[_StartPeerWatcher](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher)] + +[!code-csharp[_PeerWatcherUpdated](../windows.networking.proximity/code/Proximity_PeerWatcher/cs/MainPage.xaml.cs#Snippet_PeerWatcherUpdated)] + +[!code-js[_PeerWatcherUpdated](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherUpdated)] + +[!code-js[_StartPeerWatcher_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_StartPeerWatcher_JS)] + +[!code-js[_PeerWatcherUpdated_JS](../windows.networking.proximity/code/Proximity_PeerWatcher/js/default.js#Snippet_PeerWatcherUpdated_JS)] + +## -examples + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) diff --git a/windows.networking.proximity/proximitydevice.md b/windows.networking.proximity/proximitydevice.md index 4ac1a7c964..d8729218cf 100644 --- a/windows.networking.proximity/proximitydevice.md +++ b/windows.networking.proximity/proximitydevice.md @@ -38,3 +38,4 @@ The [ProximityDevice](proximitydevice.md) class uses publish/subscribe semantics ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_devicearrived.md b/windows.networking.proximity/proximitydevice_devicearrived.md index 8101b9626c..7aa8580c27 100644 --- a/windows.networking.proximity/proximitydevice_devicearrived.md +++ b/windows.networking.proximity/proximitydevice_devicearrived.md @@ -1,30 +1,31 @@ ---- --api-id: E:Windows.Networking.Proximity.ProximityDevice.DeviceArrived --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.ProximityDevice.DeviceArrived - -## -description -Occurs when a device enters the proximate range. - -## -remarks - -## -examples - - -[!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] - -[!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] - -[!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: E:Windows.Networking.Proximity.ProximityDevice.DeviceArrived +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.ProximityDevice.DeviceArrived + +## -description +Occurs when a device enters the proximate range. + +## -remarks + +## -examples + + +[!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] + +[!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] + +[!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_devicedeparted.md b/windows.networking.proximity/proximitydevice_devicedeparted.md index a96bf6dae5..c64e24b6f9 100644 --- a/windows.networking.proximity/proximitydevice_devicedeparted.md +++ b/windows.networking.proximity/proximitydevice_devicedeparted.md @@ -1,30 +1,31 @@ ---- --api-id: E:Windows.Networking.Proximity.ProximityDevice.DeviceDeparted --api-type: winrt event ---- - - - -# Windows.Networking.Proximity.ProximityDevice.DeviceDeparted - -## -description -Occurs when a device leaves the proximate range. - -## -remarks - -## -examples - - -[!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] - -[!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] - -[!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: E:Windows.Networking.Proximity.ProximityDevice.DeviceDeparted +-api-type: winrt event +--- + + + +# Windows.Networking.Proximity.ProximityDevice.DeviceDeparted + +## -description +Occurs when a device leaves the proximate range. + +## -remarks + +## -examples + + +[!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] + +[!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] + +[!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_deviceid.md b/windows.networking.proximity/proximitydevice_deviceid.md index 383b41d65c..61038c3bcb 100644 --- a/windows.networking.proximity/proximitydevice_deviceid.md +++ b/windows.networking.proximity/proximitydevice_deviceid.md @@ -1,34 +1,35 @@ ---- --api-id: P:Windows.Networking.Proximity.ProximityDevice.DeviceId --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.ProximityDevice.DeviceId - -## -description -Gets the [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a proximity device. - -## -property-value -The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a proximity device. - -## -remarks -If your computer supports Proximity and has an NFC device installed, which is commonly the case, then the [GetDefault](proximitydevice_getdefault.md) method will return the device that supports NFC. You can also determine whether your computer has an NFC device installed by querying the device information for the property "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2". In the [DeviceInformation.Properties](../windows.devices.enumeration/deviceinformation_properties.md) object returned from the query the value for the "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2" key contains and array of strings that describe the capabilities of the proximity device. If one of the strings is "StandardNfc", then the device supports NFC protocols such as NDEF. For more information on how to query for the properties of a device, see [How to retrieve additional properties for a device or PnP object](http://msdn.microsoft.com/library/74e2a9c2-9551-45a9-8de1-71a425dab3d3). - -## -examples - - -[!code-csharp[DeviceId](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/csharp/MainPage.xaml.cs#SnippetDeviceId)] - -[!code-js[DeviceId](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/javascript/default.js#SnippetDeviceId)] - -[!code-vb[DeviceId](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/vbnet/MainPage.xaml.vb#SnippetDeviceId)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.ProximityDevice.DeviceId +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.ProximityDevice.DeviceId + +## -description +Gets the [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a proximity device. + +## -property-value +The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) for a proximity device. + +## -remarks +If your computer supports Proximity and has an NFC device installed, which is commonly the case, then the [GetDefault](proximitydevice_getdefault.md) method will return the device that supports NFC. You can also determine whether your computer has an NFC device installed by querying the device information for the property "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2". In the [DeviceInformation.Properties](../windows.devices.enumeration/deviceinformation_properties.md) object returned from the query the value for the "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2" key contains and array of strings that describe the capabilities of the proximity device. If one of the strings is "StandardNfc", then the device supports NFC protocols such as NDEF. For more information on how to query for the properties of a device, see [How to retrieve additional properties for a device or PnP object](http://msdn.microsoft.com/library/74e2a9c2-9551-45a9-8de1-71a425dab3d3). + +## -examples + + +[!code-csharp[DeviceId](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/csharp/MainPage.xaml.cs#SnippetDeviceId)] + +[!code-js[DeviceId](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/javascript/default.js#SnippetDeviceId)] + +[!code-vb[DeviceId](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/vbnet/MainPage.xaml.vb#SnippetDeviceId)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_fromid_114571398.md b/windows.networking.proximity/proximitydevice_fromid_114571398.md index be16e61e0b..c521904375 100644 --- a/windows.networking.proximity/proximitydevice_fromid_114571398.md +++ b/windows.networking.proximity/proximitydevice_fromid_114571398.md @@ -1,38 +1,39 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.FromId(System.String) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.FromId - -## -description -Creates an instance of a [ProximityDevice](proximitydevice.md) class and activates the specified proximity device interface. - -## -parameters -### -param deviceId -The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of a proximity device. - -## -returns -A new [ProximityDevice](proximitydevice.md) that uses the specified proximity device interface. Throws a **System.IO.FileNotFoundException** exception if the specified proximity device interface isunavailable. - -## -remarks -You can enumerate proximity devices by passing the class selection string returned by the [GetDeviceSelector](proximitydevice_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. You can then use the resulting [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) value(s) to create an instance of a [ProximityDevice](proximitydevice.md) using the [FromId](proximitydevice_fromid.md) method. - -## -examples - - -[!code-csharp[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/csharp/MainPage.xaml.cs#SnippetGetDeviceSelector)] - -[!code-js[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/javascript/default.js#SnippetGetDeviceSelector)] - -[!code-vb[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/vbnet/MainPage.xaml.vb#SnippetGetDeviceSelector)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.FromId(System.String) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.FromId + +## -description +Creates an instance of a [ProximityDevice](proximitydevice.md) class and activates the specified proximity device interface. + +## -parameters +### -param deviceId +The [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) of a proximity device. + +## -returns +A new [ProximityDevice](proximitydevice.md) that uses the specified proximity device interface. Throws a **System.IO.FileNotFoundException** exception if the specified proximity device interface isunavailable. + +## -remarks +You can enumerate proximity devices by passing the class selection string returned by the [GetDeviceSelector](proximitydevice_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. You can then use the resulting [DeviceInformation Id](../windows.devices.enumeration/deviceinformation_id.md) value(s) to create an instance of a [ProximityDevice](proximitydevice.md) using the [FromId](proximitydevice_fromid.md) method. + +## -examples + + +[!code-csharp[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/csharp/MainPage.xaml.cs#SnippetGetDeviceSelector)] + +[!code-js[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/javascript/default.js#SnippetGetDeviceSelector)] + +[!code-vb[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/vbnet/MainPage.xaml.vb#SnippetGetDeviceSelector)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_getdefault_846721868.md b/windows.networking.proximity/proximitydevice_getdefault_846721868.md index 345296b242..5e86256d4c 100644 --- a/windows.networking.proximity/proximitydevice_getdefault_846721868.md +++ b/windows.networking.proximity/proximitydevice_getdefault_846721868.md @@ -1,33 +1,34 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.GetDefault --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.GetDefault - -## -description -Creates an instance of a [ProximityDevice](proximitydevice.md) class and activates the default proximity provider. - -## -returns -A new proximity device that uses the default proximity provider. Returns **NULL** if no proximity devices are installed. - -## -remarks - -## -examples - - -[!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] - -[!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] - -[!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.GetDefault +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.GetDefault + +## -description +Creates an instance of a [ProximityDevice](proximitydevice.md) class and activates the default proximity provider. + +## -returns +A new proximity device that uses the default proximity provider. Returns **NULL** if no proximity devices are installed. + +## -remarks + +## -examples + + +[!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] + +[!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] + +[!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_getdeviceselector_838466080.md b/windows.networking.proximity/proximitydevice_getdeviceselector_838466080.md index cf148aa767..f66367765e 100644 --- a/windows.networking.proximity/proximitydevice_getdeviceselector_838466080.md +++ b/windows.networking.proximity/proximitydevice_getdeviceselector_838466080.md @@ -1,36 +1,37 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.GetDeviceSelector --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.GetDeviceSelector - -## -description -Returns the class selection string that you can use to enumerate proximity devices. - -## -returns -The class selection string for proximity devices. - -## -remarks -You can enumerate proximity devices by passing the class selection string returned by the [GetDeviceSelector](proximitydevice_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. - -If your computer supports Proximity and has an NFC device installed, which is commonly the case, then the [GetDefault](proximitydevice_getdefault.md) method will return the device that supports NFC. You can also determine whether your computer has an NFC device installed by querying the device information for the property "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2". In the [DeviceInformation.Properties](../windows.devices.enumeration/deviceinformation_properties.md) object returned from the query the value for the "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2" key contains and array of strings that describe the capabilities of the proximity device. If one of the strings is "StandardNfc", then the device supports NFC protocols such as NDEF. For more information on how to query for the properties of a device, see [How to retrieve additional properties for a device or PnP object](http://msdn.microsoft.com/library/74e2a9c2-9551-45a9-8de1-71a425dab3d3). - -## -examples - - -[!code-csharp[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/csharp/MainPage.xaml.cs#SnippetGetDeviceSelector)] - -[!code-js[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/javascript/default.js#SnippetGetDeviceSelector)] - -[!code-vb[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/vbnet/MainPage.xaml.vb#SnippetGetDeviceSelector)] - -## -see-also -[DeviceId](proximitydevice_deviceid.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.GetDeviceSelector +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.GetDeviceSelector + +## -description +Returns the class selection string that you can use to enumerate proximity devices. + +## -returns +The class selection string for proximity devices. + +## -remarks +You can enumerate proximity devices by passing the class selection string returned by the [GetDeviceSelector](proximitydevice_getdeviceselector.md) method to the [FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync.md) or [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher.md) method. + +If your computer supports Proximity and has an NFC device installed, which is commonly the case, then the [GetDefault](proximitydevice_getdefault.md) method will return the device that supports NFC. You can also determine whether your computer has an NFC device installed by querying the device information for the property "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2". In the [DeviceInformation.Properties](../windows.devices.enumeration/deviceinformation_properties.md) object returned from the query the value for the "{FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} 2" key contains and array of strings that describe the capabilities of the proximity device. If one of the strings is "StandardNfc", then the device supports NFC protocols such as NDEF. For more information on how to query for the properties of a device, see [How to retrieve additional properties for a device or PnP object](http://msdn.microsoft.com/library/74e2a9c2-9551-45a9-8de1-71a425dab3d3). + +## -examples + + +[!code-csharp[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/csharp/MainPage.xaml.cs#SnippetGetDeviceSelector)] + +[!code-js[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/javascript/default.js#SnippetGetDeviceSelector)] + +[!code-vb[GetDeviceSelector](../windows.networking.proximity/code/Proximity_GetDeviceSelector1/vbnet/MainPage.xaml.vb#SnippetGetDeviceSelector)] + +## -see-also +[DeviceId](proximitydevice_deviceid.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_publishbinarymessage_285088637.md b/windows.networking.proximity/proximitydevice_publishbinarymessage_285088637.md index f03339a42d..a7fc820ee4 100644 --- a/windows.networking.proximity/proximitydevice_publishbinarymessage_285088637.md +++ b/windows.networking.proximity/proximitydevice_publishbinarymessage_285088637.md @@ -1,111 +1,112 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage(System.String,Windows.Storage.Streams.IBuffer) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage - -## -description -Publishes a message that contains binary data to subscribers of the specified message type. - -## -parameters -### -param messageType -The type of message to deliver to subscribers. - -### -param message -The binary message data to deliver to subscribers. - -## -returns -A unique publication ID for the published message. - -## -remarks -You can publish multiple messages of the same message type and each publication will have a unique ID associated with it. - -You can stop publishing a message by passing the publication ID returned by the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. - -Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) is released. - -You can subscribe to published messages using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. - -You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. - - - -> [!IMPORTANT] -> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. - -### Message Types - -You use the *messageType* parameter to supply an identifier that uniquely identifies the published message, and also defines the meaning of the message and the intended subscriber audience. - -Message type values are case-sensitive strings that consist of two parts: the *protocol* and the *subtype*. The *protocol* is first, followed by a dot (.) and then the subtype. The *subtype* is a string of alphanumeric characters and any of the valid URI characters as defined by RFC 3986: **- . _~ : / ? # [ ] @ ! $ & ‘ ( ) * + , ; = %**. The *subtype* cannot exceed a length of 250 characters. The following table shows the supported values for the *protocol* part of the message type. - -WindowsThe message contains binary data.WindowsUriThe message data contains a UTF-16LE encoded string that is a Uniform Resource Identifier (URI). - -Windows will always handle "WindowsUri" messages by prompting the user to view a received URI that in the Windows default app that handles a specific URI protocol, for example, **http://** URIs open in the default web browser. Windows will open a URI in the default app even if another app is also subscribed to "WindowsUri". - -Instead of calling the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method with this protocol, use the [PublishUriMessage](proximitydevice_publishurimessage.md) method. - -If you publish a Uri to a computer that is not running Windows, the Uri is automatically formatted based on the proximity technology that your computer supports. For example, if your computer uses NFC hardware for proximity, then the Uri is formatted as an NDEF URI record. - -If you are subscribing for a "WindowsUri" message and your Windows computer receives a message formatted for the proximity technology that your computer supports, Windows reads the formatted message and returns only the Uri as the message content.WindowsMimeThe message data is of a specific mime type. For example, if the message data is a jpeg image, the message type is "WindowsMime.image/jpeg". - -Windows will always handle "WindowsMime" messages by prompting the user to view the mime content that was received, even if an app is also subscribed for the mime content. - -If you publish a "WindowsMime" message to a computer that is not running Windows, the message content is automatically formatted based on the proximity technology that your computer supports. For example, if your computer uses NFC hardware for proximity, then the message content is formatted as an NDEF Mime record. - -If you are publishing a "WindowsMime" message, you must always include the mime type. If you are subscribing to a "WindowsMime" message, you can use "WindowsMime" without specifying the mime type to subscribe for all mime types. If you subscribe to a specific mime type and your Windows computer receives a message formatted for the proximity technology that your computer supports, Windows reads the formatted message and returns only the mime content as the message content. If you subscribe for all mime types, the first 256 bytes received is the ASCII mime type string, and the remaining bytes are the mime content.Windows:WriteTagThis is the same as the **Windows** protocol, except that the content is intended to be written to a static tag. The message is not transmitted to any device except a writable static tag. This protocol is only valid for publications. An example of this protocol is "Windows:WriteTag.SampleSubtype".WindowsUri:WriteTagThis is the same as the **WindowsUri** protocol, except that the content is intended to be written to a static tag. The message is not transmitted to any device except a writable static tag. This protocol is only valid for publications.WindowsMime:WriteTagThis is the same as the **WindowsMime** protocol, except that the content is intended to be written to a static tag. The message is not transmitted to any device except a writable static tag. This protocol is only valid for publications. An example of this protocol is "WindowsMime:WriteTag.image/jpeg".LaunchApp:WriteTagWrite a tag that can be used to launch a specific app with optional launch parameters. If you publish a **LaunchApp:WriteTag** message to a tag the result when that tag is tapped to a computer is the same as calling the [PeerFinder.Start](peerfinder_start.md) method and passing your launch parameters. The message must be a UTF-16LE encoded string where the values are delimited by tab characters or null values in the following form: - -```text -[tab][tab]...[tab][tab] -``` - -The launch arguments are optional. The message can omit them: - -```text -[tab]...[tab][tab] -``` - -You must specify at least one app platform and app name. The app platform for a Windows 8 computer is **Windows**. The format of the proximity app Id is **<package family name>!<app Id>**. You can get the package family name from the [Windows.ApplicationModel.Package.Current.Id.FamilyName](../windows.applicationmodel/packageid_familyname.md) property. You must copy the app Id value from the **Id** attribute of the **Application** element in the package manifest for your app. An example of this message is "user=default\tWindows\tExample.Proximity.JS_8wekyb3d8bbwe!Proximity.App". - -You can also support other app platforms. For more information, see [AlternateIdentities](peerfinder_alternateidentities.md).WriteableTagWhen subscribing for this message protocol, if a writeable tag is brought in to proximity, a proximity message is received that contains an **int32** (little endian) indicating the maximum writeable size of the tag. This protocol is only valid for subscriptions.Pairing:BluetoothWindows subscribes to this message type to complete a Bluetooth pairing using proximity. This protocol is not intended to be uses in apps.NDEFThe message contents are properly formatted NDEF records. The underlying type of the content for a publication using NDEF as the message type is contained in the NDEF records. A subscription for the NDEF type subscribes to all NDEF formatted messages.NDEF:extThe message data is application defined NDEF records (TNF field value of 0x04). - -This protocol will launch a properly configured application to handle these events if there is no running application already subscribing to these events. To designate an app to handle a particular protocol using NDEF:ext, you must add a Protocol tag to the app manifest to specify the URI that will launch the app. The appropriate manifest syntax is demonstrated in the following example. - -```xml - - - - - - - -``` - -> [!NOTE] -> The URI format used in the app manifest is slightly different from the URI format used on the NFC tag, in that the manifest URI uses a '**+** ' character rather than a '**:** ' character. The URI on the NFC tag that activates the app with the manifest sample above is contoso.com:testapp.NDEF:MIMEThe message data is a properly formatted NDEF mime message (TNF field value of 0x02). For example, "NDEF:MIME.image/jpeg". This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**.NDEF:URIThe message data is a properly formatted NDEF message of a type defined by a URI namespace (TNF field value of 0x03).This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**. This means that the data format is identified by the specified URI. An example of this protocol is "NDEF:URI.http://contoso.com/sometype".NDEF:wktThe message data is a properly formatted NDEF message of a type defined by the NFC forum (TNF field value of 0x01).An example of this type is "NDEF:wkt.U" for the well known type of URI. This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**.NDEF:WriteTagThe message data should be written to an NFC forum standard static tag. The message data must be in a proper NDEF format. This protocol is only valid for publications.NDEF:UnknownThe message data is an untyped NDEF message (TNF field value of 0x05).This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**. - -## -examples - - -[!code-csharp[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/csharp/MainPage.xaml.cs#SnippetLaunchAppWriteTag2)] - -[!code-js[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/js/default.js#SnippetLaunchAppWriteTag2)] - -[!code-vb[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/vbnet/MainPage.xaml.vb#SnippetLaunchAppWriteTag2)] - -[!code-csharp[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/csharp/MainPage.xaml.cs#SnippetLaunchAppWriteTag2)] - -[!code-js[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/js/default.js#SnippetLaunchAppWriteTag2)] - -[!code-vb[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/vbnet/MainPage.xaml.vb#SnippetLaunchAppWriteTag2)] - -## -see-also -[PublishBinaryMessage(String, IBuffer, MessageTransmittedHandler)](proximitydevice_publishbinarymessage_374148007.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage(System.String,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage + +## -description +Publishes a message that contains binary data to subscribers of the specified message type. + +## -parameters +### -param messageType +The type of message to deliver to subscribers. + +### -param message +The binary message data to deliver to subscribers. + +## -returns +A unique publication ID for the published message. + +## -remarks +You can publish multiple messages of the same message type and each publication will have a unique ID associated with it. + +You can stop publishing a message by passing the publication ID returned by the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. + +Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) is released. + +You can subscribe to published messages using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. + +You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. + + + +> [!IMPORTANT] +> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. + +### Message Types + +You use the *messageType* parameter to supply an identifier that uniquely identifies the published message, and also defines the meaning of the message and the intended subscriber audience. + +Message type values are case-sensitive strings that consist of two parts: the *protocol* and the *subtype*. The *protocol* is first, followed by a dot (.) and then the subtype. The *subtype* is a string of alphanumeric characters and any of the valid URI characters as defined by RFC 3986: **- . _~ : / ? # [ ] @ ! $ & ‘ ( ) * + , ; = %**. The *subtype* cannot exceed a length of 250 characters. The following table shows the supported values for the *protocol* part of the message type. + +WindowsThe message contains binary data.WindowsUriThe message data contains a UTF-16LE encoded string that is a Uniform Resource Identifier (URI). + +Windows will always handle "WindowsUri" messages by prompting the user to view a received URI that in the Windows default app that handles a specific URI protocol, for example, **http://** URIs open in the default web browser. Windows will open a URI in the default app even if another app is also subscribed to "WindowsUri". + +Instead of calling the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method with this protocol, use the [PublishUriMessage](proximitydevice_publishurimessage.md) method. + +If you publish a Uri to a computer that is not running Windows, the Uri is automatically formatted based on the proximity technology that your computer supports. For example, if your computer uses NFC hardware for proximity, then the Uri is formatted as an NDEF URI record. + +If you are subscribing for a "WindowsUri" message and your Windows computer receives a message formatted for the proximity technology that your computer supports, Windows reads the formatted message and returns only the Uri as the message content.WindowsMimeThe message data is of a specific mime type. For example, if the message data is a jpeg image, the message type is "WindowsMime.image/jpeg". + +Windows will always handle "WindowsMime" messages by prompting the user to view the mime content that was received, even if an app is also subscribed for the mime content. + +If you publish a "WindowsMime" message to a computer that is not running Windows, the message content is automatically formatted based on the proximity technology that your computer supports. For example, if your computer uses NFC hardware for proximity, then the message content is formatted as an NDEF Mime record. + +If you are publishing a "WindowsMime" message, you must always include the mime type. If you are subscribing to a "WindowsMime" message, you can use "WindowsMime" without specifying the mime type to subscribe for all mime types. If you subscribe to a specific mime type and your Windows computer receives a message formatted for the proximity technology that your computer supports, Windows reads the formatted message and returns only the mime content as the message content. If you subscribe for all mime types, the first 256 bytes received is the ASCII mime type string, and the remaining bytes are the mime content.Windows:WriteTagThis is the same as the **Windows** protocol, except that the content is intended to be written to a static tag. The message is not transmitted to any device except a writable static tag. This protocol is only valid for publications. An example of this protocol is "Windows:WriteTag.SampleSubtype".WindowsUri:WriteTagThis is the same as the **WindowsUri** protocol, except that the content is intended to be written to a static tag. The message is not transmitted to any device except a writable static tag. This protocol is only valid for publications.WindowsMime:WriteTagThis is the same as the **WindowsMime** protocol, except that the content is intended to be written to a static tag. The message is not transmitted to any device except a writable static tag. This protocol is only valid for publications. An example of this protocol is "WindowsMime:WriteTag.image/jpeg".LaunchApp:WriteTagWrite a tag that can be used to launch a specific app with optional launch parameters. If you publish a **LaunchApp:WriteTag** message to a tag the result when that tag is tapped to a computer is the same as calling the [PeerFinder.Start](peerfinder_start.md) method and passing your launch parameters. The message must be a UTF-16LE encoded string where the values are delimited by tab characters or null values in the following form: + +```text +[tab][tab]...[tab][tab] +``` + +The launch arguments are optional. The message can omit them: + +```text +[tab]...[tab][tab] +``` + +You must specify at least one app platform and app name. The app platform for a Windows 8 computer is **Windows**. The format of the proximity app Id is **<package family name>!<app Id>**. You can get the package family name from the [Windows.ApplicationModel.Package.Current.Id.FamilyName](../windows.applicationmodel/packageid_familyname.md) property. You must copy the app Id value from the **Id** attribute of the **Application** element in the package manifest for your app. An example of this message is "user=default\tWindows\tExample.Proximity.JS_8wekyb3d8bbwe!Proximity.App". + +You can also support other app platforms. For more information, see [AlternateIdentities](peerfinder_alternateidentities.md).WriteableTagWhen subscribing for this message protocol, if a writeable tag is brought in to proximity, a proximity message is received that contains an **int32** (little endian) indicating the maximum writeable size of the tag. This protocol is only valid for subscriptions.Pairing:BluetoothWindows subscribes to this message type to complete a Bluetooth pairing using proximity. This protocol is not intended to be uses in apps.NDEFThe message contents are properly formatted NDEF records. The underlying type of the content for a publication using NDEF as the message type is contained in the NDEF records. A subscription for the NDEF type subscribes to all NDEF formatted messages.NDEF:extThe message data is application defined NDEF records (TNF field value of 0x04). + +This protocol will launch a properly configured application to handle these events if there is no running application already subscribing to these events. To designate an app to handle a particular protocol using NDEF:ext, you must add a Protocol tag to the app manifest to specify the URI that will launch the app. The appropriate manifest syntax is demonstrated in the following example. + +```xml + + + + + + + +``` + +> [!NOTE] +> The URI format used in the app manifest is slightly different from the URI format used on the NFC tag, in that the manifest URI uses a '**+** ' character rather than a '**:** ' character. The URI on the NFC tag that activates the app with the manifest sample above is contoso.com:testapp.NDEF:MIMEThe message data is a properly formatted NDEF mime message (TNF field value of 0x02). For example, "NDEF:MIME.image/jpeg". This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**.NDEF:URIThe message data is a properly formatted NDEF message of a type defined by a URI namespace (TNF field value of 0x03).This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**. This means that the data format is identified by the specified URI. An example of this protocol is "NDEF:URI.http://contoso.com/sometype".NDEF:wktThe message data is a properly formatted NDEF message of a type defined by the NFC forum (TNF field value of 0x01).An example of this type is "NDEF:wkt.U" for the well known type of URI. This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**.NDEF:WriteTagThe message data should be written to an NFC forum standard static tag. The message data must be in a proper NDEF format. This protocol is only valid for publications.NDEF:UnknownThe message data is an untyped NDEF message (TNF field value of 0x05).This protocol only applies to subscriptions, when publishing NDEF content, use **NDEF**. + +## -examples + + +[!code-csharp[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/csharp/MainPage.xaml.cs#SnippetLaunchAppWriteTag2)] + +[!code-js[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/js/default.js#SnippetLaunchAppWriteTag2)] + +[!code-vb[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/vbnet/MainPage.xaml.vb#SnippetLaunchAppWriteTag2)] + +[!code-csharp[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/csharp/MainPage.xaml.cs#SnippetLaunchAppWriteTag2)] + +[!code-js[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/js/default.js#SnippetLaunchAppWriteTag2)] + +[!code-vb[LaunchAppWriteTag2](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/vbnet/MainPage.xaml.vb#SnippetLaunchAppWriteTag2)] + +## -see-also +[PublishBinaryMessage(String, IBuffer, MessageTransmittedHandler)](proximitydevice_publishbinarymessage_374148007.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_publishbinarymessage_374148007.md b/windows.networking.proximity/proximitydevice_publishbinarymessage_374148007.md index 5f56e64d1f..14a342d3b8 100644 --- a/windows.networking.proximity/proximitydevice_publishbinarymessage_374148007.md +++ b/windows.networking.proximity/proximitydevice_publishbinarymessage_374148007.md @@ -1,64 +1,65 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage(System.String,Windows.Storage.Streams.IBuffer,Windows.Networking.Proximity.MessageTransmittedHandler) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage - -## -description -Publishes a message that contains binary data to subscribers of the specified message type. The specified handler is called when the message has been transmitted. - -## -parameters -### -param messageType -The type of message to deliver to subscribers. - -### -param message -The binary message data to deliver to subscribers. - -### -param messageTransmittedHandler -The handler to call when the message has been transmitted. - -## -returns -A unique publication ID for the published message. - -## -remarks -You can publish multiple messages of the same message type and each publication will have a unique ID associated with it. - -You can stop publishing a message by passing the publication ID returned by the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. - -Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) is released. - -You can subscribe to published messages using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. - -You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. - - - -> [!IMPORTANT] -> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. - - - - -### Message Types - -For details on the types of messages that you can publish with the [PublishBinaryMessage(String, IBuffer, MessageTransmittedHandler)](proximitydevice_publishbinarymessage_374148007.md) method, see the remarks in the [PublishBinaryMessage(String, IBuffer)](proximitydevice_publishbinarymessage_285088637.md) reference topic. - -## -examples - - -[!code-csharp[LaunchAppWriteTag1](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/csharp/MainPage.xaml.cs#SnippetLaunchAppWriteTag1)] - -[!code-js[LaunchAppWriteTag1](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/js/default.js#SnippetLaunchAppWriteTag1)] - -[!code-vb[LaunchAppWriteTag1](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/vbnet/MainPage.xaml.vb#SnippetLaunchAppWriteTag1)] - -## -see-also -[PublishBinaryMessage(String, IBuffer)](proximitydevice_publishbinarymessage_285088637.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage(System.String,Windows.Storage.Streams.IBuffer,Windows.Networking.Proximity.MessageTransmittedHandler) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.PublishBinaryMessage + +## -description +Publishes a message that contains binary data to subscribers of the specified message type. The specified handler is called when the message has been transmitted. + +## -parameters +### -param messageType +The type of message to deliver to subscribers. + +### -param message +The binary message data to deliver to subscribers. + +### -param messageTransmittedHandler +The handler to call when the message has been transmitted. + +## -returns +A unique publication ID for the published message. + +## -remarks +You can publish multiple messages of the same message type and each publication will have a unique ID associated with it. + +You can stop publishing a message by passing the publication ID returned by the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. + +Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) is released. + +You can subscribe to published messages using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. + +You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. + + + +> [!IMPORTANT] +> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. + + + + +### Message Types + +For details on the types of messages that you can publish with the [PublishBinaryMessage(String, IBuffer, MessageTransmittedHandler)](proximitydevice_publishbinarymessage_374148007.md) method, see the remarks in the [PublishBinaryMessage(String, IBuffer)](proximitydevice_publishbinarymessage_285088637.md) reference topic. + +## -examples + + +[!code-csharp[LaunchAppWriteTag1](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/csharp/MainPage.xaml.cs#SnippetLaunchAppWriteTag1)] + +[!code-js[LaunchAppWriteTag1](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/js/default.js#SnippetLaunchAppWriteTag1)] + +[!code-vb[LaunchAppWriteTag1](../windows.networking.proximity/code/Proximity_PublishBinaryMessage/vbnet/MainPage.xaml.vb#SnippetLaunchAppWriteTag1)] + +## -see-also +[PublishBinaryMessage(String, IBuffer)](proximitydevice_publishbinarymessage_285088637.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_publishmessage_1881696512.md b/windows.networking.proximity/proximitydevice_publishmessage_1881696512.md index 97ea426010..ed54a09626 100644 --- a/windows.networking.proximity/proximitydevice_publishmessage_1881696512.md +++ b/windows.networking.proximity/proximitydevice_publishmessage_1881696512.md @@ -1,64 +1,65 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishMessage(System.String,System.String) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.PublishMessage - -## -description -Publishes a message to subscribers of the specified message type. - -## -parameters -### -param messageType -The type of message to deliver to subscribers. - -### -param message -The message to deliver to subscribers. - -## -returns -A unique publication ID for the published message. Pass this value to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method to stop publishing the message. - -## -remarks -You can subscribe to published messages by using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. - -Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) object is released. - -Messages are delivered to all applications that have subscribed to the message type (as indicated by the *messageType* parameter). Message type values are case-sensitive strings that consist of two parts: the *protocol* and the subtype. The *protocol* is first, followed by a dot (.) and then the *subtype*. For the [PublishMessage](proximitydevice_publishmessage.md) method, the *protocol* must always be "Windows.". The *subtype* is a string of alphanumeric characters and the following additional characters: **. ( ) + , - : = @ ; $ _ ! * ’**. The *subtype* cannot exceed a length of 250 characters. - -To publish messages by using another message type, like “WindowsMime.” or “NDEF:WriteTag”, you must use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method. - -You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. - -Messages are converted to UTF-8 characters before they're transmitted. - -For Windows Store app, publications and subscriptions are active only if the calling app is in the foreground. - - - -> [!IMPORTANT] -> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. - -## -examples - - -[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] - -[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] - -[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] - -[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] - -[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] - -[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] - -## -see-also -[PublishMessage(String, String, MessageTransmittedHandler)](proximitydevice_publishmessage_1989900324.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), [PublishUriMessage](proximitydevice_publishurimessage.md), [StopPublishingMessage](proximitydevice_stoppublishingmessage.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishMessage(System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.PublishMessage + +## -description +Publishes a message to subscribers of the specified message type. + +## -parameters +### -param messageType +The type of message to deliver to subscribers. + +### -param message +The message to deliver to subscribers. + +## -returns +A unique publication ID for the published message. Pass this value to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method to stop publishing the message. + +## -remarks +You can subscribe to published messages by using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. + +Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) object is released. + +Messages are delivered to all applications that have subscribed to the message type (as indicated by the *messageType* parameter). Message type values are case-sensitive strings that consist of two parts: the *protocol* and the subtype. The *protocol* is first, followed by a dot (.) and then the *subtype*. For the [PublishMessage](proximitydevice_publishmessage.md) method, the *protocol* must always be "Windows.". The *subtype* is a string of alphanumeric characters and the following additional characters: **. ( ) + , - : = @ ; $ _ ! * ’**. The *subtype* cannot exceed a length of 250 characters. + +To publish messages by using another message type, like “WindowsMime.” or “NDEF:WriteTag”, you must use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method. + +You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. + +Messages are converted to UTF-8 characters before they're transmitted. + +For Windows Store app, publications and subscriptions are active only if the calling app is in the foreground. + + + +> [!IMPORTANT] +> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. + +## -examples + + +[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] + +[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] + +[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] + +[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] + +[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] + +[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] + +## -see-also +[PublishMessage(String, String, MessageTransmittedHandler)](proximitydevice_publishmessage_1989900324.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), [PublishUriMessage](proximitydevice_publishurimessage.md), [StopPublishingMessage](proximitydevice_stoppublishingmessage.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_publishmessage_1989900324.md b/windows.networking.proximity/proximitydevice_publishmessage_1989900324.md index 5f4a1d686c..e9388446f7 100644 --- a/windows.networking.proximity/proximitydevice_publishmessage_1989900324.md +++ b/windows.networking.proximity/proximitydevice_publishmessage_1989900324.md @@ -1,61 +1,62 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishMessage(System.String,System.String,Windows.Networking.Proximity.MessageTransmittedHandler) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.PublishMessage - -## -description -Publishes a message to subscribers of the specified message type. The specified handler is called when the message has been transmitted. - -## -parameters -### -param messageType -The type of message to deliver to subscribers. - -### -param message -The message to deliver to subscribers. - -### -param messageTransmittedHandler -The handler to call when the message has been transmitted. - -## -returns -A unique publication ID for the published message. - -## -remarks -You can subscribe to published messages by using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. - -Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) object is released. - -Messages are delivered to all applications that have subscribed to the message type (as indicated by the *messageType* parameter). Message type values are case-sensitive strings that consist of two parts: the *protocol* and the subtype. The *protocol* is first, followed by a dot (.) and then the *subtype*. For the [PublishMessage](proximitydevice_publishmessage.md) method, the *protocol* must always be "Windows.". The *subtype* is a string of alphanumeric characters and the following additional characters: **. ( ) + , - : = @ ; $ _ ! * ’**. The *subtype* cannot exceed a length of 250 characters. - -To publish messages by using another message type, like “WindowsMime.” or “NDEF:WriteTag”, you must use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method. - -You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. - -Messages are converted to UTF-8 characters before they're transmitted. - -For Windows Store app, publications and subscriptions are active only if the calling app is in the foreground. - - - -> [!IMPORTANT] -> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. - -## -examples - - -[!code-csharp[PublishSubscribe2](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe2)] - -[!code-js[PublishSubscribe2](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe2)] - -[!code-vb[PublishSubscribe2](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe2)] - -## -see-also -[PublishMessage(String, String)](proximitydevice_publishmessage_1881696512.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), [PublishUriMessage](proximitydevice_publishurimessage.md), [StopPublishingMessage](proximitydevice_stoppublishingmessage.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishMessage(System.String,System.String,Windows.Networking.Proximity.MessageTransmittedHandler) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.PublishMessage + +## -description +Publishes a message to subscribers of the specified message type. The specified handler is called when the message has been transmitted. + +## -parameters +### -param messageType +The type of message to deliver to subscribers. + +### -param message +The message to deliver to subscribers. + +### -param messageTransmittedHandler +The handler to call when the message has been transmitted. + +## -returns +A unique publication ID for the published message. + +## -remarks +You can subscribe to published messages by using the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. + +Messages continue to be published until the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method is called or the [ProximityDevice](proximitydevice.md) object is released. + +Messages are delivered to all applications that have subscribed to the message type (as indicated by the *messageType* parameter). Message type values are case-sensitive strings that consist of two parts: the *protocol* and the subtype. The *protocol* is first, followed by a dot (.) and then the *subtype*. For the [PublishMessage](proximitydevice_publishmessage.md) method, the *protocol* must always be "Windows.". The *subtype* is a string of alphanumeric characters and the following additional characters: **. ( ) + , - : = @ ; $ _ ! * ’**. The *subtype* cannot exceed a length of 250 characters. + +To publish messages by using another message type, like “WindowsMime.” or “NDEF:WriteTag”, you must use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method. + +You can use the [PublishUriMessage](proximitydevice_publishurimessage.md) method to publish a Uniform Resource Identifier (URI) to a proximate computer. + +Messages are converted to UTF-8 characters before they're transmitted. + +For Windows Store app, publications and subscriptions are active only if the calling app is in the foreground. + + + +> [!IMPORTANT] +> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. + +## -examples + + +[!code-csharp[PublishSubscribe2](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe2)] + +[!code-js[PublishSubscribe2](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe2)] + +[!code-vb[PublishSubscribe2](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe2)] + +## -see-also +[PublishMessage(String, String)](proximitydevice_publishmessage_1881696512.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), [PublishUriMessage](proximitydevice_publishurimessage.md), [StopPublishingMessage](proximitydevice_stoppublishingmessage.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_publishurimessage_632953271.md b/windows.networking.proximity/proximitydevice_publishurimessage_632953271.md index 6d6a88ad3b..6f5c15717f 100644 --- a/windows.networking.proximity/proximitydevice_publishurimessage_632953271.md +++ b/windows.networking.proximity/proximitydevice_publishurimessage_632953271.md @@ -1,69 +1,70 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishUriMessage(Windows.Foundation.Uri) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.PublishUriMessage - -## -description -Publishes a Uniform Resource Identifier (URI) to a proximate device. - -## -parameters -### -param message -The URI to publish. - -## -returns -The publication ID of the message. - -## -remarks -Only one URI can be published at a time for each proximity device. - -You can stop publishing a URI by passing the publication ID returned by the [PublishUriMessage](proximitydevice_publishurimessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. - -Unlike the other publish methods for a proximity device, URI publishing is handled by the default protocol handler for the URI. A subscription to a URI message publication is not required. You can receive URI messages by registering a default handler for a URI protocol such as the HTTP protocol. - -The PackageFamilyName value of the sending application is automatically sent along with the URI. If no handler is registered for the protocol of a URI, the PackageFamilyName value of the sending application is used to direct the receiving application to the application store. - -You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to publish non-text messages or messages that conform to the NDEF messaging standard. - - - -> [!IMPORTANT] -> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. - -## -examples - - -[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] - -[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] - -[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] - -[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] - -[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] - -[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] - -[!code-csharp[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetPublishSubscribeUri)] - -[!code-js[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetPublishSubscribeUri)] - -[!code-vb[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetPublishSubscribeUri)] - -[!code-csharp[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetPublishSubscribeUri)] - -[!code-js[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetPublishSubscribeUri)] - -[!code-vb[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetPublishSubscribeUri)] - -## -see-also -[PublishUriMessage(Uri, MessageTransmittedHandler)](proximitydevice_publishurimessage_652448219.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishUriMessage(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.PublishUriMessage + +## -description +Publishes a Uniform Resource Identifier (URI) to a proximate device. + +## -parameters +### -param message +The URI to publish. + +## -returns +The publication ID of the message. + +## -remarks +Only one URI can be published at a time for each proximity device. + +You can stop publishing a URI by passing the publication ID returned by the [PublishUriMessage](proximitydevice_publishurimessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. + +Unlike the other publish methods for a proximity device, URI publishing is handled by the default protocol handler for the URI. A subscription to a URI message publication is not required. You can receive URI messages by registering a default handler for a URI protocol such as the HTTP protocol. + +The PackageFamilyName value of the sending application is automatically sent along with the URI. If no handler is registered for the protocol of a URI, the PackageFamilyName value of the sending application is used to direct the receiving application to the application store. + +You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to publish non-text messages or messages that conform to the NDEF messaging standard. + + + +> [!IMPORTANT] +> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. + +## -examples + + +[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] + +[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] + +[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] + +[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] + +[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] + +[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] + +[!code-csharp[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetPublishSubscribeUri)] + +[!code-js[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetPublishSubscribeUri)] + +[!code-vb[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetPublishSubscribeUri)] + +[!code-csharp[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetPublishSubscribeUri)] + +[!code-js[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetPublishSubscribeUri)] + +[!code-vb[PublishSubscribeUri](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetPublishSubscribeUri)] + +## -see-also +[PublishUriMessage(Uri, MessageTransmittedHandler)](proximitydevice_publishurimessage_652448219.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_publishurimessage_652448219.md b/windows.networking.proximity/proximitydevice_publishurimessage_652448219.md index 593d19323c..2075d145b8 100644 --- a/windows.networking.proximity/proximitydevice_publishurimessage_652448219.md +++ b/windows.networking.proximity/proximitydevice_publishurimessage_652448219.md @@ -1,66 +1,68 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishUriMessage(Windows.Foundation.Uri,Windows.Networking.Proximity.MessageTransmittedHandler) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.PublishUriMessage - -## -description -Publishes a Uniform Resource Identifier (URI) to a proximate device. The specified handler is called when the message has been transmitted. - -## -parameters -### -param message -The URI to publish. - -### -param messageTransmittedHandler -The handler to call when the message has been transmitted. - -## -returns -The publication ID of the message. - -## -remarks -Only one URI can be published at a time for each proximity device. - -You can stop publishing a URI by passing the publication ID returned by the [PublishUriMessage](proximitydevice_publishurimessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. - -Unlike the other publish methods for a proximity device, URI publishing is handled by the default protocol handler for the URI. A subscription to a URI message publication is not required. You can receive URI messages by registering a default handler for a URI protocol such as the HTTP protocol. - -The PackageFamilyName value of the sending application is automatically sent along with the URI. If no handler is registered for the protocol of a URI, the PackageFamilyName value of the sending application is used to direct the receiving application to the application store. - -You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to publish non-text messages or messages that conform to the NDEF messaging standard. - - - -> [!IMPORTANT] -> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. - -## -examples - - -[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] - -[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] - -[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] - -[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] - -[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] - -[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] - -[!code-csharp[PublishSubscribeUri2](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetPublishSubscribeUri2)] - -[!code-js[PublishSubscribeUri2](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetPublishSubscribeUri2)] - -[!code-vb[PublishSubscribeUri2](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetPublishSubscribeUri2)] - -## -see-also -[PublishUriMessage(Uri)](proximitydevice_publishurimessage_632953271.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.PublishUriMessage(Windows.Foundation.Uri,Windows.Networking.Proximity.MessageTransmittedHandler) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.PublishUriMessage + +## -description +Publishes a Uniform Resource Identifier (URI) to a proximate device. The specified handler is called when the message has been transmitted. + +## -parameters +### -param message +The URI to publish. + +### -param messageTransmittedHandler +The handler to call when the message has been transmitted. + +## -returns +The publication ID of the message. + +## -remarks +Only one URI can be published at a time for each proximity device. + +You can stop publishing a URI by passing the publication ID returned by the [PublishUriMessage](proximitydevice_publishurimessage.md) method to the [StopPublishingMessage](proximitydevice_stoppublishingmessage.md) method. + +Unlike the other publish methods for a proximity device, URI publishing is handled by the default protocol handler for the URI. A subscription to a URI message publication is not required. You can receive URI messages by registering a default handler for a URI protocol such as the HTTP protocol. + +The PackageFamilyName value of the sending application is automatically sent along with the URI. If no handler is registered for the protocol of a URI, the PackageFamilyName value of the sending application is used to direct the receiving application to the application store. + +You can use the [PublishMessage](proximitydevice_publishmessage.md) method to publish a text message to a proximate computer. You can use the [PublishBinaryMessage](proximitydevice_publishbinarymessage.md) method to publish non-text messages or messages that conform to the NDEF messaging standard. + + + +> [!IMPORTANT] +> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. + +## -examples + + +[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] + +[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] + +[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] + +[!code-csharp[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetInitialize)] + +[!code-js[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetInitialize)] + +[!code-vb[Initialize](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetInitialize)] + +[!code-csharp[PublishSubscribeUri2](../windows.networking.proximity/code/Proximity_PublishUri/csharp/MainPage.xaml.cs#SnippetPublishSubscribeUri2)] + +[!code-js[PublishSubscribeUri2](../windows.networking.proximity/code/Proximity_PublishUri/js/default.js#SnippetPublishSubscribeUri2)] + +[!code-vb[PublishSubscribeUri2](../windows.networking.proximity/code/Proximity_PublishUri/vbnet/MainPage.xaml.vb#SnippetPublishSubscribeUri2)] + +## -see-also +[PublishUriMessage(Uri)](proximitydevice_publishurimessage_632953271.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + + + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_stoppublishingmessage_1046474884.md b/windows.networking.proximity/proximitydevice_stoppublishingmessage_1046474884.md index 3edb58c9f4..2543a7cd3f 100644 --- a/windows.networking.proximity/proximitydevice_stoppublishingmessage_1046474884.md +++ b/windows.networking.proximity/proximitydevice_stoppublishingmessage_1046474884.md @@ -1,35 +1,36 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.StopPublishingMessage(System.Int64) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.StopPublishingMessage - -## -description -Stops publishing a message. - -## -parameters -### -param messageId -The publication ID for the message. - -## -remarks -The publication ID for a message is returned from the [PublishMessage](proximitydevice_publishmessage.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), and [PublishUriMessage](proximitydevice_publishurimessage.md) methods. - -## -examples - - -[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] - -[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] - -[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.StopPublishingMessage(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.StopPublishingMessage + +## -description +Stops publishing a message. + +## -parameters +### -param messageId +The publication ID for the message. + +## -remarks +The publication ID for a message is returned from the [PublishMessage](proximitydevice_publishmessage.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), and [PublishUriMessage](proximitydevice_publishurimessage.md) methods. + +## -examples + + +[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] + +[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] + +[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_stopsubscribingformessage_728466472.md b/windows.networking.proximity/proximitydevice_stopsubscribingformessage_728466472.md index 3b490ece05..d76cfe2204 100644 --- a/windows.networking.proximity/proximitydevice_stopsubscribingformessage_728466472.md +++ b/windows.networking.proximity/proximitydevice_stopsubscribingformessage_728466472.md @@ -1,35 +1,36 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.StopSubscribingForMessage(System.Int64) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.StopSubscribingForMessage - -## -description -Cancels a message subscription. - -## -parameters -### -param subscriptionId -The subscription ID for the message. - -## -remarks -The subscription ID for a message subscription is returned from the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. - -## -examples - - -[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] - -[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] - -[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.StopSubscribingForMessage(System.Int64) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.StopSubscribingForMessage + +## -description +Cancels a message subscription. + +## -parameters +### -param subscriptionId +The subscription ID for the message. + +## -remarks +The subscription ID for a message subscription is returned from the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method. + +## -examples + + +[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] + +[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] + +[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitydevice_subscribeformessage_2022774312.md b/windows.networking.proximity/proximitydevice_subscribeformessage_2022774312.md index 8e9c4fc92b..ea4ca9c423 100644 --- a/windows.networking.proximity/proximitydevice_subscribeformessage_2022774312.md +++ b/windows.networking.proximity/proximitydevice_subscribeformessage_2022774312.md @@ -1,50 +1,51 @@ ---- --api-id: M:Windows.Networking.Proximity.ProximityDevice.SubscribeForMessage(System.String,Windows.Networking.Proximity.MessageReceivedHandler) --api-type: winrt method ---- - - - -# Windows.Networking.Proximity.ProximityDevice.SubscribeForMessage - -## -description -Creates a subscription for a specified message type. - -## -parameters -### -param messageType -The type of message to deliver to this subscription. - -### -param messageReceivedHandler -The handler that the proximity provider will call when it delivers a message. - -## -returns -A unique ID for the subscription. - -## -remarks -After your app calls the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method, it will receive messages that are published with the same message type (as indicated by the *messageType* parameter) from any proximate devices. For details on the different message types, see the remarks in the [PublishBinaryMessage(String, IBuffer)](proximitydevice_publishbinarymessage_285088637.md) reference topic. - -You can cancel a subscription by passing the subscription ID that's returned by the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method to the [StopSubscribingForMessage](proximitydevice_stopsubscribingformessage.md) method. - -You can publish a message to a subscriber by using the [PublishMessage](proximitydevice_publishmessage.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), or [PublishUriMessage](proximitydevice_publishurimessage.md) method. - - - -> [!IMPORTANT] -> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. - -## -examples - - -[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] - -[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] - -[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: M:Windows.Networking.Proximity.ProximityDevice.SubscribeForMessage(System.String,Windows.Networking.Proximity.MessageReceivedHandler) +-api-type: winrt method +--- + + + +# Windows.Networking.Proximity.ProximityDevice.SubscribeForMessage + +## -description +Creates a subscription for a specified message type. + +## -parameters +### -param messageType +The type of message to deliver to this subscription. + +### -param messageReceivedHandler +The handler that the proximity provider will call when it delivers a message. + +## -returns +A unique ID for the subscription. + +## -remarks +After your app calls the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method, it will receive messages that are published with the same message type (as indicated by the *messageType* parameter) from any proximate devices. For details on the different message types, see the remarks in the [PublishBinaryMessage(String, IBuffer)](proximitydevice_publishbinarymessage_285088637.md) reference topic. + +You can cancel a subscription by passing the subscription ID that's returned by the [SubscribeForMessage](proximitydevice_subscribeformessage.md) method to the [StopSubscribingForMessage](proximitydevice_stopsubscribingformessage.md) method. + +You can publish a message to a subscriber by using the [PublishMessage](proximitydevice_publishmessage.md), [PublishBinaryMessage](proximitydevice_publishbinarymessage.md), or [PublishUriMessage](proximitydevice_publishurimessage.md) method. + + + +> [!IMPORTANT] +> The proximity APIs do not provide authentication, encryption, or message integrity. Do not use proximity to exchange user sensitive information such as passwords, financial data, text messages, email, photographs, or government id numbers. + +## -examples + + +[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] + +[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] + +[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitymessage.md b/windows.networking.proximity/proximitymessage.md index 84fcb639bf..bc5332cf45 100644 --- a/windows.networking.proximity/proximitymessage.md +++ b/windows.networking.proximity/proximitymessage.md @@ -29,3 +29,4 @@ Messages published using the [PublishMessage](proximitydevice_publishmessage.md) ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/proximitymessage_dataasstring.md b/windows.networking.proximity/proximitymessage_dataasstring.md index 24c73e8fc9..1e6ef608ef 100644 --- a/windows.networking.proximity/proximitymessage_dataasstring.md +++ b/windows.networking.proximity/proximitymessage_dataasstring.md @@ -1,34 +1,35 @@ ---- --api-id: P:Windows.Networking.Proximity.ProximityMessage.DataAsString --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.ProximityMessage.DataAsString - -## -description -Gets the message data as text. - -## -property-value -The message data as text. - -## -remarks -The [DataAsString](proximitymessage_dataasstring.md) property is available only if the binary data of the message contains only text (UTF8) characters. Otherwise, the [DataAsString](proximitymessage_dataasstring.md) property returns unpredictable results. You should not attempt to use the [DataAsString](proximitymessage_dataasstring.md) property unless you are certain the data was received as UTF8 encoded characters. You can send a message as UTF8 encoded characters using the [PublishMessage](proximitydevice_publishmessage.md) method. - -## -examples - - -[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] - -[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] - -[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] - -## -see-also -[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.ProximityMessage.DataAsString +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.ProximityMessage.DataAsString + +## -description +Gets the message data as text. + +## -property-value +The message data as text. + +## -remarks +The [DataAsString](proximitymessage_dataasstring.md) property is available only if the binary data of the message contains only text (UTF8) characters. Otherwise, the [DataAsString](proximitymessage_dataasstring.md) property returns unpredictable results. You should not attempt to use the [DataAsString](proximitymessage_dataasstring.md) property unless you are certain the data was received as UTF8 encoded characters. You can send a message as UTF8 encoded characters using the [PublishMessage](proximitydevice_publishmessage.md) method. + +## -examples + + +[!code-csharp[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetPublishSubscribe)] + +[!code-js[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetPublishSubscribe)] + +[!code-vb[PublishSubscribe](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetPublishSubscribe)] + +## -see-also +[Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/triggeredconnectionstatechangedeventargs.md b/windows.networking.proximity/triggeredconnectionstatechangedeventargs.md index e4f362193e..195391b001 100644 --- a/windows.networking.proximity/triggeredconnectionstatechangedeventargs.md +++ b/windows.networking.proximity/triggeredconnectionstatechangedeventargs.md @@ -28,3 +28,4 @@ Contains properties that the [TriggeredConnectionStateChanged](peerfinder_trigge ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/triggeredconnectionstatechangedeventargs_socket.md b/windows.networking.proximity/triggeredconnectionstatechangedeventargs_socket.md index e52652ddcf..4af75d10cb 100644 --- a/windows.networking.proximity/triggeredconnectionstatechangedeventargs_socket.md +++ b/windows.networking.proximity/triggeredconnectionstatechangedeventargs_socket.md @@ -1,34 +1,35 @@ ---- --api-id: P:Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.Socket --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.Socket - -## -description -Gets the [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) instance for the connection. - -## -property-value -The [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) instance for the connection. - -## -remarks -The [Socket](triggeredconnectionstatechangedeventargs_socket.md) property is null until a successful connection has been completed. When a successful connection is completed, [State](triggeredconnectionstatechangedeventargs_state.md) equals **Completed**. - -## -examples - - -[!code-csharp[Connect](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetConnect)] - -[!code-js[Connect](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetConnect)] - -[!code-vb[Connect](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetConnect)] - -## -see-also -[TriggeredConnectionStateChanged](peerfinder_triggeredconnectionstatechanged.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.Socket +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.Socket + +## -description +Gets the [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) instance for the connection. + +## -property-value +The [StreamSocket](../windows.networking.sockets/streamsocket_streamsocket.md) instance for the connection. + +## -remarks +The [Socket](triggeredconnectionstatechangedeventargs_socket.md) property is null until a successful connection has been completed. When a successful connection is completed, [State](triggeredconnectionstatechangedeventargs_state.md) equals **Completed**. + +## -examples + + +[!code-csharp[Connect](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetConnect)] + +[!code-js[Connect](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetConnect)] + +[!code-vb[Connect](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetConnect)] + +## -see-also +[TriggeredConnectionStateChanged](peerfinder_triggeredconnectionstatechanged.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/triggeredconnectionstatechangedeventargs_state.md b/windows.networking.proximity/triggeredconnectionstatechangedeventargs_state.md index dea3852a54..132170c789 100644 --- a/windows.networking.proximity/triggeredconnectionstatechangedeventargs_state.md +++ b/windows.networking.proximity/triggeredconnectionstatechangedeventargs_state.md @@ -1,33 +1,34 @@ ---- --api-id: P:Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.State --api-type: winrt property ---- - - - -# Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.State - -## -description -Gets the state of the connection in progress. - -## -property-value -The state of the connection in progress. - -## -remarks - -## -examples - - -[!code-csharp[Connect](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetConnect)] - -[!code-js[Connect](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetConnect)] - -[!code-vb[Connect](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetConnect)] - -## -see-also -[TriggeredConnectionStateChanged](peerfinder_triggeredconnectionstatechanged.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) - -## -capabilities -proximity, ID_CAP_PROXIMITY [Windows Phone] +--- +-api-id: P:Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Networking.Proximity.TriggeredConnectionStateChangedEventArgs.State + +## -description +Gets the state of the connection in progress. + +## -property-value +The state of the connection in progress. + +## -remarks + +## -examples + + +[!code-csharp[Connect](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetConnect)] + +[!code-js[Connect](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetConnect)] + +[!code-vb[Connect](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetConnect)] + +## -see-also +[TriggeredConnectionStateChanged](peerfinder_triggeredconnectionstatechanged.md), [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) + +## -capabilities +proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/triggeredconnectstate.md b/windows.networking.proximity/triggeredconnectstate.md index 00f668c92a..3491412aef 100644 --- a/windows.networking.proximity/triggeredconnectstate.md +++ b/windows.networking.proximity/triggeredconnectstate.md @@ -48,3 +48,4 @@ An error prevented a successful connection. ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.proximity/windows_networking_proximity.md b/windows.networking.proximity/windows_networking_proximity.md index 9e8815f2d3..1bde5ad8eb 100644 --- a/windows.networking.proximity/windows_networking_proximity.md +++ b/windows.networking.proximity/windows_networking_proximity.md @@ -21,14 +21,23 @@ This example shows how you can use the [ProximityDevice](proximitydevice.md) cla +<<<<<<< HEAD [!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] [!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] [!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] +======= +[!code-csharp[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/csharp/MainPage.xaml.cs#SnippetArriveDepart)] + +[!code-js[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/js/default.js#SnippetArriveDepart)] + +[!code-vb[ArriveDepart](../windows.networking.proximity/code/ProximityReferenceSample/vbnet/MainPage.xaml.vb#SnippetArriveDepart)] +>>>>>>> master ## -see-also [Proximity and Tapping (JavaScript)](http://msdn.microsoft.com/library/84a30dcf-ef14-4a93-9e7c-7a3de867d46b), [Proximity and Tapping (C#/VB/C++)](http://msdn.microsoft.com/library/f25bb1df-1cfd-45cd-8c67-04eec73ebfbd), [Proximity sample](http://go.microsoft.com/fwlink/p/?linkid=245082) ## -capabilities proximity, ID_CAP_PROXIMITY [Windows Phone] + ID_CAP_PROXIMITY [Windows Phone] diff --git a/windows.networking.pushnotifications/pushnotificationchannel.md b/windows.networking.pushnotifications/pushnotificationchannel.md index fc2440eda9..351daf0144 100644 --- a/windows.networking.pushnotifications/pushnotificationchannel.md +++ b/windows.networking.pushnotifications/pushnotificationchannel.md @@ -20,7 +20,7 @@ This object is returned through an instance of the [IAsyncOperation](../windows. ## -examples ## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) ## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannel_close_811482585.md b/windows.networking.pushnotifications/pushnotificationchannel_close_811482585.md index 026f1c89ca..b812fe057d 100644 --- a/windows.networking.pushnotifications/pushnotificationchannel_close_811482585.md +++ b/windows.networking.pushnotifications/pushnotificationchannel_close_811482585.md @@ -1,26 +1,26 @@ ---- --api-id: M:Windows.Networking.PushNotifications.PushNotificationChannel.Close --api-type: winrt method ---- - - - -# Windows.Networking.PushNotifications.PushNotificationChannel.Close - -## -description -Explicitly invalidates this channel. Any notifications pushed to this channel after this method is called are not delivered. - -## -remarks -After it has been closed, the channel can never be used again. Channels that are closed through this method are no different than channels that have expired. To resume sending push notifications to this app, the app must request a new channel. - -Calling [Close](pushnotificationchannel_close.md) on a channel invalidates the underlying URI as well as any non-expired, non-closed URIs previously created for the app. - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: M:Windows.Networking.PushNotifications.PushNotificationChannel.Close +-api-type: winrt method +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannel.Close + +## -description +Explicitly invalidates this channel. Any notifications pushed to this channel after this method is called are not delivered. + +## -remarks +After it has been closed, the channel can never be used again. Channels that are closed through this method are no different than channels that have expired. To resume sending push notifications to this app, the app must request a new channel. + +Calling [Close](pushnotificationchannel_close.md) on a channel invalidates the underlying URI as well as any non-expired, non-closed URIs previously created for the app. + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannel_expirationtime.md b/windows.networking.pushnotifications/pushnotificationchannel_expirationtime.md index 53e5b22e19..0c3cf4b7ee 100644 --- a/windows.networking.pushnotifications/pushnotificationchannel_expirationtime.md +++ b/windows.networking.pushnotifications/pushnotificationchannel_expirationtime.md @@ -1,30 +1,30 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationChannel.ExpirationTime --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationChannel.ExpirationTime - -## -description -Gets the time at which the channel expires. Notifications sent to this channel after this time are rejected. - -## -property-value -The time at which the channel expires. Notifications sent to this channel after this time are rejected. - -## -remarks -To prevent a channel from expiring, apps should request a new push notification channel every time that the app is run. - -An expired channel behaves as though it was closed. Because channels cannot be renewed, after a channel expires, a secondary tile or application must request a new push notification channel. - - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationChannel.ExpirationTime +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannel.ExpirationTime + +## -description +Gets the time at which the channel expires. Notifications sent to this channel after this time are rejected. + +## -property-value +The time at which the channel expires. Notifications sent to this channel after this time are rejected. + +## -remarks +To prevent a channel from expiring, apps should request a new push notification channel every time that the app is run. + +An expired channel behaves as though it was closed. Because channels cannot be renewed, after a channel expires, a secondary tile or application must request a new push notification channel. + + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannel_pushnotificationreceived.md b/windows.networking.pushnotifications/pushnotificationchannel_pushnotificationreceived.md index 060287ae11..8ab867be1a 100644 --- a/windows.networking.pushnotifications/pushnotificationchannel_pushnotificationreceived.md +++ b/windows.networking.pushnotifications/pushnotificationchannel_pushnotificationreceived.md @@ -1,36 +1,36 @@ ---- --api-id: E:Windows.Networking.PushNotifications.PushNotificationChannel.PushNotificationReceived --api-type: winrt event ---- - - - -# Windows.Networking.PushNotifications.PushNotificationChannel.PushNotificationReceived - -## -description -Fires when a push notification has arrived on this channel. - - -## -remarks -Windows Push Notification Services (WNS) sends this event only when the notification's target app is in the foreground. If the app is suspended, it does not receive the event. - -## -examples -The following example shows a listener for this event, which invokes the event handler. - -```javascript - -function listeningForPushNotification() { - if (channel) { - channel.addEventListener("pushnotificationreceived", pushNotificationReceivedHandler); -} -``` - - - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: E:Windows.Networking.PushNotifications.PushNotificationChannel.PushNotificationReceived +-api-type: winrt event +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannel.PushNotificationReceived + +## -description +Fires when a push notification has arrived on this channel. + + +## -remarks +Windows Push Notification Services (WNS) sends this event only when the notification's target app is in the foreground. If the app is suspended, it does not receive the event. + +## -examples +The following example shows a listener for this event, which invokes the event handler. + +```javascript + +function listeningForPushNotification() { + if (channel) { + channel.addEventListener("pushnotificationreceived", pushNotificationReceivedHandler); +} +``` + + + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannel_uri.md b/windows.networking.pushnotifications/pushnotificationchannel_uri.md index 20cdbc2253..4708bafd13 100644 --- a/windows.networking.pushnotifications/pushnotificationchannel_uri.md +++ b/windows.networking.pushnotifications/pushnotificationchannel_uri.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationChannel.Uri --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationChannel.Uri - -## -description -Gets the Uniform Resource Identifier (URI) to which an app server sends a push notification intended for an application or secondary tile bound to this channel. This Uniform Resource Identifier (URI) is transmitted to and stored by the third-party app server. - -## -property-value -The Uniform Resource Identifier (URI) (https) that the app server uses to post notifications. - -## -remarks - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationChannel.Uri +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannel.Uri + +## -description +Gets the Uniform Resource Identifier (URI) to which an app server sends a push notification intended for an application or secondary tile bound to this channel. This Uniform Resource Identifier (URI) is transmitted to and stored by the third-party app server. + +## -property-value +The Uniform Resource Identifier (URI) (https) that the app server uses to post notifications. + +## -remarks + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannelmanager.md b/windows.networking.pushnotifications/pushnotificationchannelmanager.md index ca042fc0c0..289f6bf4a6 100644 --- a/windows.networking.pushnotifications/pushnotificationchannelmanager.md +++ b/windows.networking.pushnotifications/pushnotificationchannelmanager.md @@ -45,7 +45,7 @@ pushNotifications.PushNotificationChannelManager.createPushNotificationChannelFo ## -see-also -[PushNotificationChannel](pushnotificationchannel.md), [Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) +[PushNotificationChannel](pushnotificationchannel.md), [Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) ## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync_684392470.md b/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync_684392470.md index da2dd63d8d..4c400b7564 100644 --- a/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync_684392470.md +++ b/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync_684392470.md @@ -1,42 +1,42 @@ ---- --api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForApplicationAsync --api-type: winrt method ---- - - - -# Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForApplicationAsync - -## -description -Creates an object, bound to the calling app, through which you retrieve a push notification channel from Windows Push Notification Services (WNS). - -## -returns -The object, bound to the calling app, that is used to request a [PushNotificationChannel](pushnotificationchannel.md) from the Windows Push Notification Services (WNS). - -## -remarks -Tile update, toast, and badge notifications that arrive on this channel are delivered to the app's main or default tile. - -An exception is thrown if you attempt to register a WNS push notification channel when there is no data connection. For a list of error codes that can be received, see [CreatePushNotificationChannelForApplicationAsync](pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync.md). - -## -examples -The following example shows the use of this method to retrieve a channel for the calling app. - -```javascript - -var pushNotifications = Windows.Networking.PushNotifications; -var channel; - -function openNotificationsChannel() { - var channelOperation = pushNotifications.PushNotificationChannelManager.createPushNotificationChannelForApplicationAsync(); - return channelOperation.then(function (newChannel) { - channel = newChannel; - } -); -``` - - - -## -see-also -[CreatePushNotificationChannelForApplicationAsync(String)](pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync_1900738870.md), [Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) \ No newline at end of file +--- +-api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForApplicationAsync +-api-type: winrt method +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForApplicationAsync + +## -description +Creates an object, bound to the calling app, through which you retrieve a push notification channel from Windows Push Notification Services (WNS). + +## -returns +The object, bound to the calling app, that is used to request a [PushNotificationChannel](pushnotificationchannel.md) from the Windows Push Notification Services (WNS). + +## -remarks +Tile update, toast, and badge notifications that arrive on this channel are delivered to the app's main or default tile. + +An exception is thrown if you attempt to register a WNS push notification channel when there is no data connection. For a list of error codes that can be received, see [CreatePushNotificationChannelForApplicationAsync](pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync.md). + +## -examples +The following example shows the use of this method to retrieve a channel for the calling app. + +```javascript + +var pushNotifications = Windows.Networking.PushNotifications; +var channel; + +function openNotificationsChannel() { + var channelOperation = pushNotifications.PushNotificationChannelManager.createPushNotificationChannelForApplicationAsync(); + return channelOperation.then(function (newChannel) { + channel = newChannel; + } +); +``` + + + +## -see-also +[CreatePushNotificationChannelForApplicationAsync(String)](pushnotificationchannelmanager_createpushnotificationchannelforapplicationasync_1900738870.md), [Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforsecondarytileasync_233711584.md b/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforsecondarytileasync_233711584.md index d84d17c1a8..0082d9051c 100644 --- a/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforsecondarytileasync_233711584.md +++ b/windows.networking.pushnotifications/pushnotificationchannelmanager_createpushnotificationchannelforsecondarytileasync_233711584.md @@ -1,42 +1,42 @@ ---- --api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForSecondaryTileAsync(System.String) --api-type: winrt method ---- - - - -# Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForSecondaryTileAsync - -## -description -Creates an object, bound to a [secondary tile](../windows.ui.startscreen/secondarytile.md), through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The tile can be a secondary tile of the calling app or any other app in the same package. - -## -parameters -### -param tileId -The ID of the secondary tile to bind to the push notification channel. - -## -returns -The object, bound to the secondary tile, that is used to request a [PushNotificationChannel](pushnotificationchannel.md) from the Windows Push Notification Services (WNS). - -## -remarks -> [!NOTE] -> Channels bound to secondary tiles only accept push notifications for **Tile** and **Badge** update types. - -## -examples -This example shows the use of this method to retrieve a push notification channel for a secondary tile. - -```javascript - -var pushNotifications = Windows.Networking.PushNotifications; -var channel; - -pushNotifications.PushNotificationChannelManager.createPushNotificationChannelForSecondaryTileAsync(myTileId).then(function (channel) { - // Your code here. -}) -``` - - - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) \ No newline at end of file +--- +-api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForSecondaryTileAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannelManager.CreatePushNotificationChannelForSecondaryTileAsync + +## -description +Creates an object, bound to a [secondary tile](../windows.ui.startscreen/secondarytile.md), through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The tile can be a secondary tile of the calling app or any other app in the same package. + +## -parameters +### -param tileId +The ID of the secondary tile to bind to the push notification channel. + +## -returns +The object, bound to the secondary tile, that is used to request a [PushNotificationChannel](pushnotificationchannel.md) from the Windows Push Notification Services (WNS). + +## -remarks +> [!NOTE] +> Channels bound to secondary tiles only accept push notifications for **Tile** and **Badge** update types. + +## -examples +This example shows the use of this method to retrieve a push notification channel for a secondary tile. + +```javascript + +var pushNotifications = Windows.Networking.PushNotifications; +var channel; + +pushNotifications.PushNotificationChannelManager.createPushNotificationChannelForSecondaryTileAsync(myTileId).then(function (channel) { + // Your code here. +}) +``` + + + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationchannelmanager_getdefault_846721868.md b/windows.networking.pushnotifications/pushnotificationchannelmanager_getdefault_846721868.md new file mode 100644 index 0000000000..d12a97f245 --- /dev/null +++ b/windows.networking.pushnotifications/pushnotificationchannelmanager_getdefault_846721868.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannelManager.GetDefault + +## -description +Gets the manager for the active user. + +## -parameters + +## -returns +A [PushNotificationChannelManagerForUser](PushNotificationChannelManagerForUser,md) object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.pushnotifications/pushnotificationchannelmanager_getforuser_2058550280.md b/windows.networking.pushnotifications/pushnotificationchannelmanager_getforuser_2058550280.md new file mode 100644 index 0000000000..dbfd295f7d --- /dev/null +++ b/windows.networking.pushnotifications/pushnotificationchannelmanager_getforuser_2058550280.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannelManager.GetForUser + +## -description +Gets the push notifications for the specified user. + +## -parameters + +### -param user +The user account for the push notifications. + +## -returns +A [PushNotificationChannelManagerForUser](PushNotificationChannelManagerForUser,md) object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.networking.pushnotifications/pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_1273173623.md b/windows.networking.pushnotifications/pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_1273173623.md new file mode 100644 index 0000000000..d066ad35a0 --- /dev/null +++ b/windows.networking.pushnotifications/pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_1273173623.md @@ -0,0 +1,39 @@ +--- +-api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManagerForUser.CreateRawPushNotificationChannelWithAlternateKeyForApplicationAsync(Windows.Storage.Streams.IBuffer,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannelManagerForUser.CreateRawPushNotificationChannelWithAlternateKeyForApplicationAsync + +## -description +Creates an object bound to a specified app through which you retrieve a push notificaiton channel from Windows Push Notification Services (WNS). The specified app must be in the same package as the calling app. + +## -parameters + +### -param appServerKey +An uncompressed key in ANSI X9.62 format. This value is from the P-256 curve defined in the [Secure Hash Standard specification](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf). + +### -param channelId +The ID of the push notification channel. + +### -param appId +The Package Relative Application ID of the app to bind to the push notification channel. + +## -returns +The object, bound to the app server specified in appServerKey, that is used to request a [PushNotificationChannel](PushNotificationChannel.md) from WNS. + +## -remarks +All raw notifications sent over this channel will have the channelID attached before being delivered to the app. This allows for apps to create multiple channels and differentiate where the notifications come from. + +> [!NOTE] +> Most applications (including all third party apps) should use the [CreateRawPushNotificationChannelWithAlternateKeyForApplicationAsync](pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_769979127.md) without the appID parameter. + + +## -see-also + +## -examples + diff --git a/windows.networking.pushnotifications/pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_769979127.md b/windows.networking.pushnotifications/pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_769979127.md new file mode 100644 index 0000000000..ead2d423d4 --- /dev/null +++ b/windows.networking.pushnotifications/pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_769979127.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Networking.PushNotifications.PushNotificationChannelManagerForUser.CreateRawPushNotificationChannelWithAlternateKeyForApplicationAsync(Windows.Storage.Streams.IBuffer,System.String) +-api-type: winrt method +--- + + + +# Windows.Networking.PushNotifications.PushNotificationChannelManagerForUser.CreateRawPushNotificationChannelWithAlternateKeyForApplicationAsync + +## -description +Creates an object bound to a specified app through which you retrieve a push notificaiton channel from Windows Push Notification Services (WNS). The specified app must be in the same package as the calling app. + +## -parameters + +### -param appServerKey +An uncompressed key in ANSI X9.62 format. This value is from the P-256 curve defined in the [Secure Hash Standard specification](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf). + +### -param channelId +The ID of the push notification channel. + +## -returns +The object, bound to the app server specified in appServerKey, that is used to request a [PushNotificationChannel](PushNotificationChannel.md) from WNS. + +## -remarks +Note that all raw notifications sent over this channel will have the channelID attached before being delivered to the app. This allows for apps to create multiple channels and differentiate where the notifications come from. + +## -see-also + +## -examples + diff --git a/windows.networking.pushnotifications/pushnotificationreceivedeventargs.md b/windows.networking.pushnotifications/pushnotificationreceivedeventargs.md index 19a681de16..031fc171b7 100644 --- a/windows.networking.pushnotifications/pushnotificationreceivedeventargs.md +++ b/windows.networking.pushnotifications/pushnotificationreceivedeventargs.md @@ -51,7 +51,7 @@ function pushNotificationReceivedHandler(e) { ## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) ## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_badgenotification.md b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_badgenotification.md index db03a85503..90cf10e5a0 100644 --- a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_badgenotification.md +++ b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_badgenotification.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.BadgeNotification --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.BadgeNotification - -## -description -Gets the content of a badge update to perform in response to this push notification. - -## -property-value -Holds the update information. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Badge**, this value is **NULL**. - -## -remarks - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.BadgeNotification +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.BadgeNotification + +## -description +Gets the content of a badge update to perform in response to this push notification. + +## -property-value +Holds the update information. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Badge**, this value is **NULL**. + +## -remarks + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_cancel.md b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_cancel.md index 70142c2a95..825ff4a4a1 100644 --- a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_cancel.md +++ b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_cancel.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.Cancel --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.Cancel - -## -description -Gets or sets whether Windows should perform its default handling of the notification. - -## -property-value -True to prevent default processing of the notification by Windows, otherwise false. The default value is false. - -## -remarks - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.Cancel +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.Cancel + +## -description +Gets or sets whether Windows should perform its default handling of the notification. + +## -property-value +True to prevent default processing of the notification by Windows, otherwise false. The default value is false. + +## -remarks + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_notificationtype.md b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_notificationtype.md index 0190b0cc0d..671819d439 100644 --- a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_notificationtype.md +++ b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_notificationtype.md @@ -1,27 +1,27 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.NotificationType --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.NotificationType - -## -description -Gets the type of push notification that has been received from the app server. - -## -property-value -The type (badge, tile, toast, or raw) of push notification that has been received. - -## -remarks -Channels bound to secondary tiles will only accept push notifications for **Tile** and **Badge** updates. **Toast** and **Raw** notifications must use a channel bound to an application. - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.NotificationType +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.NotificationType + +## -description +Gets the type of push notification that has been received from the app server. + +## -property-value +The type (badge, tile, toast, or raw) of push notification that has been received. + +## -remarks +Channels bound to secondary tiles will only accept push notifications for **Tile** and **Badge** updates. **Toast** and **Raw** notifications must use a channel bound to an application. + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_rawnotification.md b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_rawnotification.md index 96e4fbb8e0..4aaa28df9c 100644 --- a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_rawnotification.md +++ b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_rawnotification.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.RawNotification --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.RawNotification - -## -description -Gets the app-defined content contained in this push notification, the contents of which are used to perform a background task on the app. - -## -property-value -Encapsulates the app-defined content of the raw notification. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Raw**, this value is **NULL**. - -## -remarks - -## -examples - -## -see-also -[RawNotification](rawnotification.md), [Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca), [RawNotification](rawnotification.md) \ No newline at end of file +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.RawNotification +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.RawNotification + +## -description +Gets the app-defined content contained in this push notification, the contents of which are used to perform a background task on the app. + +## -property-value +Encapsulates the app-defined content of the raw notification. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Raw**, this value is **NULL**. + +## -remarks + +## -examples + +## -see-also +[RawNotification](rawnotification.md), [Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca), [RawNotification](rawnotification.md) \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_tilenotification.md b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_tilenotification.md index fe8dbec804..7f7863ac1a 100644 --- a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_tilenotification.md +++ b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_tilenotification.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.TileNotification --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.TileNotification - -## -description -Gets the content of a tile update to perform in response to this push notification. - -## -property-value -Holds the update information. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Tile**, this value is **NULL**. - -## -remarks - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.TileNotification +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.TileNotification + +## -description +Gets the content of a tile update to perform in response to this push notification. + +## -property-value +Holds the update information. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Tile**, this value is **NULL**. + +## -remarks + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_toastnotification.md b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_toastnotification.md index 81d06a3ec6..2ef0641f3e 100644 --- a/windows.networking.pushnotifications/pushnotificationreceivedeventargs_toastnotification.md +++ b/windows.networking.pushnotifications/pushnotificationreceivedeventargs_toastnotification.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.ToastNotification --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.ToastNotification - -## -description -Gets the content of a toast to display in response to this push notification. - -## -property-value -Holds the toast information. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Toast**, this value is **NULL**. - -## -remarks - -## -examples - -## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) - -## -capabilities +--- +-api-id: P:Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.ToastNotification +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.PushNotificationReceivedEventArgs.ToastNotification + +## -description +Gets the content of a toast to display in response to this push notification. + +## -property-value +Holds the toast information. If [NotificationType](pushnotificationreceivedeventargs_notificationtype.md) is not of type **Toast**, this value is **NULL**. + +## -remarks + +## -examples + +## -see-also +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) + +## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/pushnotificationtype.md b/windows.networking.pushnotifications/pushnotificationtype.md index 4e428caffa..ba81b59aba 100644 --- a/windows.networking.pushnotifications/pushnotificationtype.md +++ b/windows.networking.pushnotifications/pushnotificationtype.md @@ -34,7 +34,7 @@ A push notification to update an app's tile flyout. ## -examples ## -see-also -[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_tile_push), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](XREF:TODO:m_ui_tiles.guidelines_for_push_notifications), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) +[Windows Push Notification Services (WNS) overview](http://msdn.microsoft.com/library/2125b09f-db90-4515-9aa6-516c7e9acccd), [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476), [Quickstart: Sending a tile push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [How to authenticate with the Windows Push Notification Service (WNS)](http://msdn.microsoft.com/library/15975fe8-5e63-4d5d-b885-c4113c86b20e), [How to request, create, and save a notification channel](http://msdn.microsoft.com/library/7aae5dbd-f03e-4cfa-bcf2-c9ad1d7cdb42), [Guidelines and checklist for push notifications](http://msdn.microsoft.com/library/363b8b46-b494-44c9-b086-7f03c38212f7), [Push notification service request and response headers](http://msdn.microsoft.com/library/50575c54-b617-40c5-9dda-79a065e00cca) ## -capabilities internetClient \ No newline at end of file diff --git a/windows.networking.pushnotifications/rawnotification.md b/windows.networking.pushnotifications/rawnotification.md index 5d76d771e0..99720c6e1e 100644 --- a/windows.networking.pushnotifications/rawnotification.md +++ b/windows.networking.pushnotifications/rawnotification.md @@ -20,4 +20,4 @@ A background task that is intended to run in response to a notification must be ## -examples ## -see-also -[PushNotificationTrigger](../windows.applicationmodel.background/pushnotificationtrigger.md), [Raw notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241553), [Raw notification overview](http://msdn.microsoft.com/library/a867c75d-d16e-4ab5-8b44-614eeb9179c7), [Guidelines and checklist for raw notifications](XREF:TODO:m_ui_tiles.guidelines_for_raw), [Quickstart: Creating and registering a raw notification background task](http://msdn.microsoft.com/library/c182fded-75ab-4349-bfd0-d11732fd845e), [Quickstart: Intercepting push notifications for running apps](http://msdn.microsoft.com/library/2bb0a1ab-7b7c-4331-8dad-d5441dd61b06) \ No newline at end of file +[PushNotificationTrigger](../windows.applicationmodel.background/pushnotificationtrigger.md), [Raw notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241553), [Raw notification overview](http://msdn.microsoft.com/library/a867c75d-d16e-4ab5-8b44-614eeb9179c7), [Guidelines and checklist for raw notifications](http://msdn.microsoft.com/library/edcb7417-fa2a-4652-81be-9b39e24b2c09), [Quickstart: Creating and registering a raw notification background task](http://msdn.microsoft.com/library/c182fded-75ab-4349-bfd0-d11732fd845e), [Quickstart: Intercepting push notifications for running apps](http://msdn.microsoft.com/library/2bb0a1ab-7b7c-4331-8dad-d5441dd61b06) \ No newline at end of file diff --git a/windows.networking.pushnotifications/rawnotification_channelid.md b/windows.networking.pushnotifications/rawnotification_channelid.md new file mode 100644 index 0000000000..525e292a9c --- /dev/null +++ b/windows.networking.pushnotifications/rawnotification_channelid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Networking.PushNotifications.RawNotification.ChannelId +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.RawNotification.ChannelId + +## -description +Gets the Channel ID of the raw notification. + +## -property-value +A string that contains the app-defined Channel ID, as set by the app server. + +## -remarks +This is only valid for notifications sent over a channel created by [CreateRawPushNotificationChannelWithAlternateKeyForApplicationAsync](pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_769979127.md). If notification are sent over a channel created with [CreatePushNotificationChannelForApplicationAsync](pushnotificationchannelmanagerforuser_createpushnotificationchannelforapplicationasync_1900738870.md), this will be null. + +## -see-also + +## -examples + diff --git a/windows.networking.pushnotifications/rawnotification_content.md b/windows.networking.pushnotifications/rawnotification_content.md index c3971debe9..c69c4ed530 100644 --- a/windows.networking.pushnotifications/rawnotification_content.md +++ b/windows.networking.pushnotifications/rawnotification_content.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Networking.PushNotifications.RawNotification.Content --api-type: winrt property ---- - - - -# Windows.Networking.PushNotifications.RawNotification.Content - -## -description -Gets the content of the raw notification as a string. This string specifies a background task associated with the app. - -## -property-value -A string that contains the app-defined notification content, as set by the app server. - -## -remarks - -## -examples - -## -see-also -[Raw notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241553), [Raw notification overview](http://msdn.microsoft.com/library/a867c75d-d16e-4ab5-8b44-614eeb9179c7), [Guidelines and checklist for raw notifications](XREF:TODO:m_ui_tiles.guidelines_for_raw), [Quickstart: Creating and registering a raw notification background task](http://msdn.microsoft.com/library/c182fded-75ab-4349-bfd0-d11732fd845e), [Quickstart: Intercepting push notifications for running apps](http://msdn.microsoft.com/library/2bb0a1ab-7b7c-4331-8dad-d5441dd61b06) \ No newline at end of file +--- +-api-id: P:Windows.Networking.PushNotifications.RawNotification.Content +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.RawNotification.Content + +## -description +Gets the content of the raw notification as a string. This string specifies a background task associated with the app. + +## -property-value +A string that contains the app-defined notification content, as set by the app server. + +## -remarks + +## -examples + +## -see-also +[Raw notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241553), [Raw notification overview](http://msdn.microsoft.com/library/a867c75d-d16e-4ab5-8b44-614eeb9179c7), [Guidelines and checklist for raw notifications](http://msdn.microsoft.com/library/edcb7417-fa2a-4652-81be-9b39e24b2c09), [Quickstart: Creating and registering a raw notification background task](http://msdn.microsoft.com/library/c182fded-75ab-4349-bfd0-d11732fd845e), [Quickstart: Intercepting push notifications for running apps](http://msdn.microsoft.com/library/2bb0a1ab-7b7c-4331-8dad-d5441dd61b06) \ No newline at end of file diff --git a/windows.networking.pushnotifications/rawnotification_headers.md b/windows.networking.pushnotifications/rawnotification_headers.md new file mode 100644 index 0000000000..4e84f6f1e5 --- /dev/null +++ b/windows.networking.pushnotifications/rawnotification_headers.md @@ -0,0 +1,33 @@ +--- +-api-id: P:Windows.Networking.PushNotifications.RawNotification.Headers +-api-type: winrt property +--- + + + +# Windows.Networking.PushNotifications.RawNotification.Headers + +## -description +Gets the raw header content from the notification. + +## -property-value +A map view of the header values. See remarks for the header format. + +## -remarks +Header format: +```syntax +Content-Encoding: aesgcm +Crypto-Key: dh= +Encryption: salt= +``` + +For more information and to learn how headers are defined, see [Message Encryption for Web Push](https://tools.ietf.org/html/draft-ietf-webpush-encryption-03), section 3.2. + +The header content is for notifications sent using a channel created with [CreateRawPushNotificationChannelWithAlternateKeyForApplicationAsync](pushnotificationchannelmanagerforuser_createrawpushnotificationchannelwithalternatekeyforapplicationasync_769979127.md) and pushed to WNS using the Webpush protocol with VAPID authentication. For any other type of push notification, the header value is null. + +## -see-also + +## -examples + diff --git a/windows.perception.automation.core/windows_perception_automation_core.md b/windows.perception.automation.core/windows_perception_automation_core.md index bdb7c37704..cc0a776217 100644 --- a/windows.perception.automation.core/windows_perception_automation_core.md +++ b/windows.perception.automation.core/windows_perception_automation_core.md @@ -1,15 +1,15 @@ ---- --api-id: N:Windows.Perception.Automation.Core --api-type: winrt namespace ---- - -# Windows.Perception.Automation.Core - -## -description -Defines the support types for Microsoft UI Automation infrastructure. - -## -remarks - -## -examples - +--- +-api-id: N:Windows.Perception.Automation.Core +-api-type: winrt namespace +--- + +# Windows.Perception.Automation.Core + +## -description +Defines support types for the Perception Automation infrastructure. + +## -remarks + +## -examples + ## -see-also \ No newline at end of file diff --git a/windows.perception.automation.monitoring/windows_perception_automation_monitoring.md b/windows.perception.automation.monitoring/windows_perception_automation_monitoring.md index 6cd1c61e17..0067ebaf41 100644 --- a/windows.perception.automation.monitoring/windows_perception_automation_monitoring.md +++ b/windows.perception.automation.monitoring/windows_perception_automation_monitoring.md @@ -1,15 +1,15 @@ ---- --api-id: N:Windows.Perception.Automation.Monitoring --api-type: winrt namespace ---- - -# Windows.Perception.Automation.Monitoring - -## -description -Defines the support types for Microsoft UI Automation infrastructure. - -## -remarks - -## -examples - +--- +-api-id: N:Windows.Perception.Automation.Monitoring +-api-type: winrt namespace +--- + +# Windows.Perception.Automation.Monitoring + +## -description +Defines support types for the Perception Automation Monitoring infrastructure. + +## -remarks + +## -examples + ## -see-also \ No newline at end of file diff --git a/windows.perception.spatial.surfaces/spatialsurfaceinfo.md b/windows.perception.spatial.surfaces/spatialsurfaceinfo.md index 9126585dfd..092942eaa3 100644 --- a/windows.perception.spatial.surfaces/spatialsurfaceinfo.md +++ b/windows.perception.spatial.surfaces/spatialsurfaceinfo.md @@ -1,32 +1,29 @@ ---- --api-id: T:Windows.Perception.Spatial.Surfaces.SpatialSurfaceInfo --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceInfo - -## -description -Represents a snapshot of metadata for a surface observed in the user's surroundings. - -## -remarks -Mesh objects contain large vertex and index buffers, and so they're heavy to hold onto if you don't have good reason. For efficient use in rendering or physics, an app is expected to cache the mesh and buffer objects it's interested in, and to throw out mesh for areas where the user is no longer operating. - -You can use the set of SpatialSurfaceInfo instances given to you by SpatialSurfaceObserver, representing what mesh is present in the targeted bounding volume, in order to manage your cache. - -Correlating the Id and UpdateTime properties across multiple observations lets you identify new mesh, updated mesh and removed mesh: - -If you see a SpatialSurfaceInfo with an Id you haven't seen before, treat it as new mesh. - -If you see a SpatialSurfaceInfo with a known Id, but with a new UpdateTime, treat it as updated mesh. - -If you no longer see a SpatialSurfaceInfo with a known Id, treat it as removed mesh. - -Because this is a snapshot, the UpdateTime property will not change over time. To see if this surface's mesh has updated, or whether a surface has been removed or moved out of the bounding volume, return to the SpatialSurfaceObserver and either call GetObservedSurfaces each frame or handle the ObservedSurfacesChanged event. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.Surfaces.SpatialSurfaceInfo +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceInfo + +## -description +Represents a snapshot of metadata for a surface observed in the user's surroundings. + +## -remarks +Mesh objects contain large vertex and index buffers, and so they're heavy to hold onto if you don't have good reason. For efficient use in rendering or physics, an app is expected to cache the mesh and buffer objects it's interested in, and to throw out mesh for areas where the user is no longer operating. + +You can use the set of SpatialSurfaceInfo instances given to you by [SpatialSurfaceObserver](spatialsurfaceobserver.md), representing what mesh is present in the targeted bounding volume, in order to manage your cache. + +Correlating the [Id](spatialsurfaceinfo_id.md) and [UpdateTime](spatialsurfaceinfo_updatetime.md) properties across multiple observations lets you identify new mesh, updated mesh and removed mesh: +* If you see a SpatialSurfaceInfo with an Id you haven't seen before, treat it as new mesh. +* If you see a SpatialSurfaceInfo with a known Id, but with a new UpdateTime, treat it as updated mesh. +* If you no longer see a SpatialSurfaceInfo with a known Id, treat it as removed mesh. + +Because this is a snapshot, the UpdateTime property will not change over time. To see if this surface's mesh has updated, or whether a surface has been removed or moved out of the bounding volume, return to the SpatialSurfaceObserver and either call [GetObservedSurfaces](spatialsurfaceobserver_getobservedsurfaces_672856049.md) each frame or handle the [ObservedSurfacesChanged](spatialsurfaceobserver_observedsurfaceschanged.md) event. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemesh_coordinatesystem.md b/windows.perception.spatial.surfaces/spatialsurfacemesh_coordinatesystem.md index c0ac95b0eb..220d24645a 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemesh_coordinatesystem.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemesh_coordinatesystem.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.CoordinateSystem --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.CoordinateSystem - -## -description -Gets the coordinate system in which the VertexPositions and VertexNormals buffers express their coordinates. - -## -property-value -The vertex coordinate system. - -## -remarks -Unlike other spatial data structures, vertex buffers and normal buffers are quite heavy, and it would be prohibitive to update all of their coordinates every frame. Instead, appscan transfer these buffers to the GPU or process them for physics once, and then reason about how the surface's SpatialCoordinateSystem then changes its relative transform to the app's other relevant coordinate systems in future frames. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.CoordinateSystem +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.CoordinateSystem + +## -description +Gets the coordinate system in which the [VertexPositions](spatialsurfacemesh_vertexpositions.md) and [VertexNormals](spatialsurfacemesh_vertexnormals.md) buffers express their coordinates. + +## -property-value +The vertex coordinate system. + +## -remarks +Unlike other spatial data structures, vertex buffers and normal buffers are quite heavy, and it would be prohibitive to update all of their coordinates every frame. Instead, apps can transfer these buffers to the GPU or process them for physics once, and then reason about how the surface's [SpatialCoordinateSystem](../windows.perception.spatial/spatialcoordinatesystem.md) changes its relative transform to the app's other relevant coordinate systems in future frames. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemesh_triangleindices.md b/windows.perception.spatial.surfaces/spatialsurfacemesh_triangleindices.md index 2fb7fcf413..4f0f128ab8 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemesh_triangleindices.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemesh_triangleindices.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.TriangleIndices --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.TriangleIndices - -## -description -Gets the buffer object representing the mesh's index buffer. - -## -property-value -The mesh buffer. - -## -remarks -If SpatialSurfaceMeshOptions.TriangleIndexFormat is set as an option in the call to SpatialSurfaceInfo.TryComputeLatestMeshAsync, this buffer will be generated in the format indicated. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.TriangleIndices +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.TriangleIndices + +## -description +Gets the buffer object representing the mesh's index buffer. + +## -property-value +The mesh buffer. + +## -remarks +If [SpatialSurfaceMeshOptions.TriangleIndexFormat](spatialsurfacemeshoptions_triangleindexformat.md) is set as an option in the call to [SpatialSurfaceInfo.TryComputeLatestMeshAsync](spatialsurfaceinfo_trycomputelatestmeshasync_1431485667.md), this buffer will be generated in the format indicated. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexnormals.md b/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexnormals.md index 96e1112abf..73091cd82f 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexnormals.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexnormals.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexNormals --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexNormals - -## -description -Gets the buffer object representing the mesh's normal buffer, if IncludeVertexNormals was set as a mesh option in the call to SpatialSurfaceInfo.TryComputeLatestMeshAsync. Otherwise, this property is null. - -## -property-value -The mesh buffer if available; otherwise null. - -## -remarks -If the SpatialSurfaceMeshOptions.VertexNormalFormat option is also set, this buffer will be generated in the format indicated. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexNormals +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexNormals + +## -description +Gets the buffer object representing the mesh's normal buffer, if IncludeVertexNormals was set as a mesh option in the call to [SpatialSurfaceInfo.TryComputeLatestMeshAsync](spatialsurfaceinfo_trycomputelatestmeshasync_1431485667.md). Otherwise, this property is null. + +## -property-value +The mesh buffer if available; otherwise null. + +## -remarks +If the [SpatialSurfaceMeshOptions.VertexNormalFormat](spatialsurfacemeshoptions_vertexnormalformat.md) option is also set, this buffer will be generated in the format indicated. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositions.md b/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositions.md index 0cb1b802d6..a1a4aad364 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositions.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositions.md @@ -1,25 +1,25 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositions --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositions - -## -description -Gets the buffer object representing the mesh's vertex buffer. - -## -property-value -The mesh buffer. - -## -remarks -Note that to get correct vertex positions, coordinates must be scaled according to the VertexPositionScale property. If you are otherwise transforming these coordinates to another coordinate system before using them anyway, you can make a scale matrix from the VertexPositionScale vector and include that as the first matrix in your transform chain. - -If SpatialSurfaceMeshOptions.VertexPositionFormat is set as an option in the call to SpatialSurfaceInfo.TryComputeLatestMeshAsync, this buffer will be generated in the format indicated. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositions +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositions + +## -description +Gets the buffer object representing the mesh's vertex buffer. + +## -property-value +The mesh buffer. + +## -remarks +Note that to get correct vertex positions, coordinates must be scaled according to the VertexPositionScale property. If you are otherwise transforming these coordinates to another coordinate system before using them anyway, you can make a scale matrix from the VertexPositionScale vector and include that as the first matrix in your transform chain. + +If [SpatialSurfaceMeshOptions.VertexPositionFormat](spatialsurfacemeshoptions_vertexpositionformat.md) is set as an option in the call to [SpatialSurfaceInfo.TryComputeLatestMeshAsync](spatialsurfaceinfo_trycomputelatestmeshasync_1431485667.md), this buffer will be generated in the format indicated. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositionscale.md b/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositionscale.md index a60dd5690e..658c0342e8 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositionscale.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemesh_vertexpositionscale.md @@ -1,23 +1,25 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositionScale --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositionScale - -## -description -Gets the scale vector that you must use to scale the elements of VertexPositions. This gets you mesh coordinates in meters in the mesh's specified coordinate system. - -## -property-value -The mesh buffer. - -## -remarks -If you are otherwise transforming these coordinates to another coordinate system before using them anyway, you can make a scale matrix from the VertexPositionScale vector and include that as the first matrix in your transform chain. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositionScale +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMesh.VertexPositionScale + +## -description +Gets the scale vector that you must use to scale the elements of [VertexPositions](spatialsurfacemesh_vertexpositions.md). + +## -property-value +The mesh buffer. + +## -remarks +This gets you mesh coordinates in meters in the mesh's specified coordinate system. + +If you are otherwise transforming these coordinates to another coordinate system before using them anyway, you can make a scale matrix from the VertexPositionScale vector and include that as the first matrix in your transform chain. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions.md b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions.md index 66e3d95e3d..4b5c1b2f22 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions.md @@ -1,22 +1,19 @@ ---- --api-id: T:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions - -## -description -Provides options to customize the SpatialSurfaceMesh objects you get back from SpatialSurfaceInfo.TryComputeLatestMeshAsync. - -## -remarks -You can get the list of supported vertex position formats from SpatialSurfaceMeshOptions.SupportedVertexPositionFormats. - - - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions + +## -description +Provides options to customize the [SpatialSurfaceMesh](spatialsurfacemesh.md) objects you get back from [SpatialSurfaceInfo.TryComputeLatestMeshAsync](spatialsurfaceinfo_trycomputelatestmeshasync_1431485667.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_includevertexnormals.md b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_includevertexnormals.md index 19a17f13dd..c5b8b6f1f0 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_includevertexnormals.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_includevertexnormals.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.IncludeVertexNormals --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.IncludeVertexNormals - -## -description -Gets or sets whether to compute a normal buffer. - -## -property-value -Whether to compute normals. - -## -remarks -SpatialSurfaceMesh.VertexNormals will only be non-null if IncludeVertexNormals is set to true. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.IncludeVertexNormals +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.IncludeVertexNormals + +## -description +Gets or sets whether to compute a normal buffer. + +## -property-value +Whether to compute normals. + +## -remarks +[SpatialSurfaceMesh.VertexNormals](spatialsurfacemesh_vertexnormals.md) will only be non-null if IncludeVertexNormals is set to true. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedtriangleindexformats.md b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedtriangleindexformats.md index 429c7510a2..c5b2c0af46 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedtriangleindexformats.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedtriangleindexformats.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedTriangleIndexFormats --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedTriangleIndexFormats - -## -description -Gets a list of the triangle index formats that the system can generate an index buffer in. - -## -property-value -The supported index buffer formats. - -## -remarks -Supply a value from this list to the SpatialSurfacesMeshOptions.TriangleIndexFormat property when calling SpatialSurfaceInfo.TryComputeLatestMeshAsync to request index buffers in that format. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedTriangleIndexFormats +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedTriangleIndexFormats + +## -description +Gets a list of the triangle index formats that the system can generate an index buffer in. + +## -property-value +The supported index buffer formats. + +## -remarks +Supply a value from this list to the [TriangleIndexFormat](spatialsurfacemeshoptions_triangleindexformat.md) property when calling [SpatialSurfaceInfo.TryComputeLatestMeshAsync](spatialsurfaceinfo_trycomputelatestmeshasync_1431485667.md) to request index buffers in that format. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexnormalformats.md b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexnormalformats.md index 1efbf69fd4..c8be1d2ccd 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexnormalformats.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexnormalformats.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexNormalFormats --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexNormalFormats - -## -description -Gets a list of the vertex normal formats that the system can generate a normal buffer in. - -## -property-value -The supported normal buffer formats. - -## -remarks -Supply a value from this list to the SpatialSurfacesMeshOptions.VertexNormalFormat property when calling SpatialSurfaceInfo.TryComputeLatestMeshAsync to request normal buffers in that format. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexNormalFormats +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexNormalFormats + +## -description +Gets a list of the vertex normal formats that the system can generate a normal buffer in. + +## -property-value +The supported normal buffer formats. + +## -remarks +Supply a value from this list to the [VertexNormalFormat](spatialsurfacemeshoptions_vertexnormalformat.md) property when calling [SpatialSurfaceInfo.TryComputeLatestMeshAsync](spatialsurfaceinfo_trycomputelatestmeshasync_1431485667.md) to request normal buffers in that format. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexpositionformats.md b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexpositionformats.md index 6e61f6b2de..1bfbe5dbac 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexpositionformats.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_supportedvertexpositionformats.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexPositionFormats --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexPositionFormats - -## -description -Gets a list of the vertex position formats that the system can generate a vertex buffer in. - -## -property-value -The supported vertex buffer formats. - -## -remarks -Supply a value from this list to the SpatialSurfacesMeshOptions.VertexPositionFormat property when calling SpatialSurfaceInfo.TryComputeLatestMeshAsync to request vertex buffers in that format. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexPositionFormats +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.SupportedVertexPositionFormats + +## -description +Gets a list of the vertex position formats that the system can generate a vertex buffer in. + +## -property-value +The supported vertex buffer formats. + +## -remarks +Supply a value from this list to the [VertexPositionFormat](spatialsurfacemeshoptions_vertexpositionformat.md) property when calling [SpatialSurfaceInfo.TryComputeLatestMeshAsync](spatialsurfaceinfo_trycomputelatestmeshasync_1431485667.md) to request vertex buffers in that format. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_vertexnormalformat.md b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_vertexnormalformat.md index 94badd1079..750328e6ca 100644 --- a/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_vertexnormalformat.md +++ b/windows.perception.spatial.surfaces/spatialsurfacemeshoptions_vertexnormalformat.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.VertexNormalFormat --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.VertexNormalFormat - -## -description -Gets or sets the element format for generated normal buffers. - -## -property-value -The vertex normal format. - -## -remarks -Note that normal buffers will only be generated if you set IncludeVertexNormals to true. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.VertexNormalFormat +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceMeshOptions.VertexNormalFormat + +## -description +Gets or sets the element format for generated normal buffers. + +## -property-value +The vertex normal format. + +## -remarks +Note that normal buffers will only be generated if you set [IncludeVertexNormals](spatialsurfacemeshoptions_includevertexnormals.md) to true. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfaceobserver.md b/windows.perception.spatial.surfaces/spatialsurfaceobserver.md index daa1c29606..c1582dd655 100644 --- a/windows.perception.spatial.surfaces/spatialsurfaceobserver.md +++ b/windows.perception.spatial.surfaces/spatialsurfaceobserver.md @@ -1,24 +1,24 @@ ---- --api-id: T:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver - -## -description -Provides methods for observing surfaces in the user's surroundings. - -## -remarks -Spatial mapping lets your app understand the shape and location of the surfaces in the user's surroundings. - -Through the sensors on a device like HoloLens, Windows generates 3D triangle meshes of surfaces in large cube-shaped volumes. Over time, as Windows improves its understanding of your surroundings, new surface volumes are generated and existing volumes are updated with new mesh. Sometimes, surface volumes can be destroyed as well, when the system is running low on storage. - -You access these surfaces by expressing interest in a volume of space, either a bounding box, bounding frustum, or bounding sphere. Windows updates you to let you know when the set of surfaces in that observed volume has changed, with each surface volume identified by an Id and the time of its last update. By reasoning about changes to this set of observed surface metadata, you can detect new mesh, updated mesh, and removed mesh over time. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver + +## -description +Provides methods for observing surfaces in the user's surroundings. + +## -remarks +Spatial mapping lets your app understand the shape and location of the surfaces in the user's surroundings. + +Through the sensors on a device like HoloLens, Windows generates 3D triangle meshes of surfaces in large cube-shaped volumes. Over time, as Windows improves its understanding of your surroundings, new surface volumes are generated and existing volumes are updated with new mesh. Sometimes, surface volumes can be destroyed as well, when the system is running low on storage. + +You access these surfaces by expressing interest in a volume of space, either a bounding box, bounding frustum, or bounding sphere. Windows updates you to let you know when the set of surfaces in that observed volume has changed, with each surface volume identified by an id and the time of its last update. By reasoning about changes to this set of observed surface metadata, you can detect new mesh, updated mesh, and removed mesh over time. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfaceobserver_getobservedsurfaces_672856049.md b/windows.perception.spatial.surfaces/spatialsurfaceobserver_getobservedsurfaces_672856049.md index be983c9298..c578ca55d1 100644 --- a/windows.perception.spatial.surfaces/spatialsurfaceobserver_getobservedsurfaces_672856049.md +++ b/windows.perception.spatial.surfaces/spatialsurfaceobserver_getobservedsurfaces_672856049.md @@ -1,31 +1,28 @@ ---- --api-id: M:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.GetObservedSurfaces --api-type: winrt method ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.GetObservedSurfaces - -## -description -Gets metadata for the set of surfaces observed within the bounding volume at the moment. - -## -returns -The observed surfaces. - -## -remarks -Each SpatialSurfaceInfo snapshot is immutable, so you can compare their values later to see if a given surface has recently experienced a mesh update. - -Correlating the Id and UpdateTime properties across multiple observations lets you identify new mesh, updated mesh and removed mesh: - -If you see a SpatialSurfaceInfo with an Id you haven't seen before, treat it as new mesh. - -If you see a SpatialSurfaceInfo with a known Id, but with a new UpdateTime, treat it as updated mesh. - -If you no longer see a SpatialSurfaceInfo with a known Id, treat it as removed mesh. - -## -examples - -## -see-also +--- +-api-id: M:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.GetObservedSurfaces +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.GetObservedSurfaces + +## -description +Gets metadata for the set of surfaces observed within the bounding volume at the moment. + +## -returns +The observed surfaces. + +## -remarks +Each [SpatialSurfaceInfo](spatialsurfaceinfo.md) snapshot is immutable, so you can compare their values later to see if a given surface has recently experienced a mesh update. + +Correlating the [Id](spatialsurfaceinfo_id.md) and [UpdateTime](spatialsurfaceinfo_updatetime.md) properties across multiple observations lets you identify new mesh, updated mesh and removed mesh: +* If you see a SpatialSurfaceInfo with an Id you haven't seen before, treat it as new mesh. +* If you see a SpatialSurfaceInfo with a known Id, but with a new UpdateTime, treat it as updated mesh. +* If you no longer see a SpatialSurfaceInfo with a known Id, treat it as removed mesh. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfaceobserver_issupported_930300905.md b/windows.perception.spatial.surfaces/spatialsurfaceobserver_issupported_930300905.md new file mode 100644 index 0000000000..6204057724 --- /dev/null +++ b/windows.perception.spatial.surfaces/spatialsurfaceobserver_issupported_930300905.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.IsSupported +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.IsSupported + +## -description +Gets whether spatial mapping is supported on the current system. + +## -returns +Whether spatial mapping is supported. + +## -remarks +This returns true on HoloLens and false elsewhere. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial.surfaces/spatialsurfaceobserver_observedsurfaceschanged.md b/windows.perception.spatial.surfaces/spatialsurfaceobserver_observedsurfaceschanged.md index 0c8583e768..0a4d2bcddc 100644 --- a/windows.perception.spatial.surfaces/spatialsurfaceobserver_observedsurfaceschanged.md +++ b/windows.perception.spatial.surfaces/spatialsurfaceobserver_observedsurfaceschanged.md @@ -1,20 +1,20 @@ ---- --api-id: E:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.ObservedSurfacesChanged --api-type: winrt event ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.ObservedSurfacesChanged - -## -description -Occurs when the set of surface metadata observed within the bounding volume has changed. - -## -remarks -When this event fires, call GetObservedSurfaces to get the latest set of surface metadata. - -## -examples - -## -see-also +--- +-api-id: E:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.ObservedSurfacesChanged +-api-type: winrt event +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.ObservedSurfacesChanged + +## -description +Occurs when the set of surface metadata observed within the bounding volume has changed. + +## -remarks +When this event fires, call [GetObservedSurfaces](spatialsurfaceobserver_getobservedsurfaces_672856049.md) to get the latest set of surface metadata. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolume_1855675877.md b/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolume_1855675877.md index b97e1fb964..eb99ed64e3 100644 --- a/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolume_1855675877.md +++ b/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolume_1855675877.md @@ -1,24 +1,24 @@ ---- --api-id: M:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolume(Windows.Perception.Spatial.SpatialBoundingVolume) --api-type: winrt method ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolume - -## -description -Sets the single bounding volume that this observer will track for new, updated or removed surfaces. - -## -parameters -### -param bounds -The new bounding volume for this observer to track for surface updates. - -## -remarks -When the set of surface metadata within this bounding volume changes, the ObservedSurfacesChanged event will fire. - -## -examples - -## -see-also +--- +-api-id: M:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolume(Windows.Perception.Spatial.SpatialBoundingVolume) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolume + +## -description +Sets the single bounding volume that this observer will track for new, updated or removed surfaces. + +## -parameters +### -param bounds +The new bounding volume for this observer to track for surface updates. + +## -remarks +When the set of surface metadata within this bounding volume changes, the [ObservedSurfacesChanged](spatialsurfaceobserver_observedsurfaceschanged.md) event will fire. + +## -examples + +## -see-also diff --git a/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolumes_1367237120.md b/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolumes_1367237120.md index 295db76d24..61f161ed0b 100644 --- a/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolumes_1367237120.md +++ b/windows.perception.spatial.surfaces/spatialsurfaceobserver_setboundingvolumes_1367237120.md @@ -1,24 +1,24 @@ ---- --api-id: M:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolumes(Windows.Foundation.Collections.IIterable{Windows.Perception.Spatial.SpatialBoundingVolume}) --api-type: winrt method ---- - - - -# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolumes - -## -description -Sets the list of bounding volumes that this observer will track for new, updated or removed surfaces. - -## -parameters -### -param bounds -The bounding volumes. - -## -remarks -When the set of surface metadata within these bounding volumes changes, the ObservedSurfacesChanged event will fire. - -## -examples - -## -see-also +--- +-api-id: M:Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolumes(Windows.Foundation.Collections.IIterable{Windows.Perception.Spatial.SpatialBoundingVolume}) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.Surfaces.SpatialSurfaceObserver.SetBoundingVolumes + +## -description +Sets the list of bounding volumes that this observer will track for new, updated or removed surfaces. + +## -parameters +### -param bounds +The bounding volumes. + +## -remarks +When the set of surface metadata within these bounding volumes changes, the [ObservedSurfacesChanged](spatialsurfaceobserver_observedsurfaceschanged.md) event will fire. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchor.md b/windows.perception.spatial/spatialanchor.md index fa5141d24d..356c800494 100644 --- a/windows.perception.spatial/spatialanchor.md +++ b/windows.perception.spatial/spatialanchor.md @@ -1,32 +1,32 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialAnchor --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialAnchor - -## -description -Represents a coordinate system that is strongly anchored to a point in the user's surroundings. - -## -remarks -You can create a SpatialAnchor at any position and orientation within the SpatialCoordinateSystem of your choosing. The device must be able to locate that coordinate system at the moment, and the system must not have reached its limit of spatial anchors. - -Once defined, the coordinate system of a SpatialAnchor adjusts continually to retain the precise position and orientation of its initial location. You can then use this SpatialAnchor to render holograms that will appear fixed in the user's surroundings at that exact location. - -The effects of the adjustments that keep the anchor in place are magnified as distance from the anchor increases. You should avoid rendering content relative to an anchor that is more than 3 meters from that anchor's origin. - -You can persist a SpatialAnchor using the SpatialAnchorStore class and then get it back in a future app session. - -The CoordinateSystem property gets a coordinate system that lets you place content relative to the anchor, with easing applied when the device adjusts the anchor's precise location. - -Use the RawCoordinateSystem property and the corresponding RawCoordinateSystemAdjusted event to manage these adjustments yourself. - -The coordinate system is right-handed, with +y up, +x to the right, and -z forward. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialAnchor +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialAnchor + +## -description +Represents a coordinate system that is strongly anchored to a point in the user's surroundings. + +## -remarks +You can create a SpatialAnchor at any position and orientation within the [SpatialCoordinateSystem](spatialcoordinatesystem.md) of your choosing. The device must be able to locate that coordinate system at the moment, and the system must not have reached its limit of spatial anchors. + +Once defined, the coordinate system of a SpatialAnchor adjusts continually to retain the precise position and orientation of its initial location. You can then use this SpatialAnchor to render holograms that will appear fixed in the user's surroundings at that exact location. + +The effects of the adjustments that keep the anchor in place are magnified as distance from the anchor increases. You should avoid rendering content relative to an anchor that is more than 3 meters from that anchor's origin. + +You can persist a SpatialAnchor using the [SpatialAnchorStore](spatialanchorstore.md) class and then get it back in a future app session. + +The [CoordinateSystem](spatialanchor_coordinatesystem.md) property gets a coordinate system that lets you place content relative to the anchor, with easing applied when the device adjusts the anchor's precise location. + +Use the [RawCoordinateSystem](spatialanchor_rawcoordinatesystem.md) property and the corresponding [RawCoordinateSystemAdjusted](spatialanchor_rawcoordinatesystemadjusted.md) event to manage these adjustments yourself. + +The coordinate system is right-handed, with +y up, +x to the right, and -z forward. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchor_rawcoordinatesystem.md b/windows.perception.spatial/spatialanchor_rawcoordinatesystem.md index 682bd3dadc..c797013fa3 100644 --- a/windows.perception.spatial/spatialanchor_rawcoordinatesystem.md +++ b/windows.perception.spatial/spatialanchor_rawcoordinatesystem.md @@ -1,25 +1,25 @@ ---- --api-id: P:Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystem --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystem - -## -description -Gets the coordinate system of the anchor, without easing applied. - -## -property-value -The raw coordinate system. - -## -remarks -This coordinate system lets you precisely place holograms near the anchor, with immediate updates when the device adjusts the anchor's precise location. - -Use the corresponding RawCoordinateSystemAdjusted event to react when anchor adjustments occur. - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystem +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystem + +## -description +Gets the coordinate system of the anchor, without easing applied. + +## -property-value +The raw coordinate system. + +## -remarks +This coordinate system lets you precisely place holograms near the anchor, with immediate updates when the device adjusts the anchor's precise location. + +Use the corresponding [RawCoordinateSystemAdjusted](spatialanchor_rawcoordinatesystemadjusted.md) event to react when anchor adjustments occur. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchor_rawcoordinatesystemadjusted.md b/windows.perception.spatial/spatialanchor_rawcoordinatesystemadjusted.md index 6da91b5a32..2e6b102979 100644 --- a/windows.perception.spatial/spatialanchor_rawcoordinatesystemadjusted.md +++ b/windows.perception.spatial/spatialanchor_rawcoordinatesystemadjusted.md @@ -1,19 +1,20 @@ ---- --api-id: E:Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystemAdjusted --api-type: winrt event ---- - - - -# Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystemAdjusted - -## -description -Occurs when the device adjusts the anchor's precise location, which updates the RawCoordinateSystem. The event arguments contain a transform representing the adjustment that was made. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystemAdjusted +-api-type: winrt event +--- + + + +# Windows.Perception.Spatial.SpatialAnchor.RawCoordinateSystemAdjusted + +## -description +Occurs when the device adjusts the anchor's precise location, which updates the [RawCoordinateSystem](spatialanchor_rawcoordinatesystem.md). + +## -remarks +The event arguments contain a transform representing the adjustment that was made. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs.md b/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs.md index 6ec435db69..8c4effa7b2 100644 --- a/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs.md +++ b/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs.md @@ -1,20 +1,20 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs - -## -description -Provides data for the SpatialAnchor.RawCoordinateSystemAdjusted event. - -## -remarks - - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs + +## -description +Provides data for the [SpatialAnchor.RawCoordinateSystemAdjusted](spatialanchor_rawcoordinatesystemadjusted.md) event. + +## -remarks + + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs_oldrawcoordinatesystemtonewrawcoordinatesystemtransform.md b/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs_oldrawcoordinatesystemtonewrawcoordinatesystemtransform.md index c6cb39886b..e57162b9f8 100644 --- a/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs_oldrawcoordinatesystemtonewrawcoordinatesystemtransform.md +++ b/windows.perception.spatial/spatialanchorrawcoordinatesystemadjustedeventargs_oldrawcoordinatesystemtonewrawcoordinatesystemtransform.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs.OldRawCoordinateSystemToNewRawCoordinateSystemTransform --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs.OldRawCoordinateSystemToNewRawCoordinateSystemTransform - -## -description -Gets a transform representing the adjustment of this SpatialAnchor relative to its previous location. - -## -property-value -The transform. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs.OldRawCoordinateSystemToNewRawCoordinateSystemTransform +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialAnchorRawCoordinateSystemAdjustedEventArgs.OldRawCoordinateSystemToNewRawCoordinateSystemTransform + +## -description +Gets a transform representing the adjustment of this [SpatialAnchor](spatialanchor.md) relative to its previous location. + +## -property-value +The transform. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchorstore.md b/windows.perception.spatial/spatialanchorstore.md index c5aa3d5b0d..77d77e386b 100644 --- a/windows.perception.spatial/spatialanchorstore.md +++ b/windows.perception.spatial/spatialanchorstore.md @@ -1,22 +1,22 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialAnchorStore --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialAnchorStore - -## -description -Represents a collection of SpatialAnchor objects stored by Windows on behalf of an app. - -## -remarks -This lets an app persist SpatialAnchors and then load them back again during a future app session. The app is responsible for keeping track of which identifiers represent which logical locations within the app,for example associating an anchor with a hologram that should be displayed there. - -To request the app's SpatialAnchorStore, use the SpatialAnchorManager class. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialAnchorStore +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialAnchorStore + +## -description +Represents a collection of [SpatialAnchor](spatialanchor.md) objects stored by Windows on behalf of an app. + +## -remarks +This lets an app persist SpatialAnchors and then load them back again during a future app session. The app is responsible for keeping track of which identifiers represent which logical locations within the app, for example associating an anchor with a hologram that should be displayed there. + +To request the app's SpatialAnchorStore, use the [SpatialAnchorManager](spatialanchormanager.md) class. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchortransfermanager.md b/windows.perception.spatial/spatialanchortransfermanager.md index 43e87d0d40..36647b7fb3 100644 --- a/windows.perception.spatial/spatialanchortransfermanager.md +++ b/windows.perception.spatial/spatialanchortransfermanager.md @@ -1,19 +1,21 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialAnchorTransferManager --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialAnchorTransferManager - -## -description -Static methods for transferring spatial anchors between devices, so that both devices can reason about the same locations in their users' surroundings. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialAnchorTransferManager +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialAnchorTransferManager + +## -description +Static methods for transferring spatial anchors between devices, so that both devices can reason about the same locations in their users' surroundings. + +## -remarks +> [!IMPORTANT] +> The export/import approach of sharing spatial anchors between devices is being deprecated. In a future release of Windows, you will need to transition to the [SpatialEntityStore](spatialentitystore.md) API, which provides a shared pool of spatial anchors and metadata, which the system will synchronize on your behalf. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchortransfermanager_tryexportanchorsasync_1257828475.md b/windows.perception.spatial/spatialanchortransfermanager_tryexportanchorsasync_1257828475.md index 7ebd3cbeca..1d51bee099 100644 --- a/windows.perception.spatial/spatialanchortransfermanager_tryexportanchorsasync_1257828475.md +++ b/windows.perception.spatial/spatialanchortransfermanager_tryexportanchorsasync_1257828475.md @@ -1,74 +1,70 @@ ---- --api-id: M:Windows.Perception.Spatial.SpatialAnchorTransferManager.TryExportAnchorsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Perception.Spatial.SpatialAnchor}},Windows.Storage.Streams.IOutputStream) --api-type: winrt method ---- - - - -# Windows.Perception.Spatial.SpatialAnchorTransferManager.TryExportAnchorsAsync - -## -description -Exports spatial anchors to a stream, which can later be imported on another device. This allows both devices to reason about the same locations in their users' surroundings. - -## -parameters -### -param anchors -The collection of anchors to export, each identified by an app-specified string key. - -### -param stream -The stream to export anchors to. - -## -returns -Operation that triggers once the export is complete. - -## -remarks -It's the app's responsibility to get the data in the stream to the other device through its own network channel. - -This method yields a result of **true** if the export succeeded. The export can fail if the spatial understanding system times out during the export. - -> [!IMPORTANT] -> If you're using JavaScript, you can't create the *anchors* parameter directly, because it's of type IIterable<IKeyValuePair<Platform::String^, Windows::Perception::Spatial::SpatialAnchor^>>. Instead, create a native WinRT helper component that has a **CreateMap** function: - -```cpp -#include "pch.h" -#include "SpatialAnchorHelper.h" - -using namespace SpatialHelper; -using namespace Platform; - -Windows::Foundation::Collections::IMap^ SpatialAnchorHelper::CreateMap() -{ - return ref new Platform::Collections::Map(); -} - - -``` - - - -Now you can populate the anchors collection in JavaScript and pass it to the [TryExportAnchorsAsync](spatialanchortransfermanager_tryexportanchorsasync.md) method. The following code example shows how to use the SpatialAnchorHelper class to populate the anchors collection.```javascript -waitForPositionalTracking(function () { - var spatialAnchor = Windows.Perception.Spatial.SpatialAnchor.tryCreateRelativeTo(stationaryRef.coordinateSystem); - - if (isLocatableRelativeToUser(spatialAnchor)) { - var map = SpatialHelper.SpatialAnchorHelper.createMap(); - map.insert("test", spatialAnchor); - - var stream = Windows.Storage.Streams.InMemoryRandomAccessStream(); - - console.log("Exporting spatial anchor"); - var exportWatch = new Stopwatch(); - Windows.Perception.Spatial.SpatialAnchorTransferManager.tryExportAnchorsAsync(map.getView(), stream.getOutputStreamAt(0)).then( - function (succeeded) { - if (succeeded) { - console.log("Exported " + stream.size + " bytes to stream. Elapsed time: " + exportWatch.stop() + " seconds"); -... - -``` - - - -## -examples - -## -see-also +--- +-api-id: M:Windows.Perception.Spatial.SpatialAnchorTransferManager.TryExportAnchorsAsync(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,Windows.Perception.Spatial.SpatialAnchor}},Windows.Storage.Streams.IOutputStream) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialAnchorTransferManager.TryExportAnchorsAsync + +## -description +Exports spatial anchors to a stream, which can later be imported on another device. This allows both devices to reason about the same locations in their users' surroundings. + +## -parameters +### -param anchors +The collection of anchors to export, each identified by an app-specified string key. + +### -param stream +The stream to export anchors to. + +## -returns +Operation that triggers once the export is complete. + +## -remarks +It's the app's responsibility to get the data in the stream to the other device through its own network channel. + +This method yields a result of **true** if the export succeeded. The export can fail if the spatial understanding system times out during the export. + +**Note:** If you're using JavaScript, you can't create the *anchors* parameter directly, because it's of type IIterable<IKeyValuePair<Platform::String^, Windows::Perception::Spatial::SpatialAnchor^>>. Instead, create a native WinRT helper component that has a **CreateMap** function: + +```cpp +#include "pch.h" +#include "SpatialAnchorHelper.h" + +using namespace SpatialHelper; +using namespace Platform; + +Windows::Foundation::Collections::IMap^ SpatialAnchorHelper::CreateMap() +{ + return ref new Platform::Collections::Map(); +} +``` + +Now you can populate the anchors collection in JavaScript and pass it to the [TryExportAnchorsAsync](spatialanchortransfermanager_tryexportanchorsasync.md) method. The following code example shows how to use the SpatialAnchorHelper class to populate the anchors collection. + +```javascript +waitForPositionalTracking(function () { + var spatialAnchor = Windows.Perception.Spatial.SpatialAnchor.tryCreateRelativeTo(stationaryRef.coordinateSystem); + + if (isLocatableRelativeToUser(spatialAnchor)) { + var map = SpatialHelper.SpatialAnchorHelper.createMap(); + map.insert("test", spatialAnchor); + + var stream = Windows.Storage.Streams.InMemoryRandomAccessStream(); + + console.log("Exporting spatial anchor"); + var exportWatch = new Stopwatch(); + Windows.Perception.Spatial.SpatialAnchorTransferManager.tryExportAnchorsAsync(map.getView(), stream.getOutputStreamAt(0)).then( + function (succeeded) { + if (succeeded) { + console.log("Exported " + stream.size + " bytes to stream. Elapsed time: " + exportWatch.stop() + " seconds"); +... +``` + + + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialanchortransfermanager_tryimportanchorsasync_545235615.md b/windows.perception.spatial/spatialanchortransfermanager_tryimportanchorsasync_545235615.md index 6d42529713..11e998436c 100644 --- a/windows.perception.spatial/spatialanchortransfermanager_tryimportanchorsasync_545235615.md +++ b/windows.perception.spatial/spatialanchortransfermanager_tryimportanchorsasync_545235615.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.Perception.Spatial.SpatialAnchorTransferManager.TryImportAnchorsAsync(Windows.Storage.Streams.IInputStream) --api-type: winrt method ---- - - - -# Windows.Perception.Spatial.SpatialAnchorTransferManager.TryImportAnchorsAsync - -## -description -Imports a stream of spatial anchors that was previously exported from another device. This allows both devices to reason about the same locations in their users' surroundings. - -## -parameters -### -param stream -The stream to import anchors from. - -## -returns -The operation that triggers once the import is complete, providing the imported anchors. - -## -remarks -You must first export the anchors on the source device using the TryExportAnchorsAsync method. It is then the app's responsibility to get the data in the stream to the other device through its own network channel. - -This imports the anchors and their supporting data into the device's spatial understanding. An app should then use SpatialAnchorStore.TrySave if it needs to retain access to this anchor. - -This method can yield null if the device has reached its limit of spatial anchors, or if the spatial understanding system times out during the import. - -## -examples - -## -see-also +--- +-api-id: M:Windows.Perception.Spatial.SpatialAnchorTransferManager.TryImportAnchorsAsync(Windows.Storage.Streams.IInputStream) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialAnchorTransferManager.TryImportAnchorsAsync + +## -description +Imports a stream of spatial anchors that was previously exported from another device. This allows both devices to reason about the same locations in their users' surroundings. + +## -parameters +### -param stream +The stream to import anchors from. + +## -returns +The operation that triggers once the import is complete, providing the imported anchors. + +## -remarks +You must first export the anchors on the source device using the TryExportAnchorsAsync method. It is then the app's responsibility to get the data in the stream to the other device through its own network channel. + +This imports the anchors and their supporting data into the device's spatial understanding. An app should then use [SpatialAnchorStore.TrySave](spatialanchorstore_trysave_1258774399.md) if it needs to retain access to this anchor. + +This method can yield null if the device has reached its limit of spatial anchors, or if the spatial understanding system times out during the import. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatialentity.md b/windows.perception.spatial/spatialentity.md new file mode 100644 index 0000000000..f40ec31240 --- /dev/null +++ b/windows.perception.spatial/spatialentity.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialEntity +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialEntity + +## -description +Represents a physical location in the user's surroundings and its metadata, which an app intends to share with other devices. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentity_anchor.md b/windows.perception.spatial/spatialentity_anchor.md new file mode 100644 index 0000000000..691c4fb2a1 --- /dev/null +++ b/windows.perception.spatial/spatialentity_anchor.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntity.Anchor +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntity.Anchor + +## -description +Gets the spatial anchor representing the shared location in the user's surroundings. + +## -property-value +The anchor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentity_id.md b/windows.perception.spatial/spatialentity_id.md new file mode 100644 index 0000000000..630bbf6c88 --- /dev/null +++ b/windows.perception.spatial/spatialentity_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntity.Id +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntity.Id + +## -description +Gets the globally-unique ID for this spatial entity. + +## -property-value +The ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentity_properties.md b/windows.perception.spatial/spatialentity_properties.md new file mode 100644 index 0000000000..e01c1a2cf4 --- /dev/null +++ b/windows.perception.spatial/spatialentity_properties.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntity.Properties +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntity.Properties + +## -description +Gets the key/value store of metadata for this spatial entity. + +## -property-value +The metadata. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentity_spatialentity_1042517783.md b/windows.perception.spatial/spatialentity_spatialentity_1042517783.md new file mode 100644 index 0000000000..39ee06f85b --- /dev/null +++ b/windows.perception.spatial/spatialentity_spatialentity_1042517783.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntity.#ctor(Windows.Perception.Spatial.SpatialAnchor,Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntity.SpatialEntity + +## -description +Creates a new spatial entity to share the provided spatial anchor and metadata. + +## -parameters + +### -param spatialAnchor +The spatial anchor to share. + +### -param propertySet +The metadata to share for this anchor. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentity_spatialentity_752207517.md b/windows.perception.spatial/spatialentity_spatialentity_752207517.md new file mode 100644 index 0000000000..b7061f3ecf --- /dev/null +++ b/windows.perception.spatial/spatialentity_spatialentity_752207517.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntity.#ctor(Windows.Perception.Spatial.SpatialAnchor) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntity.SpatialEntity + +## -description +Creates a new spatial entity to share the provided spatial anchor. + +## -parameters + +### -param spatialAnchor +The spatial anchor to share. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentityaddedeventargs.md b/windows.perception.spatial/spatialentityaddedeventargs.md new file mode 100644 index 0000000000..2d437e68f4 --- /dev/null +++ b/windows.perception.spatial/spatialentityaddedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialEntityAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialEntityAddedEventArgs + +## -description +Event data for spatial entity added events. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentityaddedeventargs_entity.md b/windows.perception.spatial/spatialentityaddedeventargs_entity.md new file mode 100644 index 0000000000..7b851e9650 --- /dev/null +++ b/windows.perception.spatial/spatialentityaddedeventargs_entity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntityAddedEventArgs.Entity +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntityAddedEventArgs.Entity + +## -description +Gets the spatial entity that was added. + +## -property-value +The added entity. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentityremovedeventargs.md b/windows.perception.spatial/spatialentityremovedeventargs.md new file mode 100644 index 0000000000..19879d21e8 --- /dev/null +++ b/windows.perception.spatial/spatialentityremovedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialEntityRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialEntityRemovedEventArgs + +## -description +Event data for spatial entity removed events. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentityremovedeventargs_entity.md b/windows.perception.spatial/spatialentityremovedeventargs_entity.md new file mode 100644 index 0000000000..b35455483b --- /dev/null +++ b/windows.perception.spatial/spatialentityremovedeventargs_entity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntityRemovedEventArgs.Entity +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntityRemovedEventArgs.Entity + +## -description +Gets the spatial entity that was removed. + +## -property-value +The removed entity. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitystore.md b/windows.perception.spatial/spatialentitystore.md new file mode 100644 index 0000000000..8768118fc8 --- /dev/null +++ b/windows.perception.spatial/spatialentitystore.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialEntityStore +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialEntityStore + +## -description +Represents a shared pool of spatial entities, synchronized automatically among the participants in a remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitystore_createentitywatcher_1492646848.md b/windows.perception.spatial/spatialentitystore_createentitywatcher_1492646848.md new file mode 100644 index 0000000000..aa15954185 --- /dev/null +++ b/windows.perception.spatial/spatialentitystore_createentitywatcher_1492646848.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntityStore.CreateEntityWatcher +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntityStore.CreateEntityWatcher + +## -description +Gets a watcher that lets an app observe when participants add, update or remove entities in the store. + +## -returns +The entity watcher. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitystore_issupported.md b/windows.perception.spatial/spatialentitystore_issupported.md new file mode 100644 index 0000000000..6defebc373 --- /dev/null +++ b/windows.perception.spatial/spatialentitystore_issupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntityStore.IsSupported +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntityStore.IsSupported + +## -description +Gets whether spatial entity sharing is supported on this system. + +## -property-value +Whether spatial entity sharing is supported on this system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitystore_removeasync_832631109.md b/windows.perception.spatial/spatialentitystore_removeasync_832631109.md new file mode 100644 index 0000000000..37fe39884d --- /dev/null +++ b/windows.perception.spatial/spatialentitystore_removeasync_832631109.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntityStore.RemoveAsync(Windows.Perception.Spatial.SpatialEntity) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntityStore.RemoveAsync + +## -description +Removes a spatial entity from the store for all participants. + +## -parameters + +### -param entity +The spatial entity to remove. + +## -returns +Action that triggers once once the entity removal has been communicated to the host. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitystore_saveasync_843270112.md b/windows.perception.spatial/spatialentitystore_saveasync_843270112.md new file mode 100644 index 0000000000..8272d28f5c --- /dev/null +++ b/windows.perception.spatial/spatialentitystore_saveasync_843270112.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntityStore.SaveAsync(Windows.Perception.Spatial.SpatialEntity) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntityStore.SaveAsync + +## -description +Saves a new or updated spatial entity into the store, to be synchronized with all participants. + +## -parameters + +### -param entity +The new or updated spatial entity. + +## -returns +Action that triggers once once the entity data has been communicated to the host. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitystore_tryget_722108543.md b/windows.perception.spatial/spatialentitystore_tryget_722108543.md new file mode 100644 index 0000000000..5a5007db0c --- /dev/null +++ b/windows.perception.spatial/spatialentitystore_tryget_722108543.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntityStore.TryGet(Windows.System.RemoteSystems.RemoteSystemSession) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntityStore.TryGet + +## -description +Establishes or retrieves an automatically-synchronized pool of spatial entities for a remote session. + +## -parameters + +### -param session +The remote session with the participants that will share spatial entities. + +## -returns +The spatial entity store. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentityupdatedeventargs.md b/windows.perception.spatial/spatialentityupdatedeventargs.md new file mode 100644 index 0000000000..d9a8b1dad1 --- /dev/null +++ b/windows.perception.spatial/spatialentityupdatedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialEntityUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialEntityUpdatedEventArgs + +## -description +Event data for spatial entity updated events. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentityupdatedeventargs_entity.md b/windows.perception.spatial/spatialentityupdatedeventargs_entity.md new file mode 100644 index 0000000000..5798c2c46e --- /dev/null +++ b/windows.perception.spatial/spatialentityupdatedeventargs_entity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntityUpdatedEventArgs.Entity +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntityUpdatedEventArgs.Entity + +## -description +Gets the spatial entity that was updated. + +## -property-value +The updated entity. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher.md b/windows.perception.spatial/spatialentitywatcher.md new file mode 100644 index 0000000000..f9c6ded122 --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialEntityWatcher +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher + +## -description +Monitors changes to the set of entities that participants add, update, or remove within a spatial entity store, and provides notifications when that set changes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher_added.md b/windows.perception.spatial/spatialentitywatcher_added.md new file mode 100644 index 0000000000..88850f08f1 --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher_added.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Perception.Spatial.SpatialEntityWatcher.Added +-api-type: winrt event +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher.Added + +## -description +The event that is raised when a new spatial entity is added to the store by a participant. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher_enumerationcompleted.md b/windows.perception.spatial/spatialentitywatcher_enumerationcompleted.md new file mode 100644 index 0000000000..c917dd6b0e --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher_enumerationcompleted.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Perception.Spatial.SpatialEntityWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher.EnumerationCompleted + +## -description +The event that is raised when the initial replay of prior changes to the spatial entity store has completed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher_removed.md b/windows.perception.spatial/spatialentitywatcher_removed.md new file mode 100644 index 0000000000..ce99269773 --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher_removed.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Perception.Spatial.SpatialEntityWatcher.Removed +-api-type: winrt event +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher.Removed + +## -description +The event that is raised when a spatial entity is removed from the store by a participant. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher_start_1587696324.md b/windows.perception.spatial/spatialentitywatcher_start_1587696324.md new file mode 100644 index 0000000000..70719a7d01 --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher_start_1587696324.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntityWatcher.Start +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher.Start + +## -description +Starts watching for changes to the set of spatial entities in the store. + +## -remarks +This will replay any changes to the spatial entity store that occurred before the app called Start. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher_status.md b/windows.perception.spatial/spatialentitywatcher_status.md new file mode 100644 index 0000000000..62da8465eb --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialEntityWatcher.Status +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher.Status + +## -description +Gets the operational status of the spatial entity watcher. + +## -property-value +The status. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher_stop_1201535524.md b/windows.perception.spatial/spatialentitywatcher_stop_1201535524.md new file mode 100644 index 0000000000..c9d6d12c22 --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher_stop_1201535524.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialEntityWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher.Stop + +## -description +Stops watching for changes to the set of spatial entities in the store. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcher_updated.md b/windows.perception.spatial/spatialentitywatcher_updated.md new file mode 100644 index 0000000000..69f2ba5301 --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcher_updated.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Perception.Spatial.SpatialEntityWatcher.Updated +-api-type: winrt event +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcher.Updated + +## -description +The event that is raised when an existing spatial entity has its metadata updated by a participant. + +## -remarks +Note that adjustments to the position of a spatial anchor that occur as the device learns more about its environment are not represented by this Updated event. Apps should react to changes to the anchor's coordinate system each frame, just as is necessary for local anchors. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialentitywatcherstatus.md b/windows.perception.spatial/spatialentitywatcherstatus.md new file mode 100644 index 0000000000..8c4ecad505 --- /dev/null +++ b/windows.perception.spatial/spatialentitywatcherstatus.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialEntityWatcherStatus +-api-type: winrt enum +--- + + + +# Windows.Perception.Spatial.SpatialEntityWatcherStatus + +## -description +Describes the state of a [SpatialEntityWatcher](spatialentitywatcher.md) object. + +## -enum-fields +### -field Created:0 +This is the initial state of a Watcher object. During this state clients can register event handlers. + +### -field Started:1 +The watcher transitions to the Started state once [Start](spatialentitywatcher_start_1587696324.md) is called. The watcher is enumerating the initial collection. Note that during this enumeration phase it is possible to receive [Updated](spatialentitywatcher_updated.md) and [Removed](spatialentitywatcher_removed.md) notifications but only to items that have already been [Added](spatialentitywatcher_added.md). + +### -field EnumerationCompleted:2 +The watcher has completed enumerating the initial collection. Items can still be added, updated or removed from the collection. + +### -field Stopping:3 +The client has called [Stop](spatialentitywatcher_stop_1201535524.md) and the watcher is still in the process of stopping. Events may still be raised. + +### -field Stopped:4 +The client has called [Stop](spatialentitywatcher_stop_1201535524.md) and the watcher has completed all outstanding events. No further events will be raised. + +### -field Aborted:5 +The watcher has aborted operation. No subsequent events will be raised. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatiallocation_absoluteangularacceleration.md b/windows.perception.spatial/spatiallocation_absoluteangularacceleration.md index c7c4306e7d..475db61f5c 100644 --- a/windows.perception.spatial/spatiallocation_absoluteangularacceleration.md +++ b/windows.perception.spatial/spatiallocation_absoluteangularacceleration.md @@ -1,22 +1,23 @@ ---- --api-id: P:Windows.Perception.Spatial.SpatialLocation.AbsoluteAngularAcceleration --api-type: winrt property ---- - - - -# Windows.Perception.Spatial.SpatialLocation.AbsoluteAngularAcceleration - -## -description -Gets the absolute angular acceleration of the device. This acceleration is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings. - -## -property-value -The angular acceleration. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.Spatial.SpatialLocation.AbsoluteAngularAcceleration +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialLocation.AbsoluteAngularAcceleration + +## -description +Gets the absolute angular acceleration of the device. This acceleration is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings. + +## -property-value +The angular acceleration. + +## -remarks +The acceleration is clamped to be less than 180 degrees in any direction. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatiallocator.md b/windows.perception.spatial/spatiallocator.md index 84a27d4931..55556043a1 100644 --- a/windows.perception.spatial/spatiallocator.md +++ b/windows.perception.spatial/spatiallocator.md @@ -1,22 +1,20 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialLocator --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialLocator - -## -description -Provides access to the location of a device that's tracked relative to the user's surroundings, such as a HoloLens. - -The SpatialLocator class represents a device whose position and orientation can be tracked by Windows relative to the user's surroundings. A SpatialLocator instance is the source for locator-attached and stationary frames of reference. On a HoloLens, these frames of reference can be used for holographic rendering and for reasoning about surfaces in the world around the device. - -## -remarks - - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialLocator +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialLocator + +## -description +Provides access to the location of a device that's tracked relative to the user's surroundings, such as a HoloLens or other Mixed Reality headset. + +## -remarks +The SpatialLocator class represents a device whose position and orientation can be tracked by Windows relative to the user's surroundings. A SpatialLocator instance is the source for locator-attached and stationary frames of reference. On a Mixed Reality headset such as HoloLens, these frames of reference can be used for holographic rendering and for reasoning about surfaces in the world around the device. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatiallocatorattachedframeofreference.md b/windows.perception.spatial/spatiallocatorattachedframeofreference.md index 7cc7480d19..1d286a7014 100644 --- a/windows.perception.spatial/spatiallocatorattachedframeofreference.md +++ b/windows.perception.spatial/spatiallocatorattachedframeofreference.md @@ -1,24 +1,24 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialLocatorAttachedFrameOfReference --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialLocatorAttachedFrameOfReference - -## -description -Represents a frame of reference that is positionally attached to the device. - -## -remarks -The SpatialLocatorAttachedFrameOfReference class represents a device-relative frame of reference that tracks changes in the position reported by the device's SpatialLocator. This frame has a fixed heading relative to the user's surroundings that points in the direction the user was facing when the frame was created. From then on, all orientations in this frame of reference are relative to that fixed heading, even as the user rotates the device. - -For HoloLens, the origin of this frame's coordinate system is located at the center of rotation of the user's head, so that its position is not affected by head rotation. - -To get a SpatialLocatorAttachedFrameOfReference, use the SpatialLocator class and call CreateAttachedFrameOfReferenceAtCurrentHeading. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialLocatorAttachedFrameOfReference +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialLocatorAttachedFrameOfReference + +## -description +Represents a frame of reference that is positionally attached to the device. + +## -remarks +The SpatialLocatorAttachedFrameOfReference class represents a device-relative frame of reference that tracks changes in the position reported by the device's [SpatialLocator](spatiallocator.md). This frame has a fixed heading relative to the user's surroundings that points in the direction the user was facing when the frame was created. From then on, all orientations in this frame of reference are relative to that fixed heading, even as the user rotates the device. + +For a headset such as HoloLens, the origin of this frame's coordinate system is located at the center of rotation of the user's head, so that its position is not affected by head rotation. + +To get a SpatialLocatorAttachedFrameOfReference, use the [SpatialLocator](spatiallocator.md) class and call [CreateAttachedFrameOfReferenceAtCurrentHeading](spatiallocator_createattachedframeofreferenceatcurrentheading_609311736.md). + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatiallocatorpositionaltrackingdeactivatingeventargs.md b/windows.perception.spatial/spatiallocatorpositionaltrackingdeactivatingeventargs.md index cabee755bd..6603ed9155 100644 --- a/windows.perception.spatial/spatiallocatorpositionaltrackingdeactivatingeventargs.md +++ b/windows.perception.spatial/spatiallocatorpositionaltrackingdeactivatingeventargs.md @@ -1,20 +1,20 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialLocatorPositionalTrackingDeactivatingEventArgs --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialLocatorPositionalTrackingDeactivatingEventArgs - -## -description -Provides data for the SpatialLocator.PositionalTrackingDeactivating event. - -## -remarks -Set the Canceled property to true to prevent positional tracking from deactivating due to inactivity. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialLocatorPositionalTrackingDeactivatingEventArgs +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialLocatorPositionalTrackingDeactivatingEventArgs + +## -description +Provides data for the [SpatialLocator.PositionalTrackingDeactivating](spatiallocator_positionaltrackingdeactivating.md) event. + +## -remarks +Set the [Canceled](spatiallocatorpositionaltrackingdeactivatingeventargs_canceled.md) property to true to prevent positional tracking from deactivating due to inactivity. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/spatiallookdirectionrange.md b/windows.perception.spatial/spatiallookdirectionrange.md new file mode 100644 index 0000000000..6add20d863 --- /dev/null +++ b/windows.perception.spatial/spatiallookdirectionrange.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialLookDirectionRange +-api-type: winrt enum +--- + + + +# Windows.Perception.Spatial.SpatialLookDirectionRange + +## -description +The extent to which the user can look around with their headset. + +## -enum-fields +### -field ForwardOnly:0 +The user will generally be looking forward as defined by the [CoordinateSystem](spatialstageframeofreference_coordinatesystem.md) property. + +### -field Omnidirectional:1 +The user may look in any direction. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialmovementrange.md b/windows.perception.spatial/spatialmovementrange.md new file mode 100644 index 0000000000..40536c45dd --- /dev/null +++ b/windows.perception.spatial/spatialmovementrange.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialMovementRange +-api-type: winrt enum +--- + + + +# Windows.Perception.Spatial.SpatialMovementRange + +## -description +The extent to which the user can move while wearing their headset. + +## -enum-fields +### -field NoMovement:0 +The user can stand but has not defined a boundary within which they intend to walk while using the headset. + +### -field Bounded:1 +The user can walk around within the bounds returned by [TryGetMovementBounds](spatialstageframeofreference_trygetmovementbounds_1236197507.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialperceptionaccessstatus.md b/windows.perception.spatial/spatialperceptionaccessstatus.md index e9a022fda0..7d85f7cb53 100644 --- a/windows.perception.spatial/spatialperceptionaccessstatus.md +++ b/windows.perception.spatial/spatialperceptionaccessstatus.md @@ -1,34 +1,34 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialPerceptionAccessStatus --api-type: winrt enum ---- - - - -# SpatialPerceptionAccessStatus - -## -description -This enumeration describes an app's ability to see the user's surroundings in ways that require the spatialPerception capability. This includes use of either SpatialSurfaceObserver or SpatialAnchorTransferManager. - -## -enum-fields -### -field Unspecified:0 -The user has not yet decided whether the app can use this spatial perception functionality. - -### -field Allowed:1 -The user has allowed the app to use this spatial perception functionality. - -### -field DeniedByUser:2 -The user has denied the app use of this spatial perception functionality. - -### -field DeniedBySystem:3 -The system has denied the app use of this spatial perception functionality. - - -## -remarks -To use those APIs, call the RequestAccessAsync method on the relevant type first. - -## -examples - +--- +-api-id: T:Windows.Perception.Spatial.SpatialPerceptionAccessStatus +-api-type: winrt enum +--- + + + +# SpatialPerceptionAccessStatus + +## -description +This enumeration describes an app's ability to see the user's surroundings in ways that require the spatialPerception capability. This includes use of either [SpatialSurfaceObserver](../windows.perception.spatial.surfaces/spatialsurfaceobserver.md) or [SpatialAnchorTransferManager](spatialanchortransfermanager.md). + +## -enum-fields +### -field Unspecified:0 +The user has not yet decided whether the app can use this spatial perception functionality. + +### -field Allowed:1 +The user has allowed the app to use this spatial perception functionality. + +### -field DeniedByUser:2 +The user has denied the app use of this spatial perception functionality. + +### -field DeniedBySystem:3 +The system has denied the app use of this spatial perception functionality. + + +## -remarks +To use those APIs, call the RequestAccessAsync method on the relevant type first. + +## -examples + ## -see-also \ No newline at end of file diff --git a/windows.perception.spatial/spatialstageframeofreference.md b/windows.perception.spatial/spatialstageframeofreference.md new file mode 100644 index 0000000000..48a259b43f --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference.md @@ -0,0 +1,29 @@ +--- +-api-id: T:Windows.Perception.Spatial.SpatialStageFrameOfReference +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference + +## -description +Represents a spatial stage, defined by the user to establish the physical space in which they intend to use a Mixed Reality headset. + +## -remarks +A spatial stage consists minimally of a floor-level coordinate system whose origin is chosen by the user, representing the logical center of the area in which they intend to use their Mixed Reality headset. This floor-level coordinate system enables apps to present standing-scale experiences. + +Optionally, the user may also define a movement boundary, representing the open area in which they intend to walk while using the headset. This movement boundary enables apps to present room-scale experiences. + +If the user has not defined a spatial stage, an app may call the [RequestNewStageAsync](spatialstageframeofreference_requestnewstageasync_1196621824.md) method to guide the user through system UI that will allow them to define one. + +On HoloLens, an app may also build standing-scale or room-scale experiences using spatial mapping. Spatial mapping enables the developer to analyze the user's surroundings and determine the locations of the user's walls and floors using the [SpatialSurfaceObserver](../windows.perception.spatial.surfaces/spatialsurfaceobserver.md) type, even if the user has not defined a stage manually. Inspect the [SpatialSurfaceObserver.IsSupported](../windows.perception.spatial.surfaces/spatialsurfaceobserver_issupported_930300905.md) property to determine if the current device supports spatial mapping. + +Coordinate systems returned by the stage are right-handed, with +y up, +x to the right, and -z forward. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_coordinatesystem.md b/windows.perception.spatial/spatialstageframeofreference_coordinatesystem.md new file mode 100644 index 0000000000..36747e0d0f --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_coordinatesystem.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialStageFrameOfReference.CoordinateSystem +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.CoordinateSystem + +## -description +Gets a floor-level coordinate system located at the stage origin defined by the user. + +## -property-value +The coordinate system. + +## -remarks +The coordinate system is right-handed, with +y up, +x to the right, and -z forward. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_current.md b/windows.perception.spatial/spatialstageframeofreference_current.md new file mode 100644 index 0000000000..e2a99fe241 --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_current.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialStageFrameOfReference.Current +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.Current + +## -description +Gets the current spatial stage, if one has been defined by the user. + +## -property-value +The current spatial stage. + +## -remarks +This property will return null if the user has not defined a spatial stage. On HoloLens, users are not yet able to define a spatial stage. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_currentchanged.md b/windows.perception.spatial/spatialstageframeofreference_currentchanged.md new file mode 100644 index 0000000000..255bf3f21e --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_currentchanged.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.Perception.Spatial.SpatialStageFrameOfReference.CurrentChanged +-api-type: winrt event +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.CurrentChanged + +## -description +Occurs when the user changes or redefines the current spatial stage. + +## -remarks +When this occurs, inspect the [Current](spatialstageframeofreference_current.md) property again to get the latest stage instance. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_getcoordinatesystematcurrentlocation_1313284906.md b/windows.perception.spatial/spatialstageframeofreference_getcoordinatesystematcurrentlocation_1313284906.md new file mode 100644 index 0000000000..88833cb025 --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_getcoordinatesystematcurrentlocation_1313284906.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialStageFrameOfReference.GetCoordinateSystemAtCurrentLocation(Windows.Perception.Spatial.SpatialLocator) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.GetCoordinateSystemAtCurrentLocation + +## -description +Gets a floor-level coordinate system at the user's current position and orientation. + +## -parameters + +### -param locator +The spatial locator with the position and orientation to use as the origin for the returned coordinate system. + +## -returns +The coordinate system. + +## -remarks +The coordinate system is right-handed, with +y up, +x to the right, and -z forward. + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_lookdirectionrange.md b/windows.perception.spatial/spatialstageframeofreference_lookdirectionrange.md new file mode 100644 index 0000000000..51e328c880 --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_lookdirectionrange.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialStageFrameOfReference.LookDirectionRange +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.LookDirectionRange + +## -description +Gets the extent to which the user can look around with their headset. + +## -property-value +The look direction range. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_movementrange.md b/windows.perception.spatial/spatialstageframeofreference_movementrange.md new file mode 100644 index 0000000000..0bc97f39cb --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_movementrange.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Perception.Spatial.SpatialStageFrameOfReference.MovementRange +-api-type: winrt property +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.MovementRange + +## -description +Gets the extent to which the user can move while wearing their headset. + +## -property-value +The movement range. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_requestnewstageasync_1196621824.md b/windows.perception.spatial/spatialstageframeofreference_requestnewstageasync_1196621824.md new file mode 100644 index 0000000000..601aa30ef7 --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_requestnewstageasync_1196621824.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialStageFrameOfReference.RequestNewStageAsync +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.RequestNewStageAsync + +## -description +Shows system UI to guide the user in defining a new stage to replace the current stage. + +## -parameters + +## -returns +An app may call RequestNewStageAsync if there is no stage defined or if the current stage is insufficient to meet the app's needs, such as not defining movement bounds. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstageframeofreference_trygetmovementbounds_1236197507.md b/windows.perception.spatial/spatialstageframeofreference_trygetmovementbounds_1236197507.md new file mode 100644 index 0000000000..266517bbe3 --- /dev/null +++ b/windows.perception.spatial/spatialstageframeofreference_trygetmovementbounds_1236197507.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Perception.Spatial.SpatialStageFrameOfReference.TryGetMovementBounds(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.Perception.Spatial.SpatialStageFrameOfReference.TryGetMovementBounds + +## -description +Gets the boundary vertices of the open area defined by the user where they intend to move while using their headset. + +## -parameters + +### -param coordinateSystem +The coordinate system in which to express the boundary vertices. + +## -returns +The boundary vertices. + +## -remarks +This method will return null if the user has not defined movement bounds. (i.e. if [MovementRange](spatialstageframeofreference_movementrange.md) is NoMovement) + +## -see-also + +## -examples + diff --git a/windows.perception.spatial/spatialstationaryframeofreference.md b/windows.perception.spatial/spatialstationaryframeofreference.md index 6def044fff..a6ec225ced 100644 --- a/windows.perception.spatial/spatialstationaryframeofreference.md +++ b/windows.perception.spatial/spatialstationaryframeofreference.md @@ -1,24 +1,26 @@ ---- --api-id: T:Windows.Perception.Spatial.SpatialStationaryFrameOfReference --api-type: winrt class ---- - - - -# Windows.Perception.Spatial.SpatialStationaryFrameOfReference - -## -description -Represents a frame of reference that remains stationary relative to the user's surroundings at a point in time. - -## -remarks -The SpatialStationaryFrameOfReference class represents a frame of reference that remains stationary relative to the user's surroundings as the user moves around. This frame of reference prioritizes keeping coordinates stable near the device. One key use of a SpatialStationaryFrameOfReference is to act as the underlying world coordinate system within a rendering engine when rendering holograms. - -Holograms rendered at a coordinate in this frame stay generally in place as the user moves the device around. However, as the user walks around a large area and the device adjusts its understanding of their surroundings, these holograms may drift relative to the world. To avoid this drift and strongly anchor content to a point in the user's surroundings, create a SpatialAnchor. The system will then adjust the position of that SpatialAnchor relative to this and other frames of reference as required to keep that anchor precisely in place in the world. - -To get a SpatialStationaryFrameOfReference, use the SpatialLocator class and call CreateStationaryFrameOfReferenceAtCurrentLocation. - -## -examples - -## -see-also +--- +-api-id: T:Windows.Perception.Spatial.SpatialStationaryFrameOfReference +-api-type: winrt class +--- + + + +# Windows.Perception.Spatial.SpatialStationaryFrameOfReference + +## -description +Represents a frame of reference that remains stationary relative to the user's surroundings at a point in time. + +## -remarks +The SpatialStationaryFrameOfReference class represents a frame of reference that remains stationary relative to the user's surroundings as the user moves around. This frame of reference prioritizes keeping coordinates stable near the device. One key use of a SpatialStationaryFrameOfReference is to act as the underlying world coordinate system within a rendering engine when rendering seated-scale or world-scale experiences. + +Holograms rendered at a coordinate in this frame stay generally in place as the user moves the device around. However, as the user walks around a large area and the device adjusts its understanding of their surroundings, these holograms may drift relative to the world. To avoid this drift and strongly anchor content to a point in the user's surroundings, create a [SpatialAnchor](spatialanchor.md). The system will then adjust the position of that SpatialAnchor relative to this and other frames of reference as required to keep that anchor precisely in place in the world. + +To get a SpatialStationaryFrameOfReference, use the SpatialLocator class and call CreateStationaryFrameOfReferenceAtCurrentLocation. + +To build a standing-scale or room-scale experience based on the floor plane or movement boundary defined by the user, an app can use the [SpatialStageFrameOfReference](spatialstageframeofreference.md) class instead. + +## -examples + +## -see-also diff --git a/windows.perception.spatial/windows_perception_spatial.md b/windows.perception.spatial/windows_perception_spatial.md index 86b8fb5e32..7621001f7f 100644 --- a/windows.perception.spatial/windows_perception_spatial.md +++ b/windows.perception.spatial/windows_perception_spatial.md @@ -1,15 +1,15 @@ ---- --api-id: N:Windows.Perception.Spatial --api-type: winrt namespace ---- - -# Windows.Perception.Spatial - -## -description -Contains classes that let apps react naturally to your gaze, gestures, and voice in the world around you. - -## -remarks - -## -examples - +--- +-api-id: N:Windows.Perception.Spatial +-api-type: winrt namespace +--- + +# Windows.Perception.Spatial + +## -description +Contains classes for reasoning about the spatial relationships within the user's surroundings. + +## -remarks + +## -examples + ## -see-also \ No newline at end of file diff --git a/windows.perception/perceptiontimestamp_predictionamount.md b/windows.perception/perceptiontimestamp_predictionamount.md index 033ae35db1..0019dc52b2 100644 --- a/windows.perception/perceptiontimestamp_predictionamount.md +++ b/windows.perception/perceptiontimestamp_predictionamount.md @@ -1,24 +1,25 @@ ---- --api-id: P:Windows.Perception.PerceptionTimestamp.PredictionAmount --api-type: winrt property ---- - - - -# Windows.Perception.PerceptionTimestamp.PredictionAmount - -## -description -For timestamps about the future, gets the span of time between when the prediction was made and TargetTime. When you get an improved prediction (for example, from a newer HolographicFramePrediction), TargetTime will stay the same and PredictionAmount will decrease. - -For timestamps about the past, PredictionAmount is always 0, even if the data associated with this timestamp was interpolated between two readings. - -## -property-value -The prediction duration. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.Perception.PerceptionTimestamp.PredictionAmount +-api-type: winrt property +--- + + + +# Windows.Perception.PerceptionTimestamp.PredictionAmount + +## -description +For timestamps about the future, gets the span of time between when the prediction was made and [TargetTime](perceptiontimestamp_targettime.md). + +## -property-value +The prediction duration. + +## -remarks +When you get an improved prediction (for example, from a newer [HolographicFramePrediction](../windows.graphics.holographic/holographicframeprediction.md), TargetTime will stay the same and PredictionAmount will decrease. + +For timestamps about the past, PredictionAmount is always 0, even if the data associated with this timestamp was interpolated between two readings. + +## -examples + +## -see-also diff --git a/windows.phone.management.deployment/enterpriseenrollmentmanager_requestenrollmentasync_336197181.md b/windows.phone.management.deployment/enterpriseenrollmentmanager_requestenrollmentasync_336197181.md new file mode 100644 index 0000000000..c6860ed48f --- /dev/null +++ b/windows.phone.management.deployment/enterpriseenrollmentmanager_requestenrollmentasync_336197181.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Phone.Management.Deployment.EnterpriseEnrollmentManager.RequestEnrollmentAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Phone.Management.Deployment.EnterpriseEnrollmentManager.RequestEnrollmentAsync + +## -description +Enrolls or re-enrolls the enterprise identified by the Uri. + +## -parameters + +### -param enrollmentToken +The Uri for the enterprise to enroll. + +## -returns +The asynchronous operation that reports the result of the enrollment action. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.phone.networking.voip/callanswereventargs.md b/windows.phone.networking.voip/callanswereventargs.md new file mode 100644 index 0000000000..63f9549754 --- /dev/null +++ b/windows.phone.networking.voip/callanswereventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.CallAnswerEventArgs +-api-type: winrt class +--- + + + +# Windows.Phone.Networking.Voip.CallAnswerEventArgs + +## -description +Supports the [AnswerRequested](voipphonecall_answerrequested.md) event of the [VoipPhoneCall](voipphonecall.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/callanswereventargs_acceptedmedia.md b/windows.phone.networking.voip/callanswereventargs_acceptedmedia.md new file mode 100644 index 0000000000..ba94ddc2ea --- /dev/null +++ b/windows.phone.networking.voip/callanswereventargs_acceptedmedia.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.CallAnswerEventArgs.AcceptedMedia +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.CallAnswerEventArgs.AcceptedMedia + +## -description +Gets the media types that the user selected when answering the call. + +## -property-value +The media types that the user selected when answering the call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/callrejecteventargs.md b/windows.phone.networking.voip/callrejecteventargs.md new file mode 100644 index 0000000000..9c14cf7480 --- /dev/null +++ b/windows.phone.networking.voip/callrejecteventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.CallRejectEventArgs +-api-type: winrt class +--- + + + +# Windows.Phone.Networking.Voip.CallRejectEventArgs + +## -description +Supports the [RejectRequested](voipphonecall_rejectrequested.md) event of the [VoipPhoneCall](voipphonecall.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/callrejecteventargs_rejectreason.md b/windows.phone.networking.voip/callrejecteventargs_rejectreason.md new file mode 100644 index 0000000000..0a744bae92 --- /dev/null +++ b/windows.phone.networking.voip/callrejecteventargs_rejectreason.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.CallRejectEventArgs.RejectReason +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.CallRejectEventArgs.RejectReason + +## -description +Gets the reason the incoming call was rejected. + +## -property-value +The reasone the incoming call was rejected. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/callstatechangeeventargs.md b/windows.phone.networking.voip/callstatechangeeventargs.md new file mode 100644 index 0000000000..084200fbb9 --- /dev/null +++ b/windows.phone.networking.voip/callstatechangeeventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.CallStateChangeEventArgs +-api-type: winrt class +--- + + + +# Windows.Phone.Networking.Voip.CallStateChangeEventArgs + +## -description +Supports the [EndRequested](voipphonecall_endrequested.md), [HoldRequested](voipphonecall_holdrequested.md), and [ResumeRequested](voipphonecall_resumerequested.md) events of the [VoipPhoneCall](voipphonecall.md) class. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/callstatechangeeventargs_state.md b/windows.phone.networking.voip/callstatechangeeventargs_state.md new file mode 100644 index 0000000000..1c711b0b20 --- /dev/null +++ b/windows.phone.networking.voip/callstatechangeeventargs_state.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.CallStateChangeEventArgs.State +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.CallStateChangeEventArgs.State + +## -description +Gets the current state of the VoIP call. + +## -property-value +The current state of the VoIP call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/ivoipoperation.md b/windows.phone.networking.voip/ivoipoperation.md new file mode 100644 index 0000000000..efe121d5fa --- /dev/null +++ b/windows.phone.networking.voip/ivoipoperation.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.IVoipOperation +-api-type: winrt interface +--- + + + +# Windows.Phone.Networking.Voip.IVoipOperation + +## -description +The base interface of all VoIP operations. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.phone.networking.voip/ivoipoperation_id.md b/windows.phone.networking.voip/ivoipoperation_id.md new file mode 100644 index 0000000000..b0930e686e --- /dev/null +++ b/windows.phone.networking.voip/ivoipoperation_id.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.IVoipOperation.Id +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.IVoipOperation.Id + +## -description +Gets the ID of the VoIP operation. + +## -property-value +The ID of the VoIP operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/ivoipoperation_type.md b/windows.phone.networking.voip/ivoipoperation_type.md new file mode 100644 index 0000000000..8d9d5108fa --- /dev/null +++ b/windows.phone.networking.voip/ivoipoperation_type.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.IVoipOperation.Type +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.IVoipOperation.Type + +## -description +Gets the type of the VoIP operation. + +## -property-value +The type of the VoIP operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/mutechangeeventargs.md b/windows.phone.networking.voip/mutechangeeventargs.md new file mode 100644 index 0000000000..4b8ad057e9 --- /dev/null +++ b/windows.phone.networking.voip/mutechangeeventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.MuteChangeEventArgs +-api-type: winrt class +--- + + + +# Windows.Phone.Networking.Voip.MuteChangeEventArgs + +## -description +Supports the [Muted](mutechangeeventargs_muted.md) and [Unmuted](voipcallcoordinator_notifyunmuted.md) events. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/mutechangeeventargs_muted.md b/windows.phone.networking.voip/mutechangeeventargs_muted.md new file mode 100644 index 0000000000..f9247056c9 --- /dev/null +++ b/windows.phone.networking.voip/mutechangeeventargs_muted.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.MuteChangeEventArgs.Muted +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.MuteChangeEventArgs.Muted + +## -description +Gets whether the call is currently muted. + +## -property-value +Whether the call is currently muted. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/queryseamlessupgradesupportoperation.md b/windows.phone.networking.voip/queryseamlessupgradesupportoperation.md new file mode 100644 index 0000000000..c94cf48e96 --- /dev/null +++ b/windows.phone.networking.voip/queryseamlessupgradesupportoperation.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation +-api-type: winrt class +--- + + + +# Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation + +## -description +Represents a VoIP operation to determine if a remote user supports seamless upgrade from a cellular call to a VoIP call. + +## -remarks + +## -examples + +## -see-also +[IVoipOperation](ivoipoperation.md) \ No newline at end of file diff --git a/windows.phone.networking.voip/queryseamlessupgradesupportoperation_id.md b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_id.md new file mode 100644 index 0000000000..ab680230a4 --- /dev/null +++ b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_id.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.Id +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.Id + +## -description +Gets the ID of the VoIP operation. + +## -property-value +The ID of the VoIP operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/queryseamlessupgradesupportoperation_notifycompletion_50902544.md b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_notifycompletion_50902544.md new file mode 100644 index 0000000000..ef19a0ccb0 --- /dev/null +++ b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_notifycompletion_50902544.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.NotifyCompletion(System.Boolean,Windows.Phone.Networking.Voip.SeamlessCallUpgradeSupport) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.NotifyCompletion + +## -description +Notifies the system that the VoIP operation has completed. + +## -parameters +### -param succeeded +Whether the operation succeeded. + +### -param seamlessCallUpgradeSupport +The support level for seamlessly upgrading calls to VoIP. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/queryseamlessupgradesupportoperation_remoteid.md b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_remoteid.md new file mode 100644 index 0000000000..53c5b43ff0 --- /dev/null +++ b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_remoteid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.RemoteId +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.RemoteId + +## -description +Gets the remote ID of the user for which seamless VoIP upgrade support is being queried. + +## -property-value +The remote ID of the user for which seamless VoIP upgrade support is being queried. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/queryseamlessupgradesupportoperation_type.md b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_type.md new file mode 100644 index 0000000000..0beca553d4 --- /dev/null +++ b/windows.phone.networking.voip/queryseamlessupgradesupportoperation_type.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.Type +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.QuerySeamlessUpgradeSupportOperation.Type + +## -description +Gets the type of the VoIP operation. + +## -property-value +The type of the VoIP operation. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/seamlesscallupgradesupport.md b/windows.phone.networking.voip/seamlesscallupgradesupport.md new file mode 100644 index 0000000000..618328127b --- /dev/null +++ b/windows.phone.networking.voip/seamlesscallupgradesupport.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.SeamlessCallUpgradeSupport +-api-type: winrt enum +--- + + + +# SeamlessCallUpgradeSupport + +## -description +Specifies the support level for seamlessly upgrading cellular calls to VoIP. + +## -enum-fields +### -field Unknown:0 +VoIP call upgrade support cannot be determined. + +### -field NotSupported:1 +VoIP call upgrade is not supported. + +### -field Supported:2 +VoIP call upgrade is supported. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator.md b/windows.phone.networking.voip/voipcallcoordinator.md new file mode 100644 index 0000000000..30aeb80762 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.VoipCallCoordinator +-api-type: winrt class +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator + +## -description +Allows an application to manage VoIP calls. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator_cancelupgrade_1383369175.md b/windows.phone.networking.voip/voipcallcoordinator_cancelupgrade_1383369175.md new file mode 100644 index 0000000000..db4218c09b --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_cancelupgrade_1383369175.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.CancelUpgrade(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.CancelUpgrade + +## -description +Notifies the system to cancel the upgrade process. + +## -parameters +### -param callUpgradeGuid + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/voipcallcoordinator_confirmnonseamlessupgrade_168297368.md b/windows.phone.networking.voip/voipcallcoordinator_confirmnonseamlessupgrade_168297368.md new file mode 100644 index 0000000000..d9c6d8cb19 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_confirmnonseamlessupgrade_168297368.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.ConfirmNonSeamlessUpgrade(System.Guid) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.ConfirmNonSeamlessUpgrade + +## -description +Notifies the system to end the originating cellular call. + +## -parameters +### -param callUpgradeGuid + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/voipcallcoordinator_getdefault_846721868.md b/windows.phone.networking.voip/voipcallcoordinator_getdefault_846721868.md new file mode 100644 index 0000000000..2264691169 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_getdefault_846721868.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.GetDefault +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.GetDefault + +## -description +Retrieves the default instance of the [VoipCallCoordinator](voipcallcoordinator.md) class. + +## -returns +The default instance. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator_getnextoperation_323606075.md b/windows.phone.networking.voip/voipcallcoordinator_getnextoperation_323606075.md new file mode 100644 index 0000000000..d2d55661d0 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_getnextoperation_323606075.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.GetNextOperation +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.GetNextOperation + +## -description +Gets the next VoIP operation to be performed. + +## -returns +The next VoIP operation to be performed. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/voipcallcoordinator_muterequested.md b/windows.phone.networking.voip/voipcallcoordinator_muterequested.md new file mode 100644 index 0000000000..acca3121b2 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_muterequested.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Phone.Networking.Voip.VoipCallCoordinator.MuteRequested +-api-type: winrt event +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.MuteRequested + +## -description +Raised when the VoIP app should mute all of its calls. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator_notifymuted_910830725.md b/windows.phone.networking.voip/voipcallcoordinator_notifymuted_910830725.md new file mode 100644 index 0000000000..b630485673 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_notifymuted_910830725.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.NotifyMuted +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.NotifyMuted + +## -description +Notifies the system that the user has muted the call using the VoIP app's UI. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator_notifyunmuted_41225160.md b/windows.phone.networking.voip/voipcallcoordinator_notifyunmuted_41225160.md new file mode 100644 index 0000000000..9812c84cbd --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_notifyunmuted_41225160.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.NotifyUnmuted +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.NotifyUnmuted + +## -description +Notifies the system that the user has unmuted the call using the VoIP app's UI. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator_requestincomingupgradetovideocall_532215100.md b/windows.phone.networking.voip/voipcallcoordinator_requestincomingupgradetovideocall_532215100.md new file mode 100644 index 0000000000..2de6ed0f22 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_requestincomingupgradetovideocall_532215100.md @@ -0,0 +1,50 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestIncomingUpgradeToVideoCall(System.String,System.String,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,Windows.Foundation.TimeSpan,Windows.Phone.Networking.Voip.VoipPhoneCall@) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestIncomingUpgradeToVideoCall + +## -description +Notifies the system of a new incoming video call that will replace an existing cellular call. + +## -parameters +### -param context +A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file. + +### -param contactName +The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactNumber +The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactImage +The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1 MB. + +### -param serviceName +The name of the VoIP service or application. The maximum length is 128 characters. + +### -param brandingImage +The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128 KB. + +### -param callDetails +A string indicating who the call is on behalf of. The maximum length is 128 characters. + +### -param ringtone +The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1 MB. + +### -param ringTimeout +The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds. + +### -param call +The object representing the new incoming call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/voipcallcoordinator_requestnewincomingcall_2060014560.md b/windows.phone.networking.voip/voipcallcoordinator_requestnewincomingcall_2060014560.md new file mode 100644 index 0000000000..1d074eb086 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_requestnewincomingcall_2060014560.md @@ -0,0 +1,57 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestNewIncomingCall(System.String,System.String,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,System.String,Windows.Foundation.Uri,Windows.Phone.Networking.Voip.VoipCallMedia,Windows.Foundation.TimeSpan,Windows.Phone.Networking.Voip.VoipPhoneCall@) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestNewIncomingCall + +## -description +Notifies the system of a new incoming call. + +## -parameters +### -param context +A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null. + +### -param contactName +The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactNumber +The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters. + +### -param contactImage +The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1MB. + +### -param serviceName +The name of the VoIP service or application. The maximum length is 128 characters. + +### -param brandingImage +The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128KB. + +### -param callDetails +A string indicating who the call is on behalf of. The maximum length is 128 characters. + +### -param ringtone +The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1MB. + +### -param media +The media types of the new incoming call. + +### -param ringTimeout +The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds. + +### -param call +The object representing the new incoming call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator_requestnewoutgoingcall_214813965.md b/windows.phone.networking.voip/voipcallcoordinator_requestnewoutgoingcall_214813965.md new file mode 100644 index 0000000000..0336a09527 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_requestnewoutgoingcall_214813965.md @@ -0,0 +1,39 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestNewOutgoingCall(System.String,System.String,System.String,Windows.Phone.Networking.Voip.VoipCallMedia,Windows.Phone.Networking.Voip.VoipPhoneCall@) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestNewOutgoingCall + +## -description +Notifies the system of a new outgoing call. + +## -parameters +### -param context +A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null. + +### -param contactName +The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +### -param serviceName +The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +### -param media +The media types of the new outgoing call. + +### -param call +The object representing the new outgoing call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallcoordinator_requestoutgoingupgradetovideocall_1197932214.md b/windows.phone.networking.voip/voipcallcoordinator_requestoutgoingupgradetovideocall_1197932214.md new file mode 100644 index 0000000000..a253ea651b --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_requestoutgoingupgradetovideocall_1197932214.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestOutgoingUpgradeToVideoCall(System.Guid,System.String,System.String,System.String,Windows.Phone.Networking.Voip.VoipPhoneCall@) +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.RequestOutgoingUpgradeToVideoCall + +## -description +Notifies the system of a new outgoing video call that will replace an existing cellular call. + +## -parameters +### -param callUpgradeGuid +The GUID of the call. + +### -param context +A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file. + +### -param contactName +The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +### -param serviceName +The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters. + +### -param call +The object representing the new outgoing call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/voipcallcoordinator_unmuterequested.md b/windows.phone.networking.voip/voipcallcoordinator_unmuterequested.md new file mode 100644 index 0000000000..2938566d61 --- /dev/null +++ b/windows.phone.networking.voip/voipcallcoordinator_unmuterequested.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Phone.Networking.Voip.VoipCallCoordinator.UnmuteRequested +-api-type: winrt event +--- + + + +# Windows.Phone.Networking.Voip.VoipCallCoordinator.UnmuteRequested + +## -description +Raised when the VoIP app should unmute all of its calls. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallmedia.md b/windows.phone.networking.voip/voipcallmedia.md new file mode 100644 index 0000000000..324a160168 --- /dev/null +++ b/windows.phone.networking.voip/voipcallmedia.md @@ -0,0 +1,34 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.VoipCallMedia +-api-type: winrt enum +--- + + + +# VoipCallMedia + +## -description +Specifies the media types used by a VoIP call. + +## -enum-fields +### -field None:0 +The call uses no media. + +### -field Audio:1 +The call uses audio. + +### -field Video:2 +The call uses video. + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallrejectreason.md b/windows.phone.networking.voip/voipcallrejectreason.md new file mode 100644 index 0000000000..3f532b4c64 --- /dev/null +++ b/windows.phone.networking.voip/voipcallrejectreason.md @@ -0,0 +1,40 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.VoipCallRejectReason +-api-type: winrt enum +--- + + + +# VoipCallRejectReason + +## -description +Specifies the reason that an incoming call was rejected. + +## -enum-fields +### -field UserIgnored:0 +The user pressed a button to ignore the call. + +### -field TimedOut:1 +The incoming call timed out. + +### -field OtherIncomingCall:2 +Another incoming call was accepted. + +### -field EmergencyCallExists:3 +An emergency call is in progress. + +### -field InvalidCallState:4 +The call is in an invalid state. + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipcallstate.md b/windows.phone.networking.voip/voipcallstate.md new file mode 100644 index 0000000000..f319530716 --- /dev/null +++ b/windows.phone.networking.voip/voipcallstate.md @@ -0,0 +1,40 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.VoipCallState +-api-type: winrt enum +--- + + + +# VoipCallState + +## -description +Specifies the state of a VoIP call. + +## -enum-fields +### -field Ended:0 +The call has ended. + +### -field Held:1 +The call is on hold. + +### -field Active:2 +The call is active. + +### -field Incoming:3 +The call is incoming but not yet active. + +### -field Outgoing:4 +The call is outgoing but not yet active. + + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipoperationtype.md b/windows.phone.networking.voip/voipoperationtype.md new file mode 100644 index 0000000000..6903b84bca --- /dev/null +++ b/windows.phone.networking.voip/voipoperationtype.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.VoipOperationType +-api-type: winrt enum +--- + + + +# VoipOperationType + +## -description +Specifies the type of a VoIP operation. + +## -enum-fields +### -field QueryRemotePartySeamless:0 +The operation is a query to see if the remote party supports upgrading calls from cellular to VoIP. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall.md b/windows.phone.networking.voip/voipphonecall.md new file mode 100644 index 0000000000..100f2bf71e --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.Phone.Networking.Voip.VoipPhoneCall +-api-type: winrt class +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall + +## -description +Represents a VoIP phone call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_answerrequested.md b/windows.phone.networking.voip/voipphonecall_answerrequested.md new file mode 100644 index 0000000000..261072c4e3 --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_answerrequested.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.Phone.Networking.Voip.VoipPhoneCall.AnswerRequested +-api-type: winrt event +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.AnswerRequested + +## -description +Raised when the user answers an incoming call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_callmedia.md b/windows.phone.networking.voip/voipphonecall_callmedia.md new file mode 100644 index 0000000000..3f95767ea7 --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_callmedia.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.VoipPhoneCall.CallMedia +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.CallMedia + +## -description +Gets the media types used by the call. + +## -property-value +The media types used by the call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_contactname.md b/windows.phone.networking.voip/voipphonecall_contactname.md new file mode 100644 index 0000000000..fa8a1a12bd --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_contactname.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.VoipPhoneCall.ContactName +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.ContactName + +## -description +Gets or sets contact name associated with the VoIP call. + +## -property-value +The contact name associated with the VoIP call. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_endrequested.md b/windows.phone.networking.voip/voipphonecall_endrequested.md new file mode 100644 index 0000000000..119ff4d30c --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_endrequested.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Phone.Networking.Voip.VoipPhoneCall.EndRequested +-api-type: winrt event +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.EndRequested + +## -description +Raised to alert the VoIP app that the call should be ended. + +## -remarks +After this event has been raised, the application is required to call [NotifyCallEnded](voipphonecall_notifycallended.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_holdrequested.md b/windows.phone.networking.voip/voipphonecall_holdrequested.md new file mode 100644 index 0000000000..bcdfbcb05e --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_holdrequested.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Phone.Networking.Voip.VoipPhoneCall.HoldRequested +-api-type: winrt event +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.HoldRequested + +## -description +Raised to alert the VoIP app that the call should be placed on hold. + +## -remarks +After this event is raised, the application is required to call [NotifyCallHeld](voipphonecall_notifycallheld.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_notifycallactive_97340177.md b/windows.phone.networking.voip/voipphonecall_notifycallactive_97340177.md new file mode 100644 index 0000000000..6f889352fa --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_notifycallactive_97340177.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallActive +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallActive + +## -description +Notifies the system that the VoIP call is active. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_notifycallended_1962259325.md b/windows.phone.networking.voip/voipphonecall_notifycallended_1962259325.md new file mode 100644 index 0000000000..a972c0f4b9 --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_notifycallended_1962259325.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallEnded +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallEnded + +## -description +Notifies the system that the call has ended. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_notifycallheld_666131143.md b/windows.phone.networking.voip/voipphonecall_notifycallheld_666131143.md new file mode 100644 index 0000000000..060dce2cdb --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_notifycallheld_666131143.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallHeld +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallHeld + +## -description +Notifies the system that the call is currently on hold. + +## -remarks +Apps must call this method before calling [NotifyCallActive](voipphonecall_notifycallactive.md) on another VoIP call. Only one call can be active at a time. + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_notifycallready_1838502474.md b/windows.phone.networking.voip/voipphonecall_notifycallready_1838502474.md new file mode 100644 index 0000000000..a0bacdfd3e --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_notifycallready_1838502474.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallReady +-api-type: winrt method +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.NotifyCallReady + +## -description +When upgrading a call from cellular to video, notifies the system that the app is done setting up the audio and video streams for the video call so that the system can end the existing cellular call. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.phone.networking.voip/voipphonecall_rejectrequested.md b/windows.phone.networking.voip/voipphonecall_rejectrequested.md new file mode 100644 index 0000000000..02fe4e836d --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_rejectrequested.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Phone.Networking.Voip.VoipPhoneCall.RejectRequested +-api-type: winrt event +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.RejectRequested + +## -description +Raised when a call has been rejected. + +## -remarks +After this event is raised, the application must call [NotifyCallEnded](voipphonecall_notifycallended.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_resumerequested.md b/windows.phone.networking.voip/voipphonecall_resumerequested.md new file mode 100644 index 0000000000..7abcff0651 --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_resumerequested.md @@ -0,0 +1,24 @@ +--- +-api-id: E:Windows.Phone.Networking.Voip.VoipPhoneCall.ResumeRequested +-api-type: winrt event +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.ResumeRequested + +## -description +Raised to indicate that a previously held VoIP call should be made active. + +## -remarks +After this event has been raised, the application must call [NotifyCallActive](voipphonecall_notifycallactive.md) within 5 seconds. + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/voipphonecall_starttime.md b/windows.phone.networking.voip/voipphonecall_starttime.md new file mode 100644 index 0000000000..f05523394b --- /dev/null +++ b/windows.phone.networking.voip/voipphonecall_starttime.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.Phone.Networking.Voip.VoipPhoneCall.StartTime +-api-type: winrt property +--- + + + +# Windows.Phone.Networking.Voip.VoipPhoneCall.StartTime + +## -description +Gets or sets the start time associated with the VoIP call. + +## -property-value +Gets or sets the start time associated with the VoIP call. + +## -remarks +Apps can set the start time for the given call to match their service's conventions for when calls begin. The value can be queried to allow the foreground VoIP application to display the same current call duration that the system shows in the minimized call UI. + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.networking.voip/windows_phone_networking_voip.md b/windows.phone.networking.voip/windows_phone_networking_voip.md new file mode 100644 index 0000000000..9c1711dbdf --- /dev/null +++ b/windows.phone.networking.voip/windows_phone_networking_voip.md @@ -0,0 +1,19 @@ +--- +-api-id: N:Windows.Phone.Networking.Voip +-api-type: winrt namespace +--- + +# Windows.Phone.Networking.Voip + +## -description +Provides APIs for implementing VoIP applications. + +## -remarks + +## -examples + +## -see-also + + +## -capabilities +ID_CAP_VOIP [Windows Phone] \ No newline at end of file diff --git a/windows.phone.personalinformation/contactstore_getchangesasync_1173548322.md b/windows.phone.personalinformation/contactstore_getchangesasync_1173548322.md index 4709b29d89..3a96eb2c93 100644 --- a/windows.phone.personalinformation/contactstore_getchangesasync_1173548322.md +++ b/windows.phone.personalinformation/contactstore_getchangesasync_1173548322.md @@ -13,7 +13,7 @@ public Windows.Foundation.IAsyncOperation + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresence + +## -description +Contains values that describe the presence of a companion device (such as a wearable device). + +## -enum-fields +### -field Present:1 +The device is detected by the system. + +### -field Absent:0 +The device is not detected by the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactordevicepresencemonitoringmode.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactordevicepresencemonitoringmode.md new file mode 100644 index 0000000000..faa4cb4a7a --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactordevicepresencemonitoringmode.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresenceMonitoringMode +-api-type: winrt enum +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresenceMonitoringMode + +## -description +Contains values that describe the type of connection that the system uses to monitor the presence of a companion device (such as a wearable device). + +## -enum-fields +### -field Unsupported:0 +Device presence monitoring is not supported. + +### -field SystemManaged:2 +The system uses classing Bluetooth protocol to monitor the presence of the companion device. + +### -field AppManaged:1 +The system uses an app that corresponds to the companion device to monitor its presence. + +## -remarks +A companion device must specify this value when registering for presence monitoring. If the companion device has only registered for secondary authentication and not presence monitoring, its corresponding [**SecondaryAuthenticationFactorInfo**](SecondaryAuthenticationFactorInfo.md) will show a default value of *unsupported*. + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactordevicepresencemonitoringregistrationstatus.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactordevicepresencemonitoringregistrationstatus.md new file mode 100644 index 0000000000..2cd043782b --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactordevicepresencemonitoringregistrationstatus.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus +-api-type: winrt enum +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus + +## -description +Contains values that describe the status of the registration of a companion device for presence monitoring. + +## -enum-fields +### -field Unsupported:0 +Presence monitoring is not supported on this device. + +### -field Succeeded:1 +The device was registered for presence monitoring successfully. + +### -field DisabledByPolicy:2 +Presence monitoring registration was prevented by a policy setting on the device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_isauthenticationsupported.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_isauthenticationsupported.md new file mode 100644 index 0000000000..81e59ae463 --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_isauthenticationsupported.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorInfo.IsAuthenticationSupported +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorInfo.IsAuthenticationSupported + +## -description +Checks whether the companion device supports some kind of user authentication function. + +## -property-value +**True** if the device supports authentication, otherwise **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_presencemonitoringmode.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_presencemonitoringmode.md new file mode 100644 index 0000000000..992a99f179 --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_presencemonitoringmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorInfo.PresenceMonitoringMode +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorInfo.PresenceMonitoringMode + +## -description +Gets the presence monitoring mode of the companion device (the mechanism by which the main device checks the presence of the companion device). + +## -property-value +A [**SecondaryAuthenticationFactorDevicePresenceMonitoringMode**](SecondaryAuthenticationFactorDevicePresenceMonitoringMode.md) value describing the monitoring mode. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_updatedevicepresenceasync_1962005349.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_updatedevicepresenceasync_1962005349.md new file mode 100644 index 0000000000..05bdec8b5f --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorinfo_updatedevicepresenceasync_1962005349.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorInfo.UpdateDevicePresenceAsync(Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresence) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorInfo.UpdateDevicePresenceAsync + +## -description +Manually assigns a presence state to a device. + +## -parameters + +### -param presenceState +A [**SecondaryAuthenticationFactorDevicePresence**](SecondaryAuthenticationFactorDevicePresence.md) value indicating the device's presence state. + +## -returns +An asynchronous action for the operation. + +## -remarks +This method should only be used when a companion device's monitoring mode is set to [**SecondaryAuthenticationFactorDevicePresenceMonitoringMode.AppManaged**](SecondaryAuthenticationFactorDevicePresenceMonitoringMode.md). In this case, the app that is using the companion device for authentication must incorporate the third party app's presence-monitoring functionality and manually assign a [**SecondaryAuthenticationFactorDevicePresence**](SecondaryAuthenticationFactorDevicePresence.md) value according to the result. + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_isdevicepresencemonitoringsupported_73628582.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_isdevicepresencemonitoringsupported_73628582.md new file mode 100644 index 0000000000..6c6bd9d60b --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_isdevicepresencemonitoringsupported_73628582.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.IsDevicePresenceMonitoringSupported +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.IsDevicePresenceMonitoringSupported + +## -description +Checks whether the main device is able to monitor for the presence of companion devices. + +## -returns +A value of **true** if the device can monitor companion devices, otherwise **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_registerdevicepresencemonitoringasync_1661363696.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_registerdevicepresencemonitoringasync_1661363696.md new file mode 100644 index 0000000000..f70545714a --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_registerdevicepresencemonitoringasync_1661363696.md @@ -0,0 +1,35 @@ +--- +-api-id: M:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.RegisterDevicePresenceMonitoringAsync(System.String,System.String,Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresenceMonitoringMode) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.RegisterDevicePresenceMonitoringAsync + +## -description +Registers a companion device for presence monitoring by the main device. + +## -parameters + +### -param deviceId +The unique identifier for the companion device. + +### -param deviceInstancePath +The device instance path string. + +### -param monitoringMode +A [**SecondaryAuthenticationFactorDevicePresenceMonitoringMode**](SecondaryAuthenticationFactorDevicePresenceMonitoringMode.md) value describing the monitoring mode type that will be used. + +## -returns +An asynchronous operation with the status of the registration. + +## -remarks +A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring. + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_registerdevicepresencemonitoringasync_453367216.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_registerdevicepresencemonitoringasync_453367216.md new file mode 100644 index 0000000000..a6dc6cb8a9 --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_registerdevicepresencemonitoringasync_453367216.md @@ -0,0 +1,44 @@ +--- +-api-id: M:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.RegisterDevicePresenceMonitoringAsync(System.String,System.String,Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorDevicePresenceMonitoringMode,System.String,System.String,Windows.Storage.Streams.IBuffer) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.RegisterDevicePresenceMonitoringAsync + +## -description +Registers a companion device for presence monitoring by the main device. Includes additional information about the companion device. + +## -parameters + +### -param deviceId +The unique identifier for the companion device. + +### -param deviceInstancePath +The device instance path string. + +### -param monitoringMode +A [**SecondaryAuthenticationFactorDevicePresenceMonitoringMode**](SecondaryAuthenticationFactorDevicePresenceMonitoringMode.md) value describing the monitoring mode type that will be used. + +### -param deviceFriendlyName +The friendly name of the device. + +### -param deviceModelNumber +The model number of the device. + +### -param deviceConfigurationData +The device configuration data. This data is capped at 4KB. + +## -returns +An asynchronous operation with the status of the registration. + +## -remarks +A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring. + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_requeststartregisteringdeviceasync_1957875050.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_requeststartregisteringdeviceasync_1957875050.md index b3143b85b2..2e84cc35ba 100644 --- a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_requeststartregisteringdeviceasync_1957875050.md +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_requeststartregisteringdeviceasync_1957875050.md @@ -35,9 +35,10 @@ The device key. The mutual authentication key. ## -returns -This method does not return a value. +An asynchronous operation with a registration result instance. ## -remarks +A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring. ## -examples diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_unregisterdevicepresencemonitoringasync_646670219.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_unregisterdevicepresencemonitoringasync_646670219.md new file mode 100644 index 0000000000..4d4d2db106 --- /dev/null +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_unregisterdevicepresencemonitoringasync_646670219.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.UnregisterDevicePresenceMonitoringAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistration.UnregisterDevicePresenceMonitoringAsync + +## -description +Unregisters a companion device from presence monitoring. + +## -parameters + +### -param deviceId +The unique identifier for the device. + +## -returns +This method does not return a value. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_updatedeviceconfigurationdataasync_383973359.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_updatedeviceconfigurationdataasync_383973359.md index d69076994b..6c1f25d2c5 100644 --- a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_updatedeviceconfigurationdataasync_383973359.md +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistration_updatedeviceconfigurationdataasync_383973359.md @@ -20,7 +20,7 @@ Updates the configuration data of a companion device. The Id of the device to update. ### -param deviceConfigurationData -The updated configuration data. +The updated configuration data. This data is capped at 4KB. ## -returns This method does not return a value. diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_registration.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_registration.md index 267100b6bd..70ed662be7 100644 --- a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_registration.md +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_registration.md @@ -10,13 +10,13 @@ public Windows.Security.Authentication.Identity.Provider.SecondaryAuthentication # Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistrationResult.Registration ## -description -Gets the registration. +Gets the registration class instance for the intended companion device. > [!NOTE] > This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft to use the **secondaryAuthenticationFactor** capability, calls to this API will fail. To apply for approval, contact [cdfonboard@microsoft.com](mailto:cdfonboard@microsoft.com). For more information on capabilities, see [App capability declarations](http://aka.ms/appcap). For an overview of the Companion Device Framework, see the [Windows Unlock with companion (IoT) devices](https://msdn.microsoft.com/windows/uwp/security/companion-device-unlock) overview. ## -property-value -The registration. +A [**SecondaryAuthenticationFactorRegistration**](SecondaryAuthenticationFactorRegistration.md) instance handling the registration for a companion device. ## -remarks diff --git a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_status.md b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_status.md index 7a0a4fe4db..71c612f649 100644 --- a/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_status.md +++ b/windows.security.authentication.identity.provider/secondaryauthenticationfactorregistrationresult_status.md @@ -10,13 +10,13 @@ public Windows.Security.Authentication.Identity.Provider.SecondaryAuthentication # Windows.Security.Authentication.Identity.Provider.SecondaryAuthenticationFactorRegistrationResult.Status ## -description -Gets the status. +Gets the status of the registration attempt. > [!NOTE] > This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft to use the **secondaryAuthenticationFactor** capability, calls to this API will fail. To apply for approval, contact [cdfonboard@microsoft.com](mailto:cdfonboard@microsoft.com). For more information on capabilities, see [App capability declarations](http://aka.ms/appcap). For an overview of the Companion Device Framework, see the [Windows Unlock with companion (IoT) devices](https://msdn.microsoft.com/windows/uwp/security/companion-device-unlock) overview. ## -property-value -The status. +A [**SecondaryAuthenticationFactorRegistrationStatus**](SecondaryAuthenticationFactorRegistrationStatus.md) value describing the result of the registration attempt. ## -remarks diff --git a/windows.security.authentication.identity.provider/windows_security_authentication_identity_provider.md b/windows.security.authentication.identity.provider/windows_security_authentication_identity_provider.md index 5b9db8104c..5f77ddb2a3 100644 --- a/windows.security.authentication.identity.provider/windows_security_authentication_identity_provider.md +++ b/windows.security.authentication.identity.provider/windows_security_authentication_identity_provider.md @@ -12,6 +12,7 @@ Supports unlocking Windows with a companion device. > This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft to use the **secondaryAuthenticationFactor** capability, calls to this API will fail. To apply for approval, contact [cdfonboard@microsoft.com](mailto:cdfonboard@microsoft.com). For more information on capabilities, see [App capability declarations](http://aka.ms/appcap). ## -remarks +A companion device is a device that cannot act as a standalone authenticator but can function as a companion to an authenticator for better user experience. The companion device must have a corresponding UWP app that can receive authentication information from the device (such as biometric info) and pass it on to the main device through the APIs in this namespace. ## -examples diff --git a/windows.security.authentication.onlineid/onlineidsystemauthenticator.md b/windows.security.authentication.onlineid/onlineidsystemauthenticator.md new file mode 100644 index 0000000000..959d6e6055 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemauthenticator.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticator +-api-type: winrt class +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticator + +## -description +This class handles an app's attempts to acquire the local user id on a device, for use with the System Ticket feature (see Remarks). + +## -remarks +With the System Ticket feature, an app can provide cloud services to a user and store user info even if the user is not signed on with their Microsoft account (MSA). The app can acquire information about the local user account on a system, as well as information about the system itself, in order to keep track of settings and data for this user. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemauthenticator_default.md b/windows.security.authentication.onlineid/onlineidsystemauthenticator_default.md new file mode 100644 index 0000000000..5ee8b0456d --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemauthenticator_default.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticator.Default +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticator.Default + +## -description +Gets an instance of [**OnlineIdSystemAuthenticatorForUser**](OnlineIdSystemAuthenticatorForUser.md) that corresponds to the user currently logged in to the device. + +## -property-value +The [**OnlineIdSystemAuthenticatorForUser**](OnlineIdSystemAuthenticatorForUser.md) corresponding to the local user. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemauthenticator_getforuser_2058550280.md b/windows.security.authentication.onlineid/onlineidsystemauthenticator_getforuser_2058550280.md new file mode 100644 index 0000000000..c9c43518e5 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemauthenticator_getforuser_2058550280.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticator.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticator.GetForUser + +## -description +This method is not currently implemented. If called, it will throw a [**NotImplementedException**](https://msdn.microsoft.com/en-us/library/windows/apps/system.notimplementedexception(v=vs.105).aspx). + +## -parameters +### -param user +The local Windows user. + +## -returns +A [**OnlineIdSystemAuthenticatorForUser**](OnlineIdSystemAuthenticatorForUser.md) corresponding to the user. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser.md b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser.md new file mode 100644 index 0000000000..e25956a292 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser +-api-type: winrt class +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser + +## -description +Represents the authentication info for a single user entity on a single device (system). + +## -remarks + + +## -examples + +## -see-also +[**OnlineIdSystemAuthenticator**](OnlineIdSystemAuthenticator.md) \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_applicationid.md b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_applicationid.md new file mode 100644 index 0000000000..fb2f5ce0fe --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_applicationid.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser.ApplicationId +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser.ApplicationId + +## -description +The unique id value of the calling application. Windows desktop applications that are to use the System Ticket feature must set this value explicitly before calling [**getTicketAsync**](OnlineIdSystemAuthenticatorForUser_getTicketAsync.md). + +## -property-value +The id of the calling application. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_getticketasync_693125757.md b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_getticketasync_693125757.md new file mode 100644 index 0000000000..01550da999 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_getticketasync_693125757.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser.GetTicketAsync(Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser.GetTicketAsync + +## -description +Attempts to retrieve the system ticket for the device. + +## -parameters +### -param request +The [**OnlineIdServiceTicketRequest**](OnlineIdServiceTicketRequest.md) representing the specifications for authenticating this user account. + +## -returns +An asynchronous task containing the system ticket result. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_user.md b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_user.md new file mode 100644 index 0000000000..33bb422c67 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemauthenticatorforuser_user.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser.User +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemAuthenticatorForUser.User + +## -description +Gets the corresponding Windows user for this [**OnlineIdSystemAuthenticatorForUser**](OnlineIdSystemAuthenticatorForUser.md). + +## -property-value +The Windows user for this [**OnlineIdSystemAuthenticatorForUser**](OnlineIdSystemAuthenticatorForUser.md). + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemidentity.md b/windows.security.authentication.onlineid/onlineidsystemidentity.md new file mode 100644 index 0000000000..c79b7f1252 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemidentity.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Security.Authentication.OnlineId.OnlineIdSystemIdentity +-api-type: winrt class +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemIdentity + +## -description +Identifies the local device (system) on which the user account in question exists. + +## -remarks + +## -examples + +## -see-also +[**OnlineIdSystemAuthenticator**](OnlineIdSystemAuthenticator.md) \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemidentity_id.md b/windows.security.authentication.onlineid/onlineidsystemidentity_id.md new file mode 100644 index 0000000000..eed36ecebd --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemidentity_id.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemIdentity.Id +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemIdentity.Id + +## -description +A unique string identifier for the local system of this [**OnlineIdSystemIdentity**](OnlineIdSystemIdentity.md). + +## -property-value +The unique identifier for this local system. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemidentity_ticket.md b/windows.security.authentication.onlineid/onlineidsystemidentity_ticket.md new file mode 100644 index 0000000000..9bd95a236d --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemidentity_ticket.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemIdentity.Ticket +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemIdentity.Ticket + +## -description +Provides additional information about the device. + +## -property-value +The [**OnlineIdServiceTicket**](OnlineIdServiceTicket.md) corresponding to this device. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemticketresult.md b/windows.security.authentication.onlineid/onlineidsystemticketresult.md new file mode 100644 index 0000000000..699153b0b7 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemticketresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult +-api-type: winrt class +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult + +## -description +Represents the result of a call to retrieve a system ticket. + +## -remarks + +## -examples + +## -see-also +[**OnlineIdSystemAuthenticator**](OnlineIdSystemAuthenticator.md) \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemticketresult_extendederror.md b/windows.security.authentication.onlineid/onlineidsystemticketresult_extendederror.md new file mode 100644 index 0000000000..4a7dde0121 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemticketresult_extendederror.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult.ExtendedError +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult.ExtendedError + +## -description +Represents the Windows Runtime error associated with a failed attempt to retrieve the system ticket. + +## -property-value +The Windows Runtime error code. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemticketresult_identity.md b/windows.security.authentication.onlineid/onlineidsystemticketresult_identity.md new file mode 100644 index 0000000000..144aa5f7cb --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemticketresult_identity.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult.Identity +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult.Identity + +## -description +The [**OnlineIdSystemIdentity**](OnlineIdSystemIdentity.md) object corresponding to the device whose system ticket was retrieved. + +## -property-value +The identity of the device. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemticketresult_status.md b/windows.security.authentication.onlineid/onlineidsystemticketresult_status.md new file mode 100644 index 0000000000..e7e3daa401 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemticketresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult.Status +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketResult.Status + +## -description +Gets the status of the system ticket call. + +## -property-value +The status of the system ticket call. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.onlineid/onlineidsystemticketstatus.md b/windows.security.authentication.onlineid/onlineidsystemticketstatus.md new file mode 100644 index 0000000000..11a1398159 --- /dev/null +++ b/windows.security.authentication.onlineid/onlineidsystemticketstatus.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Security.Authentication.OnlineId.OnlineIdSystemTicketStatus +-api-type: winrt enum +--- + + + +# OnlineIdSystemTicketStatus + +## -description +Represents the status of a call to retrieve the system ticket. + +## -enum-fields +### -field Success:0 +The call to retrieve the system ticket was successful. + +### -field Error:1 +An unexpected error prevented the retrieval of the system ticket. + +### -field ServiceConnectionError:2 +A network error prevented the retrieval of the system ticket. + + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.web.core/webtokenrequest_correlationid.md b/windows.security.authentication.web.core/webtokenrequest_correlationid.md new file mode 100644 index 0000000000..abc9a5380c --- /dev/null +++ b/windows.security.authentication.web.core/webtokenrequest_correlationid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Authentication.Web.Core.WebTokenRequest.CorrelationId +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.Web.Core.WebTokenRequest.CorrelationId + +## -description +Gets and sets the correlation Id. + +## -property-value +The correlation Id. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.web.provider/iwebaccountprovidertokenobjects2.md b/windows.security.authentication.web.provider/iwebaccountprovidertokenobjects2.md new file mode 100644 index 0000000000..d5b47877af --- /dev/null +++ b/windows.security.authentication.web.provider/iwebaccountprovidertokenobjects2.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Security.Authentication.Web.Provider.IWebAccountProviderTokenObjects2 +-api-type: winrt interface +--- + + + +# Windows.Security.Authentication.Web.Provider.IWebAccountProviderTokenObjects2 + +## -description +Defines properties for web account provider token objects. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_288816579.md b/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_288816579.md new file mode 100644 index 0000000000..9a6d96b294 --- /dev/null +++ b/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_288816579.md @@ -0,0 +1,43 @@ +--- +-api-id: M:Windows.Security.Authentication.Web.Provider.WebAccountManager.AddWebAccountForUserAsync(Windows.System.User,System.String,System.String,Windows.Foundation.Collections.IMapView{System.String,System.String},Windows.Security.Authentication.Web.Provider.WebAccountScope,System.String) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Web.Provider.WebAccountManager.AddWebAccountForUserAsync + +## -description +Adds a new web account for a specific user (for use with multi-user-aware apps). + +## -parameters + +### -param user +The user for which an account must be authenticated. + +### -param webAccountId +The Id for the web account. + +### -param webAccountUserName +The user name for the web account. + +### -param props +Properties for the web account. + +### -param scope +The scope of the web account. + +### -param perUserWebAccountId +The per-user web account Id. + +## -returns +When this method completes, it returns the new web account. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_554293699.md b/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_554293699.md new file mode 100644 index 0000000000..ee48bbf826 --- /dev/null +++ b/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_554293699.md @@ -0,0 +1,40 @@ +--- +-api-id: M:Windows.Security.Authentication.Web.Provider.WebAccountManager.AddWebAccountForUserAsync(Windows.System.User,System.String,System.String,Windows.Foundation.Collections.IMapView{System.String,System.String},Windows.Security.Authentication.Web.Provider.WebAccountScope) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Web.Provider.WebAccountManager.AddWebAccountForUserAsync + +## -description +Adds a new web account for a specific user (for use with multi-user-aware apps). + +## -parameters + +### -param user +The user for which an account must be authenticated. + +### -param webAccountId +The Id for the web account. + +### -param webAccountUserName +The user name for the web account. + +### -param props +Properties for the web account. + +### -param scope +The scope of the web account. + +## -returns +When this method completes, it returns the new web account. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_746738349.md b/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_746738349.md new file mode 100644 index 0000000000..2d5c4fc2d7 --- /dev/null +++ b/windows.security.authentication.web.provider/webaccountmanager_addwebaccountforuserasync_746738349.md @@ -0,0 +1,37 @@ +--- +-api-id: M:Windows.Security.Authentication.Web.Provider.WebAccountManager.AddWebAccountForUserAsync(Windows.System.User,System.String,System.String,Windows.Foundation.Collections.IMapView{System.String,System.String}) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Web.Provider.WebAccountManager.AddWebAccountForUserAsync + +## -description +Adds a new web account for a specific user (for use with multi-user-aware apps). + +## -parameters + +### -param user +The user for which an account must be authenticated. + +### -param webAccountId +The Id for the web account. + +### -param webAccountUserName +The user name for the web account. + +### -param props +Properties for the web account. + +## -returns +When this method completes, it returns the new web account. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.web.provider/webaccountmanager_findallproviderwebaccountsforuserasync_1740187132.md b/windows.security.authentication.web.provider/webaccountmanager_findallproviderwebaccountsforuserasync_1740187132.md new file mode 100644 index 0000000000..5c5b0b0eaf --- /dev/null +++ b/windows.security.authentication.web.provider/webaccountmanager_findallproviderwebaccountsforuserasync_1740187132.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Security.Authentication.Web.Provider.WebAccountManager.FindAllProviderWebAccountsForUserAsync(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.Security.Authentication.Web.Provider.WebAccountManager.FindAllProviderWebAccountsForUserAsync + +## -description +Finds all provider web accounts for a given user asynchronously (for use with multi-user-aware apps). + +## -parameters + +### -param user +The user for these accounts. + +## -returns +When this method completes, it returns all provider web accounts for the user. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.web.provider/webaccountprovidertriggerdetails_user.md b/windows.security.authentication.web.provider/webaccountprovidertriggerdetails_user.md new file mode 100644 index 0000000000..0a4a90f264 --- /dev/null +++ b/windows.security.authentication.web.provider/webaccountprovidertriggerdetails_user.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Authentication.Web.Provider.WebAccountProviderTriggerDetails.User +-api-type: winrt property +--- + + + +# Windows.Security.Authentication.Web.Provider.WebAccountProviderTriggerDetails.User + +## -description +Gets the user that issued this web account provider trigger + +## -property-value +The user for this trigger. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.authentication.web/webauthenticationbroker.md b/windows.security.authentication.web/webauthenticationbroker.md index 8cd1141539..880030fd41 100644 --- a/windows.security.authentication.web/webauthenticationbroker.md +++ b/windows.security.authentication.web/webauthenticationbroker.md @@ -18,7 +18,7 @@ All members of this class are static. You can access them without creating an ob ## -examples -[!code-csharp[webauthenticationbroker](../windows.security.authentication.web/code/webauthenticationbroker/cs/ScenarioInput1.xaml.cs#Snippetwebauthenticationbroker)] +[!code-xml[webauthenticationbroker](../windows.security.authentication.web/code/webauthenticationbroker/cs/ScenarioInput1.xaml.cs#Snippetwebauthenticationbroker)] [!code-xml[WebAuthenticationBrokerXAML](../windows.security.authentication.web/code/webauthenticationbroker/cs/Scenario1.xaml#SnippetWebAuthenticationBrokerXAML)] diff --git a/windows.security.credentials.ui/userconsentverificationresult.md b/windows.security.credentials.ui/userconsentverificationresult.md index 3bc915524b..98919f2e24 100644 --- a/windows.security.credentials.ui/userconsentverificationresult.md +++ b/windows.security.credentials.ui/userconsentverificationresult.md @@ -44,6 +44,7 @@ The following example shows a method that requests fingerprint verification and [!code-csharp[2](../windows.security.credentials.ui/code/BiometricAuth/cs/MainPage.xaml.cs#Snippet2)] +[!code-js[2](../windows.security.credentials.ui/code/BiometricAuth/js/default.js#Snippet2)] [!code-js[2_JS](../windows.security.credentials.ui/code/BiometricAuth/js/default.js#Snippet2_JS)] @@ -51,3 +52,4 @@ The following example shows a method that requests fingerprint verification and ## -see-also [Fingerprint biometrics](http://msdn.microsoft.com/library/55483729-5f8a-401a-8072-3cd611ddfed2), [UserConsentVerifier sample](http://go.microsoft.com/fwlink/p/?LinkID=303650), [RequestVerificationAsync](userconsentverifier_requestverificationasync.md), [UserConsentVerifier](userconsentverifier.md), [Windows.Security.Credentials.UI](windows_security_credentials_ui.md), [Authentication and user identity](http://msdn.microsoft.com/library/53e36ddc-200a-4850-aaf0-07eca3662bb9) +6ddc-200a-4850-aaf0-07eca3662bb9) diff --git a/windows.security.credentials.ui/userconsentverifier.md b/windows.security.credentials.ui/userconsentverifier.md index bf05ff2e3f..8d74dd13bc 100644 --- a/windows.security.credentials.ui/userconsentverifier.md +++ b/windows.security.credentials.ui/userconsentverifier.md @@ -23,6 +23,7 @@ The following example shows a method that requests fingerprint verification and [!code-csharp[2](../windows.security.credentials.ui/code/BiometricAuth/cs/MainPage.xaml.cs#Snippet2)] +[!code-js[2](../windows.security.credentials.ui/code/BiometricAuth/js/default.js#Snippet2)] [!code-js[2_JS](../windows.security.credentials.ui/code/BiometricAuth/js/default.js#Snippet2_JS)] @@ -30,3 +31,4 @@ The following example shows a method that requests fingerprint verification and ## -see-also [Fingerprint biometrics](http://msdn.microsoft.com/library/55483729-5f8a-401a-8072-3cd611ddfed2), [UserConsentVerifier sample](http://go.microsoft.com/fwlink/p/?LinkID=303650), [Windows.Security.Credentials.UI](windows_security_credentials_ui.md), [Authentication and user identity](http://msdn.microsoft.com/library/53e36ddc-200a-4850-aaf0-07eca3662bb9), [UserConsentVerifier sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620615) +soft.com/fwlink/p/?LinkId=620615) diff --git a/windows.security.credentials.ui/userconsentverifieravailability.md b/windows.security.credentials.ui/userconsentverifieravailability.md index bde0b09d94..590eed591b 100644 --- a/windows.security.credentials.ui/userconsentverifieravailability.md +++ b/windows.security.credentials.ui/userconsentverifieravailability.md @@ -40,6 +40,7 @@ The following example shows a method that checks to see if fingerprint authentic [!code-csharp[1](../windows.security.credentials.ui/code/BiometricAuth/cs/MainPage.xaml.cs#Snippet1)] +[!code-js[1](../windows.security.credentials.ui/code/BiometricAuth/js/default.js#Snippet1)] [!code-js[1_JS](../windows.security.credentials.ui/code/BiometricAuth/js/default.js#Snippet1_JS)] @@ -47,3 +48,4 @@ The following example shows a method that checks to see if fingerprint authentic ## -see-also [Fingerprint biometrics](http://msdn.microsoft.com/library/55483729-5f8a-401a-8072-3cd611ddfed2), [UserConsentVerifier sample](http://go.microsoft.com/fwlink/p/?LinkID=303650), [CheckAvailabilityAsync](userconsentverifier_checkavailabilityasync.md), [UserConsentVerifier](userconsentverifier.md), [Windows.Security.Credentials.UI](windows_security_credentials_ui.md), [Authentication and user identity](http://msdn.microsoft.com/library/53e36ddc-200a-4850-aaf0-07eca3662bb9) +6ddc-200a-4850-aaf0-07eca3662bb9) diff --git a/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_2003079147.md b/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_2003079147.md index 593e88112f..5eb31eb762 100644 --- a/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_2003079147.md +++ b/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_2003079147.md @@ -1,54 +1,54 @@ ---- --api-id: M:Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync(System.String,System.String,Windows.Security.Cryptography.Certificates.ExportOption,Windows.Security.Cryptography.Certificates.KeyProtectionLevel,Windows.Security.Cryptography.Certificates.InstallOptions,System.String,System.String) --api-type: winrt method ---- - - - -# Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync - -## -description -Asynchronously imports a certificate from a Personal Information Exchange (PFX) message using the specified key storage provider. - -## -parameters -### -param pfxData -Base64-encoded PFX message. - -### -param password -The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. - -### -param exportable -A value of the [ExportOption](exportoption.md) enumeration that specifies whether the key can be exported. - -### -param keyProtectionLevel -A value of the [KeyProtectionLevel](keyprotectionlevel.md) enumeration that specifies the strength of the key protection. The default is **NoConsent**. - -### -param installOption -An [InstallOptions](installoptions.md) enumeration value that specifies the certificate installation option. - -### -param friendlyName -The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. - -### -param keyStorageProvider -The name of the key storage provider to use when importing the certificate. - -## -returns -This method does not return a value. - -## -remarks -This method imports the certificate chain into the app container. - - -+ To import an issued certificate, it is not necessary for the certificate request to have been generated on the importing computer. -+ The certificates included in the response need not be chained to trusted root certificates on the importing computer. -+ The certificate is installed in the app container MY store. -+ [Certification authority](XREF:TODO:security.c_gly) and Root certificates are installed in the app container intermediate [certification authority](XREF:TODO:security.c_gly) store. -+ The key container name and key specification for the imported certificate are determined as described in the Remarks section of [PFXImportCertStore](XREF:TODO:security.pfximportcertstore) with the exception that if AttributeId 1.3.6.1.4.1.311.17.1 is not present, MS_KEY_STORAGE_PROVIDER is always used as the provider name. - - -## -examples - -## -see-also +--- +-api-id: M:Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync(System.String,System.String,Windows.Security.Cryptography.Certificates.ExportOption,Windows.Security.Cryptography.Certificates.KeyProtectionLevel,Windows.Security.Cryptography.Certificates.InstallOptions,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync + +## -description +Asynchronously imports a certificate from a Personal Information Exchange (PFX) message using the specified key storage provider. + +## -parameters +### -param pfxData +Base64-encoded PFX message. + +### -param password +The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. + +### -param exportable +A value of the [ExportOption](exportoption.md) enumeration that specifies whether the key can be exported. + +### -param keyProtectionLevel +A value of the [KeyProtectionLevel](keyprotectionlevel.md) enumeration that specifies the strength of the key protection. The default is **NoConsent**. + +### -param installOption +An [InstallOptions](installoptions.md) enumeration value that specifies the certificate installation option. + +### -param friendlyName +The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. + +### -param keyStorageProvider +The name of the key storage provider to use when importing the certificate. + +## -returns +This method does not return a value. + +## -remarks +This method imports the certificate chain into the app container. + + ++ To import an issued certificate, it is not necessary for the certificate request to have been generated on the importing computer. ++ The certificates included in the response need not be chained to trusted root certificates on the importing computer. ++ The certificate is installed in the app container MY store. ++ [Certification authority](http://msdn.microsoft.com/library/db46def4-bfdc-4801-a57d-d568e94a2dbb) and Root certificates are installed in the app container intermediate [certification authority](http://msdn.microsoft.com/library/db46def4-bfdc-4801-a57d-d568e94a2dbb) store. ++ The key container name and key specification for the imported certificate are determined as described in the Remarks section of [PFXImportCertStore](http://msdn.microsoft.com/library/2c83774a-f2df-4d28-9abd-e39aa507ba88) with the exception that if AttributeId 1.3.6.1.4.1.311.17.1 is not present, MS_KEY_STORAGE_PROVIDER is always used as the provider name. + + +## -examples + +## -see-also [ImportPfxDataAsync(String, String, ExportOption, KeyProtectionLevel, InstallOptions, String)](certificateenrollmentmanager_importpfxdataasync_387631083.md) \ No newline at end of file diff --git a/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_387631083.md b/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_387631083.md index f605e994c6..f8a3d8ab5c 100644 --- a/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_387631083.md +++ b/windows.security.cryptography.certificates/certificateenrollmentmanager_importpfxdataasync_387631083.md @@ -1,51 +1,51 @@ ---- --api-id: M:Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync(System.String,System.String,Windows.Security.Cryptography.Certificates.ExportOption,Windows.Security.Cryptography.Certificates.KeyProtectionLevel,Windows.Security.Cryptography.Certificates.InstallOptions,System.String) --api-type: winrt method ---- - - - -# Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync - -## -description -Asynchronously imports a certificate from a Personal Information Exchange (PFX) message. - -## -parameters -### -param pfxData -Base64-encoded PFX message. - -### -param password -The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. - -### -param exportable -A value of the [ExportOption](exportoption.md) enumeration that specifies whether the key can be exported. - -### -param keyProtectionLevel -A value of the [KeyProtectionLevel](keyprotectionlevel.md) enumeration that specifies the strength of the key protection. The default is **NoConsent**. - -### -param installOption -An [InstallOptions](installoptions.md) enumeration value that specifies the certificate installation option. - -### -param friendlyName -The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. - -## -returns -This method does not return a value. - -## -remarks -This method imports the certificate chain into the app container. - - -+ To import an issued certificate, it is not necessary for the certificate request to have been generated on the importing computer. -+ The certificates included in the response need not be chained to trusted root certificates on the importing computer. -+ The certificate is installed in the app container MY store. -+ [Certification authority](XREF:TODO:security.c_gly) and Root certificates are installed in the app container intermediate [certification authority](XREF:TODO:security.c_gly) store. -+ The key container name and key specification for the imported certificate are determined as described in the Remarks section of [PFXImportCertStore](XREF:TODO:security.pfximportcertstore) with the exception that if AttributeId 1.3.6.1.4.1.311.17.1 is not present, MS_KEY_STORAGE_PROVIDER is always used as the provider name. - - -## -examples - -## -see-also +--- +-api-id: M:Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync(System.String,System.String,Windows.Security.Cryptography.Certificates.ExportOption,Windows.Security.Cryptography.Certificates.KeyProtectionLevel,Windows.Security.Cryptography.Certificates.InstallOptions,System.String) +-api-type: winrt method +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateEnrollmentManager.ImportPfxDataAsync + +## -description +Asynchronously imports a certificate from a Personal Information Exchange (PFX) message. + +## -parameters +### -param pfxData +Base64-encoded PFX message. + +### -param password +The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. + +### -param exportable +A value of the [ExportOption](exportoption.md) enumeration that specifies whether the key can be exported. + +### -param keyProtectionLevel +A value of the [KeyProtectionLevel](keyprotectionlevel.md) enumeration that specifies the strength of the key protection. The default is **NoConsent**. + +### -param installOption +An [InstallOptions](installoptions.md) enumeration value that specifies the certificate installation option. + +### -param friendlyName +The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. + +## -returns +This method does not return a value. + +## -remarks +This method imports the certificate chain into the app container. + + ++ To import an issued certificate, it is not necessary for the certificate request to have been generated on the importing computer. ++ The certificates included in the response need not be chained to trusted root certificates on the importing computer. ++ The certificate is installed in the app container MY store. ++ [Certification authority](http://msdn.microsoft.com/library/db46def4-bfdc-4801-a57d-d568e94a2dbb) and Root certificates are installed in the app container intermediate [certification authority](http://msdn.microsoft.com/library/db46def4-bfdc-4801-a57d-d568e94a2dbb) store. ++ The key container name and key specification for the imported certificate are determined as described in the Remarks section of [PFXImportCertStore](http://msdn.microsoft.com/library/2c83774a-f2df-4d28-9abd-e39aa507ba88) with the exception that if AttributeId 1.3.6.1.4.1.311.17.1 is not present, MS_KEY_STORAGE_PROVIDER is always used as the provider name. + + +## -examples + +## -see-also [ImportPfxDataAsync(String, String, ExportOption, KeyProtectionLevel, InstallOptions, String, String)](certificateenrollmentmanager_importpfxdataasync_2003079147.md) \ No newline at end of file diff --git a/windows.security.cryptography.certificates/certificateextension.md b/windows.security.cryptography.certificates/certificateextension.md new file mode 100644 index 0000000000..8af1c15817 --- /dev/null +++ b/windows.security.cryptography.certificates/certificateextension.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Security.Cryptography.Certificates.CertificateExtension +-api-type: winrt class +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateExtension + +## -description +Represents a certificate extension. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificateextension_certificateextension_1221375020.md b/windows.security.cryptography.certificates/certificateextension_certificateextension_1221375020.md new file mode 100644 index 0000000000..0e55c93ac8 --- /dev/null +++ b/windows.security.cryptography.certificates/certificateextension_certificateextension_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.Security.Cryptography.Certificates.CertificateExtension.#ctor +-api-type: winrt method +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateExtension.CertificateExtension + +## -description +Creates a new certificateExtension object. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificateextension_encodevalue_641074129.md b/windows.security.cryptography.certificates/certificateextension_encodevalue_641074129.md new file mode 100644 index 0000000000..9f60f83851 --- /dev/null +++ b/windows.security.cryptography.certificates/certificateextension_encodevalue_641074129.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Security.Cryptography.Certificates.CertificateExtension.EncodeValue(System.String) +-api-type: winrt method +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateExtension.EncodeValue + +## -description +Encodes the string value into the value byte array. + +## -parameters + +### -param value +The string value to encode. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificateextension_iscritical.md b/windows.security.cryptography.certificates/certificateextension_iscritical.md new file mode 100644 index 0000000000..263b92d118 --- /dev/null +++ b/windows.security.cryptography.certificates/certificateextension_iscritical.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.CertificateExtension.IsCritical +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateExtension.IsCritical + +## -description +Gets or sets a boolean indicating if the certificate extension is critical. + +## -property-value +A boolean indicating if the certificate extension is critical. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificateextension_objectid.md b/windows.security.cryptography.certificates/certificateextension_objectid.md new file mode 100644 index 0000000000..a22e8c9538 --- /dev/null +++ b/windows.security.cryptography.certificates/certificateextension_objectid.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.CertificateExtension.ObjectId +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateExtension.ObjectId + +## -description +Gets or sets the object ID. + +## -property-value +The object ID. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificateextension_value.md b/windows.security.cryptography.certificates/certificateextension_value.md new file mode 100644 index 0000000000..2f68e1808e --- /dev/null +++ b/windows.security.cryptography.certificates/certificateextension_value.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.CertificateExtension.Value +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateExtension.Value + +## -description +Gets or sets the value of the certificate extension. + +## -property-value +The value of the certificate extension. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificaterequestproperties_extensions.md b/windows.security.cryptography.certificates/certificaterequestproperties_extensions.md new file mode 100644 index 0000000000..2ad21cda91 --- /dev/null +++ b/windows.security.cryptography.certificates/certificaterequestproperties_extensions.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.CertificateRequestProperties.Extensions +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateRequestProperties.Extensions + +## -description +Gets a vector of certificate extensions. + +## -property-value +A vector of certificate extensions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificaterequestproperties_friendlyname.md b/windows.security.cryptography.certificates/certificaterequestproperties_friendlyname.md index 72f910d172..c05a285ff1 100644 --- a/windows.security.cryptography.certificates/certificaterequestproperties_friendlyname.md +++ b/windows.security.cryptography.certificates/certificaterequestproperties_friendlyname.md @@ -16,7 +16,7 @@ Gets or sets the display name of the enrolled certificate. The display name. ## -remarks -By default, this value is an empty string. +By default, this value is an empty string. FriendlyName ## -examples diff --git a/windows.security.cryptography.certificates/certificaterequestproperties_keystorageprovidername.md b/windows.security.cryptography.certificates/certificaterequestproperties_keystorageprovidername.md index 1178f28cf2..2fa35d9d32 100644 --- a/windows.security.cryptography.certificates/certificaterequestproperties_keystorageprovidername.md +++ b/windows.security.cryptography.certificates/certificaterequestproperties_keystorageprovidername.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.Security.Cryptography.Certificates.CertificateRequestProperties.KeyStorageProviderName --api-type: winrt property ---- - - - -# Windows.Security.Cryptography.Certificates.CertificateRequestProperties.KeyStorageProviderName - -## -description -Gets or sets the name of the key storage provider (KSP) that will be used to generate the private key. - -## -property-value -The KSP name. The default value is "Microsoft Software Key Storage Provider". - -## -remarks -The name of a [cryptographic service provider](XREF:TODO:security.c_gly) ([CSP](XREF:TODO:security.cryptographic_service_providers)) cannot be used. - -## -examples - - -[!code-csharp[ShowKspName] (../windows.security.cryptography/code/crypto-snippets/cs/cryptosnippets.cs#ShowKspName)] - -## -see-also +--- +-api-id: P:Windows.Security.Cryptography.Certificates.CertificateRequestProperties.KeyStorageProviderName +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateRequestProperties.KeyStorageProviderName + +## -description +Gets or sets the name of the key storage provider (KSP) that will be used to generate the private key. + +## -property-value +The KSP name. The default value is "Microsoft Software Key Storage Provider". + +## -remarks +The name of a [cryptographic service provider](http://msdn.microsoft.com/library/db46def4-bfdc-4801-a57d-d568e94a2dbb) ([CSP](http://msdn.microsoft.com/library/4e6eb2df-a917-4533-b9f1-8da39598d0b8)) cannot be used. + +## -examples + + +[!code-csharp[ShowKspName] (../windows.security.cryptography/code/crypto-snippets/cs/cryptosnippets.cs#ShowKspName)] + +## -see-also diff --git a/windows.security.cryptography.certificates/certificaterequestproperties_subjectalternativename.md b/windows.security.cryptography.certificates/certificaterequestproperties_subjectalternativename.md new file mode 100644 index 0000000000..4b31d3f2e0 --- /dev/null +++ b/windows.security.cryptography.certificates/certificaterequestproperties_subjectalternativename.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.CertificateRequestProperties.SubjectAlternativeName +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateRequestProperties.SubjectAlternativeName + +## -description +Gets the subject alternative name. + +## -property-value +The subject alternative name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/certificaterequestproperties_suppresseddefaults.md b/windows.security.cryptography.certificates/certificaterequestproperties_suppresseddefaults.md new file mode 100644 index 0000000000..fa8da1d8d0 --- /dev/null +++ b/windows.security.cryptography.certificates/certificaterequestproperties_suppresseddefaults.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.CertificateRequestProperties.SuppressedDefaults +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.CertificateRequestProperties.SuppressedDefaults + +## -description +Gets a vector of suppressed defaults. + +## -property-value +A vector of suppressed defaults. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/keyattestationhelper_decrypttpmattestationcredentialasync_993248326.md b/windows.security.cryptography.certificates/keyattestationhelper_decrypttpmattestationcredentialasync_993248326.md index b0dba60a1b..28ab320f6b 100644 --- a/windows.security.cryptography.certificates/keyattestationhelper_decrypttpmattestationcredentialasync_993248326.md +++ b/windows.security.cryptography.certificates/keyattestationhelper_decrypttpmattestationcredentialasync_993248326.md @@ -1,19 +1,26 @@ ---- --api-id: M:Windows.Security.Cryptography.Certificates.KeyAttestationHelper.DecryptTpmAttestationCredentialAsync(System.String) --api-type: winrt method ---- - - - -# Windows.Security.Cryptography.Certificates.KeyAttestationHelper.DecryptTpmAttestationCredentialAsync - -## -description -Decrypts a TPM key attestation credential. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.Security.Cryptography.Certificates.KeyAttestationHelper.DecryptTpmAttestationCredentialAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Security.Cryptography.Certificates.KeyAttestationHelper.DecryptTpmAttestationCredentialAsync + +## -description +Decrypts a TPM key attestation credential. + +## -remarks + +## -examples + +## -see-also +### -param credential + + + +## -returns + + diff --git a/windows.security.cryptography.certificates/subjectalternativenameinfo_distinguishednames.md b/windows.security.cryptography.certificates/subjectalternativenameinfo_distinguishednames.md new file mode 100644 index 0000000000..a0b766edc4 --- /dev/null +++ b/windows.security.cryptography.certificates/subjectalternativenameinfo_distinguishednames.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.DistinguishedNames +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.DistinguishedNames + +## -description +Gets a vector of distinguished names. + +## -property-value +A vector of distinguished names. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/subjectalternativenameinfo_dnsnames.md b/windows.security.cryptography.certificates/subjectalternativenameinfo_dnsnames.md new file mode 100644 index 0000000000..f323090495 --- /dev/null +++ b/windows.security.cryptography.certificates/subjectalternativenameinfo_dnsnames.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.DnsNames +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.DnsNames + +## -description +Gets a vector of dns names. + +## -property-value +A vector of dns names. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/subjectalternativenameinfo_emailnames.md b/windows.security.cryptography.certificates/subjectalternativenameinfo_emailnames.md new file mode 100644 index 0000000000..f7609b6e1a --- /dev/null +++ b/windows.security.cryptography.certificates/subjectalternativenameinfo_emailnames.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.EmailNames +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.EmailNames + +## -description +Gets a vector of email names. + +## -property-value +A vector of email names. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/subjectalternativenameinfo_extension.md b/windows.security.cryptography.certificates/subjectalternativenameinfo_extension.md new file mode 100644 index 0000000000..cd86717487 --- /dev/null +++ b/windows.security.cryptography.certificates/subjectalternativenameinfo_extension.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.Extension +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.Extension + +## -description +Gets the certificate extension. + +## -property-value +The certificate extension. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/subjectalternativenameinfo_ipaddresses.md b/windows.security.cryptography.certificates/subjectalternativenameinfo_ipaddresses.md new file mode 100644 index 0000000000..1da308e598 --- /dev/null +++ b/windows.security.cryptography.certificates/subjectalternativenameinfo_ipaddresses.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.IPAddresses +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.IPAddresses + +## -description +Gets the IP addresses. + +## -property-value +The IP addresses. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/subjectalternativenameinfo_principalnames.md b/windows.security.cryptography.certificates/subjectalternativenameinfo_principalnames.md new file mode 100644 index 0000000000..6c208239d2 --- /dev/null +++ b/windows.security.cryptography.certificates/subjectalternativenameinfo_principalnames.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.PrincipalNames +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.PrincipalNames + +## -description +Gets a vector of principal names. + +## -property-value +A vector of principal names. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.certificates/subjectalternativenameinfo_urls.md b/windows.security.cryptography.certificates/subjectalternativenameinfo_urls.md new file mode 100644 index 0000000000..d1a0ae938a --- /dev/null +++ b/windows.security.cryptography.certificates/subjectalternativenameinfo_urls.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.Urls +-api-type: winrt property +--- + + + +# Windows.Security.Cryptography.Certificates.SubjectAlternativeNameInfo.Urls + +## -description +Gets a vector of URLs. + +## -property-value +A vector of URLs. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.security.cryptography.core/cryptographicprivatekeyblobtype.md b/windows.security.cryptography.core/cryptographicprivatekeyblobtype.md index ede52f195f..47bc895095 100644 --- a/windows.security.cryptography.core/cryptographicprivatekeyblobtype.md +++ b/windows.security.cryptography.core/cryptographicprivatekeyblobtype.md @@ -42,15 +42,15 @@ The key is an RSA private key defined in the PKCS #1 standard. For more informat Microsoft private key format defined by Cryptography API: Next Generation (CNG). For examples, see the following CNG structures: -+ [BCRYPT_DH_KEY_BLOB](XREF:TODO:security.bcrypt_dh_key_blob) -+ [BCRYPT_DSA_KEY_BLOB](XREF:TODO:security.bcrypt_dsa_key_blob) -+ [BCRYPT_ECCKEY_BLOB](XREF:TODO:security.bcrypt_ecckey_blob) -+ [BCRYPT_KEY_BLOB](XREF:TODO:security.bcrypt_key_blob) -+ [BCRYPT_RSAKEY_BLOB](XREF:TODO:security.bcrypt_rsakey_blob) ++ [BCRYPT_DH_KEY_BLOB](http://msdn.microsoft.com/library/6004b2e5-7e06-4108-a0da-472b9b6d5fea) ++ [BCRYPT_DSA_KEY_BLOB](http://msdn.microsoft.com/library/3db36170-106e-49c8-9866-e25759bdd7f9) ++ [BCRYPT_ECCKEY_BLOB](http://msdn.microsoft.com/library/e60f6630-e4b0-4f35-a3cf-95dbcb007124) ++ [BCRYPT_KEY_BLOB](http://msdn.microsoft.com/library/ae7e8db3-858d-4573-afe1-c9bc14d76480) ++ [BCRYPT_RSAKEY_BLOB](http://msdn.microsoft.com/library/bbf3f4b9-5c69-4212-bb23-34bb2c84185c) ### -field Capi1PrivateKey:3 -Microsoft private key format defined by the legacy Cryptography API (CAPI). For more information, see [Base Provider Key BLOBs](XREF:TODO:security.base_provider_key_blobs). +Microsoft private key format defined by the legacy Cryptography API (CAPI). For more information, see [Base Provider Key BLOBs](http://msdn.microsoft.com/library/b4592036-0fa3-4b7e-beed-78cf1d2f39a9). ### -field BCryptEccFullPrivateKey:4 diff --git a/windows.security.cryptography.core/cryptographicpublickeyblobtype.md b/windows.security.cryptography.core/cryptographicpublickeyblobtype.md index 340a2685ba..afb132f81b 100644 --- a/windows.security.cryptography.core/cryptographicpublickeyblobtype.md +++ b/windows.security.cryptography.core/cryptographicpublickeyblobtype.md @@ -32,15 +32,15 @@ The key is an RSA public key defined in the PKCS #1 standard. For more informati Microsoft public key format defined by Cryptography API: Next Generation (CNG). For examples, see the following CNG structures: -+ [BCRYPT_DH_KEY_BLOB](XREF:TODO:security.bcrypt_dh_key_blob) -+ [BCRYPT_DSA_KEY_BLOB](XREF:TODO:security.bcrypt_dsa_key_blob) -+ [BCRYPT_ECCKEY_BLOB](XREF:TODO:security.bcrypt_ecckey_blob) -+ [BCRYPT_KEY_BLOB](XREF:TODO:security.bcrypt_key_blob) -+ [BCRYPT_RSAKEY_BLOB](XREF:TODO:security.bcrypt_rsakey_blob) ++ [BCRYPT_DH_KEY_BLOB](http://msdn.microsoft.com/library/6004b2e5-7e06-4108-a0da-472b9b6d5fea) ++ [BCRYPT_DSA_KEY_BLOB](http://msdn.microsoft.com/library/3db36170-106e-49c8-9866-e25759bdd7f9) ++ [BCRYPT_ECCKEY_BLOB](http://msdn.microsoft.com/library/e60f6630-e4b0-4f35-a3cf-95dbcb007124) ++ [BCRYPT_KEY_BLOB](http://msdn.microsoft.com/library/ae7e8db3-858d-4573-afe1-c9bc14d76480) ++ [BCRYPT_RSAKEY_BLOB](http://msdn.microsoft.com/library/bbf3f4b9-5c69-4212-bb23-34bb2c84185c) ### -field Capi1PublicKey:3 -Microsoft public key format defined by the legacy Cryptography API (CAPI). For more information, see [Base Provider Key BLOBs](XREF:TODO:security.base_provider_key_blobs). +Microsoft public key format defined by the legacy Cryptography API (CAPI). For more information, see [Base Provider Key BLOBs](http://msdn.microsoft.com/library/b4592036-0fa3-4b7e-beed-78cf1d2f39a9). ### -field BCryptEccFullPublicKey:4 diff --git a/windows.security.enterprisedata/fileprotectionmanager_unprotectasync_1068907817.md b/windows.security.enterprisedata/fileprotectionmanager_unprotectasync_1068907817.md new file mode 100644 index 0000000000..5f0901bcca --- /dev/null +++ b/windows.security.enterprisedata/fileprotectionmanager_unprotectasync_1068907817.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.FileProtectionManager.UnprotectAsync(Windows.Storage.IStorageItem) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.FileProtectionManager.UnprotectAsync + +## -description +Removes protection from an enterprise-protected file. + +## -parameters +### -param target +The file to unprotect. + +## -returns +When the call to this method completes successfully, it returns a [FileProtectionInfo](fileprotectioninfo.md) object that provides information about the protection status of the file. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/fileprotectionmanager_unprotectasync_1695831187.md b/windows.security.enterprisedata/fileprotectionmanager_unprotectasync_1695831187.md new file mode 100644 index 0000000000..e31b9bac9c --- /dev/null +++ b/windows.security.enterprisedata/fileprotectionmanager_unprotectasync_1695831187.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.FileProtectionManager.UnprotectAsync(Windows.Storage.IStorageItem,Windows.Security.EnterpriseData.FileUnprotectOptions) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.FileProtectionManager.UnprotectAsync + +## -description +Removes protection from an enterprise-protected file. + +## -parameters +### -param target +The file to unprotect. + +### -param options +An object that specifies whether to audit this action. + +## -returns +When the call to this method completes successfully, it returns a [FileProtectionInfo](fileprotectioninfo.md) object that provides information about the protection status of the file. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.security.enterprisedata/fileprotectionstatus.md b/windows.security.enterprisedata/fileprotectionstatus.md index 36b9b0bf51..2b731cd3dc 100644 --- a/windows.security.enterprisedata/fileprotectionstatus.md +++ b/windows.security.enterprisedata/fileprotectionstatus.md @@ -32,7 +32,7 @@ The item is not protected using enterprise protection. The item has been revoked using enterprise protection. ### -field Protected:3 -The item is protected using enterprise protection. +The item is protected using enterprise protection and you're app can open this file because it is on the allowed list of the policy. ### -field ProtectedByOtherUser:4 > [!NOTE] @@ -67,4 +67,4 @@ The item is being used by another process. You can apply enterprise protection t ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.security.enterprisedata/filerevocationmanager_copyprotectionasync_491662270.md b/windows.security.enterprisedata/filerevocationmanager_copyprotectionasync_491662270.md index efc1381e51..1a7a709b37 100644 --- a/windows.security.enterprisedata/filerevocationmanager_copyprotectionasync_491662270.md +++ b/windows.security.enterprisedata/filerevocationmanager_copyprotectionasync_491662270.md @@ -1,49 +1,52 @@ ---- --api-id: M:Windows.Security.EnterpriseData.FileRevocationManager.CopyProtectionAsync(Windows.Storage.IStorageItem,Windows.Storage.IStorageItem) --api-type: winrt method ---- - - - -# Windows.Security.EnterpriseData.FileRevocationManager.CopyProtectionAsync - -## -description -> [!NOTE] -> [FileRevocationManager](filerevocationmanager.md) may be unavailable for releases after Windows 10. Instead, use [FileProtectionManager](fileprotectionmanager.md). - - - -> [!NOTE] -> Windows Information Protection (WIP) policy cannot be applied on Windows 10, version 1511 (build 10586) or earlier. - -Copy the selective wipe protection state of a file or folder to a new file or folder. - -## -parameters -### -param sourceStorageItem -The source item to copy the selective wipe protection status from. - -### -param targetStorageItem -The target item to copy the selective wipe protection status to. - -## -returns -True if the copy operation was successful; otherwise false. - -## -remarks -If you save a new copy of a file as the result of a "save as" operation, the selective wipe protection status is not copied with the file. To protect the file, you must call the [CopyProtectionAsync](filerevocationmanager_copyprotectionasync.md) method to copy the existing protection status to the new file. If you copy a protected file using the [CopyAsync](../windows.storage/istoragefile_copyasync.md) or [CopyAndReplaceAsync](../windows.storage/istoragefile_copyandreplaceasync.md) methods, the selective wipe protection status is copied with the file and you do not need to call the [CopyProtectionAsync](filerevocationmanager_copyprotectionasync.md) method. - - - -[!code-csharp[_CopyProtection](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_CopyProtection)] - -[!code-js[_CopyProtection_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_CopyProtection_JS)] - - - -The [CopyProtectionAsync](filerevocationmanager_copyprotectionasync.md) method requires exclusive access to the file or folder being encrypted, and will fail if another process is using has a handle open to the file or folder. - -## -examples - -## -see-also -[FileRevocationManager sample](http://go.microsoft.com/fwlink/p/?LinkID=299023), [How to protect files with Selective Wipe (C#/VB/C++)](http://msdn.microsoft.com/library/a1afb4fb-6731-461a-8dd2-51eec5e880a1), [How to protect files with Selective Wipe (JavaScript)](http://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) +--- +-api-id: M:Windows.Security.EnterpriseData.FileRevocationManager.CopyProtectionAsync(Windows.Storage.IStorageItem,Windows.Storage.IStorageItem) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.FileRevocationManager.CopyProtectionAsync + +## -description +> [!NOTE] +> [FileRevocationManager](filerevocationmanager.md) may be unavailable for releases after Windows 10. Instead, use [FileProtectionManager](fileprotectionmanager.md). + + + +> [!NOTE] +> Windows Information Protection (WIP) policy cannot be applied on Windows 10, version 1511 (build 10586) or earlier. + +Copy the selective wipe protection state of a file or folder to a new file or folder. + +## -parameters +### -param sourceStorageItem +The source item to copy the selective wipe protection status from. + +### -param targetStorageItem +The target item to copy the selective wipe protection status to. + +## -returns +True if the copy operation was successful; otherwise false. + +## -remarks +If you save a new copy of a file as the result of a "save as" operation, the selective wipe protection status is not copied with the file. To protect the file, you must call the [CopyProtectionAsync](filerevocationmanager_copyprotectionasync.md) method to copy the existing protection status to the new file. If you copy a protected file using the [CopyAsync](../windows.storage/istoragefile_copyasync.md) or [CopyAndReplaceAsync](../windows.storage/istoragefile_copyandreplaceasync.md) methods, the selective wipe protection status is copied with the file and you do not need to call the [CopyProtectionAsync](filerevocationmanager_copyprotectionasync.md) method. + + + +[!code-csharp[_CopyProtection](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_CopyProtection)] + +[!code-js[_CopyProtection](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_CopyProtection)] + +[!code-js[_CopyProtection_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_CopyProtection_JS)] + + + +The [CopyProtectionAsync](filerevocationmanager_copyprotectionasync.md) method requires exclusive access to the file or folder being encrypted, and will fail if another process is using has a handle open to the file or folder. + +## -examples + +## -see-also +[FileRevocationManager sample](http://go.microsoft.com/fwlink/p/?LinkID=299023), [How to protect files with Selective Wipe (C#/VB/C++)](http://msdn.microsoft.com/library/a1afb4fb-6731-461a-8dd2-51eec5e880a1), [How to protect files with Selective Wipe (JavaScript)](http://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) +52eb-6462-4bf1-b5b7-4a37957c605f) diff --git a/windows.security.enterprisedata/filerevocationmanager_getstatusasync_872885170.md b/windows.security.enterprisedata/filerevocationmanager_getstatusasync_872885170.md index a71a0e51a9..0f27985828 100644 --- a/windows.security.enterprisedata/filerevocationmanager_getstatusasync_872885170.md +++ b/windows.security.enterprisedata/filerevocationmanager_getstatusasync_872885170.md @@ -1,51 +1,53 @@ ---- --api-id: M:Windows.Security.EnterpriseData.FileRevocationManager.GetStatusAsync(Windows.Storage.IStorageItem) --api-type: winrt method ---- - - - -# Windows.Security.EnterpriseData.FileRevocationManager.GetStatusAsync - -## -description -> [!NOTE] -> [FileRevocationManager](filerevocationmanager.md) may be unavailable for releases after Windows 10. Instead, use [FileProtectionManager](fileprotectionmanager.md). - - - -> [!NOTE] -> Windows Information Protection (WIP) policy cannot be applied on Windows 10, version 1511 (build 10586) or earlier. - -Gets the selective wipe protection status for a file or folder. - -## -parameters -### -param storageItem -The file or folder to get the selective wipe protection status for. - -## -returns -An aysnchronous operation that retrieves the selective wipe protection status for the *storageItem*. - -## -remarks -You can use the [GetStatusAsync](filerevocationmanager_getstatusasync.md) method to determine the Selective Wipe protection status of a file or folder. This will tell you if a file is protected or not, if a file is protected by another user on the computer, and so on. A common use of the [GetStatusAsync](filerevocationmanager_getstatusasync.md) method is to determine when a protected file should be deleted. For example, when a protected file is revoked, an attempt to access the file contents will result in an "Access is denied" exception. When you encounter that exception, you can use the [GetStatusAsync](filerevocationmanager_getstatusasync.md) method to determine if the file has been revoked by Selective Wipe and then delete the file if it has, as shown in the following example. - - - -[!code-csharp[_Global](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_Global)] - - -[!code-csharp[_GetStatus](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_GetStatus)] - - - - - -[!code-js[_Global_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Global_JS)] - -[!code-js[_GetStatus_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_GetStatus_JS)] - -## -examples - -## -see-also -[FileRevocationManager sample](http://go.microsoft.com/fwlink/p/?LinkID=299023), [How to protect files with Selective Wipe (C#/VB/C++)](http://msdn.microsoft.com/library/a1afb4fb-6731-461a-8dd2-51eec5e880a1), [How to protect files with Selective Wipe (JavaScript)](http://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) +--- +-api-id: M:Windows.Security.EnterpriseData.FileRevocationManager.GetStatusAsync(Windows.Storage.IStorageItem) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.FileRevocationManager.GetStatusAsync + +## -description +> [!NOTE] +> [FileRevocationManager](filerevocationmanager.md) may be unavailable for releases after Windows 10. Instead, use [FileProtectionManager](fileprotectionmanager.md). + + + +> [!NOTE] +> Windows Information Protection (WIP) policy cannot be applied on Windows 10, version 1511 (build 10586) or earlier. + +Gets the selective wipe protection status for a file or folder. + +## -parameters +### -param storageItem +The file or folder to get the selective wipe protection status for. + +## -returns +An aysnchronous operation that retrieves the selective wipe protection status for the *storageItem*. + +## -remarks +You can use the [GetStatusAsync](filerevocationmanager_getstatusasync.md) method to determine the Selective Wipe protection status of a file or folder. This will tell you if a file is protected or not, if a file is protected by another user on the computer, and so on. A common use of the [GetStatusAsync](filerevocationmanager_getstatusasync.md) method is to determine when a protected file should be deleted. For example, when a protected file is revoked, an attempt to access the file contents will result in an "Access is denied" exception. When you encounter that exception, you can use the [GetStatusAsync](filerevocationmanager_getstatusasync.md) method to determine if the file has been revoked by Selective Wipe and then delete the file if it has, as shown in the following example. + + + +[!code-csharp[_Global](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_Global)] + +[!code-js[_Global](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Global)] + +[!code-csharp[_GetStatus](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_GetStatus)] + +[!code-js[_GetStatus](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_GetStatus)] + + + +[!code-js[_Global_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Global_JS)] + +[!code-js[_GetStatus_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_GetStatus_JS)] + +## -examples + +## -see-also +[FileRevocationManager sample](http://go.microsoft.com/fwlink/p/?LinkID=299023), [How to protect files with Selective Wipe (C#/VB/C++)](http://msdn.microsoft.com/library/a1afb4fb-6731-461a-8dd2-51eec5e880a1), [How to protect files with Selective Wipe (JavaScript)](http://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) +p://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) diff --git a/windows.security.enterprisedata/filerevocationmanager_protectasync_1331169532.md b/windows.security.enterprisedata/filerevocationmanager_protectasync_1331169532.md index 162c4a263d..e009dcfdc4 100644 --- a/windows.security.enterprisedata/filerevocationmanager_protectasync_1331169532.md +++ b/windows.security.enterprisedata/filerevocationmanager_protectasync_1331169532.md @@ -1,53 +1,58 @@ ---- --api-id: M:Windows.Security.EnterpriseData.FileRevocationManager.ProtectAsync(Windows.Storage.IStorageItem,System.String) --api-type: winrt method ---- - - - -# Windows.Security.EnterpriseData.FileRevocationManager.ProtectAsync - -## -description -> [!NOTE] -> [FileRevocationManager](filerevocationmanager.md) may be unavailable for releases after Windows 10. Instead, use [FileProtectionManager](fileprotectionmanager.md). - - - -> [!NOTE] -> Windows Information Protection (WIP) policy cannot be applied on Windows 10, version 1511 (build 10586) or earlier. - -Protects a file or folder for selective wipe. - -## -parameters -### -param storageItem -The file or folder to protect for selective wipe. - -### -param enterpriseIdentity -The enterprise id that the file or folder is protected for. The *enterpriseIdentity* value must be formatted as an Internationalized Domain Name (IDN) and cannot contain spaces. For example, **contoso.com**. - -## -returns -An asynchronous operation that retrieves the selective wipe protection status for the *storageItem*. - -## -remarks -You can use the [ProtectAsync](filerevocationmanager_protectasync.md) method to protect a file or folder using Selective Wipe. This identifies the file as protected for your enterprise identifier, such as "example.com", as shown in the previous code example. If you protect a folder using the [ProtectAsync](filerevocationmanager_protectasync.md) method, then all files in that folder inherit the same protection. - - - -[!code-csharp[_Global](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_Global)] - - -[!code-csharp[_Protect](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_Protect)] - - -[!code-js[_Global_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Global_JS)] - -[!code-js[_Protect_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Protect_JS)] - -The [ProtectAsync](filerevocationmanager_protectasync.md) method requires exclusive access to the file or folder being encrypted, and will fail if another process is using has a handle open to the file or folder. - -## -examples - -## -see-also -[FileRevocationManager sample](http://go.microsoft.com/fwlink/p/?LinkID=299023), [How to protect files with Selective Wipe (C#/VB/C++)](http://msdn.microsoft.com/library/a1afb4fb-6731-461a-8dd2-51eec5e880a1), [How to protect files with Selective Wipe (JavaScript)](http://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) +--- +-api-id: M:Windows.Security.EnterpriseData.FileRevocationManager.ProtectAsync(Windows.Storage.IStorageItem,System.String) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.FileRevocationManager.ProtectAsync + +## -description +> [!NOTE] +> [FileRevocationManager](filerevocationmanager.md) may be unavailable for releases after Windows 10. Instead, use [FileProtectionManager](fileprotectionmanager.md). + + + +> [!NOTE] +> Windows Information Protection (WIP) policy cannot be applied on Windows 10, version 1511 (build 10586) or earlier. + +Protects a file or folder for selective wipe. + +## -parameters +### -param storageItem +The file or folder to protect for selective wipe. + +### -param enterpriseIdentity +The enterprise id that the file or folder is protected for. The *enterpriseIdentity* value must be formatted as an Internationalized Domain Name (IDN) and cannot contain spaces. For example, **contoso.com**. + +## -returns +An asynchronous operation that retrieves the selective wipe protection status for the *storageItem*. + +## -remarks +You can use the [ProtectAsync](filerevocationmanager_protectasync.md) method to protect a file or folder using Selective Wipe. This identifies the file as protected for your enterprise identifier, such as "example.com", as shown in the previous code example. If you protect a folder using the [ProtectAsync](filerevocationmanager_protectasync.md) method, then all files in that folder inherit the same protection. + + + +[!code-csharp[_Global](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_Global)] + +[!code-js[_Global](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Global)] + +[!code-csharp[_Protect](../windows.security.enterprisedata/code/SelectiveWipeSnippets/cs/MainPage.xaml.cs#Snippet_Protect)] + +[!code-js[_Protect](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Protect)] + + + +[!code-js[_Global_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Global_JS)] + +[!code-js[_Protect_JS](../windows.security.enterprisedata/code/SelectiveWipeSnippets/js/default.js#Snippet_Protect_JS)] + +The [ProtectAsync](filerevocationmanager_protectasync.md) method requires exclusive access to the file or folder being encrypted, and will fail if another process is using has a handle open to the file or folder. + +## -examples + +## -see-also +[FileRevocationManager sample](http://go.microsoft.com/fwlink/p/?LinkID=299023), [How to protect files with Selective Wipe (C#/VB/C++)](http://msdn.microsoft.com/library/a1afb4fb-6731-461a-8dd2-51eec5e880a1), [How to protect files with Selective Wipe (JavaScript)](http://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) +p://msdn.microsoft.com/library/5b8652eb-6462-4bf1-b5b7-4a37957c605f) diff --git a/windows.security.enterprisedata/fileunprotectoptions.md b/windows.security.enterprisedata/fileunprotectoptions.md new file mode 100644 index 0000000000..0a5d083e4d --- /dev/null +++ b/windows.security.enterprisedata/fileunprotectoptions.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Security.EnterpriseData.FileUnprotectOptions +-api-type: winrt class +--- + + + +# Windows.Security.EnterpriseData.FileUnprotectOptions + +## -description +Contains options that apply to removing protection from an enterprise-protected file. + +## -remarks +You can pass an instance of this class to the [UnprotectAsync](XREF:TODO:w_sec_entdata.fileprotectionmanager_unprotectasync_1695831187.xml) method. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/fileunprotectoptions_audit.md b/windows.security.enterprisedata/fileunprotectoptions_audit.md new file mode 100644 index 0000000000..4fe5f64d8d --- /dev/null +++ b/windows.security.enterprisedata/fileunprotectoptions_audit.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.EnterpriseData.FileUnprotectOptions.Audit +-api-type: winrt property +--- + + + +# Windows.Security.EnterpriseData.FileUnprotectOptions.Audit + +## -description +Specifies whether to log the unprotect action for audit. + +## -property-value +**true** if the removing protection from the file will be logged for audit, otherwise **false**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/fileunprotectoptions_fileunprotectoptions_1174655024.md b/windows.security.enterprisedata/fileunprotectoptions_fileunprotectoptions_1174655024.md new file mode 100644 index 0000000000..6ca0c9718c --- /dev/null +++ b/windows.security.enterprisedata/fileunprotectoptions_fileunprotectoptions_1174655024.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.FileUnprotectOptions.#ctor(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.FileUnprotectOptions.FileUnprotectOptions + +## -description +Creates an instance of the [FileUnprotectOptions](fileunprotectoptions.md) class. + +## -parameters +### -param audit +Specifies whether to log this action for audit. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/protectionpolicymanager_getprimarymanagedidentityforidentity_1205353119.md b/windows.security.enterprisedata/protectionpolicymanager_getprimarymanagedidentityforidentity_1205353119.md new file mode 100644 index 0000000000..9812cf5832 --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_getprimarymanagedidentityforidentity_1205353119.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.GetPrimaryManagedIdentityForIdentity(System.String) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.GetPrimaryManagedIdentityForIdentity + +## -description +Gets the parent or primary identity of a given child or secondary identity. + +## -parameters +### -param identity +The child or secondary identity that you want to use to get the parent or primary identity. + +## -returns +The parent or primary identity. + +## -remarks +Most policies have a list of identities. The primary identity usually appears first in that list. The secondary identities usually appear after the primary identity. Those secondary identities are, in a sense "owned" by the primary identity. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/protectionpolicymanager_isfileprotectionrequiredasync_2068771327.md b/windows.security.enterprisedata/protectionpolicymanager_isfileprotectionrequiredasync_2068771327.md new file mode 100644 index 0000000000..7153d7fcc0 --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_isfileprotectionrequiredasync_2068771327.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.IsFileProtectionRequiredAsync(Windows.Storage.IStorageItem,System.String) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.IsFileProtectionRequiredAsync + +## -description +Indicates whether a file needs to be protected by the enterprise identity. + +## -parameters +### -param target +The file that you want to know whether to protect. + +### -param identity +The enterprise identity. + +## -returns +**true** if the file should be protected, otherwise **false**. + +## -remarks +Your code can call this method to avoid encrypting files that don’t need to be encrypted such as exe, dll, and other build artifacts. This lowers the risk of those files being inaccessible to other users of a computer and lowers performance cost for unnecessarily encrypting files. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/protectionpolicymanager_isfileprotectionrequiredfornewfileasync_217958627.md b/windows.security.enterprisedata/protectionpolicymanager_isfileprotectionrequiredfornewfileasync_217958627.md new file mode 100644 index 0000000000..297a0d81cc --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_isfileprotectionrequiredfornewfileasync_217958627.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.IsFileProtectionRequiredForNewFileAsync(Windows.Storage.IStorageFolder,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.IsFileProtectionRequiredForNewFileAsync + +## -description +Indicates whether a file needs to be protected by the enterprise identity. + +## -parameters + +### -param parentFolder +The folder that contains files that that you want to know whether to protect. + +### -param identity +The enterprise identity. + +### -param desiredName +The name that you would like to give the file. + +## -returns +**true** if files in this folder should be protected, otherwise **false**. + +## -remarks +See the remarks section of this method: [IsFileProtectionRequiredAsync](protectionpolicymanager_isfileprotectionrequiredasync.md). + +## -examples + +## -see-also diff --git a/windows.security.enterprisedata/protectionpolicymanager_isroamableprotectionenabled_1309947165.md b/windows.security.enterprisedata/protectionpolicymanager_isroamableprotectionenabled_1309947165.md new file mode 100644 index 0000000000..d7fa82acbe --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_isroamableprotectionenabled_1309947165.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.IsRoamableProtectionEnabled(System.String) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.IsRoamableProtectionEnabled + +## -description +Determines whether the policy is configured to protect files that are copied to removable drives by using [Azure Information Protection](https://www.microsoft.com/cloud-platform/azure-information-protection). + +## -parameters +### -param identity +The enterprise identity. + +## -returns +**true** if files will be protected by using RMS keys, otherwise **false**. + +## -remarks +If this method returns **false**, files that users copy to removable drives will be protected by using local keys and those files won't be accessible on those drives to other users on the current device or, if the drive is connected to another device, to anyone on that newly connected device. If this method returns **false**, you could (optionally) let users know about this limitation by presenting this information in a dialog box. + +## -examples + +## -see-also diff --git a/windows.security.enterprisedata/protectionpolicymanager_primarymanagedidentity.md b/windows.security.enterprisedata/protectionpolicymanager_primarymanagedidentity.md new file mode 100644 index 0000000000..2581d2ed05 --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_primarymanagedidentity.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Security.EnterpriseData.ProtectionPolicyManager.PrimaryManagedIdentity +-api-type: winrt property +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.PrimaryManagedIdentity + +## -description +Gets the primary enterprise identity. + +## -property-value +The primary enterprise identity. This is an email address or domain that is managed. This property returns **null** if there is no managed identity associated with the [ProtectionPolicyManager](protectionpolicymanager.md) . + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/protectionpolicymanager_requestaccessasync_1905038971.md b/windows.security.enterprisedata/protectionpolicymanager_requestaccessasync_1905038971.md new file mode 100644 index 0000000000..812142623c --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_requestaccessasync_1905038971.md @@ -0,0 +1,39 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessAsync(System.String,System.String,Windows.Security.EnterpriseData.ProtectionPolicyAuditInfo,System.String,Windows.Security.EnterpriseData.ProtectionPolicyRequestAccessBehavior) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessAsync + +## -description +Request access to enterprise protected content for an identity + +## -parameters +### -param sourceIdentity +The enterprise identity to which the content is protected. + +### -param targetIdentity +The enterprise identity to which the content is being disclosed. This is an email address or domain. + +### -param auditInfo +An audit info object; an instance of [ProtectionPolicyAuditInfo](protectionpolicyauditinfo.md). + +### -param messageFromApp +A message that will be displayed in the consent dialog so that the user can make a consent decision. + +### -param behavior +A constant that defines how you would like to override default policy behavior. + +## -returns +A value of the [ProtectionPolicyEvaluationResult](protectionpolicyevaluationresult.md) enumeration that is the result of the request. + +## -remarks +Call this method from the main UI thread of your foreground app. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.security.enterprisedata/protectionpolicymanager_requestaccessforappasync_1690640020.md b/windows.security.enterprisedata/protectionpolicymanager_requestaccessforappasync_1690640020.md new file mode 100644 index 0000000000..51fe7bebed --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_requestaccessforappasync_1690640020.md @@ -0,0 +1,39 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessForAppAsync(System.String,System.String,Windows.Security.EnterpriseData.ProtectionPolicyAuditInfo,System.String,Windows.Security.EnterpriseData.ProtectionPolicyRequestAccessBehavior) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessForAppAsync + +## -description +Request access to enterprise-protected content for a specific target app. + +## -parameters +### -param sourceIdentity +The enterprise identity to which the content is protected. This is an email address or domain that is managed. + +### -param appPackageFamilyName +The enterprise identity to which the content is being disclosed. This is an email address or domain. + +### -param auditInfo +An audit info object; an instance of [ProtectionPolicyAuditInfo](protectionpolicyauditinfo.md). + +### -param messageFromApp +A message that will be displayed in the consent dialog so that the user can make a consent decision. + +### -param behavior +A constant that defines how you would like to override default policy behavior. + + +## -returns +A value of the [ProtectionPolicyEvaluationResult](protectionpolicyevaluationresult.md) enumeration that is the result of the query. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.security.enterprisedata/protectionpolicymanager_requestaccessforappasync_377805400.md b/windows.security.enterprisedata/protectionpolicymanager_requestaccessforappasync_377805400.md index 9c1cb7e378..b6dd6656f2 100644 --- a/windows.security.enterprisedata/protectionpolicymanager_requestaccessforappasync_377805400.md +++ b/windows.security.enterprisedata/protectionpolicymanager_requestaccessforappasync_377805400.md @@ -16,11 +16,12 @@ public Windows.Foundation.IAsyncOperation ProtectionPolicyManager.RequestAccessToFilesForAppAsync(IIterable sourceItemList, String appPackageFamilyName, ProtectionPolicyAuditInfo auditInfo, String messageFromApp, ProtectionPolicyRequestAccessBehavior behavior) +--> + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessToFilesForAppAsync + +## -description +Requests access to enterprise-protected content for a specific app. +## -params + +## -param sourceItemList +An array of files to that you want to grant access to.  +## -param appPackageFamilyName +The package name of the app that you want to grant the permission to. +## -param auditInfo +An audit info object; an instance of [ProtectionPolicyAuditInfo](protectionpolicyauditinfo.md). +## -param messageFromApp +A message that will be displayed in the consent dialog box so that the user can make a consent decision.  +## -param behavior +A constant that defines how you would like to override default policy behavior. +## -returns +A value of the [ProtectionPolicyEvaluationResult](protectionpolicyevaluationresult.md) enumeration that is the result of the query. +## -remarks + +## -see-also + +## -examples diff --git a/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforappasync_218706816.md b/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforappasync_218706816.md new file mode 100644 index 0000000000..af95973fe0 --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforappasync_218706816.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessToFilesForAppAsync(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageItem},System.String,Windows.Security.EnterpriseData.ProtectionPolicyAuditInfo) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessToFilesForAppAsync + +## -description +Requests access to enterprise-protected content for a specific app. +## -params + +## -param sourceItemList +An array of files to that you want to grant access to.  +## -param appPackageFamilyName +The package name of the app that you want to grant permission to. +## -param auditInfo +An audit info object; an instance of [ProtectionPolicyAuditInfo](protectionpolicyauditinfo.md). +## -returns +A value of the [ProtectionPolicyEvaluationResult](protectionpolicyevaluationresult.md) enumeration that is the result of the query.  +## -remarks + +## -see-also + +## -examples diff --git a/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforprocessasync_141726157.md b/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforprocessasync_141726157.md new file mode 100644 index 0000000000..e63b42d1bf --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforprocessasync_141726157.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessToFilesForProcessAsync(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageItem},System.UInt32,Windows.Security.EnterpriseData.ProtectionPolicyAuditInfo,System.String,Windows.Security.EnterpriseData.ProtectionPolicyRequestAccessBehavior) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessToFilesForProcessAsync + +## -description +Requests access to enterprise-protected content for a process of an app. +## -params + +## -param sourceItemList +An array of files to that you want to grant access to.  +## -param processId +The process id of the process that you want to grant the permission to. +## -param auditInfo +An audit info object; an instance of [ProtectionPolicyAuditInfo](protectionpolicyauditinfo.md). +## -param messageFromApp +A message that will be displayed in the consent dialog box so that the user can make a consent decision. +## -param behavior +A constant that defines how you would like to override default policy behavior. +## -returns +A value of the [ProtectionPolicyEvaluationResult](protectionpolicyevaluationresult.md) enumeration that is the result of the query. +## -remarks +Use this method to temporarily grant access of a protected file to a process that can only access unprotected files. +## -see-also + +## -examples diff --git a/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforprocessasync_1957401037.md b/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforprocessasync_1957401037.md new file mode 100644 index 0000000000..6bbd63c5d5 --- /dev/null +++ b/windows.security.enterprisedata/protectionpolicymanager_requestaccesstofilesforprocessasync_1957401037.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessToFilesForProcessAsync(Windows.Foundation.Collections.IIterable{Windows.Storage.IStorageItem},System.UInt32,Windows.Security.EnterpriseData.ProtectionPolicyAuditInfo) +-api-type: winrt method +--- + + + +# Windows.Security.EnterpriseData.ProtectionPolicyManager.RequestAccessToFilesForProcessAsync +Requests access to enterprise-protected content for a process of an app. +## -description + +## -params + +## -param sourceItemList +An array of files to that you want to grant access to. +## -param processId +The process id of the process that you want to grant the permission to. +## -param auditInfo +An audit info object; an instance of [ProtectionPolicyAuditInfo](protectionpolicyauditinfo.md). +## -returns +A value of the [ProtectionPolicyEvaluationResult](protectionpolicyevaluationresult.md) enumeration that is the result of the query. +## -remarks + +## -see-also + +## -examples diff --git a/windows.security.enterprisedata/protectionpolicyrequestaccessbehavior.md b/windows.security.enterprisedata/protectionpolicyrequestaccessbehavior.md index dac6c1149a..eef798f41c 100644 --- a/windows.security.enterprisedata/protectionpolicyrequestaccessbehavior.md +++ b/windows.security.enterprisedata/protectionpolicyrequestaccessbehavior.md @@ -13,7 +13,7 @@ public enum Windows.Security.EnterpriseData.ProtectionPolicyRequestAccessBehavio > [!NOTE] > Windows Information Protection (WIP) policy cannot be applied on Windows 10, version 1511 (build 10586) or earlier. -Defines constants that you can use to override default policy behavior. +Defines constants that you can use to override default behavior of the request access overloads of the [ProtectionPolicyManager](protectionpolicymanager.md) class. ## -enum-fields ### -field Decrypt:0 @@ -27,4 +27,4 @@ Indicates that an override action behaves as a block action. ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.services.cortana/cortanapermission.md b/windows.services.cortana/cortanapermission.md new file mode 100644 index 0000000000..30e6a956af --- /dev/null +++ b/windows.services.cortana/cortanapermission.md @@ -0,0 +1,59 @@ +--- +-api-id: T:Windows.Services.Cortana.CortanaPermission +-api-type: winrt enum +--- + + + +# Windows.Services.Cortana.CortanaPermission + +## -description +Specifies the Cortana permissions available to a [CortanaPermissionManager](cortanapermissionsmanager.md) object. + +## -enum-fields +### -field PhoneCall:10 +Cortana can make phone calls. + +### -field Personalization:9 +Cortana personalization settings are exposed. + +### -field Microphone:8 +Cortana can access the microphone. + +### -field Messaging:7 +Cortana can send text messages. + +### -field Location:6 +Cortana can access the user's location. + +### -field InputPersonalization:5 +Cortana can access input personalization settings. + +### -field Email:4 +Cortana can send email. + +### -field Contacts:3 +Cortana can access the user's contacts. + +### -field CallHistory:2 +Cortana can access the user's call history. + +### -field Calendar:1 +Cortana can access the user's calendar. + +### -field BrowsingHistory:0 +Cortana can access the user's web browsing history. + +## -remarks + +## -see-also +- [CortanaPermissionsChangeResult](cortanapermissionschangeresult.md) +- [CortanaPermissionManager](cortanapermissionsmanager.md) +- [CortanaPermissionsManager.ArePermissionsGrantedAsync](cortanapermissionsmanager_arepermissionsgrantedasync_1821808521.md) +- [CortanaPermissionsManager.GrantPermissionsAsync](cortanapermissionsmanager_grantpermissionsasync_1382961431.md) +- [CortanaPermissionsManager.RevokePermissionsAsync](cortanapermissionsmanager_revokepermissionsasync_517405145.md) + +## -examples + diff --git a/windows.services.cortana/cortanapermissionschangeresult.md b/windows.services.cortana/cortanapermissionschangeresult.md new file mode 100644 index 0000000000..573a96420a --- /dev/null +++ b/windows.services.cortana/cortanapermissionschangeresult.md @@ -0,0 +1,36 @@ +--- +-api-id: T:Windows.Services.Cortana.CortanaPermissionsChangeResult +-api-type: winrt enum +--- + + + +# Windows.Services.Cortana.CortanaPermissionsChangeResult + +## -description +Specifies the possible results from setting permissions using the [CortanaPermissionsManager](cortanapermissionsmanager.md). + +## -enum-fields +### -field Unavailable:1 +Setting one or more permissions failed. + +### -field Success:0 +Setting all permissions succeeded. + +### -field DisabledByPolicy:2 +Changes to settings are not permitted. + +## -remarks +- [CortanaPermission](cortanapermission.md) +- [CortanaPermissionManager](cortanapermissionsmanager.md) +- [CortanaPermissionsManager.ArePermissionsGrantedAsync](cortanapermissionsmanager_arepermissionsgrantedasync_1821808521.md) +- [CortanaPermissionsManager.GrantPermissionsAsync](cortanapermissionsmanager_grantpermissionsasync_1382961431.md) +- [CortanaPermissionsManager.RevokePermissionsAsync](cortanapermissionsmanager_revokepermissionsasync_517405145.md) + +## -see-also + + +## -examples + diff --git a/windows.services.cortana/cortanapermissionsmanager.md b/windows.services.cortana/cortanapermissionsmanager.md new file mode 100644 index 0000000000..49c025ace9 --- /dev/null +++ b/windows.services.cortana/cortanapermissionsmanager.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Services.Cortana.CortanaPermissionsManager +-api-type: winrt class +--- + + + +# Windows.Services.Cortana.CortanaPermissionsManager + +## -description +Provides access to the users Cortana authorization settings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/cortanapermissionsmanager_arepermissionsgrantedasync_1821808521.md b/windows.services.cortana/cortanapermissionsmanager_arepermissionsgrantedasync_1821808521.md new file mode 100644 index 0000000000..aac043a201 --- /dev/null +++ b/windows.services.cortana/cortanapermissionsmanager_arepermissionsgrantedasync_1821808521.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Services.Cortana.CortanaPermissionsManager.ArePermissionsGrantedAsync(Windows.Foundation.Collections.IIterable{Windows.Services.Cortana.CortanaPermission}) +-api-type: winrt method +--- + + + +# Windows.Services.Cortana.CortanaPermissionsManager.ArePermissionsGrantedAsync + +## -description +Asynchronously retreives whether the specified permissions are granted. + +## -parameters + +### -param permissions +The collection of [permissions](cortanapermission.md) of interest. + +## -returns +**true** if permission is granted. Otherwise, **false**. + +## -remarks + +## -see-also +[CortanaPermission](cortanapermission.md) + +## -examples + diff --git a/windows.services.cortana/cortanapermissionsmanager_getdefault_846721868.md b/windows.services.cortana/cortanapermissionsmanager_getdefault_846721868.md new file mode 100644 index 0000000000..41ee920e04 --- /dev/null +++ b/windows.services.cortana/cortanapermissionsmanager_getdefault_846721868.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Services.Cortana.CortanaPermissionsManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.Services.Cortana.CortanaPermissionsManager.GetDefault + +## -description +Retrieves the Cortana permissions for the current user. + +## -parameters +A CortanaPermissionsManager object. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/cortanapermissionsmanager_grantpermissionsasync_1382961431.md b/windows.services.cortana/cortanapermissionsmanager_grantpermissionsasync_1382961431.md new file mode 100644 index 0000000000..47ad88e43b --- /dev/null +++ b/windows.services.cortana/cortanapermissionsmanager_grantpermissionsasync_1382961431.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Services.Cortana.CortanaPermissionsManager.GrantPermissionsAsync(Windows.Foundation.Collections.IIterable{Windows.Services.Cortana.CortanaPermission}) +-api-type: winrt method +--- + + + +# Windows.Services.Cortana.CortanaPermissionsManager.GrantPermissionsAsync + +## -description +Asynchronously grants the specified set of Cortana permissions. + +## -parameters + +### -param permissions +The collection of [permissions](cortanapermission.md) to grant. + +## -returns +The result of the permission operation. + +## -remarks + +## -see-also +[CortanaPermission](cortanapermission.md) + +## -examples + diff --git a/windows.services.cortana/cortanapermissionsmanager_issupported_930300905.md b/windows.services.cortana/cortanapermissionsmanager_issupported_930300905.md new file mode 100644 index 0000000000..721b12fea3 --- /dev/null +++ b/windows.services.cortana/cortanapermissionsmanager_issupported_930300905.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Services.Cortana.CortanaPermissionsManager.IsSupported +-api-type: winrt method +--- + + + +# Windows.Services.Cortana.CortanaPermissionsManager.IsSupported + +## -description +Retrieves whether Cortana is supported. + +## -parameters + +## -returns +**true** if Cortana is supported. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/cortanapermissionsmanager_revokepermissionsasync_517405145.md b/windows.services.cortana/cortanapermissionsmanager_revokepermissionsasync_517405145.md new file mode 100644 index 0000000000..3e3934d71b --- /dev/null +++ b/windows.services.cortana/cortanapermissionsmanager_revokepermissionsasync_517405145.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.Services.Cortana.CortanaPermissionsManager.RevokePermissionsAsync(Windows.Foundation.Collections.IIterable{Windows.Services.Cortana.CortanaPermission}) +-api-type: winrt method +--- + + + +# Windows.Services.Cortana.CortanaPermissionsManager.RevokePermissionsAsync + +## -description +Asynchronously revokes the specified set of Cortana permissions. + +## -parameters + +### -param permissions +The collection of [permissions](cortanapermission.md) to revoke. + +## -returns +The result of the permission operation. + +## -remarks + +## -see-also +[CortanaPermission](cortanapermission.md) + +## -examples + diff --git a/windows.services.cortana/cortanasettings.md b/windows.services.cortana/cortanasettings.md new file mode 100644 index 0000000000..69cd048dcb --- /dev/null +++ b/windows.services.cortana/cortanasettings.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Services.Cortana.CortanaSettings +-api-type: winrt class +--- + + + +# Windows.Services.Cortana.CortanaSettings + +## -description +Provides access to Cortana settings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/cortanasettings_getdefault_846721868.md b/windows.services.cortana/cortanasettings_getdefault_846721868.md new file mode 100644 index 0000000000..663928ebbf --- /dev/null +++ b/windows.services.cortana/cortanasettings_getdefault_846721868.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.Cortana.CortanaSettings.GetDefault +-api-type: winrt method +--- + + + +# Windows.Services.Cortana.CortanaSettings.GetDefault + +## -description +Retrieves the Cortana settings for the current user. + +## -returns +A CortanaSettings object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/cortanasettings_hasuserconsenttovoiceactivation.md b/windows.services.cortana/cortanasettings_hasuserconsenttovoiceactivation.md new file mode 100644 index 0000000000..6a3252600e --- /dev/null +++ b/windows.services.cortana/cortanasettings_hasuserconsenttovoiceactivation.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Services.Cortana.CortanaSettings.HasUserConsentToVoiceActivation +-api-type: winrt property +--- + + + +# Windows.Services.Cortana.CortanaSettings.HasUserConsentToVoiceActivation + +## -description +Gets whether the user has consented to voice activation. + +## -property-value +**true** if the user has consented. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/cortanasettings_issupported_930300905.md b/windows.services.cortana/cortanasettings_issupported_930300905.md new file mode 100644 index 0000000000..8649c2ea7f --- /dev/null +++ b/windows.services.cortana/cortanasettings_issupported_930300905.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.Cortana.CortanaSettings.IsSupported +-api-type: winrt method +--- + + + +# Windows.Services.Cortana.CortanaSettings.IsSupported + +## -description +Retrieves whether Cortana settings are supported. + +## -returns +**true** if Cortana settings are supported. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/cortanasettings_isvoiceactivationenabled.md b/windows.services.cortana/cortanasettings_isvoiceactivationenabled.md new file mode 100644 index 0000000000..b2ce1c1eaf --- /dev/null +++ b/windows.services.cortana/cortanasettings_isvoiceactivationenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Services.Cortana.CortanaSettings.IsVoiceActivationEnabled +-api-type: winrt property +--- + + + +# Windows.Services.Cortana.CortanaSettings.IsVoiceActivationEnabled + +## -description +Gets or sets whether voice activation is enabled. + +## -property-value +**true** if voice activation is enabled. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.cortana/windows_services_cortana.md b/windows.services.cortana/windows_services_cortana.md new file mode 100644 index 0000000000..8804ab8b7d --- /dev/null +++ b/windows.services.cortana/windows_services_cortana.md @@ -0,0 +1,22 @@ +--- +-api-id: N:Windows.Services.Cortana +-api-type: winrt namespace +--- + + + +# Windows.Services.Cortana + +## -description +Provides types and members for accessing and managing the information an app shares with the Cortana service. + +For example, apps that require the user to enable a particular Cortana permission can display in-app consent UI and can then grant the appropriate permissions to Cortana on behalf of the user.  + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.maps.offlinemaps/offlinemappackage.md b/windows.services.maps.offlinemaps/offlinemappackage.md new file mode 100644 index 0000000000..af5d3ca4e0 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage.md @@ -0,0 +1,58 @@ +--- +-api-id: T:Windows.Services.Maps.OfflineMaps.OfflineMapPackage +-api-type: winrt class +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage + +## -description +Represents the map data for a particular geographical region. The data can be downloaded and used offline. + +## -remarks +Use this class to asynchronously find map packages that you are interested in using offline. You can check the status of packages to determine whether those packages exist on your local system. If they do not, you can asynchronously download them to your system. + +You can then access that data in system controls such as the [MapControl](../windows.ui.xaml.controls.maps/mapcontrol.md), and from other objects in the [Windows.Services.Maps](../windows.services.maps/windows_services_maps.md) namespace. + +## -see-also + +## -examples +The following example finds a map packages by using a geographical location. If the map package has not been previously downloaded to the local system, this code asynchronously downloads that map. + +> [!NOTE] +> The points near a border or large boxes and circles might return multiple map package matches. + +```csharp + +private async Task getMapPackages() +{ + Geopoint myPoint = new Geopoint(new BasicGeoposition() + { + //Geopoint for Seattle + Latitude = 47.604, + Longitude = -122.329 + }); + + var queryResult = await OfflineMapPackage.FindPackagesAsync(myPoint); + + if (queryResult.Status == OfflineMapPackageQueryStatus.Success) + { + foreach (OfflineMapPackage package in queryResult.Packages) + { + if (package.Status != OfflineMapPackageStatus.Downloaded) + { + var downloadRequestResult = await package.RequestStartDownloadAsync(); + + if (downloadRequestResult.Status == OfflineMapPackageStartDownloadStatus.Success) + { + // do something with the offline map package. + } + } + } + } +} + +``` diff --git a/windows.services.maps.offlinemaps/offlinemappackage_displayname.md b/windows.services.maps.offlinemaps/offlinemappackage_displayname.md new file mode 100644 index 0000000000..b8b27fffc8 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_displayname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.DisplayName +-api-type: winrt property +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.DisplayName + +## -description +Gets the display name of a geographic location for the offline map package. + +## -property-value +Gets the display name of a geographic location for the offline map package. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_enclosingregionname.md b/windows.services.maps.offlinemaps/offlinemappackage_enclosingregionname.md new file mode 100644 index 0000000000..fda2feea8a --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_enclosingregionname.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.EnclosingRegionName +-api-type: winrt property +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.EnclosingRegionName + +## -description +Gets the surrounding or containing region of the offline map package (for example: USA). + +## -property-value +The surrounding or containing region of the offline map package (for example: USA). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_estimatedsizeinbytes.md b/windows.services.maps.offlinemaps/offlinemappackage_estimatedsizeinbytes.md new file mode 100644 index 0000000000..3b5f4d774d --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_estimatedsizeinbytes.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.EstimatedSizeInBytes +-api-type: winrt property +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.EstimatedSizeInBytes + +## -description +Gets the estimated size in bytes of the offline map package. + +## -property-value +The estimated size in bytes of the offline map package. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_findpackagesasync_1312242741.md b/windows.services.maps.offlinemaps/offlinemappackage_findpackagesasync_1312242741.md new file mode 100644 index 0000000000..ac243b13d9 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_findpackagesasync_1312242741.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.FindPackagesAsync(Windows.Devices.Geolocation.Geopoint) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.FindPackagesAsync + +## -description +Starts an asynchronous operation to find a map package that contains map data for specified geographical location. + +## -params + +## -param queryPoint +The geographical location that you want to locate a map package for. + +## -returns +An [OfflineMapPackageQueryResult](offlinemappackagequeryresult.md) that contains the result of the query. + +## -remarks +This query can find multiple matches. It can also find no matches at all (For example: if you specify a border region or an area in the middle of the ocean). + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_findpackagesinboundingboxasync_121221617.md b/windows.services.maps.offlinemaps/offlinemappackage_findpackagesinboundingboxasync_121221617.md new file mode 100644 index 0000000000..2821338c6c --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_findpackagesinboundingboxasync_121221617.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.FindPackagesInBoundingBoxAsync(Windows.Devices.Geolocation.GeoboundingBox) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.FindPackagesInBoundingBoxAsync + +## -description +Starts an asynchronous operation to find a map package that contains map data for specified rectangular area. +## -params + +## -param queryBoundingBox +A rectangular area that defines the area that you want to locate a map package for. + +## -returns +An [OfflineMapPackageQueryResult](offlinemappackagequeryresult.md) that contains the result of the query. + +## -remarks +This query can find multiple matches. It can also find no matches at all (For example: if you specify a border region or an area in the middle of the ocean). + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_findpackagesingeocircleasync_917543629.md b/windows.services.maps.offlinemaps/offlinemappackage_findpackagesingeocircleasync_917543629.md new file mode 100644 index 0000000000..24b1d6c5fa --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_findpackagesingeocircleasync_917543629.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.FindPackagesInGeocircleAsync(Windows.Devices.Geolocation.Geocircle) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.FindPackagesInGeocircleAsync + +## -description +Starts an asynchronous operation to find a map package that contains map data for specified geographic area. + +## -params + +## -param queryCircle +The geographic area that defines the area that you want to locate a map package for. + +## -returns +An [OfflineMapPackageQueryResult](offlinemappackagequeryresult.md) that contains the result of the query. + +## -remarks +This query can find multiple matches. It can also find no matches at all (For example: if you specify a border region or an area in the middle of the ocean). + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_requeststartdownloadasync_735451469.md b/windows.services.maps.offlinemaps/offlinemappackage_requeststartdownloadasync_735451469.md new file mode 100644 index 0000000000..8d8b775423 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_requeststartdownloadasync_735451469.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.RequestStartDownloadAsync +-api-type: winrt method +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.RequestStartDownloadAsync + +## -description +Starts an asynchronous operation to download a map package to your local system. + +## -params + +## -returns +An [OfflineMapPackageStartDownloadResult](offlinemappackagestartdownloadresult.md) that contains the result of the operation. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_status.md b/windows.services.maps.offlinemaps/offlinemappackage_status.md new file mode 100644 index 0000000000..f8a502f24c --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.Status +-api-type: winrt property +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.Status + +## -description +Gets the status of a map package (For example, whether the package is downloaded to your local system or not). + +## -property-value +The status of a map package. + +## -remarks +You can listen for changes in that status by handling the [StatusChanged](offlinemappackage_statuschanged.md) event. + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackage_statuschanged.md b/windows.services.maps.offlinemaps/offlinemappackage_statuschanged.md new file mode 100644 index 0000000000..c46e5e3688 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackage_statuschanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.Services.Maps.OfflineMaps.OfflineMapPackage.StatusChanged +-api-type: winrt event +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackage.StatusChanged + +## -description +Occurs when the status of an [OfflineMapPackageQueryResult](offlinemappackagequeryresult.md) changes. + +## -remarks +Handle this event if you want to know whether a status of map package that you previously searched for has changed. For example, if the [Status](offlinemappackage_status.md) property of a map package previously returned a value of **Downloading**, this event notifies you when the status changes to **Downloaded**. + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagequeryresult.md b/windows.services.maps.offlinemaps/offlinemappackagequeryresult.md new file mode 100644 index 0000000000..5630193d46 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagequeryresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryResult +-api-type: winrt class +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryResult + +## -description +Represents the result of a query for map packages. + +## -remarks +You can query your system for map data by using the [FindPackagesAsync](offlinemappackage_findpackagesasync_1312242741.md), [FindPackagesInBoundingBoxAsync](offlinemappackage_findpackagesinboundingboxasync_121221617.md), and [FindPackagesInGeocircle](offlinemappackage_findpackagesingeocircleasync_917543629.md) methods. + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagequeryresult_packages.md b/windows.services.maps.offlinemaps/offlinemappackagequeryresult_packages.md new file mode 100644 index 0000000000..e6308fa488 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagequeryresult_packages.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryResult.Packages +-api-type: winrt property +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryResult.Packages + +## -description +Gets the map packages returned by a call to the [FindPackagesAsync](offlinemappackage_findpackagesasync_1312242741.md), [FindPackagesInBoundingBoxAsync](offlinemappackage_findpackagesinboundingboxasync_121221617.md), and [FindPackagesInGeocircle](offlinemappackage_findpackagesingeocircleasync_917543629.md) methods. + +## -property-value +The map packages returned by a call to the [FindPackagesAsync](offlinemappackage_findpackagesasync_1312242741.md), [FindPackagesInBoundingBoxAsync](offlinemappackage_findpackagesinboundingboxasync_121221617.md), and [FindPackagesInGeocircle](offlinemappackage_findpackagesingeocircleasync_917543629.md) methods. + +## -remarks +Before using the [Packages](offlinemappackagequeryresult_packages.md) property, use the [Status](offlinemappackagequeryresult_status.md) to determine if the query is successful. +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagequeryresult_status.md b/windows.services.maps.offlinemaps/offlinemappackagequeryresult_status.md new file mode 100644 index 0000000000..ff4782ff4d --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagequeryresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryResult.Status +-api-type: winrt property +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryResult.Status + +## -description +Gets the success or failure of the query to find map packages. + +## -property-value +The status of the query. + +## -remarks +If the status is *Success*, then use the [Packages](offlinemappackagequeryresult_packages.md) property to obtain the list of map packages that were found as a result of the query. +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagequerystatus.md b/windows.services.maps.offlinemaps/offlinemappackagequerystatus.md new file mode 100644 index 0000000000..79b10cbfcc --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagequerystatus.md @@ -0,0 +1,41 @@ +--- +-api-id: T:Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryStatus +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageQueryStatus + +## -description +Specifies the status of a [OfflineMapPackageQueryResult](offlinemappackagequeryresult.md). + +## -enum-fields + +## -field UnknownError:1 +There is an error. + +## -field Success:0 +The query completed successfully. + +## -field NetworkFailure:3 +There was a network failure that prevented the query from being completed successfully. + +## -field InvalidCredentials:2 +The credentials used to perform this query are invalid. + +## -remarks +You can query your system for map data by using the [FindPackagesAsync](offlinemappackage_findpackagesasync_1312242741.md), [FindPackagesInBoundingBoxAsync](offlinemappackage_findpackagesinboundingboxasync_121221617.md), and [FindPackagesInGeocircle](offlinemappackage_findpackagesingeocircleasync_917543629.md) methods. + +Use the [Status](offlinemappackagequeryresult_status.md) property of the resulting query result to obtain of the enumeration values described in this topic. + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagestartdownloadresult.md b/windows.services.maps.offlinemaps/offlinemappackagestartdownloadresult.md new file mode 100644 index 0000000000..6281aa22ee --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagestartdownloadresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.Services.Maps.OfflineMaps.OfflineMapPackageStartDownloadResult +-api-type: winrt class +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageStartDownloadResult + +## -description +Represents the result of an asynchronous request to queue the download of a map package onto the local system. + +## -remarks +This class doesn't represent the final result of a download. It represents the result of requesting the download to be queued. Downloads are queued even if the network isn't available. Download attempts run in the background. If you want to know when a download completes, and the package is fully available for use, handle the [StatusChanged](offlinemappackage_statuschanged.md) event of the [OfflineMapPackage](offlinemappackage.md). You can use the package offline when the [Status](offlinemappackage_status.md) property of the [OfflineMapPackage](offlinemappackage.md) has a value of **Downloaded**. Packages may take a while to download. You can test download times by using the **Offline Maps** page in system settings to manually download regions. + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagestartdownloadresult_status.md b/windows.services.maps.offlinemaps/offlinemappackagestartdownloadresult_status.md new file mode 100644 index 0000000000..c58e850b7a --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagestartdownloadresult_status.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.OfflineMaps.OfflineMapPackageStartDownloadResult.Status +-api-type: winrt property +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageStartDownloadResult.Status + +## -description +Gets the status of an asynchronous request to download a map package onto the local system. + +## -property-value +The status of an asynchronous request to download a map package onto the local system. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagestartdownloadstatus.md b/windows.services.maps.offlinemaps/offlinemappackagestartdownloadstatus.md new file mode 100644 index 0000000000..ee7bd3bb04 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagestartdownloadstatus.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.Services.Maps.OfflineMaps.OfflineMapPackageStartDownloadStatus +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageStartDownloadStatus + +## -description +Specifies the status of an [OfflineMapPackageStartDownloadResult](offlinemappackagestartdownloadresult.md). + +## -enum-fields + +## -field UnknownError:1 +An error occurred. + +## -field Success:0 +The operation completed successfully. + +## -field InvalidCredentials:2 +The credentials used to complete this operation were invalid. + +## -field DeniedWithoutCapability:3 +The ```` has not been added to the package manifest. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/offlinemappackagestatus.md b/windows.services.maps.offlinemaps/offlinemappackagestatus.md new file mode 100644 index 0000000000..c26b81ae82 --- /dev/null +++ b/windows.services.maps.offlinemaps/offlinemappackagestatus.md @@ -0,0 +1,38 @@ +--- +-api-id: T:Windows.Services.Maps.OfflineMaps.OfflineMapPackageStatus +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.OfflineMaps.OfflineMapPackageStatus + +## -description +Specifies the status of a [OfflineMapPackage](offlinemappackage.md). +## -enum-fields + +## -field NotDownloaded:0 +The map package is not downloaded to the local system. + +## -field Downloading:1 +The map packaging is currently downloading to the local system. + +## -field Downloaded:2 +The map package is downloaded to the local system. + +## -field Deleting:3 +The map package is being deleted from the local system. + +## -remarks +You can download map packages for offline use by using the [RequestStartDownloadAsync](offlinemappackage_requeststartdownloadasync_735451469.md) method. + +## -see-also + +## -examples diff --git a/windows.services.maps.offlinemaps/windows_services_maps_offlinemaps.md b/windows.services.maps.offlinemaps/windows_services_maps_offlinemaps.md new file mode 100644 index 0000000000..ba0b19435b --- /dev/null +++ b/windows.services.maps.offlinemaps/windows_services_maps_offlinemaps.md @@ -0,0 +1,19 @@ +--- +-api-id: N:Windows.Services.Maps.OfflineMaps +-api-type: winrt namespace +--- + + + +# Windows.Services.Maps.OfflineMaps + +## -description +Contains classes that you can use to find and download map packages for offline use. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/enhancedwaypoint.md b/windows.services.maps/enhancedwaypoint.md new file mode 100644 index 0000000000..7f041cd034 --- /dev/null +++ b/windows.services.maps/enhancedwaypoint.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.Maps.EnhancedWaypoint +-api-type: winrt class +--- + + + +# Windows.Services.Maps.EnhancedWaypoint + +## -description +Represents a stop, start, or intermediate waypoint that a route must pass through. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/enhancedwaypoint_enhancedwaypoint_1796435826.md b/windows.services.maps/enhancedwaypoint_enhancedwaypoint_1796435826.md new file mode 100644 index 0000000000..406354a296 --- /dev/null +++ b/windows.services.maps/enhancedwaypoint_enhancedwaypoint_1796435826.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.Services.Maps.EnhancedWaypoint.#ctor(Windows.Devices.Geolocation.Geopoint,Windows.Services.Maps.WaypointKind) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.EnhancedWaypoint.EnhancedWaypoint + +## -description +Creates an instance of the [EnhancedWayPoint](enhancedwaypoint.md) class. +## -params + +## -param point +The coordinates of a geographic location. +## -param kind +The type of waypoint. +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/enhancedwaypoint_kind.md b/windows.services.maps/enhancedwaypoint_kind.md new file mode 100644 index 0000000000..8114d380cf --- /dev/null +++ b/windows.services.maps/enhancedwaypoint_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.Services.Maps.EnhancedWaypoint.Kind +-api-type: winrt property +--- + + + +# Windows.Services.Maps.EnhancedWaypoint.Kind + +## -description +Gets the type of waypoint. +## -property-value +The type of waypoint. +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/enhancedwaypoint_point.md b/windows.services.maps/enhancedwaypoint_point.md new file mode 100644 index 0000000000..3a7d795853 --- /dev/null +++ b/windows.services.maps/enhancedwaypoint_point.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.EnhancedWaypoint.Point +-api-type: winrt property +--- + + + +# Windows.Services.Maps.EnhancedWaypoint.Point + +## -description +Gets the coordinates of a geographic location. + +## -property-value +The coordinates of a geographic location. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maneuverwarning.md b/windows.services.maps/maneuverwarning.md new file mode 100644 index 0000000000..363d502ab3 --- /dev/null +++ b/windows.services.maps/maneuverwarning.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.Maps.ManeuverWarning +-api-type: winrt class +--- + + + +# Windows.Services.Maps.ManeuverWarning + +## -description +Represents a potential issue along a route leg. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maneuverwarning_kind.md b/windows.services.maps/maneuverwarning_kind.md new file mode 100644 index 0000000000..a4d609d9fa --- /dev/null +++ b/windows.services.maps/maneuverwarning_kind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.ManeuverWarning.Kind +-api-type: winrt property +--- + + + +# Windows.Services.Maps.ManeuverWarning.Kind + +## -description +Gets the type of potential issue along a route leg. + +## -property-value +The type of potential issue along a route leg. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maneuverwarning_severity.md b/windows.services.maps/maneuverwarning_severity.md new file mode 100644 index 0000000000..afff1e8cf1 --- /dev/null +++ b/windows.services.maps/maneuverwarning_severity.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.ManeuverWarning.Severity +-api-type: winrt property +--- + + + +# Windows.Services.Maps.ManeuverWarning.Severity + +## -description +Gets the severity of a potential issue along a route leg. + +## -property-value +The severity of a potential issue along a route leg. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maneuverwarningkind.md b/windows.services.maps/maneuverwarningkind.md new file mode 100644 index 0000000000..07261439f3 --- /dev/null +++ b/windows.services.maps/maneuverwarningkind.md @@ -0,0 +1,162 @@ +--- +-api-id: T:Windows.Services.Maps.ManeuverWarningKind +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.ManeuverWarningKind + +## -description +Specifies the type of potential issue along a route leg. +## -enum-fields + +## -field Weather:35 +There is significant weather at this location. + +## -field UnscheduledConstruction:34 +There is construction along the route that does not have any specific start and end dates. + +## -field UnpavedRoad:33 +The road is unpaved. + +## -field TransitLineChange:32 +There is a transit line change but a change of vehicle is not required. + +## -field TrafficFlow:31 +The warning is about traffic flow. + +## -field TollZoneExit:30 +The exit of a toll zone. + +## -field TollZoneEnter:29 +The entrance to a toll zone. + +## -field TollRoad:28 +The road is a toll road. + +## -field Tollbooth:27 +A toll is required at this location to continue along the route. + +## -field SeasonalClosures:26 +A seasonal closure occurs at this location. + +## -field ScheduledConstruction:25 +There is construction along the route that has specific start and end dates. + +## -field RoadHazard:24 +There is a road hazard. + +## -field RoadClosures:23 +There are road closures at this location. + +## -field RestrictedTurn:22 +The turn may be restricted. + +## -field PrivateRoad:21 +The road being travelled on is private. + +## -field PlannedEvent:20 +There are scheduled events in the area. + +## -field OtherTrafficIncidents:19 +There are other traffic incidents at this location. + +## -field OtherNews:18 +There is additional traffic incident information. + +## -field Other:17 +There is a warning at this location that cannot be classified as any other type of warning. +## -field None:0 +There is no warning at this location. +## -field NoIncident:16 +There is no incident at this location. + +## -field Miscellaneous:15 +A miscellaneous warning is available for this location. + +## -field MassTransit:14 +There is mass transit incident. + +## -field IllegalUTurn:13 +A U-turn is illegal at this location. + +## -field GetOnTransit:12 +Get on the transit at this location. + +## -field GetOffTransit:11 +Get off the transit at this location. +## -field GateAccess:10 +A gate blocks the road and access is required to continue along the route. + +## -field DisabledVehicle:9 +There is a disabled vehicle. + +## -field CountryChange:8 +The route has left one country and entered another. + +## -field Construction:7 +There is construction along the route. This value is used for any type of construction and not just construction that has specific start and end dates. + +## -field Congestion:6 +The traffic is slow. + +## -field CheckTimetable:5 +Check a time table. This usually refers to a ferry or auto rail time table. + +## -field BlockedRoad:4 +The road is closed or blocked. + +## -field Alert:3 +There is an alert. + +## -field AdministrativeDivisionChange:2 +The route has left one administrative division and entered another. + +## -field Accident:1 +There is a traffic accident. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maneuverwarningseverity.md b/windows.services.maps/maneuverwarningseverity.md new file mode 100644 index 0000000000..6b63e0f3be --- /dev/null +++ b/windows.services.maps/maneuverwarningseverity.md @@ -0,0 +1,42 @@ +--- +-api-id: T:Windows.Services.Maps.ManeuverWarningSeverity +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.ManeuverWarningSeverity + +## -description +Specifies the severity of a potential issue along a route leg. + +## -enum-fields + +## -field Serious:4 +The issue has a high level of impact. + +## -field None:0 +The issue has no impact. + +## -field Moderate:3 +The issue has a moderate level of impact. + +## -field Minor:2 +The issue has a minor level impact. + +## -field LowImpact:1 +The issue has a low impact. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maproute_durationwithouttraffic.md b/windows.services.maps/maproute_durationwithouttraffic.md new file mode 100644 index 0000000000..af190320c5 --- /dev/null +++ b/windows.services.maps/maproute_durationwithouttraffic.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.MapRoute.DurationWithoutTraffic +-api-type: winrt property +--- + + + +# Windows.Services.Maps.MapRoute.DurationWithoutTraffic + +## -description +Gets the estimated time required to traverse the route without traffic. + +## -property-value +The estimated time required to traverse the route without traffic. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maproute_trafficcongestion.md b/windows.services.maps/maproute_trafficcongestion.md new file mode 100644 index 0000000000..91c4dbc174 --- /dev/null +++ b/windows.services.maps/maproute_trafficcongestion.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.MapRoute.TrafficCongestion +-api-type: winrt property +--- + + + +# Windows.Services.Maps.MapRoute.TrafficCongestion + +## -description +Gets the level of traffic congestion along a map route. + +## -property-value +The level of traffic congestion along a map route. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maproutefinder_getdrivingroutefromenhancedwaypointsasync_1351452315.md b/windows.services.maps/maproutefinder_getdrivingroutefromenhancedwaypointsasync_1351452315.md new file mode 100644 index 0000000000..f1e8dc6e01 --- /dev/null +++ b/windows.services.maps/maproutefinder_getdrivingroutefromenhancedwaypointsasync_1351452315.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.Services.Maps.MapRouteFinder.GetDrivingRouteFromEnhancedWaypointsAsync(Windows.Foundation.Collections.IIterable{Windows.Services.Maps.EnhancedWaypoint}) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.MapRouteFinder.GetDrivingRouteFromEnhancedWaypointsAsync + +## -description +Gets a driving route for the specified waypoints (using optimizations). + +## -params + +## -param waypoints +A collection of stop, start, or intermediate waypoint that a route must pass through. + +## -returns +When this method completes successfully, it returns a driving route contained in the [MapRouteFinderResult](maproutefinderresult.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maproutefinder_getdrivingroutefromenhancedwaypointsasync_1781831139.md b/windows.services.maps/maproutefinder_getdrivingroutefromenhancedwaypointsasync_1781831139.md new file mode 100644 index 0000000000..f60bc5dade --- /dev/null +++ b/windows.services.maps/maproutefinder_getdrivingroutefromenhancedwaypointsasync_1781831139.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.Services.Maps.MapRouteFinder.GetDrivingRouteFromEnhancedWaypointsAsync(Windows.Foundation.Collections.IIterable{Windows.Services.Maps.EnhancedWaypoint},Windows.Services.Maps.MapRouteDrivingOptions) +-api-type: winrt method +--- + + + +# Windows.Services.Maps.MapRouteFinder.GetDrivingRouteFromEnhancedWaypointsAsync + +## -description +Gets a driving route for the specified waypoints (using optimizations). + +## -params + +## -param waypoints +A collection of stop, start, or intermediate waypoint that a route must pass through. + +## -param options +The advanced routing options to be applied to this route. + +## -returns +When this method completes successfully, it returns a driving route contained in the [MapRouteFinderResult](maproutefinderresult.md). + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maprouteleg_durationwithouttraffic.md b/windows.services.maps/maprouteleg_durationwithouttraffic.md new file mode 100644 index 0000000000..7c9a47110c --- /dev/null +++ b/windows.services.maps/maprouteleg_durationwithouttraffic.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.MapRouteLeg.DurationWithoutTraffic +-api-type: winrt property +--- + + + +# Windows.Services.Maps.MapRouteLeg.DurationWithoutTraffic + +## -description +Gets the estimated time required to traverse the route without traffic. + +## -property-value +The estimated time required to traverse the route without traffic. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maprouteleg_trafficcongestion.md b/windows.services.maps/maprouteleg_trafficcongestion.md new file mode 100644 index 0000000000..ef0f5faa47 --- /dev/null +++ b/windows.services.maps/maprouteleg_trafficcongestion.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.MapRouteLeg.TrafficCongestion +-api-type: winrt property +--- + + + +# Windows.Services.Maps.MapRouteLeg.TrafficCongestion + +## -description +Gets the level of traffic congestion along a map route leg. + +## -property-value +The level of traffic congestion along a map route leg. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/maproutemaneuver_warnings.md b/windows.services.maps/maproutemaneuver_warnings.md new file mode 100644 index 0000000000..9d9b2efcfb --- /dev/null +++ b/windows.services.maps/maproutemaneuver_warnings.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.MapRouteManeuver.Warnings +-api-type: winrt property +--- + + + +# Windows.Services.Maps.MapRouteManeuver.Warnings + +## -description +Gets a list of potential issues along a route leg. + +## -property-value +A list of potential issues along a route leg. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/mapservice_datausagepreference.md b/windows.services.maps/mapservice_datausagepreference.md new file mode 100644 index 0000000000..3e444be596 --- /dev/null +++ b/windows.services.maps/mapservice_datausagepreference.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.Services.Maps.MapService.DataUsagePreference +-api-type: winrt property +--- + + + +# Windows.Services.Maps.MapService.DataUsagePreference + +## -description +Gets or sets an object that specifies whether to use offline or online map data. + +## -property-value +An object that specifies whether to use offline or online map data. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/mapservicedatausagepreference.md b/windows.services.maps/mapservicedatausagepreference.md new file mode 100644 index 0000000000..cd755f01e1 --- /dev/null +++ b/windows.services.maps/mapservicedatausagepreference.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Services.Maps.MapServiceDataUsagePreference +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.MapServiceDataUsagePreference + +## -description +Specifies whether to use online or offline map data. + +## -enum-fields + +## -field OfflineMapDataOnly:1 +Use offline map data. + +## -field Default:0 +Use online map data. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/trafficcongestion.md b/windows.services.maps/trafficcongestion.md new file mode 100644 index 0000000000..da77b8045c --- /dev/null +++ b/windows.services.maps/trafficcongestion.md @@ -0,0 +1,41 @@ +--- +-api-id: T:Windows.Services.Maps.TrafficCongestion +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.TrafficCongestion + +## -description +Specifies the level of traffic congestion along a map route or route leg. +## -enum-fields + +## -field Unknown:0 +The level of traffic congestion is unknown. + +## -field Mild:2 +The level of traffic congestion is mild. + +## -field Medium:3 +The level of traffic congestion is medium. + +## -field Light:1 +The level of traffic congestion is light. + +## -field Heavy:4 +The level of traffic congestion is heavy. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.maps/waypointkind.md b/windows.services.maps/waypointkind.md new file mode 100644 index 0000000000..cf5f136797 --- /dev/null +++ b/windows.services.maps/waypointkind.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.Services.Maps.WaypointKind +-api-type: winrt enumeration +--- + + + +# Windows.Services.Maps.WaypointKind + +## -description +Specifies the type of waypoint. + +## -enum-fields + +## -field Via:1 +An intermediate waypoint that a route must pass through. + +## -field Stop:0 +A start or stop waypoint of a route or route leg. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.services.store/storecontext.md b/windows.services.store/storecontext.md index 3f19af7b80..b91070c9e3 100644 --- a/windows.services.store/storecontext.md +++ b/windows.services.store/storecontext.md @@ -27,7 +27,7 @@ To get a [StoreContext](storecontext.md) object, use one of these static methods Windows.Services.Store.StoreContext context = StoreContext.GetDefault(); ``` -+ [GetForUser](storecontext_getforuser.md). Use this method in multi-user apps. This method gets a [StoreContext](storecontext.md) object that you can use to access and manage Windows Store-related data for a specific user. For more information about multi-user apps, see [Introduction to multi-user applications](https://msdn.microsoft.com/windows/uwp/xbox-apps/multi-user-applications). ++ [GetForUser](storecontext_getforuser.md): Use this method in multi-user apps. This method gets a [StoreContext](storecontext.md) object that you can use to access and manage Windows Store-related data for a specific user. For more information about multi-user apps, see [Introduction to multi-user applications](https://msdn.microsoft.com/windows/uwp/xbox-apps/multi-user-applications). ```csharp var users = await Windows.System.User.FindAllAsync(); diff --git a/windows.services.store/storecontext_findstoreproductforpackageasync_196862284.md b/windows.services.store/storecontext_findstoreproductforpackageasync_196862284.md new file mode 100644 index 0000000000..3fb0f25678 --- /dev/null +++ b/windows.services.store/storecontext_findstoreproductforpackageasync_196862284.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.Services.Store.StoreContext.FindStoreProductForPackageAsync(Windows.Foundation.Collections.IIterable{System.String},Windows.ApplicationModel.Package) +-api-type: winrt method +--- + + + +# Windows.Services.Store.StoreContext.FindStoreProductForPackageAsync + +## -description +Gets Store product details for the app or add-on that is associated with the specified package. + +## -params + +## -param productKinds +An array of strings that specify the types of Store products that might be associated with the package. For a list of the supported string values, see the [ProductKind](storeproduct_productkind.md) property. + +## -param package +A [Package](../windows.applicationmodel/package.md) that represents the package for which you want to get the corresponding Store product details. + +## -returns +An asynchronous operation that, on successful completion, returns a [StoreProductResult](storeproductresult.md) object. Use the [Product](storeproductresult_product.md) property of this object to access a [StoreProduct](storeproduct.md) that contains Store product details for the specified package. + +## -remarks +Use this method to get Store product details (such as the Store ID) for a package that is associated with the current app or an add-on for the current app. This method may return errors if the package is not associated with the current app, the current device is offline, or if the current app was not installed from the Store (for example, if the app was sideloaded). In these cases, you can examine the [ExtendedError](storeproductresult_extendederror.md) property of the [StoreProductResult](storeproductresult.md) return object to get more details about the error. + +## -examples + +## -see-also +[StoreContext](storecontext.md), [StoreProduct](storeproduct.md), [Get product info for apps and add-ons](https://msdn.microsoft.com/windows/uwp/monetize/get-product-info-for-apps-and-add-ons) \ No newline at end of file diff --git a/windows.services.store/storesendrequestresult_httpstatuscode.md b/windows.services.store/storesendrequestresult_httpstatuscode.md new file mode 100644 index 0000000000..4edba358b6 --- /dev/null +++ b/windows.services.store/storesendrequestresult_httpstatuscode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.Services.Store.StoreSendRequestResult.HttpStatusCode +-api-type: winrt property +--- + + + +# Windows.Services.Store.StoreSendRequestResult.HttpStatusCode + +## -description +Gets the HTTP status code for the request. + +## -property-value +The HTTP status code for the request. + +## -remarks + +## -examples + +## -see-also +[SendRequestAsync](storerequesthelper_sendrequestasync.md), [StoreSendRequestResult](storesendrequestresult.md) \ No newline at end of file diff --git a/windows.services.store/storesku_customdeveloperdata.md b/windows.services.store/storesku_customdeveloperdata.md index 5663bf22f9..f9ff6a7e0b 100644 --- a/windows.services.store/storesku_customdeveloperdata.md +++ b/windows.services.store/storesku_customdeveloperdata.md @@ -1,24 +1,23 @@ ---- --api-id: P:Windows.Services.Store.StoreSku.CustomDeveloperData --api-type: winrt property ---- - - - -# Windows.Services.Store.StoreSku.CustomDeveloperData - -## -description -Gets the custom developer data string (also called a tag) that contains custom information about the add-on (also called an in-app product or IAP) that this product SKU represents. This string corresponds to the value of the **Custom developer data field** in the properties page for the add-on in the Windows Dev Center dashboard. - -## -property-value -The custom developer data for the add-on. - -## -remarks -The custom developer data provides a way for developers to associate custom contextual information with an add-on. For more information about setting this value for an add-on, see [Enter add-on properties](https://msdn.microsoft.com/windows/uwp/publish/enter-add-on-properties#custom-developer-data). - -## -examples - -## -see-also - +--- +-api-id: P:Windows.Services.Store.StoreSku.CustomDeveloperData +-api-type: winrt property +--- + + + +# Windows.Services.Store.StoreSku.CustomDeveloperData + +## -description +Gets the custom developer data string (also called a tag) that contains custom information about the add-on (also called an in-app product or IAP) that this product SKU represents. This string corresponds to the value of the **Custom developer data field** in the properties page for the add-on in the Windows Dev Center dashboard. + +## -property-value +The custom developer data for the add-on. + +## -remarks +The custom developer data provides a way for developers to associate custom contextual information with an add-on. For more information about setting this value for an add-on, see [Enter add-on properties](https://msdn.microsoft.com/windows/uwp/publish/enter-add-on-properties#custom-developer-data). + +## -examples + +## -see-also diff --git a/windows.services.store/windows_services_store.md b/windows.services.store/windows_services_store.md index 6a1bd24448..994ee45719 100644 --- a/windows.services.store/windows_services_store.md +++ b/windows.services.store/windows_services_store.md @@ -12,32 +12,9 @@ Provides types and members you can use to access and manage Windows Store-relate > The [Windows.Services.Store](windows_services_store.md) namespace was introduced in Windows 10, version 1607, and the members of this namespace can only be used in apps that target this release or a later release. If your app targets an earlier version of Windows 10, you must use the [Windows.ApplicationModel.Store](../windows.applicationmodel.store/windows_applicationmodel_store.md) namespace instead of the [Windows.Services.Store](windows_services_store.md) namespace. For more information, see [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials). ## -remarks -The [StoreContext](storecontext.md) class is the primary class in the [Windows.Services.Store](windows_services_store.md) namespace. This class provides members that you use to access and manage Windows Store-related data for the current app. Other classes and types in this namespace represent Windows Store-related data objects such as products that are offered for sale by the app, licenses for the app and its products, and Windows Store listing info for the app. - -To get a [StoreContext](storecontext.md) object, use one of these static methods of the [StoreContext](storecontext.md) class: -+ [GetDefault](storecontext_getdefault.md): Use this method in single-user apps (that is, apps that run only in the context of the user that launched the app). This method gets a [StoreContext](storecontext.md) object that you can use to access and manage Windows Store-related data for the user. Most Universal Windows Platform (UWP) apps are single-user apps.```csharp - Windows.Services.Store.StoreContext context = StoreContext.GetDefault(); -``` - - -+ [GetForUser](storecontext_getforuser.md). Use this method in multi-user apps. This method gets a [StoreContext](storecontext.md) object that you can use to access and manage Windows Store-related data for a specific user. For more information about multi-user apps, see [Introduction to multi-user applications](https://msdn.microsoft.com/windows/uwp/xbox-apps/multi-user-applications).```csharp -var users = await Windows.System.User.FindAllAsync(); - Windows.Services.Store.StoreContext context = StoreContext.GetForUser(users[0]); -``` - - - - -After you have a [StoreContext](storecontext.md), you can start calling methods to purchase an app or add-on for the current user and other tasks. For more information, see the following articles: -+ [In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials) -+ [Get product info for apps and add-ons](https://msdn.microsoft.com/windows/uwp/monetize/get-product-info-for-apps-and-add-ons) -+ [Get license info for apps and add-ons](https://msdn.microsoft.com/windows/uwp/monetize/get-license-info-for-apps-and-add-ons) -+ [Enable in-app purchases of apps and add-ons](https://msdn.microsoft.com/windows/uwp/monetize/enable-in-app-purchases-of-apps-and-add-ons) -+ [Enable consumable add-on purchases](https://msdn.microsoft.com/windows/uwp/monetize/enable-consumable-add-on-purchases) -+ [Implement a trial version of your app](https://msdn.microsoft.com/windows/uwp/monetize/implement-a-trial-version-of-your-app) - +The [StoreContext](storecontext.md) class is the main entry point to the [Windows.Services.Store](windows_services_store.md) namespace. Use members of this class to perform tasks such as getting Windows Store listing and license info for the current app, purchasing the current app or add-ons that are offered by the app, or downloading and installing package updates for the app. Other classes and types in this namespace represent items such as add-ons for the app, licenses for the app and its add-ons, and Windows Store listing info for the app. ## -examples ## -see-also -[Store sample](https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/Store) \ No newline at end of file +[In-app purchases and trials](https://msdn.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials), [Download and install package updates for your app](https://msdn.microsoft.com/windows/uwp/packaging/self-install-package-updates), [Store sample](https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/Store) diff --git a/windows.services.targetedcontent/targetedcontentaction.md b/windows.services.targetedcontent/targetedcontentaction.md new file mode 100644 index 0000000000..4d396b4102 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentaction.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentAction +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentAction + +## -description +Represents the TargetedContentValue of the TargetedContentValueKind action. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentaction_invokeasync_828119061.md b/windows.services.targetedcontent/targetedcontentaction_invokeasync_828119061.md new file mode 100644 index 0000000000..7c8c8833ad --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentaction_invokeasync_828119061.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentAction.InvokeAsync +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentAction.InvokeAsync + +## -description +Invokes the action. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentappinstallationstate.md b/windows.services.targetedcontent/targetedcontentappinstallationstate.md new file mode 100644 index 0000000000..bba7fb8738 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentappinstallationstate.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentAppInstallationState +-api-type: winrt enum +--- + + + +# Windows.Services.TargetedContent.TargetedContentAppInstallationState + +## -description +Enum that defines all vaules for that TargetedContentAppInstallState can hold: NotApplicable, NotInstalled or Installed. +## -enum-fields +### -field NotInstalled:1 + +### -field NotApplicable:0 + +### -field Installed:2 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentavailability.md b/windows.services.targetedcontent/targetedcontentavailability.md new file mode 100644 index 0000000000..fdd22d4817 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentavailability.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentAvailability +-api-type: winrt enum +--- + + + +# Windows.Services.TargetedContent.TargetedContentAvailability + +## -description +Enum that defines all values TargetedContentAvailability can hold: All, Partial or None. +## -enum-fields +### -field Partial:1 + +### -field None:0 + +### -field All:2 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentavailabilitychangedeventargs.md b/windows.services.targetedcontent/targetedcontentavailabilitychangedeventargs.md new file mode 100644 index 0000000000..3d97cdf41a --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentavailabilitychangedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentAvailabilityChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentAvailabilityChangedEventArgs + +## -description +Represents the arguments for the Availability Changed event. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentavailabilitychangedeventargs_getdeferral_254836512.md b/windows.services.targetedcontent/targetedcontentavailabilitychangedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..bd68da3100 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentavailabilitychangedeventargs_getdeferral_254836512.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentAvailabilityChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentAvailabilityChangedEventArgs.GetDeferral + +## -description +Represents the arguments for the Availability Changed event. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentchangedeventargs.md b/windows.services.targetedcontent/targetedcontentchangedeventargs.md new file mode 100644 index 0000000000..26c1560b91 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentchangedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentChangedEventArgs + +## -description +Represents the arguments for the Content Changed event. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentchangedeventargs_getdeferral_254836512.md b/windows.services.targetedcontent/targetedcontentchangedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..d6fd64390d --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentchangedeventargs_getdeferral_254836512.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentChangedEventArgs.GetDeferral + +## -description +Gets the deferral. Required for async handlers. The caller is responsible for calling Complete when the event is handled. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentchangedeventargs_haspreviouscontentexpired.md b/windows.services.targetedcontent/targetedcontentchangedeventargs_haspreviouscontentexpired.md new file mode 100644 index 0000000000..fbf97cdaf6 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentchangedeventargs_haspreviouscontentexpired.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentChangedEventArgs.HasPreviousContentExpired +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentChangedEventArgs.HasPreviousContentExpired + +## -description +Gets a boolean value indicating if the previous content for TargetedContentChangedEventArgs has expired. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection.md b/windows.services.targetedcontent/targetedcontentcollection.md new file mode 100644 index 0000000000..e2b0734287 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentCollection +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection + +## -description +Represents a collection of items or subcollections in a TargetedContentContainer object. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection_collections.md b/windows.services.targetedcontent/targetedcontentcollection_collections.md new file mode 100644 index 0000000000..6dc61429cc --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection_collections.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentCollection.Collections +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection.Collections + +## -description +Gets the TargetedContentCollection object in a TargetedContentContainer object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection_id.md b/windows.services.targetedcontent/targetedcontentcollection_id.md new file mode 100644 index 0000000000..b68dda3225 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection_id.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentCollection.Id +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection.Id + +## -description +Gets the ID of the Collection. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection_items.md b/windows.services.targetedcontent/targetedcontentcollection_items.md new file mode 100644 index 0000000000..9142f13d70 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection_items.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentCollection.Items +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection.Items + +## -description +Gets a collection of TargetedContentItems in a TargetedContentCollection object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection_path.md b/windows.services.targetedcontent/targetedcontentcollection_path.md new file mode 100644 index 0000000000..704b50f014 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection_path.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentCollection.Path +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection.Path + +## -description +Gets the path of TargetedContentCollection object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection_properties.md b/windows.services.targetedcontent/targetedcontentcollection_properties.md new file mode 100644 index 0000000000..9d08bb7de6 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection_properties.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentCollection.Properties +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection.Properties + +## -description +Gets a collection containing property name as keys and TargetedContentValues as values in TargetedContentCollection object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection_reportcustominteraction_1298848762.md b/windows.services.targetedcontent/targetedcontentcollection_reportcustominteraction_1298848762.md new file mode 100644 index 0000000000..d45f4b78a5 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection_reportcustominteraction_1298848762.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentCollection.ReportCustomInteraction(System.String) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection.ReportCustomInteraction + +## -description +Reports custom interaction for a TargetedContentCollection object. +## -parameters + +### -param customInteractionName + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcollection_reportinteraction_1054998729.md b/windows.services.targetedcontent/targetedcontentcollection_reportinteraction_1054998729.md new file mode 100644 index 0000000000..cbf55d7672 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcollection_reportinteraction_1054998729.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentCollection.ReportInteraction(Windows.Services.TargetedContent.TargetedContentInteraction) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentCollection.ReportInteraction + +## -description +Reports interaction for a TargetedContentCollection object. +## -parameters + +### -param interaction + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcontainer.md b/windows.services.targetedcontent/targetedcontentcontainer.md new file mode 100644 index 0000000000..139005670f --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcontainer.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentContainer +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentContainer + +## -description +Represents a container for all the content in a TargetedContentSubscription object. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcontainer_availability.md b/windows.services.targetedcontent/targetedcontentcontainer_availability.md new file mode 100644 index 0000000000..20aa1d683b --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcontainer_availability.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentContainer.Availability +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentContainer.Availability + +## -description +Gets TargetedContentAvailability for a TargetedContentContainer object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcontainer_content.md b/windows.services.targetedcontent/targetedcontentcontainer_content.md new file mode 100644 index 0000000000..4a844e0033 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcontainer_content.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentContainer.Content +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentContainer.Content + +## -description +Gets TargetedContentCollection object for a TargetedContentContainer object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcontainer_getasync_1291799672.md b/windows.services.targetedcontent/targetedcontentcontainer_getasync_1291799672.md new file mode 100644 index 0000000000..b3232b1467 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcontainer_getasync_1291799672.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentContainer.GetAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentContainer.GetAsync + +## -description +Returns a TargetedContainerContainer object for specified ContentId. +## -parameters + +### -param contentId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcontainer_id.md b/windows.services.targetedcontent/targetedcontentcontainer_id.md new file mode 100644 index 0000000000..04cda2e98e --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcontainer_id.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentContainer.Id +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentContainer.Id + +## -description +Gets the ID for the TargetedContainerContainer object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcontainer_selectsingleobject_1732333786.md b/windows.services.targetedcontent/targetedcontentcontainer_selectsingleobject_1732333786.md new file mode 100644 index 0000000000..f52da5844b --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcontainer_selectsingleobject_1732333786.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentContainer.SelectSingleObject(System.String) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentContainer.SelectSingleObject + +## -description +Gets the TargetedContentObject object in the TargetedContentContainer object. +## -parameters + +### -param path + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentcontainer_timestamp.md b/windows.services.targetedcontent/targetedcontentcontainer_timestamp.md new file mode 100644 index 0000000000..701c387476 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentcontainer_timestamp.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentContainer.Timestamp +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentContainer.Timestamp + +## -description +The time the content was last updated. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentfile.md b/windows.services.targetedcontent/targetedcontentfile.md new file mode 100644 index 0000000000..3a93241f73 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentfile.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentFile +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentFile + +## -description +Represents the TargetedContentValue of the TargetedContentValueKind File. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentfile_openreadasync_489951197.md b/windows.services.targetedcontent/targetedcontentfile_openreadasync_489951197.md new file mode 100644 index 0000000000..ffa8e0a7b4 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentfile_openreadasync_489951197.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentFile.OpenReadAsync +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentFile.OpenReadAsync + +## -description +Opens a stream for read-only, random access. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentimage.md b/windows.services.targetedcontent/targetedcontentimage.md new file mode 100644 index 0000000000..290c195677 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentimage.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentImage +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentImage + +## -description +Represents the TargetedContentValue of the TargetedContentValueKind Image. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentimage_height.md b/windows.services.targetedcontent/targetedcontentimage_height.md new file mode 100644 index 0000000000..7b2ef6cd8b --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentimage_height.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentImage.Height +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentImage.Height + +## -description +Gets a value indicating the height of the TargetedContentImage object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentimage_openreadasync_489951197.md b/windows.services.targetedcontent/targetedcontentimage_openreadasync_489951197.md new file mode 100644 index 0000000000..a242919c70 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentimage_openreadasync_489951197.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentImage.OpenReadAsync +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentImage.OpenReadAsync + +## -description +Opens a stream for read-only, random access. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentimage_width.md b/windows.services.targetedcontent/targetedcontentimage_width.md new file mode 100644 index 0000000000..b77014b8a1 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentimage_width.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentImage.Width +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentImage.Width + +## -description +Gets a value indicating the width of the TargetedContentImage object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentinteraction.md b/windows.services.targetedcontent/targetedcontentinteraction.md new file mode 100644 index 0000000000..fb740d5fae --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentinteraction.md @@ -0,0 +1,46 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentInteraction +-api-type: winrt enum +--- + + + +# Windows.Services.TargetedContent.TargetedContentInteraction + +## -description +Enum that defines all the values that TargetedContentInteraction can hold. +## -enum-fields +### -field Opportunity:12 + +### -field Like:3 + +### -field Dislike:4 + +### -field Conversion:11 + +### -field Canceled:10 + +### -field ClickThrough:1 + +### -field Ineligible:6 + +### -field Impression:0 + +### -field Hover:2 + +### -field Dismiss:5 + +### -field Defer:9 + +### -field Decline:8 + +### -field Accept:7 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitem.md b/windows.services.targetedcontent/targetedcontentitem.md new file mode 100644 index 0000000000..69235e4427 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitem.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentItem +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentItem + +## -description +Represents an item with the TargetedContentCollection. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitem_collections.md b/windows.services.targetedcontent/targetedcontentitem_collections.md new file mode 100644 index 0000000000..28b2a689f1 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitem_collections.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentItem.Collections +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentItem.Collections + +## -description +Gets a TargetedContentCollection object in the TargetedContentItem object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitem_path.md b/windows.services.targetedcontent/targetedcontentitem_path.md new file mode 100644 index 0000000000..b21d7eefb8 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitem_path.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentItem.Path +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentItem.Path + +## -description +Gets the string path of the TargetedContentItem object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitem_properties.md b/windows.services.targetedcontent/targetedcontentitem_properties.md new file mode 100644 index 0000000000..499b8329a1 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitem_properties.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentItem.Properties +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentItem.Properties + +## -description +Gets a collection containing property name as keys and TargetedContentValues in the TargetedContentItem object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitem_reportcustominteraction_1298848762.md b/windows.services.targetedcontent/targetedcontentitem_reportcustominteraction_1298848762.md new file mode 100644 index 0000000000..27627c14e7 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitem_reportcustominteraction_1298848762.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentItem.ReportCustomInteraction(System.String) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentItem.ReportCustomInteraction + +## -description +Reports Custom Interaction for the item. +## -parameters + +### -param customInteractionName + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitem_reportinteraction_1054998729.md b/windows.services.targetedcontent/targetedcontentitem_reportinteraction_1054998729.md new file mode 100644 index 0000000000..2e562fa450 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitem_reportinteraction_1054998729.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentItem.ReportInteraction(Windows.Services.TargetedContent.TargetedContentInteraction) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentItem.ReportInteraction + +## -description +Reports TargetedContentInteraction for the item. +## -parameters + +### -param interaction + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitem_state.md b/windows.services.targetedcontent/targetedcontentitem_state.md new file mode 100644 index 0000000000..d3a3bcf489 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitem_state.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentItem.State +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentItem.State + +## -description +Gets the TargetedContentItemState for the item. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitemstate.md b/windows.services.targetedcontent/targetedcontentitemstate.md new file mode 100644 index 0000000000..ecce92ca80 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitemstate.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentItemState +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentItemState + +## -description +Represents a state of a TargetedContentItem object: AppInstallationState, ShouldDisplay. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitemstate_appinstallationstate.md b/windows.services.targetedcontent/targetedcontentitemstate_appinstallationstate.md new file mode 100644 index 0000000000..8807cc6cec --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitemstate_appinstallationstate.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentItemState.AppInstallationState +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentItemState.AppInstallationState + +## -description +Gets TargetedContentAppInstallationState for the item. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentitemstate_shoulddisplay.md b/windows.services.targetedcontent/targetedcontentitemstate_shoulddisplay.md new file mode 100644 index 0000000000..a8ac43b4e3 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentitemstate_shoulddisplay.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentItemState.ShouldDisplay +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentItemState.ShouldDisplay + +## -description +Gets the boolean for the ShouldDisplay state for the item. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentobject.md b/windows.services.targetedcontent/targetedcontentobject.md new file mode 100644 index 0000000000..3211b18cc6 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentobject.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentObject +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentObject + +## -description +Represents a single object within the TargetedContentContainer. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentobject_collection.md b/windows.services.targetedcontent/targetedcontentobject_collection.md new file mode 100644 index 0000000000..669455797c --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentobject_collection.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentObject.Collection +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentObject.Collection + +## -description +Gets a TargetedContentCollection object in the TargetedContentObject object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentobject_item.md b/windows.services.targetedcontent/targetedcontentobject_item.md new file mode 100644 index 0000000000..8b3e7f07c3 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentobject_item.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentObject.Item +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentObject.Item + +## -description +Gets a TargetedContentItem object in the TargetedContentObject object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentobject_objectkind.md b/windows.services.targetedcontent/targetedcontentobject_objectkind.md new file mode 100644 index 0000000000..5d755aec0d --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentobject_objectkind.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentObject.ObjectKind +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentObject.ObjectKind + +## -description +Gets the TargetedContentObjectKind object for the TargetedContentObject object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentobject_value.md b/windows.services.targetedcontent/targetedcontentobject_value.md new file mode 100644 index 0000000000..fc2f90747d --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentobject_value.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentObject.Value +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentObject.Value + +## -description +Gets the TargetedContentValue object for the TargetedContentObject object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentobjectkind.md b/windows.services.targetedcontent/targetedcontentobjectkind.md new file mode 100644 index 0000000000..563f087694 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentobjectkind.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentObjectKind +-api-type: winrt enum +--- + + + +# Windows.Services.TargetedContent.TargetedContentObjectKind + +## -description +Enum that defines all the type of values TargetedContentObject object can have. +## -enum-fields +### -field Value:2 + +### -field Item:1 + +### -field Collection:0 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentstatechangedeventargs.md b/windows.services.targetedcontent/targetedcontentstatechangedeventargs.md new file mode 100644 index 0000000000..d01b26fde0 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentstatechangedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentStateChangedEventArgs +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentStateChangedEventArgs + +## -description +Represents the arguments for the State Changed event. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentstatechangedeventargs_getdeferral_254836512.md b/windows.services.targetedcontent/targetedcontentstatechangedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..cb50ca0318 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentstatechangedeventargs_getdeferral_254836512.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentStateChangedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentStateChangedEventArgs.GetDeferral + +## -description +Gets the deferral. Required for async handlers. The caller is responsible for calling Complete when the event is handled. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription.md b/windows.services.targetedcontent/targetedcontentsubscription.md new file mode 100644 index 0000000000..1f6641c8dc --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentSubscription +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription + +## -description +Represents a Subscription object. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription_availabilitychanged.md b/windows.services.targetedcontent/targetedcontentsubscription_availabilitychanged.md new file mode 100644 index 0000000000..14915d5dc9 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription_availabilitychanged.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.Services.TargetedContent.TargetedContentSubscription.AvailabilityChanged +-api-type: winrt event +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription.AvailabilityChanged + +## -description +Event invoked when TargetedContentSubscription Availability has changed. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription_contentchanged.md b/windows.services.targetedcontent/targetedcontentsubscription_contentchanged.md new file mode 100644 index 0000000000..b78ea2a6d2 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription_contentchanged.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.Services.TargetedContent.TargetedContentSubscription.ContentChanged +-api-type: winrt event +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription.ContentChanged + +## -description +Event invoked when TargetedContentSubscription Content has changed. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription_getasync_1291799672.md b/windows.services.targetedcontent/targetedcontentsubscription_getasync_1291799672.md new file mode 100644 index 0000000000..0a0ba050ff --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription_getasync_1291799672.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentSubscription.GetAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription.GetAsync + +## -description +Returns a TargetedContentContainer object for a subscriptionID. +## -parameters + +### -param subscriptionId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription_getcontentcontainerasync_472573581.md b/windows.services.targetedcontent/targetedcontentsubscription_getcontentcontainerasync_472573581.md new file mode 100644 index 0000000000..5c251111e7 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription_getcontentcontainerasync_472573581.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentSubscription.GetContentContainerAsync +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription.GetContentContainerAsync + +## -description +Returns a TargetedContentContainer object for a TargetedContentSubscription. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription_getoptions_338274691.md b/windows.services.targetedcontent/targetedcontentsubscription_getoptions_338274691.md new file mode 100644 index 0000000000..055be0aaa5 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription_getoptions_338274691.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentSubscription.GetOptions(System.String) +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription.GetOptions + +## -description +Gets an object to TargetedContentSubscriptionOptions for a given subscription. +## -parameters + +### -param subscriptionId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription_id.md b/windows.services.targetedcontent/targetedcontentsubscription_id.md new file mode 100644 index 0000000000..49363afaef --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription_id.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentSubscription.Id +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription.Id + +## -description +Gets the ID of a Subscription. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscription_statechanged.md b/windows.services.targetedcontent/targetedcontentsubscription_statechanged.md new file mode 100644 index 0000000000..a8887c1043 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscription_statechanged.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.Services.TargetedContent.TargetedContentSubscription.StateChanged +-api-type: winrt event +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscription.StateChanged + +## -description +Event invoked when TargetedContentSubscription State has changed. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscriptionoptions.md b/windows.services.targetedcontent/targetedcontentsubscriptionoptions.md new file mode 100644 index 0000000000..02f816412b --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscriptionoptions.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentSubscriptionOptions +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscriptionOptions + +## -description +Represents options for a subscription in form of CloudQuery Parameters, Local Filters and Partial Content Availability. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscriptionoptions_allowpartialcontentavailability.md b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_allowpartialcontentavailability.md new file mode 100644 index 0000000000..2163af5004 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_allowpartialcontentavailability.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.AllowPartialContentAvailability +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.AllowPartialContentAvailability + +## -description +Gets or Sets the Partial Content Availability for the TargetedContentSubscription object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscriptionoptions_cloudqueryparameters.md b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_cloudqueryparameters.md new file mode 100644 index 0000000000..557b6cf5d7 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_cloudqueryparameters.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.CloudQueryParameters +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.CloudQueryParameters + +## -description +Gets a collection of Cloud Query parameters for the TargetedContentSubscription object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscriptionoptions_localfilters.md b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_localfilters.md new file mode 100644 index 0000000000..021c2ade85 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_localfilters.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.LocalFilters +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.LocalFilters + +## -description +Gets a collection of Local Filters for the TargetedContentSubscription object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscriptionoptions_subscriptionid.md b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_subscriptionid.md new file mode 100644 index 0000000000..71696f49a1 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_subscriptionid.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.SubscriptionId +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.SubscriptionId + +## -description +Gets the ID of a Subscription. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentsubscriptionoptions_update_1590299467.md b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_update_1590299467.md new file mode 100644 index 0000000000..a05b650a76 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentsubscriptionoptions_update_1590299467.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.Update +-api-type: winrt method +--- + + + +# Windows.Services.TargetedContent.TargetedContentSubscriptionOptions.Update + +## -description +Updates the TargetedContentSubscriptionOptions object for a subscription. +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue.md b/windows.services.targetedcontent/targetedcontentvalue.md new file mode 100644 index 0000000000..3c5b96c518 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentValue +-api-type: winrt class +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue + +## -description +Represents the content value object for a subscription. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_action.md b/windows.services.targetedcontent/targetedcontentvalue_action.md new file mode 100644 index 0000000000..589014a948 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_action.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Action +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Action + +## -description +Gets a TargetedContentAction object in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_actions.md b/windows.services.targetedcontent/targetedcontentvalue_actions.md new file mode 100644 index 0000000000..527b74692a --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_actions.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Actions +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Actions + +## -description +Gets an array of TargetedContentAction objects in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_boolean.md b/windows.services.targetedcontent/targetedcontentvalue_boolean.md new file mode 100644 index 0000000000..3e2b86743e --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_boolean.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Boolean +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Boolean + +## -description +Gets a Boolean in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_booleans.md b/windows.services.targetedcontent/targetedcontentvalue_booleans.md new file mode 100644 index 0000000000..35f406f98a --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_booleans.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Booleans +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Booleans + +## -description +Gets an array of Booleans in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_file.md b/windows.services.targetedcontent/targetedcontentvalue_file.md new file mode 100644 index 0000000000..8b8b7a5516 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_file.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.File +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.File + +## -description +Gets a TargetedContentFile object in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_files.md b/windows.services.targetedcontent/targetedcontentvalue_files.md new file mode 100644 index 0000000000..f5c0588d58 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_files.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Files +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Files + +## -description +Gets an array of TargetedContentFile objects in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_imagefile.md b/windows.services.targetedcontent/targetedcontentvalue_imagefile.md new file mode 100644 index 0000000000..1ef79a0ea9 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_imagefile.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.ImageFile +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.ImageFile + +## -description +Gets a TargetedContentImage object in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_imagefiles.md b/windows.services.targetedcontent/targetedcontentvalue_imagefiles.md new file mode 100644 index 0000000000..0792779028 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_imagefiles.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.ImageFiles +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.ImageFiles + +## -description +Gets an array of TargetedContentImage objects in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_number.md b/windows.services.targetedcontent/targetedcontentvalue_number.md new file mode 100644 index 0000000000..bb80841254 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_number.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Number +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Number + +## -description +Gets a double in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_numbers.md b/windows.services.targetedcontent/targetedcontentvalue_numbers.md new file mode 100644 index 0000000000..0f1929885f --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_numbers.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Numbers +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Numbers + +## -description +Gets an array of doubles in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_path.md b/windows.services.targetedcontent/targetedcontentvalue_path.md new file mode 100644 index 0000000000..759113603b --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_path.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Path +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Path + +## -description +Gets the string path for the TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_string.md b/windows.services.targetedcontent/targetedcontentvalue_string.md new file mode 100644 index 0000000000..169d328626 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_string.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.String +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.String + +## -description +Gets a string in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_strings.md b/windows.services.targetedcontent/targetedcontentvalue_strings.md new file mode 100644 index 0000000000..a7d6f53b4c --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_strings.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Strings +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Strings + +## -description +Gets an array of strings in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_uri.md b/windows.services.targetedcontent/targetedcontentvalue_uri.md new file mode 100644 index 0000000000..4c7a79d7d9 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_uri.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Uri +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Uri + +## -description +Gets a Uri object in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_uris.md b/windows.services.targetedcontent/targetedcontentvalue_uris.md new file mode 100644 index 0000000000..96e358167c --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_uris.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.Uris +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.Uris + +## -description +Gets an array of Uri objects in a TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvalue_valuekind.md b/windows.services.targetedcontent/targetedcontentvalue_valuekind.md new file mode 100644 index 0000000000..51ae000404 --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvalue_valuekind.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.Services.TargetedContent.TargetedContentValue.ValueKind +-api-type: winrt property +--- + + + +# Windows.Services.TargetedContent.TargetedContentValue.ValueKind + +## -description +Gets the TargetedContentValueKind object for the TargetedContentValue object. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/targetedcontentvaluekind.md b/windows.services.targetedcontent/targetedcontentvaluekind.md new file mode 100644 index 0000000000..ee418736cd --- /dev/null +++ b/windows.services.targetedcontent/targetedcontentvaluekind.md @@ -0,0 +1,48 @@ +--- +-api-id: T:Windows.Services.TargetedContent.TargetedContentValueKind +-api-type: winrt enum +--- + + + +# Windows.Services.TargetedContent.TargetedContentValueKind + +## -description +Defines all the types of values content within a TargetedContentContainer can have. +## -enum-fields +### -field Uris:8 + +### -field Uri:1 + +### -field Strings:7 + +### -field String:0 + +### -field Numbers:9 + +### -field Number:2 + +### -field ImageFiles:12 + +### -field ImageFile:5 + +### -field Files:11 + +### -field File:4 + +### -field Booleans:10 + +### -field Boolean:3 + +### -field Actions:13 + +### -field Action:6 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.services.targetedcontent/windows_services_targetedcontent.md b/windows.services.targetedcontent/windows_services_targetedcontent.md new file mode 100644 index 0000000000..90b9eedf65 --- /dev/null +++ b/windows.services.targetedcontent/windows_services_targetedcontent.md @@ -0,0 +1,19 @@ +--- +-api-id: N:Windows.Services.TargetedContent +-api-type: winrt namespace +--- + + + +# Windows.Services.TargetedContent + +## -description +The Targeted Content namespace provides applications with the ability to subscribe to and access cloud-delivered, subscription-specific content and assets. This content is cached locally so that it is available while a device is offline. Subscription content can be updated periodically when new content is available. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.storage.pickers.provider/fileopenpickerui.md b/windows.storage.pickers.provider/fileopenpickerui.md index 4212423c5b..e80b51fe11 100644 --- a/windows.storage.pickers.provider/fileopenpickerui.md +++ b/windows.storage.pickers.provider/fileopenpickerui.md @@ -82,4 +82,4 @@ For JavaScript, `eventObject` contains a [webUIFileOpenPickerActivatedEventArgs] For C#, `args` contains a [FileOpenPickerActivatedEventArgs](../windows.applicationmodel.activation/fileopenpickeractivatedeventargs.md) object. Additionally, the `OnFileOpenPickerActivated` is in the App.xaml.cs file and the `Activate` method is in the FileOpenPickerPage.xaml.cs file of the [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890). ## -see-also -[Open files and folders with a picker](https://docs.microsoft.com/windows/uwp/files/quickstart-using-file-and-folder-pickers), [Windows.ApplicationModel.Activation.activationKind enumeration](../windows.applicationmodel.activation/activationkind.md), [Windows.UI.WebUI.webUIFileOpenPickerActivatedEventArgs class](../windows.ui.webui/webuifileopenpickeractivatedeventargs.md), [Windows.ApplicationModel.Activation.ActivationKind enumeration](../windows.applicationmodel.activation/activationkind.md), [Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs class](../windows.applicationmodel.activation/fileopenpickeractivatedeventargs.md), [File picker provider sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620543) \ No newline at end of file +[Open files and folders with a picker](https://docs.microsoft.com/windows/uwp/files/quickstart-using-file-and-folder-pickers), [Windows.ApplicationModel.Activation.activationKind enumeration](../windows.applicationmodel.activation/activationkind.md), [Windows.UI.WebUI.webUIFileOpenPickerActivatedEventArgs class](../windows.ui.webui/webuifileopenpickeractivatedeventargs.md), [Windows.ApplicationModel.Activation.ActivationKind enumeration](../windows.applicationmodel.activation/activationkind.md), [Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs class](../windows.applicationmodel.activation/fileopenpickeractivatedeventargs.md), [File picker provider sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620543) diff --git a/windows.storage.pickers.provider/filesavepickerui.md b/windows.storage.pickers.provider/filesavepickerui.md index 86c5011930..026cf109ac 100644 --- a/windows.storage.pickers.provider/filesavepickerui.md +++ b/windows.storage.pickers.provider/filesavepickerui.md @@ -80,4 +80,5 @@ For JavaScript, `eventObject` contains a [webUIFileSavePickerActivatedEventArgs] For C#, `args` contains a [FileSavePickerActivatedEventArgs](../windows.applicationmodel.activation/filesavepickeractivatedeventargs.md) object. Additionally, the `OnFileSavePickerActivated` is in the App.xaml.cs file and the `Activate` method is in the FileSavePickerPage.xaml.cs file of the [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890). ## -see-also -[Open files and folders with a picker](https://docs.microsoft.com/windows/uwp/files/quickstart-using-file-and-folder-pickers), [Windows.ApplicationModel.Activation.activationKind](../windows.applicationmodel.activation/activationkind.md), [Windows.UI.WebUI.webUIFileOpenPickerActivatedEventArgs.fileSavePickerUI](../windows.ui.webui/webuifilesavepickeractivatedeventargs_filesavepickerui.md), [Windows.ApplicationModel.Activation.ActivationKind](../windows.applicationmodel.activation/activationkind.md), [Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.FileSavePickerUI](../windows.applicationmodel.activation/filesavepickeractivatedeventargs_filesavepickerui.md), [File picker provider sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620543) \ No newline at end of file +[Open files and folders with a picker](https://docs.microsoft.com/windows/uwp/files/quickstart-using-file-and-folder-pickers), [Windows.ApplicationModel.Activation.activationKind](../windows.applicationmodel.activation/activationkind.md), [Windows.UI.WebUI.webUIFileOpenPickerActivatedEventArgs.fileSavePickerUI](../windows.ui.webui/webuifilesavepickeractivatedeventargs_filesavepickerui.md), [Windows.ApplicationModel.Activation.ActivationKind](../windows.applicationmodel.activation/activationkind.md), [Windows.ApplicationModel.Activation.FileOpenPickerActivatedEventArgs.FileSavePickerUI](../windows.applicationmodel.activation/filesavepickeractivatedeventargs_filesavepickerui.md), [File picker provider sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620543) + diff --git a/windows.storage.pickers/fileextensionvector.md b/windows.storage.pickers/fileextensionvector.md index 3b563b419c..73352293fd 100644 --- a/windows.storage.pickers/fileextensionvector.md +++ b/windows.storage.pickers/fileextensionvector.md @@ -43,3 +43,4 @@ The [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890) demons ## -see-also [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890), [Quickstart: Accessing files with ](http://msdn.microsoft.com/library/df082239-381c-462f-9f97-d2b390a2052e), [fileOpenPicker.fileTypeFilter property](fileopenpicker_filetypefilter.md), [folderPicker.fileTypeFilter property](folderpicker_filetypefilter.md) +olderPicker.fileTypeFilter property](folderpicker_filetypefilter.md) diff --git a/windows.storage.pickers/fileopenpicker.md b/windows.storage.pickers/fileopenpicker.md index c9d72f7a59..492e3d5997 100644 --- a/windows.storage.pickers/fileopenpicker.md +++ b/windows.storage.pickers/fileopenpicker.md @@ -46,3 +46,4 @@ The [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890) demons ## -see-also [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890), [Quickstart: Accessing files with ](http://msdn.microsoft.com/library/df082239-381c-462f-9f97-d2b390a2052e), [How to continue your Windows Phone app after calling a file picker](http://msdn.microsoft.com/library/465bbb7a-9ed1-4b57-b60f-e5c6e7cd1470), [Blobs sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620573), [File picker sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=619994) +ample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=619994) diff --git a/windows.storage.pickers/fileopenpicker_filetypefilter.md b/windows.storage.pickers/fileopenpicker_filetypefilter.md index 17294dd7ff..7532574491 100644 --- a/windows.storage.pickers/fileopenpicker_filetypefilter.md +++ b/windows.storage.pickers/fileopenpicker_filetypefilter.md @@ -34,3 +34,4 @@ The [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890) demons ## -see-also [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890), [Quickstart: Accessing files with ](http://msdn.microsoft.com/library/df082239-381c-462f-9f97-d2b390a2052e), [fileOpenPicker class](fileopenpicker.md), [fileExtensionVector class](fileextensionvector.md) +eopenpicker.md), [fileExtensionVector class](fileextensionvector.md) diff --git a/windows.storage.pickers/filepickerfiletypesorderedmap.md b/windows.storage.pickers/filepickerfiletypesorderedmap.md index c4cf49a997..5da545f9f1 100644 --- a/windows.storage.pickers/filepickerfiletypesorderedmap.md +++ b/windows.storage.pickers/filepickerfiletypesorderedmap.md @@ -32,3 +32,4 @@ The [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890) demons ## -see-also [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890), [Quickstart: Accessing files with file pickers (HTML)](http://msdn.microsoft.com/library/df082239-381c-462f-9f97-d2b390a2052e), [Open files and folders with a picker](http://msdn.microsoft.com/library/f87dbe2f-77db-4573-8172-29e11abefd34), [FileSavePicker.FileTypeChoices property](filesavepicker_filetypechoices.md) +ilesavepicker_filetypechoices.md) diff --git a/windows.storage.pickers/filepickerselectedfilesarray.md b/windows.storage.pickers/filepickerselectedfilesarray.md index 1e3368e24e..9f6d077f37 100644 --- a/windows.storage.pickers/filepickerselectedfilesarray.md +++ b/windows.storage.pickers/filepickerselectedfilesarray.md @@ -42,3 +42,4 @@ The [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890) demons ## -see-also [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890), [Quickstart: Accessing files with ](http://msdn.microsoft.com/library/df082239-381c-462f-9f97-d2b390a2052e), [fileOpenPicker.pickMultipleFilesAsync method](fileopenpicker_pickmultiplefilesasync.md) +picker_pickmultiplefilesasync.md) diff --git a/windows.storage.pickers/filesavepicker.md b/windows.storage.pickers/filesavepicker.md index 96cab69e16..2acd796bf0 100644 --- a/windows.storage.pickers/filesavepicker.md +++ b/windows.storage.pickers/filesavepicker.md @@ -37,3 +37,4 @@ The [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890) demons ## -see-also [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890), [Quickstart: Accessing files with ](http://msdn.microsoft.com/library/df082239-381c-462f-9f97-d2b390a2052e), [How to save files through ](http://msdn.microsoft.com/library/d29085cb-71d1-4537-a375-4a07fc75efc2), [How to continue your Windows Phone app after calling a file picker](http://msdn.microsoft.com/library/465bbb7a-9ed1-4b57-b60f-e5c6e7cd1470), [Windows.Storage.StorageFile class](../windows.storage/storagefile.md), [File picker sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=619994) +soft.com/fwlink/p/?LinkId=619994) diff --git a/windows.storage.pickers/filesavepicker_filetypechoices.md b/windows.storage.pickers/filesavepicker_filetypechoices.md index 41d9781f85..0bf04488c1 100644 --- a/windows.storage.pickers/filesavepicker_filetypechoices.md +++ b/windows.storage.pickers/filesavepicker_filetypechoices.md @@ -31,3 +31,4 @@ The [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890) demons ## -see-also [File picker sample](http://go.microsoft.com/fwlink/p/?linkid=234890), [FileSavePicker class](filesavepicker.md), [FilePickerFileTypesOrderedMap](filepickerfiletypesorderedmap.md) +filepickerfiletypesorderedmap.md) diff --git a/windows.storage.search/queryoptions_applicationsearchfilter.md b/windows.storage.search/queryoptions_applicationsearchfilter.md index ab71b5f169..46a5025b1b 100644 --- a/windows.storage.search/queryoptions_applicationsearchfilter.md +++ b/windows.storage.search/queryoptions_applicationsearchfilter.md @@ -13,7 +13,7 @@ public string ApplicationSearchFilter { get; set; } Gets or sets an application-defined Advanced Query Syntax (AQS) string for filtering files by keywords or properties. This property is combined with the [UserSearchFilter](queryoptions_usersearchfilter.md) to create the query's search filter. ## -property-value -A simple keyword, or a string that conforms to Advanced Query Syntax (AQS). For more information, see [Using Advanced Query Syntax Programmatically](https://msdn.microsoft.com/library/windows/desktop/bb266512.aspx). +A simple keyword, or a string that conforms to Advanced Query Syntax (AQS). For more information, see [Using Advanced Query Syntax Programmatically](http://msdn.microsoft.com/library/76e33903-d063-48c0-9afe-912c3daa8237). ## -remarks The application search filter should always use locale-invariant Advanced Query Syntax (AQS) syntax (such as [System.FileName](https://msdn.microsoft.com/library/windows/desktop/bb760703.aspx) instead of "filename" (because the term "filename" that is associated with the property [System.FileName](https://msdn.microsoft.com/library/windows/desktop/bb760703.aspx) is localized differently in different languages). This will ensure that the query returns the expected results on systems with non-English locales. Windows builds the search query by combining this property with the [UserSearchFilter](queryoptions_usersearchfilter.md) property. diff --git a/windows.storage.search/queryoptions_usersearchfilter.md b/windows.storage.search/queryoptions_usersearchfilter.md index 9c1f9ac466..e6dcd050c2 100644 --- a/windows.storage.search/queryoptions_usersearchfilter.md +++ b/windows.storage.search/queryoptions_usersearchfilter.md @@ -13,7 +13,7 @@ public string UserSearchFilter { get; set; } Gets or sets a user-defined Advanced Query Syntax (AQS) string for filtering files by keywords or properties. This property is combined with the [ApplicationSearchFilter](queryoptions_applicationsearchfilter.md) to create the query's search filter. ## -property-value -A simple keyword or a string that conforms to Advanced Query Syntax (AQS). For more information, see [Using Advanced Query Syntax Programmatically](https://msdn.microsoft.com/library/windows/desktop/bb266512.aspx). +A simple keyword or a string that conforms to Advanced Query Syntax (AQS). For more information, see [Using Advanced Query Syntax Programmatically](http://msdn.microsoft.com/library/76e33903-d063-48c0-9afe-912c3daa8237). ## -remarks Windows builds the search query by combining this property with the [ApplicationSearchFilter](queryoptions_applicationsearchfilter.md) property. diff --git a/windows.storage.streams/inputstreamoverstream.md b/windows.storage.streams/inputstreamoverstream.md index 819759f52c..8e520fe7dd 100644 --- a/windows.storage.streams/inputstreamoverstream.md +++ b/windows.storage.streams/inputstreamoverstream.md @@ -15,9 +15,10 @@ Provides a Windows Runtime input stream for an [IStream](https://msdn.microsoft. ## -remarks The [InputStreamOverStream](inputstreamoverstream.md), [OutputStreamOverStream](outputstreamoverstream.md), and [RandomAccessStreamOverStream](randomaccessstreamoverstream.md) classes are interop helpers to convert between the Windows Runtime stream types, which are natively asynchronous, and the Component Object Model (COM) [IStream](https://msdn.microsoft.com/library/windows/desktop/aa380034.aspx) types, which are natively synchronous. + These helper classes make it easier for to reuse legacy code when you transition to the Windows Runtime stream types. ## -examples ## -see-also -[OutputStreamOverStream](outputstreamoverstream.md), [RandomAccessStreamOverStream](randomaccessstreamoverstream.md), [IStream](https://msdn.microsoft.com/library/windows/desktop/aa380034.aspx) \ No newline at end of file +[OutputStreamOverStream](outputstreamoverstream.md), [RandomAccessStreamOverStream](randomaccessstreamoverstream.md), [IStream](https://msdn.microsoft.com/library/windows/desktop/aa380034.aspx) diff --git a/windows.storage.streams/outputstreamoverstream.md b/windows.storage.streams/outputstreamoverstream.md index 37879f6868..711dea9503 100644 --- a/windows.storage.streams/outputstreamoverstream.md +++ b/windows.storage.streams/outputstreamoverstream.md @@ -20,4 +20,4 @@ These helper classes make it easier for to reuse legacy code when you transition ## -examples ## -see-also -[InputStreamOverStream](inputstreamoverstream.md), [RandomAccessStreamOverStream](randomaccessstreamoverstream.md), [IStream](https://msdn.microsoft.com/library/windows/desktop/aa380034.aspx) \ No newline at end of file +[InputStreamOverStream](inputstreamoverstream.md), [RandomAccessStreamOverStream](randomaccessstreamoverstream.md), [IStream](https://msdn.microsoft.com/library/windows/desktop/aa380034.aspx) diff --git a/windows.storage.streams/randomaccessstreamoverstream.md b/windows.storage.streams/randomaccessstreamoverstream.md index b9c21d3268..ba8ed3d21e 100644 --- a/windows.storage.streams/randomaccessstreamoverstream.md +++ b/windows.storage.streams/randomaccessstreamoverstream.md @@ -20,4 +20,5 @@ These helper classes make it easier for to reuse legacy code when you transition ## -examples ## -see-also -[RandomAccessStream](randomaccessstream.md), [RandomAccessStreamReference](randomaccessstreamreference.md), [InputStreamOverStream](inputstreamoverstream.md), [OutputStreamOverStream](outputstreamoverstream.md), [IStream](https://msdn.microsoft.com/library/windows/desktop/aa380034.aspx) \ No newline at end of file +[RandomAccessStream](randomaccessstream.md), [RandomAccessStreamReference](randomaccessstreamreference.md), [InputStreamOverStream](inputstreamoverstream.md), [OutputStreamOverStream](outputstreamoverstream.md), [IStream](https://msdn.microsoft.com/library/windows/desktop/aa380034.aspx) + diff --git a/windows.storage/applicationdata.md b/windows.storage/applicationdata.md index ef7ebba8e1..284fd5a9c5 100644 --- a/windows.storage/applicationdata.md +++ b/windows.storage/applicationdata.md @@ -209,4 +209,4 @@ void MainPage::ReadTimestamp() ## -see-also -[Quickstart: Local application data (JavaScript)](http://msdn.microsoft.com/library/87dfe8e5-2d01-45cf-bcb1-25f54219a439), [Quickstart: Roaming application data (JavaScript)](http://msdn.microsoft.com/library/60f40214-c201-4afe-a2f5-0ef3a7de0076), [Quickstart: Temporary application data (JavaScript)](http://msdn.microsoft.com/library/2e875049-85ef-4581-b6df-f9f0663d93c9), [Store and retrieve settings and other app data](http://msdn.microsoft.com/library/41676a02-325a-455e-8565-c9ec0bc3a8fe), [Guidelines for roaming application data](https://msdn.microsoft.com/library/windows/apps/hh465094.aspx), [Guidelines for app settings](https://docs.microsoft.com/windows/uwp/app-settings/guidelines-for-app-settings), [ApplicationDataCompositeValue](applicationdatacompositevalue.md), [ApplicationDataContainer](applicationdatacontainer.md), [ApplicationDataContainerSettings](applicationdatacontainersettings.md), [Application settings sample (Windows 8.1, Windows Phone 8.1)](http://go.microsoft.com/fwlink/p/?linkid=226738), [Application data sample (Windows 8.1, Windows Phone 8.1)](http://go.microsoft.com/fwlink/p/?linkid=231478), [Application data sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620486) \ No newline at end of file +[Quickstart: Local application data (JavaScript)](http://msdn.microsoft.com/library/87dfe8e5-2d01-45cf-bcb1-25f54219a439), [Quickstart: Roaming application data (JavaScript)](http://msdn.microsoft.com/library/60f40214-c201-4afe-a2f5-0ef3a7de0076), [Quickstart: Temporary application data (JavaScript)](http://msdn.microsoft.com/library/2e875049-85ef-4581-b6df-f9f0663d93c9), [Store and retrieve settings and other app data](http://msdn.microsoft.com/library/41676a02-325a-455e-8565-c9ec0bc3a8fe), [Guidelines for roaming application data](https://msdn.microsoft.com/library/windows/apps/hh465094.aspx), [Guidelines for app settings](https://docs.microsoft.com/windows/uwp/app-settings/guidelines-for-app-settings), [ApplicationDataCompositeValue](applicationdatacompositevalue.md), [ApplicationDataContainer](applicationdatacontainer.md), [ApplicationDataContainerSettings](applicationdatacontainersettings.md), [Application settings sample (Windows 8.1, Windows Phone 8.1)](http://go.microsoft.com/fwlink/p/?linkid=226738), [Application data sample (Windows 8.1, Windows Phone 8.1)](http://go.microsoft.com/fwlink/p/?linkid=231478), [Application data sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620486) diff --git a/windows.storage/istoragefile2_openasync_1542217918.md b/windows.storage/istoragefile2_openasync_1542217918.md index c25a640b97..f0cfe6aeb4 100644 --- a/windows.storage/istoragefile2_openasync_1542217918.md +++ b/windows.storage/istoragefile2_openasync_1542217918.md @@ -30,9 +30,9 @@ Using this method, a file can be accessed by both file readers and writers simul | | FileAccessMode | | |------------------------|------|-----------| | **StorageOpenOptions** | Read | ReadWrite | -| None | A polite reader, which is lower priority than a writer. If a write occurs, the reader will fail. | This is a single writer. The file cannot be opened if OpenAsync(Read, AllowOnlyReaders) has been used, and it will prevent a new OpenAsync(Read, AllowOnlyReaders) from being used. | -| AllowOnlyReaders | A non-polite reader which can only exist with other readers. If an open is attempted with a writer, it will fail with ERROR_SHARING_VIOLATION. | This is a single writer. The file cannot be opened if OpenAsync(Read, AllowOnlyReaders) has been used, and it will prevent a new OpenAsync(Read, AllowOnlyReaders) from being used. | -| AllowReadersAndWriters | A a non-polite reader which can exist with other readers and writers simultaneously. | This writer will invalidate polite readers when a write occurs and can coexist with other writers and non-polite readers. | +| None | A reader which is lower priority than a writer. If a write occurs, this low priority reader will fail. | This is a single writer. The file cannot be opened if OpenAsync(Read, AllowOnlyReaders) has been used, and it will prevent a new OpenAsync(Read, AllowOnlyReaders) from being used. | +| AllowOnlyReaders | A reader which can only exist with other readers. If an open is attempted with a writer, it will fail. | This is a single writer. The file cannot be opened if OpenAsync(Read, AllowOnlyReaders) has been used, and it will prevent a new OpenAsync(Read, AllowOnlyReaders) from being used. | +| AllowReadersAndWriters | A reader which can exist with other readers and writers simultaneously. | This writer will invalidate low priority readers when a write occurs and can coexist with other readers and writers. | ## -examples diff --git a/windows.storage/istoragefile2_opentransactedwriteasync_2121527812.md b/windows.storage/istoragefile2_opentransactedwriteasync_2121527812.md index 69f0f641d7..4af2aac100 100644 --- a/windows.storage/istoragefile2_opentransactedwriteasync_2121527812.md +++ b/windows.storage/istoragefile2_opentransactedwriteasync_2121527812.md @@ -17,7 +17,7 @@ Opens a random-access stream to the file that can be used for transacted-write o A bitwise combination of the enumeration values that specify options for opening the stream. ## -returns -When this method completes, it returns a [StorageStreamTransaction](storagestreamtransaction.md) that contains the random-access stream and methods that can be used to complete transactions. +When this method completes, it returns a [StorageStreamTransaction](storagestreamtransaction.md) containing the random-access stream and methods that can be used to complete transactions. ## -remarks This method results in a stream that writes to a temporary file, then atomically commits the writes to the actual file by renaming the temporary file onto the actual file. Because of how the stream writing works, a transacted writer cannot coexist with another writer, meaning StorageOpenOptions.AllowReadersAndWriters is not valid for this method and will return E_INVALIDARG if used. diff --git a/windows.storage/knownfolders.md b/windows.storage/knownfolders.md index b1807dcf1a..3e9289d463 100644 --- a/windows.storage/knownfolders.md +++ b/windows.storage/knownfolders.md @@ -63,4 +63,4 @@ Windows.Storage.KnownFolders.picturesLibrary.createFileAsync("sample.png", Windo After the [CreateFileAsync](storagefolder_createfileasync.md) method completes, the `file` variable contains a [StorageFile](storagefile.md) that represents the new file. ## -see-also -[File access sample]( http://go.microsoft.com/fwlink/p/?linkid=231445), [File access permissions](http://msdn.microsoft.com/library/3a404cc0-a997-45c8-b2e8-44745539759d), [Enumerate and query files and folders](http://msdn.microsoft.com/library/4c59d5ac-58f7-4863-a884-e9e54228a5ad), [StorageFile class](storagefile.md), [StorageFolder class](storagefolder.md), [Windows.Storage.Search namespace](../windows.storage.search/windows_storage_search.md), [HomeGroup sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620549) \ No newline at end of file +[File access sample]( http://go.microsoft.com/fwlink/p/?linkid=231445), [File access permissions](http://msdn.microsoft.com/library/3a404cc0-a997-45c8-b2e8-44745539759d), [Enumerate and query files and folders](http://msdn.microsoft.com/library/4c59d5ac-58f7-4863-a884-e9e54228a5ad), [StorageFile class](storagefile.md), [StorageFolder class](storagefolder.md), [Windows.Storage.Search namespace](../windows.storage.search/windows_storage_search.md), [HomeGroup sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620549) diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnection.md b/windows.system.diagnostics.deviceportal/deviceportalconnection.md new file mode 100644 index 0000000000..063803c891 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnection.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Diagnostics.DevicePortal.DevicePortalConnection +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnection + +## -description +Handles a connection to a [Windows Device Portal](https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/device-portal). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnection_closed.md b/windows.system.diagnostics.deviceportal/deviceportalconnection_closed.md new file mode 100644 index 0000000000..716d4ace14 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnection_closed.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.Diagnostics.DevicePortal.DevicePortalConnection.Closed +-api-type: winrt event +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnection.Closed + +## -description +Raised when the connection to the device portal is closed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnection_getforappserviceconnection_1678796475.md b/windows.system.diagnostics.deviceportal/deviceportalconnection_getforappserviceconnection_1678796475.md new file mode 100644 index 0000000000..a1805a9604 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnection_getforappserviceconnection_1678796475.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.System.Diagnostics.DevicePortal.DevicePortalConnection.GetForAppServiceConnection(Windows.ApplicationModel.AppService.AppServiceConnection) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnection.GetForAppServiceConnection + +## -description +Initialized an instance of [**DevicePortalConnection**](DevicePortalConnection.md) by using the app service connection passed in from the containing background task. + +## -parameters + +### -param appServiceConnection +The [**AppServiceConnection**](https://docs.microsoft.com/en-us/uwp/api/Windows.ApplicationModel.AppService.AppServiceConnection) that was used to launch the containing background task. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnection_requestreceived.md b/windows.system.diagnostics.deviceportal/deviceportalconnection_requestreceived.md new file mode 100644 index 0000000000..c0012feea9 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnection_requestreceived.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.Diagnostics.DevicePortal.DevicePortalConnection.RequestReceived +-api-type: winrt event +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnection.RequestReceived + +## -description +Raised when a request has been received through the Windows Device Portal server. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedeventargs.md b/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedeventargs.md new file mode 100644 index 0000000000..154a758c8b --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionClosedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionClosedEventArgs + +## -description +Describes a [**DevicePortalConnection.Closed**](DevicePortalConnection_Closed.md) event that was raised. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedeventargs_reason.md b/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedeventargs_reason.md new file mode 100644 index 0000000000..d4214a4d26 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedeventargs_reason.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionClosedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionClosedEventArgs.Reason + +## -description +Describes the reason that the device portal connection was closed. + +## -property-value +A [**DevicePortalConnectionClosedReason**](DevicePortalConnectionClosedReason.md) value describing the reason for closing. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedreason.md b/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedreason.md new file mode 100644 index 0000000000..d186f30cb3 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnectionclosedreason.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionClosedReason +-api-type: winrt enum +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionClosedReason + +## -description +Contains values that explain why a device portal connection was closed. + +## -enum-fields +### -field UserNotPresent:4 +The WTS active console user was missing. + +### -field Unknown:0 +The connection closed for an unknown reason. + +### -field ServiceTerminated:5 +Windows Device Portal has shut down. + +### -field ResourceLimitsExceeded:1 +Windows Devices Portal closed the connection because the resource limit was exceeded. + +### -field ProtocolError:2 +The connection closed because of an unrecognized app service message. + +### -field NotAuthorized:3 +The app is missing the appropriate capability to use a device portal. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs.md b/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs.md new file mode 100644 index 0000000000..bd6b59fc17 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionRequestReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionRequestReceivedEventArgs + +## -description +Describes a [**DevicePortalConnection.RequestReceived**](DevicePortalConnection_RequestReceived.md) event that was raised. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs_requestmessage.md b/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs_requestmessage.md new file mode 100644 index 0000000000..cc1ef7e824 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs_requestmessage.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionRequestReceivedEventArgs.RequestMessage +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionRequestReceivedEventArgs.RequestMessage + +## -description +Gets the http request message for this request. + +## -property-value +An [HttpRequestMessage](https://docs.microsoft.com/en-us/uwp/api/Windows.Web.Http.HttpRequestMessage) instance for the request. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs_responsemessage.md b/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs_responsemessage.md new file mode 100644 index 0000000000..9c86325a7c --- /dev/null +++ b/windows.system.diagnostics.deviceportal/deviceportalconnectionrequestreceivedeventargs_responsemessage.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionRequestReceivedEventArgs.ResponseMessage +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.DevicePortal.DevicePortalConnectionRequestReceivedEventArgs.ResponseMessage + +## -description +Gets the http response message for this request. + +## -property-value +An [HttpResponseMessage](https://docs.microsoft.com/en-us/uwp/api/Windows.Web.Http.HttpResponseMessage) instance for the request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.deviceportal/windows_system_diagnostics_deviceportal.md b/windows.system.diagnostics.deviceportal/windows_system_diagnostics_deviceportal.md new file mode 100644 index 0000000000..1657648023 --- /dev/null +++ b/windows.system.diagnostics.deviceportal/windows_system_diagnostics_deviceportal.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.System.Diagnostics.DevicePortal +-api-type: winrt namespace +--- + + + +# Windows.System.Diagnostics.DevicePortal + +## -description +Provides functionality for creating, installing, and launching a [Windows Device Portal](https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/device-portal) through the use of a background task. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryclient.md b/windows.system.diagnostics.telemetry/platformtelemetryclient.md new file mode 100644 index 0000000000..51a8e6fd15 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryclient.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.System.Diagnostics.Telemetry.PlatformTelemetryClient +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryClient + +## -description +Provides functionality to register a client with the Connected User Experience and Telemetry component. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. + +## -see-also +[Configure Windows telemetry in your organization](https://technet.microsoft.com/itpro/windows/manage/configure-windows-telemetry-in-your-organization) + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryclient_register_1223384297.md b/windows.system.diagnostics.telemetry/platformtelemetryclient_register_1223384297.md new file mode 100644 index 0000000000..af24c840b7 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryclient_register_1223384297.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.System.Diagnostics.Telemetry.PlatformTelemetryClient.Register(System.String) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryClient.Register + +## -description +Registers a client with the Connected User Experience and Telemetry component. + +## -params + +## -param id +Unique string value that identifies the client. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryclient_register_1960146455.md b/windows.system.diagnostics.telemetry/platformtelemetryclient_register_1960146455.md new file mode 100644 index 0000000000..b611b6b374 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryclient_register_1960146455.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.System.Diagnostics.Telemetry.PlatformTelemetryClient.Register(System.String,Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryClient.Register + +## -description +Registers a client with the Connected User Experience and Telemetry component. + +## -params + +## -param id +Unique string value that identifies the client. + +## -param settings +[PlatformTelemetryRegistrationSettings](PlatformTelemetryRegistrationSettings.md) for registering a client. + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryregistrationresult.md b/windows.system.diagnostics.telemetry/platformtelemetryregistrationresult.md new file mode 100644 index 0000000000..0af1e14f37 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryregistrationresult.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationResult +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationResult + +## -description +The result of registering a client with or without registration settings. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryregistrationresult_status.md b/windows.system.diagnostics.telemetry/platformtelemetryregistrationresult_status.md new file mode 100644 index 0000000000..0bf09cb6c4 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryregistrationresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationResult.Status +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationResult.Status + +## -description +Gets the status of the client registration result. + +## -property-value +Success; SettingsOutOfRange; UnknownFailure. For more information, see [PlatformTelemetryRegistrationStatus](PlatformTelemetryRegistrationStatus.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings.md b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings.md new file mode 100644 index 0000000000..e3d8e0c918 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings + +## -description +Describes the settings for registering an app with the Connected User Experience and Telemetry component. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_platformtelemetryregistrationsettings_1221375020.md b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_platformtelemetryregistrationsettings_1221375020.md new file mode 100644 index 0000000000..5a98c1d68c --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_platformtelemetryregistrationsettings_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings.#ctor +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings.PlatformTelemetryRegistrationSettings + +## -description +Settings for registering a client. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_storagesize.md b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_storagesize.md new file mode 100644 index 0000000000..0e64604c4f --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_storagesize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings.StorageSize +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings.StorageSize + +## -description +Gets the storage size of the client. + +## -property-value +Storage size of the client, in bytes. Value must be greater than 0 and less than 100 megabytes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_uploadquotasize.md b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_uploadquotasize.md new file mode 100644 index 0000000000..ba719b7879 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryregistrationsettings_uploadquotasize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings.UploadQuotaSize +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationSettings.UploadQuotaSize + +## -description +Gets the upload quota size of the client. + +## -property-value +Upload quota for the client, in bytes. A value of 0 indicates no upload limitation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/platformtelemetryregistrationstatus.md b/windows.system.diagnostics.telemetry/platformtelemetryregistrationstatus.md new file mode 100644 index 0000000000..5512866b46 --- /dev/null +++ b/windows.system.diagnostics.telemetry/platformtelemetryregistrationstatus.md @@ -0,0 +1,37 @@ +--- +-api-id: T:Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationStatus +-api-type: winrt enumeration +--- + + + +# Windows.System.Diagnostics.Telemetry.PlatformTelemetryRegistrationStatus + +## -description +Provides information about the status of registering a client with the Connected User Experience and Telemetry component. + +## -enum-fields + +## -field UnknownFailure:2 +Registration failed for another unknown reason. + +## -field Success:0 +Registration is successful or the app has already been registered. + +## -field SettingsOutOfRange:1 +The registration settings are invalid. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this type. + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics.telemetry/windows_system_diagnostics_telemetry.md b/windows.system.diagnostics.telemetry/windows_system_diagnostics_telemetry.md new file mode 100644 index 0000000000..14f9034c15 --- /dev/null +++ b/windows.system.diagnostics.telemetry/windows_system_diagnostics_telemetry.md @@ -0,0 +1,23 @@ +--- +-api-id: N:Windows.System.Diagnostics.Telemetry +-api-type: winrt namespace +--- + + + +# Windows.System.Diagnostics.Telemetry + +## -description +Provides functionality for registering clients with the Connected User Experience and Telemetry component. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. + +## -see-also +[Configure Windows telemetry in your organization](https://technet.microsoft.com/itpro/windows/manage/configure-windows-telemetry-in-your-organization) + +## -examples + diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions.md new file mode 100644 index 0000000000..400f473382 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions.md @@ -0,0 +1,17 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions + +## -description +Manages diagnostic scenarios + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_downloadlatestsettingsfornamespace_2049837105.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_downloadlatestsettingsfornamespace_2049837105.md new file mode 100644 index 0000000000..fbd214a6c6 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_downloadlatestsettingsfornamespace_2049837105.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.DownloadLatestSettingsForNamespace(System.String,System.String,System.Boolean,System.Boolean,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.DownloadLatestSettingsForNamespace + +## -description +Downloads the settings that describes which diagnostic data is collected as part of the specified profile. + +## -params + +### -param partner +The name of the partner associated with this profile. + +### -param feature +The name of the feature associated with this profile. + +### -param isScenarioNamespace +*true* if this profile is associated with a scenario; *false* otherwise. + +### -param downloadOverCostedNetwork +*true* to download settings even if the device only has access to a costed network connection; *false* otherwise. + +### -param downloadOverBattery +*true* to download the settings even if the device is running on battery; *false*, otherwise. + +## -returns +The result of trying to download the settings. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_forceupload_1947368557.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_forceupload_1947368557.md new file mode 100644 index 0000000000..f371e5b64b --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_forceupload_1947368557.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.ForceUpload(Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticEventBufferLatencies,System.Boolean,System.Boolean) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.ForceUpload + +## -description +Cause diagnostic data to be uploaded within the specified parameters. + +## -params + +### -param latency + +### -param uploadOverCostedNetwork +True to upload even if the device only has access to a cellular data connection; false otherwise. + +### -param uploadOverBattery +**True** to upload even if the device is running on battery; **false** otherwise. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getactivescenariolist_1665244867.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getactivescenariolist_1665244867.md new file mode 100644 index 0000000000..9bd01e78be --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getactivescenariolist_1665244867.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.GetActiveScenarioList +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.GetActiveScenarioList + +## -description +Get the list of scenarios that have been downloaded to the device. + +## -params +None + +## -returns +A list of GUIDs that identify the scenarios that have been downloaded. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getactivetraceruntime_1761251013.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getactivetraceruntime_1761251013.md new file mode 100644 index 0000000000..0f109881ba --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getactivetraceruntime_1761251013.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.GetActiveTraceRuntime(Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceSlotType) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.GetActiveTraceRuntime + +## -description +Returns the amount of time that a trace in the specified slot has been running. + +## -params + +### -param slotType +Which slot to query. + +## -returns +How long the trace in the specified slot has been running. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getknowntracelist_1006537213.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getknowntracelist_1006537213.md new file mode 100644 index 0000000000..eca6a5df56 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_getknowntracelist_1006537213.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.GetKnownTraceList(Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceSlotType) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.GetKnownTraceList + +## -description +Get the list of diagnostic traces that are available on the system. + +## -params + +### -param slotType +The slot for which you want a list of traces. + +## -returns +A list that describes the traces available for the slot. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_isscenarioenabled_490848955.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_isscenarioenabled_490848955.md new file mode 100644 index 0000000000..4571f1c24d --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_isscenarioenabled_490848955.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.IsScenarioEnabled(System.Guid) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.IsScenarioEnabled + +## -description +Whether a scenario profile has been downloaded to the device. + +## -params + +### -param scenarioId +The scenario identifier. + +## -returns +*True* if the scenario is available; *false* otherwise. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_istracerunning_1135513996.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_istracerunning_1135513996.md new file mode 100644 index 0000000000..436db90494 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_istracerunning_1135513996.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.IsTraceRunning(Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceSlotType,System.Guid,System.UInt64) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.IsTraceRunning + +## -description +Whether a trace for the specified scenario is in progress. + +## -params + +### -param slotType +The slot for the scenario. + +### -param scenarioId +The scenario identifier. + +### -param traceProfileHash +The trace profile identifier. + +## -returns +**True** if the specified trace is running; **false** otherwise. + +## -remarks +Get a profile's hash from [GetKnownTraceList](platformdiagnosticactions_getknowntracelist_1006537213.md) + +## -see-also +[PlatformDiagnosticTraceInfo](platformdiagnostictraceinfo.md) diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactions_tryescalatescenario_909016441.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_tryescalatescenario_909016441.md new file mode 100644 index 0000000000..82fcb1c09c --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactions_tryescalatescenario_909016441.md @@ -0,0 +1,36 @@ +--- +-api-id: M:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.TryEscalateScenario(System.Guid,Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticEscalationType,System.String,System.Boolean,System.Boolean,Windows.Foundation.Collections.IMapView{System.String,System.String}) +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActions.TryEscalateScenario + +## -description +Try to run a scenario on demand. + +## -params + +### -param scenarioId +The scenario identifier. + +### -param escalationType + + +### -param outputDirectory +The path to the location where the diagnostic data will be stored. + +### -param timestampOutputDirectory +*True* to have the output directory timestamp reflect when the diagnostic data is written to the directory; *false* otherwise. + +### -param forceEscalationUpload +If the diagnostic scenario cannot be found on the device, *true* initiates an upload of the escalation scenario. + +### -param triggers +A dictionary of trigger and property pairs. The format is "$(T,P)=V where T is the trigger, P is the property, and V is the value. For example, {""$(T1,Filename)=c:\foo.dat"} implies that the Connected User Experience and Telemetry component will substitute c:\foo.dat in any action which specifies $(T1,FileName). + +## -returns +*True* indicates the scenario was escalated; *false*, otherwise. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticactionstate.md b/windows.system.diagnostics.tracereporting/platformdiagnosticactionstate.md new file mode 100644 index 0000000000..03227a2737 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticactionstate.md @@ -0,0 +1,36 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActionState +-api-type: winrt enumeration +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticActionState + +## -description +Specifies the outcome of a diagnostic trace operation. + +## -enum-fields + +## -field Success:0 +The operation was successful. + +## -field FreeNetworkNotAvailable:1 +The operation failed because a non-metered network connection is not available. + +## -field ACPowerNotAvailable:2 +The operation failed because the device is running on battery power. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this type. + +## -see-also +[DownloadLatestSettingsForNamespace](DownloadLatestSettingsForNamespace.md) +[ForceUpload](ForceUpload.md) diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticescalationtype.md b/windows.system.diagnostics.tracereporting/platformdiagnosticescalationtype.md new file mode 100644 index 0000000000..3b2bde2e72 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticescalationtype.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticEscalationType +-api-type: winrt enumeration +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticEscalationType + +## -description +Specifies the categories of escalation actions. + +## -enum-fields + +## -field OnFailure:1 +Take the actions associated with diagnostic escalation failure. + +## -field OnCompletion:0 +Take the actions associated with diagnostic escalation success. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this type. + +## -see-also +[TryEscalateScenario](TryEscalateScenario.md) diff --git a/windows.system.diagnostics.tracereporting/platformdiagnosticeventbufferlatencies.md b/windows.system.diagnostics.tracereporting/platformdiagnosticeventbufferlatencies.md new file mode 100644 index 0000000000..0e41e4ba2d --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnosticeventbufferlatencies.md @@ -0,0 +1,35 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticEventBufferLatencies +-api-type: winrt enumeration +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticEventBufferLatencies + +## -description +Specifies the kinds of network connections that can be used to transfer diagnostic data. + +## -enum-fields + +## -field Realtime:4 +Trace data will be uploaded as soon as a network connection (of any kind) is available. + +## -field Normal:1 +Trace data will be transferred unless the device is on a metered connection. + +## -field CostDeferred:2 +Less strict than **Normal**. If, after three days, there has been no opportunity to connect over a non-cellular connection, trace data will be transferred even if the device is still on a cellular connection. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this type. + +## -see-also +[ForceUpload()](ForceUpload.md) diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo.md new file mode 100644 index 0000000000..9e2d7ca53e --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo.md @@ -0,0 +1,17 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo + +## -description +Provides information about the trace. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_isautologger.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_isautologger.md new file mode 100644 index 0000000000..b72d909540 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_isautologger.md @@ -0,0 +1,19 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.IsAutoLogger +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.IsAutoLogger + +## -description +Indicates whether the trace is from an ETW AutoLogger session. + +## -property-value +**True** if the trace is from an ETW autologger session; **false** otherwise. + +## -see-also +[Configuring and Starting an AutoLogger Session](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363687.aspx) diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_isexclusive.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_isexclusive.md new file mode 100644 index 0000000000..367091ed82 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_isexclusive.md @@ -0,0 +1,19 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.IsExclusive +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.IsExclusive + +## -description +Indicates whether the trace is exclusive. + +## -property-value +**true** - the trace is exclusive; **false** otherwise. + +## -remarks +An exclusive trace can be the only trace running. All other traces will be throttled while an exclusive trace is running. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_maxtracedurationfiletime.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_maxtracedurationfiletime.md new file mode 100644 index 0000000000..268783060f --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_maxtracedurationfiletime.md @@ -0,0 +1,16 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.MaxTraceDurationFileTime +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.MaxTraceDurationFileTime + +## -description +Trace files are circular. This property reflects the amount of time that will pass before the trace file starts writing over itself--starting at the beginning of the file. + +## -property-value +The amount of time until the file overwrites itself, expressed in clock ticks. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_priority.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_priority.md new file mode 100644 index 0000000000..e363aecdaa --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_priority.md @@ -0,0 +1,16 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.Priority +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.Priority + +## -description +The trace priority. + +## -property-value +Whether the priority of the trace is normal or has been elevated by the user. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_profilehash.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_profilehash.md new file mode 100644 index 0000000000..e1d967643a --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_profilehash.md @@ -0,0 +1,16 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.ProfileHash +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.ProfileHash + +## -description +An identifier for this trace. + +## -property-value +The trace hash value. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_scenarioid.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_scenarioid.md new file mode 100644 index 0000000000..5ebcccab36 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceinfo_scenarioid.md @@ -0,0 +1,16 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.ScenarioId +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceInfo.ScenarioId + +## -description +A unique identifier for this scenario. + +## -property-value +The globally unique identifier (GUID) for this scenario. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictracepriority.md b/windows.system.diagnostics.tracereporting/platformdiagnostictracepriority.md new file mode 100644 index 0000000000..0eaa47fc73 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictracepriority.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTracePriority +-api-type: winrt enumeration +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTracePriority + +## -description +Describes the priority of a trace. + +## -enum-fields + +## -field UserElevated:1 +The trace priority has been elevated by user action. + +## -field Normal:0 +The trace is being collected at normal priority. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this type. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo.md new file mode 100644 index 0000000000..d185ed7caa --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo.md @@ -0,0 +1,17 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceRuntimeInfo +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceRuntimeInfo + +## -description +Provides timestamp information about the trace. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this class. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo_etwruntimefiletime.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo_etwruntimefiletime.md new file mode 100644 index 0000000000..9e5bf09a8c --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo_etwruntimefiletime.md @@ -0,0 +1,16 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceRuntimeInfo.EtwRuntimeFileTime +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceRuntimeInfo.EtwRuntimeFileTime + +## -description +The internal time stamp (in ticks) for the Event Tracing for Windows (ETW) file. + +## -property-value +The time stamp for the Event Tracing for Windows (ETW) file. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo_runtimefiletime.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo_runtimefiletime.md new file mode 100644 index 0000000000..b55ad11f40 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceruntimeinfo_runtimefiletime.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceRuntimeInfo.RuntimeFileTime +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceRuntimeInfo.RuntimeFileTime + +## -description +The timestamp (in ticks) for the trace. + +## -property-value +The timestamp for the trace file. + +## -remarks +A Windows file time is a 64-bit value that represents the number of 100-nanosecond intervals that have elapsed since 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC). Windows uses a file time to record when an application creates, accesses, or writes to a file. + +Convert the return value to a DateTime with DateTime.FromFileTimeUtc(); diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceslotstate.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceslotstate.md new file mode 100644 index 0000000000..86edd0e9ea --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceslotstate.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceSlotState +-api-type: winrt enumeration +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceSlotState + +## -description +Describes the state of a trace. + +## -enum-fields + +## -field Throttled:2 +The trace is not running because another trace has higher priority, or the device is running on battery power. + +## -field Running:1 +The trace is running. + +## -field NotRunning:0 +The trace is not currently running. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this type. diff --git a/windows.system.diagnostics.tracereporting/platformdiagnostictraceslottype.md b/windows.system.diagnostics.tracereporting/platformdiagnostictraceslottype.md new file mode 100644 index 0000000000..ebe772d907 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/platformdiagnostictraceslottype.md @@ -0,0 +1,33 @@ +--- +-api-id: T:Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceSlotType +-api-type: winrt enumeration +--- + + + +# Windows.System.Diagnostics.TraceReporting.PlatformDiagnosticTraceSlotType +## -description +Describes the slot type that a trace can be assigned to. + +## -enum-fields + +## -field Mini:2 +Always running, low impact traces, are assigned to this slot. + +## -field AlwaysOn:1 +A slot for long running traces. Traces in this slot are circular (they don't grow indefinitely ). This slot might be used to run a diagnostic trace for an infrequent failure. With the trace always running, you can gather trace information that immediately preceded the failure. + +## -field Alternative:0 +Traces that run briefly are assigned to this slot. For example, a user initiated trace that is started while the user reproduces a scenario, and then stops the trace, is assigned to this slot. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this type. + +A slot is used to manage the priority of the traces that are assigned to that slot. diff --git a/windows.system.diagnostics.tracereporting/windows_system_diagnostics_tracereporting.md b/windows.system.diagnostics.tracereporting/windows_system_diagnostics_tracereporting.md new file mode 100644 index 0000000000..39f3e27372 --- /dev/null +++ b/windows.system.diagnostics.tracereporting/windows_system_diagnostics_tracereporting.md @@ -0,0 +1,17 @@ +--- +-api-id: N:Windows.System.Diagnostics.TraceReporting +-api-type: winrt namespace +--- + + + +# Windows.System.Diagnostics.TraceReporting + +## -description +This namespace represents the Connected User Experience and Telemetry component that manages the telemetry escalations. + +## -remarks +> [!IMPORTANT] +> Only first-party applications should use this property. diff --git a/windows.system.diagnostics/processdiagnosticinfo_memoryusage.md b/windows.system.diagnostics/processdiagnosticinfo_memoryusage.md index 49eea66ed4..b2f4132e90 100644 --- a/windows.system.diagnostics/processdiagnosticinfo_memoryusage.md +++ b/windows.system.diagnostics/processdiagnosticinfo_memoryusage.md @@ -10,7 +10,7 @@ public Windows.System.Diagnostics.ProcessMemoryUsage MemoryUsage { get; } # Windows.System.Diagnostics.ProcessDiagnosticInfo.MemoryUsage ## -description -Get memory usage data for the process. +Gets memory usage data for the process. ## -property-value Memory usage data for the process. diff --git a/windows.system.diagnostics/systemcpuusage.md b/windows.system.diagnostics/systemcpuusage.md new file mode 100644 index 0000000000..7b3fe198bb --- /dev/null +++ b/windows.system.diagnostics/systemcpuusage.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Diagnostics.SystemCpuUsage +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.SystemCpuUsage + +## -description +Provides access to data about the CPU usage of the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemcpuusage_getreport_610268658.md b/windows.system.diagnostics/systemcpuusage_getreport_610268658.md new file mode 100644 index 0000000000..7407193956 --- /dev/null +++ b/windows.system.diagnostics/systemcpuusage_getreport_610268658.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.Diagnostics.SystemCpuUsage.GetReport +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.SystemCpuUsage.GetReport + +## -description +Gets the CPU usage report for the system. + +## -parameters + +## -returns +The [SystemCpuUsageReport](systemcpuusagereport.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemcpuusagereport.md b/windows.system.diagnostics/systemcpuusagereport.md new file mode 100644 index 0000000000..9a44f54d72 --- /dev/null +++ b/windows.system.diagnostics/systemcpuusagereport.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Diagnostics.SystemCpuUsageReport +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.SystemCpuUsageReport + +## -description +Provides data about the CPU usage of the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemcpuusagereport_idletime.md b/windows.system.diagnostics/systemcpuusagereport_idletime.md new file mode 100644 index 0000000000..d333c0410b --- /dev/null +++ b/windows.system.diagnostics/systemcpuusagereport_idletime.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemCpuUsageReport.IdleTime +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemCpuUsageReport.IdleTime + +## -description +Gets the amount of time the CPU was idle. + +## -property-value +The amount of time the CPU was idle. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemcpuusagereport_kerneltime.md b/windows.system.diagnostics/systemcpuusagereport_kerneltime.md new file mode 100644 index 0000000000..a41874b6bc --- /dev/null +++ b/windows.system.diagnostics/systemcpuusagereport_kerneltime.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemCpuUsageReport.KernelTime +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemCpuUsageReport.KernelTime + +## -description +Gets the amount of CPU kernel time consumed by the system. + +## -property-value +The amount of CPU kernel time consumed by the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemcpuusagereport_usertime.md b/windows.system.diagnostics/systemcpuusagereport_usertime.md new file mode 100644 index 0000000000..bf1de34363 --- /dev/null +++ b/windows.system.diagnostics/systemcpuusagereport_usertime.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemCpuUsageReport.UserTime +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemCpuUsageReport.UserTime + +## -description +Gets the amount of CPU user time consumed by the system. + +## -property-value +The amount of CPU user time consumed by the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemdiagnosticinfo.md b/windows.system.diagnostics/systemdiagnosticinfo.md new file mode 100644 index 0000000000..41d2f16322 --- /dev/null +++ b/windows.system.diagnostics/systemdiagnosticinfo.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Diagnostics.SystemDiagnosticInfo +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.SystemDiagnosticInfo + +## -description +Provides diagnostic information about the system, such as CPU usage, disk usage, memory usage and so on. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemdiagnosticinfo_cpuusage.md b/windows.system.diagnostics/systemdiagnosticinfo_cpuusage.md new file mode 100644 index 0000000000..1fa61bc9f7 --- /dev/null +++ b/windows.system.diagnostics/systemdiagnosticinfo_cpuusage.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemDiagnosticInfo.CpuUsage +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemDiagnosticInfo.CpuUsage + +## -description +Gets the CPU time used by the system. + +## -property-value +The CPU time used by the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemdiagnosticinfo_getforcurrentsystem_985727303.md b/windows.system.diagnostics/systemdiagnosticinfo_getforcurrentsystem_985727303.md new file mode 100644 index 0000000000..7b298455a2 --- /dev/null +++ b/windows.system.diagnostics/systemdiagnosticinfo_getforcurrentsystem_985727303.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.Diagnostics.SystemDiagnosticInfo.GetForCurrentSystem +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.SystemDiagnosticInfo.GetForCurrentSystem + +## -description +Gets the [SystemDiagnosticInfo](systemdiagnosticinfo.md) for the current system. + +## -parameters + +## -returns +The [SystemDiagnosticInfo](systemdiagnosticinfo.md) for the current system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemdiagnosticinfo_memoryusage.md b/windows.system.diagnostics/systemdiagnosticinfo_memoryusage.md new file mode 100644 index 0000000000..d63c237f1c --- /dev/null +++ b/windows.system.diagnostics/systemdiagnosticinfo_memoryusage.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemDiagnosticInfo.MemoryUsage +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemDiagnosticInfo.MemoryUsage + +## -description +Gets memory usage data for the system. + +## -property-value +Memory usage data for the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemmemoryusage.md b/windows.system.diagnostics/systemmemoryusage.md new file mode 100644 index 0000000000..684c96de73 --- /dev/null +++ b/windows.system.diagnostics/systemmemoryusage.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.Diagnostics.SystemMemoryUsage +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.SystemMemoryUsage + +## -description +Provides access to data about the memory usage of the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemmemoryusage_getreport_610268658.md b/windows.system.diagnostics/systemmemoryusage_getreport_610268658.md new file mode 100644 index 0000000000..9a6f3b5853 --- /dev/null +++ b/windows.system.diagnostics/systemmemoryusage_getreport_610268658.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.Diagnostics.SystemMemoryUsage.GetReport +-api-type: winrt method +--- + + + +# Windows.System.Diagnostics.SystemMemoryUsage.GetReport + +## -description +Gets the memory usage report for the system. + +## -parameters + +## -returns +The [SystemMemoryUsageReport](systemmemoryusagereport.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemmemoryusagereport.md b/windows.system.diagnostics/systemmemoryusagereport.md new file mode 100644 index 0000000000..cfc064d385 --- /dev/null +++ b/windows.system.diagnostics/systemmemoryusagereport.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.Diagnostics.SystemMemoryUsageReport +-api-type: winrt class +--- + + + +# Windows.System.Diagnostics.SystemMemoryUsageReport + +## -description +Provides data about the memory usage of the system. + +## -remarks +Call [SystemMemoryUsage.GetReport](systemmemoryusage_getreport_610268658.md) to get an instance of this class. + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemmemoryusagereport_availablesizeinbytes.md b/windows.system.diagnostics/systemmemoryusagereport_availablesizeinbytes.md new file mode 100644 index 0000000000..014a3bb5a9 --- /dev/null +++ b/windows.system.diagnostics/systemmemoryusagereport_availablesizeinbytes.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemMemoryUsageReport.AvailableSizeInBytes +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemMemoryUsageReport.AvailableSizeInBytes + +## -description +Gets the amount of system memory available in bytes. + +## -property-value +The amount of system memory available in bytes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemmemoryusagereport_committedsizeinbytes.md b/windows.system.diagnostics/systemmemoryusagereport_committedsizeinbytes.md new file mode 100644 index 0000000000..7b7dc5a4d6 --- /dev/null +++ b/windows.system.diagnostics/systemmemoryusagereport_committedsizeinbytes.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemMemoryUsageReport.CommittedSizeInBytes +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemMemoryUsageReport.CommittedSizeInBytes + +## -description +Gets the amount of committed memory for the system. + +## -property-value +The amount of committed memory for the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.diagnostics/systemmemoryusagereport_totalphysicalsizeinbytes.md b/windows.system.diagnostics/systemmemoryusagereport_totalphysicalsizeinbytes.md new file mode 100644 index 0000000000..015e7cf0c4 --- /dev/null +++ b/windows.system.diagnostics/systemmemoryusagereport_totalphysicalsizeinbytes.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.Diagnostics.SystemMemoryUsageReport.TotalPhysicalSizeInBytes +-api-type: winrt property +--- + + + +# Windows.System.Diagnostics.SystemMemoryUsageReport.TotalPhysicalSizeInBytes + +## -description +Get the total amount of physical memory for the system. + +## -property-value +The total amount of physical memory for the system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.profile/analyticsinfo_deviceform.md b/windows.system.profile/analyticsinfo_deviceform.md index 01844b4a78..bd1c1f8dc9 100644 --- a/windows.system.profile/analyticsinfo_deviceform.md +++ b/windows.system.profile/analyticsinfo_deviceform.md @@ -20,4 +20,4 @@ The device form factor. ## -examples ## -see-also -[DeviceForm](XREF:TODO:p_unattend.microsoft_windows_deployment_deviceform) \ No newline at end of file +[DeviceForm](https://msdn.microsoft.com/windows/hardware/commercialize/customize/desktop/unattend/microsoft-windows-deployment-deviceform) \ No newline at end of file diff --git a/windows.system.profile/educationsettings.md b/windows.system.profile/educationsettings.md new file mode 100644 index 0000000000..e8368ac010 --- /dev/null +++ b/windows.system.profile/educationsettings.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.System.Profile.EducationSettings +-api-type: winrt class +--- + + + +# Windows.System.Profile.EducationSettings + +## -description +Indicates if an app is running in an education environment. + +## -remarks +Examples of changes you might make in an education environment: + +- Simplify the user interface +- Do not collect data or personally identifiable information (PII). +- Change default content + +## -see-also + +## -examples diff --git a/windows.system.profile/educationsettings_iseducationenvironment.md b/windows.system.profile/educationsettings_iseducationenvironment.md new file mode 100644 index 0000000000..bd916f1dfa --- /dev/null +++ b/windows.system.profile/educationsettings_iseducationenvironment.md @@ -0,0 +1,39 @@ +--- +-api-id: P:Windows.System.Profile.EducationSettings.IsEducationEnvironment +-api-type: winrt property +--- + + + +# Windows.System.Profile.EducationSettings.IsEducationEnvironment + +## -description +Gets a Boolean value indicating if the app is running in an education environment. + +## -property-value +A Boolean value indicating if the app is running in an education environment. + +## -remarks +Returns **true** when running an Education SKU (Pro Education or Education). + +Returns **true** when the [SetEduPolicies](https://msdn.microsoft.com/en-us/windows/hardware/commercialize/customize/mdm/sharedpc-csp) policy is set. + +Always returns **false** on the Home SKU. + +A **true** value means the PC is running in an education environment (set either by the SKU or by the IT admin) and sets policies and behaviors to make Windows education ready. + +## -see-also + +## -examples +``` cs +if (Windows.System.Profile.EducationSettings.IsEducationEnvironment) +{ + SetHomePage("about:EDU"); +} +else +{ + SetHomePage("about:start"); +} +``` diff --git a/windows.system.profile/knownretailinfoproperties.md b/windows.system.profile/knownretailinfoproperties.md index 865dd954b2..afee5a76e6 100644 --- a/windows.system.profile/knownretailinfoproperties.md +++ b/windows.system.profile/knownretailinfoproperties.md @@ -13,7 +13,7 @@ public class KnownRetailInfoProperties Identifies the string keys that might exist within the [RetailInfo.Properties](retailinfo_properties.md) map of retail-demo relevant property values. ## -remarks -All members of [KnownRetailInfoProperties](knownretailinfoproperties.md) are static string properties where the base API name and the value of the string match exactly. The intention of this type is to use the members as the string source when you use the generic [IMapView](../windows.foundation.collections/imapview_2.md) or [IReadOnlyDictionary](XREF:TODO:T:System.Collections.Generic.IReadOnlyDictionary`2) APIs that access the [RetailInfo.Properties](retailinfo_properties.md) items by string key, so that you're asking for properties that typically exist. +All members of [KnownRetailInfoProperties](knownretailinfoproperties.md) are static string properties where the base API name and the value of the string match exactly. The intention of this type is to use the members as the string source when you use the generic [IMapView](../windows.foundation.collections/imapview_2.md) or [IReadOnlyDictionary](https://msdn.microsoft.com/library/hh136548) APIs that access the [RetailInfo.Properties](retailinfo_properties.md) items by string key, so that you're asking for properties that typically exist. ## -examples diff --git a/windows.system.profile/retailinfo_properties.md b/windows.system.profile/retailinfo_properties.md index ad2e0cbb6f..ffa150e0cb 100644 --- a/windows.system.profile/retailinfo_properties.md +++ b/windows.system.profile/retailinfo_properties.md @@ -23,8 +23,8 @@ If [IsDemoModeEnabled](retailinfo_isdemomodeenabled.md) is **false**, [Propertie Once you have a valid collection, this collection is a map/dictionary where each property is identified by a property name. These property names are predefined, and each known property name is represented by a static string property of the [KnownRetailInfoProperties](knownretailinfoproperties.md) class. So whenever you attempt to get a specific property, use a [KnownRetailInfoProperties](knownretailinfoproperties.md) property to supply the string key value, rather than hard-coded strings. That will assure you aren't asking for values that don't exist in the collection. The collection is represented by a different interface/object depending on which programming language you are using. -+ If you're using .NET code, the collection is an [IReadOnlyDictionary](XREF:TODO:T:System.Collections.Generic.IReadOnlyDictionary`2) instance, with string keys and nominally untyped ([Object](https://msdn.microsoft.com/library/system.object.aspx)) values. Use the [Item](XREF:TODO:P:System.Collections.Generic.IReadOnlyDictionary`2.Item(`0)) indexer or [TryGetValue](XREF:TODO:M:System.Collections.Generic.IReadOnlyDictionary`2.TryGetValue(`0,`1@)) to get the values of specific properties. Always use [KnownRetailInfoProperties](knownretailinfoproperties.md) properties to specify the *key* parameters. -+ If you're using C++/CX, the collection is an [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md) instance, which can be used as [Platform::Collections::MapView](XREF:TODO:9577dde7-f599-43c6-b1e4-7d653706fd62). It has string keys and nominally untyped ([Platform::Object](XREF:TODO:709e84a8-0bff-471b-bc14-63e424080b5a)) values. Use **Lookup** to get the values of specific properties. Always use [KnownRetailInfoProperties](knownretailinfoproperties.md) properties to specify the *key* parameters. ++ If you're using .NET code, the collection is an [IReadOnlyDictionary](https://msdn.microsoft.com/library/hh136548) instance, with string keys and nominally untyped ([Object](https://msdn.microsoft.com/library/system.object.aspx)) values. Use the [Item](https://msdn.microsoft.com/library/hh136396) indexer or [TryGetValue](https://msdn.microsoft.com/library/hh192400) to get the values of specific properties. Always use [KnownRetailInfoProperties](knownretailinfoproperties.md) properties to specify the *key* parameters. ++ If you're using C++/CX, the collection is an [IMapView(String, Object)](../windows.foundation.collections/imapview_2.md) instance, which can be used as [Platform::Collections::MapView](http://msdn.microsoft.com/library/9577dde7-f599-43c6-b1e4-7d653706fd62). It has string keys and nominally untyped ([Platform::Object](http://msdn.microsoft.com/library/709e84a8-0bff-471b-bc14-63e424080b5a)) values. Use **Lookup** to get the values of specific properties. Always use [KnownRetailInfoProperties](knownretailinfoproperties.md) properties to specify the *key* parameters. + If you're using JavaScript, the object represents [IMapView](../windows.foundation.collections/imapview_2.md) API with string keys and untyped values. Use [Lookup](../windows.foundation.collections/imapview_2_lookup.md) to get the values of specific properties. diff --git a/windows.system.profile/sharedmodesettings.md b/windows.system.profile/sharedmodesettings.md index f33258609b..959a82f792 100644 --- a/windows.system.profile/sharedmodesettings.md +++ b/windows.system.profile/sharedmodesettings.md @@ -13,7 +13,8 @@ public class SharedModeSettings Provides access to the settings for shared mode. For example, devices with large screens could support communal shared apps. ## -remarks - + For more info on when **SharedModeSettings** is used on Desktop, see [Set up a shared or guest PC with Windows 10](https://technet.microsoft.com/en-us/itpro/windows/manage/set-up-shared-or-guest-pc). + ## -examples ## -see-also diff --git a/windows.system.profile/sharedmodesettings_isenabled.md b/windows.system.profile/sharedmodesettings_isenabled.md index 2a06a39e3d..4677ab0807 100644 --- a/windows.system.profile/sharedmodesettings_isenabled.md +++ b/windows.system.profile/sharedmodesettings_isenabled.md @@ -16,7 +16,21 @@ Gets a Boolean value that indicates if shared mode is currently enabled. A Boolean value that indicates if shared mode is currently enabled. ## -remarks +Returns **true** when the [EnableSharedPCMode](https://msdn.microsoft.com/en-us/windows/hardware/commercialize/customize/mdm/sharedpc-csp) policy is set. + +Returns **true** when running on a Surface Hub. + +Examples of changes you might make in an education environment: + - Not launch the first-run experience + +A **true** value means the PC is running in scenarios where multiple consecutive users use the PC. These user accounts may be deleted, which means that users may have a new account created each time they use the same device. ## -examples +``` cs +if (!Windows.System.Profile.SharedModeSettings.IsEnabled) +{ + LaunchWelcomeExperience(); +} +``` ## -see-also diff --git a/windows.system.profile/sharedmodesettings_shouldavoidlocalstorage.md b/windows.system.profile/sharedmodesettings_shouldavoidlocalstorage.md new file mode 100644 index 0000000000..2f5d2775a0 --- /dev/null +++ b/windows.system.profile/sharedmodesettings_shouldavoidlocalstorage.md @@ -0,0 +1,44 @@ +--- +-api-id: P:Windows.System.Profile.SharedModeSettings.ShouldAvoidLocalStorage +-api-type: winrt property +--- + + + +# Windows.System.Profile.SharedModeSettings.ShouldAvoidLocalStorage + +## -description +Gets a Boolean value indicating that your app should not store files on the local hard drive. + +## -property-value +A Boolean value indicating that apps should not store files on the local hard drive. Instead, files should be saved to cloud storage. + +## -remarks +If **true**, then your app should not show local storage locations in its UI. + +Returns **true** when the [RestrictLocalStorage](https://msdn.microsoft.com/en-us/windows/hardware/commercialize/customize/mdm/sharedpc-csp) policy is set. + +A **true** value means the PC is running in a scenario where apps should hide all entry and save points to the local disk. Windows File Explorer is disabled so customers won’t be able to navigate to any local storage (except downloads, removable drives, and mapped network drives) to access those files. + + +## -see-also + +## -examples +``` xml + + + + +``` + +``` cs +protected override void OnNavigatedTo(NavigationEventArgs e) +{ + if (Windows.System.Profile.SharedModeSettings.ShouldAvoidLocalStorage) + { + ThisPC.Visibility = Visibility.Collapsed; + } +} +``` diff --git a/windows.system.remotesystems/knownremotesystemcapabilities.md b/windows.system.remotesystems/knownremotesystemcapabilities.md new file mode 100644 index 0000000000..7762d712f4 --- /dev/null +++ b/windows.system.remotesystems/knownremotesystemcapabilities.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.KnownRemoteSystemCapabilities +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.KnownRemoteSystemCapabilities + +## -description +Contains the string names of different features of the Remote Systems platform. A remote system is either compatible or incompatible with each of the capabilities corresponding to the properties of this class. + +## -remarks +The [**RemoteSystem.getCapabilitySupportedAsync**](remotesystem_getcapabilitysupportedasync_1130940389.md) method uses this class' property values to query for feature support on specific remote systems. +## -see-also +[**RemoteSystem**](remotesystem.md) + +## -examples + diff --git a/windows.system.remotesystems/knownremotesystemcapabilities_appservice.md b/windows.system.remotesystems/knownremotesystemcapabilities_appservice.md new file mode 100644 index 0000000000..a879b64c7a --- /dev/null +++ b/windows.system.remotesystems/knownremotesystemcapabilities_appservice.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.AppService +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.AppService + +## -description +Gets the canonical string name of the app service capability. + +## -property-value +The canonical string name of the app service capability. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/knownremotesystemcapabilities_launchuri.md b/windows.system.remotesystems/knownremotesystemcapabilities_launchuri.md new file mode 100644 index 0000000000..61badb4146 --- /dev/null +++ b/windows.system.remotesystems/knownremotesystemcapabilities_launchuri.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.LaunchUri +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.LaunchUri + +## -description +Gets the canonical string name of the launch URI capability. + +## -property-value +The canonical string name of the launch URI capability. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/knownremotesystemcapabilities_remotesession.md b/windows.system.remotesystems/knownremotesystemcapabilities_remotesession.md new file mode 100644 index 0000000000..596bcf8183 --- /dev/null +++ b/windows.system.remotesystems/knownremotesystemcapabilities_remotesession.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.RemoteSession +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.RemoteSession + +## -description +Gets the canonical string name of the remote session capability. + +## -property-value +The canonical string name of the remote session capability. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/knownremotesystemcapabilities_spatialentity.md b/windows.system.remotesystems/knownremotesystemcapabilities_spatialentity.md new file mode 100644 index 0000000000..51d390b466 --- /dev/null +++ b/windows.system.remotesystems/knownremotesystemcapabilities_spatialentity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.SpatialEntity +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.KnownRemoteSystemCapabilities.SpatialEntity + +## -description +Gets the canonical string name of the spatial entity capability. + +## -property-value +The canonical string name of the spatial entity capability. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystem.md b/windows.system.remotesystems/remotesystem.md index 59fc0cd03f..7460608057 100644 --- a/windows.system.remotesystems/remotesystem.md +++ b/windows.system.remotesystems/remotesystem.md @@ -10,7 +10,7 @@ public class RemoteSystem : Windows.System.RemoteSystems.IRemoteSystem, Windows. # Windows.System.RemoteSystems.RemoteSystem ## -description -This class manages the attributes of a discovered remote system (device) and provides the capabilities to discover remote systems as part of Project "Rome". +This class manages the attributes of a discovered remote system (device) and provides the capabilities to discover remote systems as part of Project Rome. ## -remarks This class is instantiated whenever a remote system (device) is discovered, is updated, or disappears (the instance is referenced as a property of the [RemoteSystemAddedEventArgs](remotesystemaddedeventargs.md), [RemoteSystemUpdatedEventArgs](remotesystemupdatedeventargs.md), or [RemoteSystemRemovedEventArgs](remotesystemremovedeventargs.md) class). @@ -20,7 +20,7 @@ The properties of the [RemoteSystem](remotesystem.md) class are used to determin ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystem_displayname.md b/windows.system.remotesystems/remotesystem_displayname.md index 4fde5c439c..2114476516 100644 --- a/windows.system.remotesystems/remotesystem_displayname.md +++ b/windows.system.remotesystems/remotesystem_displayname.md @@ -10,7 +10,7 @@ public string DisplayName { get; } # Windows.System.RemoteSystems.RemoteSystem.DisplayName ## -description -Gets the "friendly" name of the given remote system. +Gets the machine name of the given remote system. ## -property-value The name of the given remote system. diff --git a/windows.system.remotesystems/remotesystem_getcapabilitysupportedasync_1130940389.md b/windows.system.remotesystems/remotesystem_getcapabilitysupportedasync_1130940389.md new file mode 100644 index 0000000000..1d5a8804e9 --- /dev/null +++ b/windows.system.remotesystems/remotesystem_getcapabilitysupportedasync_1130940389.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystem.GetCapabilitySupportedAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystem.GetCapabilitySupportedAsync + +## -description +Reports whether the **RemoteSystem** is capable of the given Remote System feature. + +## -parameters + +### -param capabilityName +The Remote System capability to check. This should be the value of one of the properties of [**KnownRemoteSystemCapabilities**](KnownRemoteSystemCapabilities.md). + +## -returns +An asynchronous operation with a value of **true** if the **RemoteSystem** is capable, otherwise **false**. + +## -remarks + +## -see-also + +## -examples +TBD2 + diff --git a/windows.system.remotesystems/remotesystem_isauthorizationkindenabled_756735636.md b/windows.system.remotesystems/remotesystem_isauthorizationkindenabled_756735636.md new file mode 100644 index 0000000000..002c88172f --- /dev/null +++ b/windows.system.remotesystems/remotesystem_isauthorizationkindenabled_756735636.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystem.IsAuthorizationKindEnabled(Windows.System.RemoteSystems.RemoteSystemAuthorizationKind) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystem.IsAuthorizationKindEnabled + +## -description +Checks whether the client device is authorized to discover other users' devices or just same-user devices. + +## -parameters + +### -param kind +The [**RemoteSystemAuthorizationKind**](remotesystemauthorizationkind.md) to check. + +## -returns +Returns **true** if the client device is set to *kind* authorization scheme, otherwise **false**. + +## -remarks +This authorization is a system-wide setting. The user can view and change it by going to Settings > System > Shared experiences. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystem_isavailablebyproximity.md b/windows.system.remotesystems/remotesystem_isavailablebyproximity.md index 06d369645b..acab9603e7 100644 --- a/windows.system.remotesystems/remotesystem_isavailablebyproximity.md +++ b/windows.system.remotesystems/remotesystem_isavailablebyproximity.md @@ -10,10 +10,10 @@ public bool IsAvailableByProximity { get; } # Windows.System.RemoteSystems.RemoteSystem.IsAvailableByProximity ## -description -Gets whether the given remote system is available for connection by proximity (such as a Bluetooth or local network connection) as opposed to cloud connection. +Checks whether the given remote system is available through proximal connection (such as a Bluetooth or local network connection) as opposed to cloud connection. ## -property-value -**True** if the given remote system is available by proximity connection, **False** otherwise. +**True** if the given remote system is available by proximal connection, **False** otherwise. ## -remarks diff --git a/windows.system.remotesystems/remotesystem_isavailablebyspatialproximity.md b/windows.system.remotesystems/remotesystem_isavailablebyspatialproximity.md new file mode 100644 index 0000000000..1c299eeb75 --- /dev/null +++ b/windows.system.remotesystems/remotesystem_isavailablebyspatialproximity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystem.IsAvailableBySpatialProximity +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystem.IsAvailableBySpatialProximity + +## -description +Checks whether the given remote system is available through spatially proximal connection. + +## -property-value +**true** if the given remote system is available by spatially proximal connection, **false** otherwise. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemaccessstatus.md b/windows.system.remotesystems/remotesystemaccessstatus.md index 58615c9ca4..f580a359cb 100644 --- a/windows.system.remotesystems/remotesystemaccessstatus.md +++ b/windows.system.remotesystems/remotesystemaccessstatus.md @@ -31,7 +31,7 @@ Access is denied to this app by the System; the app hasn't requested the proper ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemauthorizationkind.md b/windows.system.remotesystems/remotesystemauthorizationkind.md new file mode 100644 index 0000000000..5056f70010 --- /dev/null +++ b/windows.system.remotesystems/remotesystemauthorizationkind.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemAuthorizationKind +-api-type: winrt enum +--- + + + +# Windows.System.RemoteSystems.RemoteSystemAuthorizationKind + +## -description +Contains values specifying whether the client device can discover only same-user devices or other users' devices as well. Cross-user devices must be available through a proximal connection in order to be discovered (see [**RemoteSystemDiscoveryType**](remotesystemdiscoverytype.md) for details). + +## -enum-fields +### -field SameUser:0 +The client device can only discover devices signed in by the same user or nearby communal devices such as the Surface Hub and Xbox One. + +### -field Anonymous:1 +The client device can discover other users' devices, provided they are available for proximal connection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemauthorizationkindfilter.md b/windows.system.remotesystems/remotesystemauthorizationkindfilter.md new file mode 100644 index 0000000000..77b612e117 --- /dev/null +++ b/windows.system.remotesystems/remotesystemauthorizationkindfilter.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemAuthorizationKindFilter +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemAuthorizationKindFilter + +## -description +An [IRemoteSystemFilter](iremotesystemfilter.md) that alters the set of discoverable remote systems by allowing those of a specific authorization kind. + +## -remarks +In order to discover cross-user devices, the client device must both use the appropriate filter *and* be set to allow sharing with anonymous devices. Check this system-wide setting with the [**RemoteSystem.isAuthorizationKindEnabled**](RemoteSystem_isAuthorizationKindEnabled_756735636.md) method. If the client device is not set to allow anonymous sharing, prompt the user to change this setting in Settings > System > Shared experiences. + +## -see-also +[IRemoteSystemFilter](iremotesystemfilter.md) + +## -examples + diff --git a/windows.system.remotesystems/remotesystemauthorizationkindfilter_remotesystemauthorizationkind.md b/windows.system.remotesystems/remotesystemauthorizationkindfilter_remotesystemauthorizationkind.md new file mode 100644 index 0000000000..c3a135df27 --- /dev/null +++ b/windows.system.remotesystems/remotesystemauthorizationkindfilter_remotesystemauthorizationkind.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemAuthorizationKindFilter.RemoteSystemAuthorizationKind +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemAuthorizationKindFilter.RemoteSystemAuthorizationKind + +## -description +The authorization kind setting that the containing [RemoteSystemAuthorizationKindFilter](RemoteSystemAuthorizationKindFilter.md) object targets. + + +## -property-value +The authorization kind to target. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemauthorizationkindfilter_remotesystemauthorizationkindfilter_1755845286.md b/windows.system.remotesystems/remotesystemauthorizationkindfilter_remotesystemauthorizationkindfilter_1755845286.md new file mode 100644 index 0000000000..409f82177a --- /dev/null +++ b/windows.system.remotesystems/remotesystemauthorizationkindfilter_remotesystemauthorizationkindfilter_1755845286.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemAuthorizationKindFilter.#ctor(Windows.System.RemoteSystems.RemoteSystemAuthorizationKind) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemAuthorizationKindFilter.RemoteSystemAuthorizationKindFilter + +## -description +Initializes an instance of the [RemoteSystemAuthorizationKindFilter](RemoteSystemAuthorizationKindFilter.md) class. + +## -parameters + +### -param remoteSystemAuthorizationKind +The authorization kind to target. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemconnectionrequest.md b/windows.system.remotesystems/remotesystemconnectionrequest.md index 81545a9200..b58a151ed1 100644 --- a/windows.system.remotesystems/remotesystemconnectionrequest.md +++ b/windows.system.remotesystems/remotesystemconnectionrequest.md @@ -13,12 +13,12 @@ public class RemoteSystemConnectionRequest : Windows.System.RemoteSystems.IRemot Represents an intent to communicate with a specific remote system (device). ## -remarks -An instance of this class is constructed from a given [RemoteSystem](remotesystem.md) object. All of the remote system features, such as remote launch or remote app service connection, require the use of a object to determine which system (device) to connect to. +An instance of this class is constructed from a given [RemoteSystem](remotesystem.md) object. All of the remote system features, such as remote launch or remote app service connection, require the use of this object to determine which system (device) to connect to. ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemconnectionrequest_remotesystem.md b/windows.system.remotesystems/remotesystemconnectionrequest_remotesystem.md index 88a671c425..a47ad1d106 100644 --- a/windows.system.remotesystems/remotesystemconnectionrequest_remotesystem.md +++ b/windows.system.remotesystems/remotesystemconnectionrequest_remotesystem.md @@ -21,6 +21,5 @@ The remote system to communicate with. ## -see-also - ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemdiscoverytype.md b/windows.system.remotesystems/remotesystemdiscoverytype.md index d5cd25bb34..92eec65e5f 100644 --- a/windows.system.remotesystems/remotesystemdiscoverytype.md +++ b/windows.system.remotesystems/remotesystemdiscoverytype.md @@ -22,13 +22,16 @@ The remote system is only discoverable through a proximal connection, such as a ### -field Cloud:2 The remote system is only discoverable through cloud connection. +### -field SpatiallyProximal:3 +The remote system is discoverable through a proximal connection and is expected to be spatially near to the client device. + ## -remarks ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities -remoteSystem \ No newline at end of file +remoteSystem diff --git a/windows.system.remotesystems/remotesystemdiscoverytypefilter.md b/windows.system.remotesystems/remotesystemdiscoverytypefilter.md index edf7deba7c..cf25cdb304 100644 --- a/windows.system.remotesystems/remotesystemdiscoverytypefilter.md +++ b/windows.system.remotesystems/remotesystemdiscoverytypefilter.md @@ -17,7 +17,7 @@ An [IRemoteSystemFilter](iremotesystemfilter.md) that limits the set of discover ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices), [IRemoteSystemFilter](iremotesystemfilter.md) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices), [IRemoteSystemFilter](iremotesystemfilter.md) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemkindfilter.md b/windows.system.remotesystems/remotesystemkindfilter.md index af77d546b3..e0644d9b6a 100644 --- a/windows.system.remotesystems/remotesystemkindfilter.md +++ b/windows.system.remotesystems/remotesystemkindfilter.md @@ -17,7 +17,7 @@ An [IRemoteSystemFilter](iremotesystemfilter.md) that limits the set of discover ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices), [IRemoteSystemFilter](iremotesystemfilter.md) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices), [IRemoteSystemFilter](iremotesystemfilter.md) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemkinds.md b/windows.system.remotesystems/remotesystemkinds.md index f3b65613a9..a57eebdc01 100644 --- a/windows.system.remotesystems/remotesystemkinds.md +++ b/windows.system.remotesystems/remotesystemkinds.md @@ -17,7 +17,7 @@ Contains read-only strings that identify various device types. ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemremovedeventargs.md b/windows.system.remotesystems/remotesystemremovedeventargs.md index 3c1bbb14c5..35f5ff3643 100644 --- a/windows.system.remotesystems/remotesystemremovedeventargs.md +++ b/windows.system.remotesystems/remotesystemremovedeventargs.md @@ -18,7 +18,7 @@ This class is instantiated whenever the [RemoteSystemRemoved](remotesystemwatche ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemsession.md b/windows.system.remotesystems/remotesystemsession.md new file mode 100644 index 0000000000..f909c4ff7c --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSession +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession + +## -description +Represents and handles a remote session that can be shared between two or more connected devices. See Remarks for information on this feature. + +## -remarks +Remote System Sessions is a part of the broader Remote Systems feature set. It allows an app to establish a session object as an intermediate third party that two or more devices can continually communicate through, enabling a number of new cross-device scenarios such as remote app messaging. + +A session that has been joined is represented by a [**RemoteSystemSession**](RemoteSystemSession.md) object. A session that is known about but has not been joined is represented by a [**RemoteSystemSessionInfo**](RemoteSystemSessionInfo.md) object. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_close_811482585.md b/windows.system.remotesystems/remotesystemsession_close_811482585.md new file mode 100644 index 0000000000..e625b9d6f2 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_close_811482585.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSession.Close +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.Close + +## -description +Closes the session, disconnecting all participants. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_controllerdisplayname.md b/windows.system.remotesystems/remotesystemsession_controllerdisplayname.md new file mode 100644 index 0000000000..0514137fd7 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_controllerdisplayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSession.ControllerDisplayName +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.ControllerDisplayName + +## -description +Gets the machine name of the device that is the controller of this remote session. + +## -property-value +The machine name of the controller device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_createparticipantwatcher_1904561387.md b/windows.system.remotesystems/remotesystemsession_createparticipantwatcher_1904561387.md new file mode 100644 index 0000000000..573ef01b76 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_createparticipantwatcher_1904561387.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSession.CreateParticipantWatcher +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.CreateParticipantWatcher + +## -description +Initializes a [**RemoteSystemSessionParticipantWatcher**](RemoteSystemSessionParticipantWatcher.md) to monitor the participants of this remote session. + +## -returns +A [**RemoteSystemSessionParticipantWatcher**](RemoteSystemSessionParticipantWatcher.md) for this session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_createwatcher_1506431823.md b/windows.system.remotesystems/remotesystemsession_createwatcher_1506431823.md new file mode 100644 index 0000000000..1759698080 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_createwatcher_1506431823.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSession.CreateWatcher +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.CreateWatcher + +## -description +Initializes and returns a [**RemoteSystemSessionWatcher**](remotesystemsessionwatcher.md) object to monitor the presence of remote sessions. + +## -returns +A watcher object to be used in discovering remote sessions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_disconnected.md b/windows.system.remotesystems/remotesystemsession_disconnected.md new file mode 100644 index 0000000000..92b2719922 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_disconnected.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSession.Disconnected +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.Disconnected + +## -description +Raised when this device has been disconnected from this remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_displayname.md b/windows.system.remotesystems/remotesystemsession_displayname.md new file mode 100644 index 0000000000..08bf10993b --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_displayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSession.DisplayName +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.DisplayName + +## -description +Gets the public-facing name for this remote session, given by the controller of the session. + +## -property-value +The display name for this session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_id.md b/windows.system.remotesystems/remotesystemsession_id.md new file mode 100644 index 0000000000..9ac8806a37 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_id.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSession.Id +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.Id + +## -description +Gets the unique identifier for this remote session. + +## -property-value +An id string unique to this session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsession_sendinvitationasync_1664759118.md b/windows.system.remotesystems/remotesystemsession_sendinvitationasync_1664759118.md new file mode 100644 index 0000000000..e0997f60ca --- /dev/null +++ b/windows.system.remotesystems/remotesystemsession_sendinvitationasync_1664759118.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSession.SendInvitationAsync(Windows.System.RemoteSystems.RemoteSystem) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSession.SendInvitationAsync + +## -description +Invites a given remote device to join this remote session. + +## -parameters + +### -param invitee +The RemoteSystem object representing the system to which this invitation is being sent. + +## -returns +An asynchronous operation with a boolean value: **true** if the invitation was sent successfully, otherwise **false**. + +## -remarks +The device receiving an invitation will need to use a [**RemoteSystemSessionInvitationListener**](RemoteSystemSessionInvitationListener.md) to handle it. See the code example below for the full invitation handling workflow: +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionaddedeventargs.md b/windows.system.remotesystems/remotesystemsessionaddedeventargs.md new file mode 100644 index 0000000000..0c2691de43 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionaddedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionAddedEventArgs + +## -description +Contains information about a [**RemoteSystemSessionWatcher.Added**](RemoteSystemSessionWatcher_added.md) event. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionWatcher.Added**](RemoteSystemSessionWatcher_Added.md) event is raised, and its contents should be handled by the method(s) registered to this event. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionaddedeventargs_sessioninfo.md b/windows.system.remotesystems/remotesystemsessionaddedeventargs_sessioninfo.md new file mode 100644 index 0000000000..dd5c8b8b49 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionaddedeventargs_sessioninfo.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionAddedEventArgs.SessionInfo +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionAddedEventArgs.SessionInfo + +## -description +Gets information about the remote session that has been discovered. + +## -property-value +A [**RemoteSystemSessionInfo**](RemoteSystemSessionInfo.md) object corresponding to the newly discovered remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncontroller.md b/windows.system.remotesystems/remotesystemsessioncontroller.md new file mode 100644 index 0000000000..d6a7b3e756 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncontroller.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionController +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionController + +## -description +Handles the creation and management of a new remote session for other devices to join. + +## -remarks +Every remote session has one participant that is the session's controller. Only the controller can specify options for the session and remove participants from the session. + + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncontroller_createsessionasync_1379655332.md b/windows.system.remotesystems/remotesystemsessioncontroller_createsessionasync_1379655332.md new file mode 100644 index 0000000000..d67d42e534 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncontroller_createsessionasync_1379655332.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionController.CreateSessionAsync +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionController.CreateSessionAsync + +## -description +Asynchronously attempts to create a remote session. + +## -returns +An asynchronous operation with a [**RemoteSystemSessionCreationResult**](RemoteSystemSessionCreationResult.md) object describing the result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncontroller_joinrequested.md b/windows.system.remotesystems/remotesystemsessioncontroller_joinrequested.md new file mode 100644 index 0000000000..b941999a32 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncontroller_joinrequested.md @@ -0,0 +1,23 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionController.JoinRequested +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionController.JoinRequested + +## -description +Raised whenever another device has discovered and requested access to the remote session managed by this [**RemoteSystemSessionController**](RemoteSystemSessionController.md). + +## -remarks +See the code example below for the full process of handling a join request. +TBD2 + + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncontroller_remotesystemsessioncontroller_1384443124.md b/windows.system.remotesystems/remotesystemsessioncontroller_remotesystemsessioncontroller_1384443124.md new file mode 100644 index 0000000000..39e077f9d8 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncontroller_remotesystemsessioncontroller_1384443124.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionController.#ctor(System.String,Windows.System.RemoteSystems.RemoteSystemSessionOptions) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionController.RemoteSystemSessionController + +## -description +Initializes a [**RemoteSystemSessionController**](RemoteSystemSessionController.md) with a custom display name and specified options. + +## -parameters + +### -param displayName +The public-facing name for this remote session. It should be simple and descriptive. + +### -param options +The [**RemoteSystemSessionOptions**](RemoteSystemSessionOptions.md) object specifying additional options for this remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncontroller_remotesystemsessioncontroller_290278668.md b/windows.system.remotesystems/remotesystemsessioncontroller_remotesystemsessioncontroller_290278668.md new file mode 100644 index 0000000000..fbab9e6348 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncontroller_remotesystemsessioncontroller_290278668.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionController.#ctor(System.String) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionController.RemoteSystemSessionController + +## -description +Initializes a [**RemoteSystemSessionController**](RemoteSystemSessionController.md) with a custom display name. + +## -parameters + +### -param displayName +The public-facing name for this remote session. It should be simple and descriptive. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncontroller_removeparticipantasync_1776870069.md b/windows.system.remotesystems/remotesystemsessioncontroller_removeparticipantasync_1776870069.md new file mode 100644 index 0000000000..abc9345880 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncontroller_removeparticipantasync_1776870069.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionController.RemoveParticipantAsync(Windows.System.RemoteSystems.RemoteSystemSessionParticipant) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionController.RemoveParticipantAsync + +## -description +Removes a participant from the remote session. + +## -parameters + +### -param pParticipant +A [**RemoteSystemSessionParticipant**](RemoteSystemSessionParticipant.md) object corresponding to the participant being removed. + +## -returns +An asynchronous operation containing a boolean value: **true** if the removal operation was a success, otherwise **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncreationresult.md b/windows.system.remotesystems/remotesystemsessioncreationresult.md new file mode 100644 index 0000000000..d22aaa9b7e --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncreationresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionCreationResult +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionCreationResult + +## -description +Represents the result of an attempt by a [**RemoteSystemSessionController**](RemoteSystemSessionController.md) object to create a new remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncreationresult_session.md b/windows.system.remotesystems/remotesystemsessioncreationresult_session.md new file mode 100644 index 0000000000..1ade5f3d1c --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncreationresult_session.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionCreationResult.Session +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionCreationResult.Session + +## -description +Gets the [**RemoteSystemSession**](RemoteSystemSession.md) object related to this creation attempt. + +## -property-value +The [**RemoteSystemSession**](RemoteSystemSession.md) object representing the session that was created (if the attempt was successful). If the session was not created successfully, this value is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncreationresult_status.md b/windows.system.remotesystems/remotesystemsessioncreationresult_status.md new file mode 100644 index 0000000000..a0667f5901 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncreationresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionCreationResult.Status +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionCreationResult.Status + +## -description +Gets the status of a [**RemoteSystemSessionController**](RemoteSystemSessionController.md) object's attempt to create a remote session. + +## -property-value +A [**RemoteSystemSessionCreationStatus**](RemoteSystemSessionCreationStatus.md) value describing the result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioncreationstatus.md b/windows.system.remotesystems/remotesystemsessioncreationstatus.md new file mode 100644 index 0000000000..95791e52d1 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioncreationstatus.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionCreationStatus +-api-type: winrt enum +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionCreationStatus + +## -description +Describes the status of an attempt to create a remote session. + +## -enum-fields +### -field Success:0 +The remote session was created successfully. + +### -field SessionLimitsExceeded:1 +The remote session was not created because this device is already a participant in the maximum allowed number of sessions. + +### -field OperationAborted:2 +The creation attempt failed for an unknown reason. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs.md b/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs.md new file mode 100644 index 0000000000..12576d939e --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionDisconnectedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionDisconnectedEventArgs + +## -description +Contains information about a [**RemoteSystemSession.Disconnected**](RemoteSystemSession_Disconnected.md) event, namely the reason that this device was disconnected from the session. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSession.Disconnected**](RemoteSystemSession_Disconnected.md) event is raised, and it should be handled by the method(s) registered to this event. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs_reason.md b/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs_reason.md new file mode 100644 index 0000000000..f160f862ef --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessiondisconnectedeventargs_reason.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionDisconnectedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionDisconnectedEventArgs.Reason + +## -description +Gets the reason this device was disconnected from the session. + +## -property-value +The [**RemoteSystemSessionDisconnectedReason**](RemoteSystemSessionDisconnectedReason.md) value representing the reason for disconnection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessiondisconnectedreason.md b/windows.system.remotesystems/remotesystemsessiondisconnectedreason.md new file mode 100644 index 0000000000..76aca44b24 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessiondisconnectedreason.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionDisconnectedReason +-api-type: winrt enum +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionDisconnectedReason + +## -description +Contains values that describe the reason that a device may be disconnected from a remote session. + +## -enum-fields +### -field SessionUnavailable:0 +The connection to the remote session was lost. + +### -field SessionClosed:2 +The device controlling the remote session ended the session. + +### -field RemovedByController:1 +The device controlling the remote session removed this device as a participant. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninfo.md b/windows.system.remotesystems/remotesystemsessioninfo.md new file mode 100644 index 0000000000..582e565d40 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninfo.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionInfo +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInfo + +## -description +Contains identifying information about a remote session. + +## -remarks +A session that has been joined is represented by a [**RemoteSystemSession**](RemoteSystemSession.md) object. A session that is known about but has not been joined is represented by a [**RemoteSystemSessionInfo**](RemoteSystemSessionInfo.md) object. + +See the code example below for the full process of handling a join request. +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninfo_controllerdisplayname.md b/windows.system.remotesystems/remotesystemsessioninfo_controllerdisplayname.md new file mode 100644 index 0000000000..2a32573488 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninfo_controllerdisplayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionInfo.ControllerDisplayName +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInfo.ControllerDisplayName + +## -description +Gets the machine name of the device that is the controller of the remote session. + +## -property-value +The machine name of the controller device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninfo_displayname.md b/windows.system.remotesystems/remotesystemsessioninfo_displayname.md new file mode 100644 index 0000000000..a28a07c6ea --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninfo_displayname.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionInfo.DisplayName +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInfo.DisplayName + +## -description +Gets the public-facing name for the remote session, given by the controller of the session. + +## -property-value +The display name for the session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninfo_joinasync_1718388163.md b/windows.system.remotesystems/remotesystemsessioninfo_joinasync_1718388163.md new file mode 100644 index 0000000000..54a90e31e2 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninfo_joinasync_1718388163.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionInfo.JoinAsync +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInfo.JoinAsync + +## -description +Issues a request from the calling device to join the given remote session. + +## -returns +An asynchronous operation with the result of this join request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitation.md b/windows.system.remotesystems/remotesystemsessioninvitation.md new file mode 100644 index 0000000000..9acb5ff98a --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitation.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionInvitation +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitation + +## -description +Represents an invitation from a session participant to join their remote session. + +## -remarks +An instance of this class is contained in the [**RemoteSystemSessionInvitationReceivedEventArgs**](RemoteSystemSessionInvitationReceivedEventArgs.md) object that was passed in with the [**RemoteSystemSessionInvitationListener.InvitationReceived**](RemoteSystemSessionInvitationListener_InvitationReceived.md) event. + +The device receiving an invitation will need to use a [**RemoteSystemSessionInvitationListener**](RemoteSystemSessionInvitationListener.md) to handle it. See the code example below for the full invitation handling workflow: +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitation_sender.md b/windows.system.remotesystems/remotesystemsessioninvitation_sender.md new file mode 100644 index 0000000000..12711cc35d --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitation_sender.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionInvitation.Sender +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitation.Sender + +## -description +Gets a [**RemoteSystem**](RemoteSystem.md) object representing the device that sent the invitation. + +## -property-value +The [**RemoteSystem**](RemoteSystem.md) object representing the sending device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitation_sessioninfo.md b/windows.system.remotesystems/remotesystemsessioninvitation_sessioninfo.md new file mode 100644 index 0000000000..e216c2d1ed --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitation_sessioninfo.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionInvitation.SessionInfo +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitation.SessionInfo + +## -description +Gets a [**RemoteSystemSessionInfo**](RemoteSystemSessionInfo.md) object representing the session to which this device was invited. + +## -property-value +The [**RemoteSystemSessionInfo**](RemoteSystemSessionInfo.md) object representing the session to which this device was invited. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitationlistener.md b/windows.system.remotesystems/remotesystemsessioninvitationlistener.md new file mode 100644 index 0000000000..84113b784e --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitationlistener.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionInvitationListener +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitationListener + +## -description +Contains the functionality for receiving and responding to invitations to join remote sessions. + +## -remarks +See the code example below for the full invitation handling workflow: +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitationlistener_invitationreceived.md b/windows.system.remotesystems/remotesystemsessioninvitationlistener_invitationreceived.md new file mode 100644 index 0000000000..76dbac006a --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitationlistener_invitationreceived.md @@ -0,0 +1,22 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionInvitationListener.InvitationReceived +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitationListener.InvitationReceived + +## -description +Raised when a remote session invitation from another device has been detected. + +## -remarks +The device receiving an invitation will need to use a [**RemoteSystemSessionInvitationListener**](RemoteSystemSessionInvitationListener.md) to handle it. See the code example below for the full invitation handling workflow: +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitationlistener_remotesystemsessioninvitationlistener_1221375020.md b/windows.system.remotesystems/remotesystemsessioninvitationlistener_remotesystemsessioninvitationlistener_1221375020.md new file mode 100644 index 0000000000..0503e1d711 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitationlistener_remotesystemsessioninvitationlistener_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionInvitationListener.#ctor +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitationListener.RemoteSystemSessionInvitationListener + +## -description +Initializes an instance of [**RemoteSystemSessionInvitationListener**](RemoteSystemSessionInvitationListener.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs.md b/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs.md new file mode 100644 index 0000000000..90c8120cc9 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionInvitationReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitationReceivedEventArgs + +## -description +Contains information about a [**RemoteSystemSessionInvitationListener.InvitationReceived**](RemoteSystemSessionInvitationListener_InvitationReceived.md) event, namely the associated [**RemoteSystemSessionInvitation**](RemoteSystemSessionInvitation.md) object. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionInvitationListener.InvitationReceived**](RemoteSystemSessionInvitationListener_InvitationReceived.md) event is raised, and it should be handled by the method(s) registered to this event. + +See the code example below for the full invitation handling workflow: +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs_invitation.md b/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs_invitation.md new file mode 100644 index 0000000000..ee07feeae0 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessioninvitationreceivedeventargs_invitation.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionInvitationReceivedEventArgs.Invitation +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionInvitationReceivedEventArgs.Invitation + +## -description +Gets the [**RemoteSystemSessionInvitation**](RemoteSystemSessionInvitation.md) object associated with the invitation received. + +## -property-value +The [**RemoteSystemSessionInvitation**](RemoteSystemSessionInvitation.md) object representing this invitation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequest.md b/windows.system.remotesystems/remotesystemsessionjoinrequest.md new file mode 100644 index 0000000000..92e0be1653 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinrequest.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionJoinRequest +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinRequest + +## -description +Represents a remote device's request to join a session controlled by this device. + +## -remarks +See the code example below for the full process of handling a join request. +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequest_accept_1944939200.md b/windows.system.remotesystems/remotesystemsessionjoinrequest_accept_1944939200.md new file mode 100644 index 0000000000..b67c7ae58e --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinrequest_accept_1944939200.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionJoinRequest.Accept +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinRequest.Accept + +## -description +Causes the app to accept the requesting device into the remote session it is controlling. + +## -remarks +When this method is called, the device in question (described by the [**RemoteSystemSessionJoinRequest.Participant**](RemoteSystemSessionJoinRequest_Participant.md) property) will receive back a [**RemoteSystemSessionJoinResult**](RemoteSystemSessionJoinResult.md) object with a reference to the remote session that it attempted to join. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequest_participant.md b/windows.system.remotesystems/remotesystemsessionjoinrequest_participant.md new file mode 100644 index 0000000000..16a018f1ae --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinrequest_participant.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionJoinRequest.Participant +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinRequest.Participant + +## -description +Describes a request by a remote device to join a remote session. + +## -property-value +A [**RemoteSystemSessionParticipant**](RemoteSystemSessionParticipant.md) object representing the participant that issued the join request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs.md b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs.md new file mode 100644 index 0000000000..b06ebd0f85 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs.md @@ -0,0 +1,25 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionJoinRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinRequestedEventArgs + +## -description +Contains information about the [**RemoteSystemSessionController.JoinRequested**](RemoteSystemSessionController_JoinRequested.md) event that was raised. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionController.JoinRequested**](RemoteSystemSessionController_JoinRequested.md) event is raised, and it should be handled by the method(s) registered to this event. + + +See the code example below for the full process of handling a join request. +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs_getdeferral_254836512.md b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..b1d494b58b --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs_getdeferral_254836512.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionJoinRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinRequestedEventArgs.GetDeferral + +## -description +Gets a deferral object for this operation. + +## -returns +A [**Deferral**](https://docs.microsoft.com/en-us/uwp/api/windows.foundation.deferral) object that the app uses to signal when it has finished processing this request. + +## -remarks +See the code example below for the full process of handling a join request. +TBD2 + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs_joinrequest.md b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs_joinrequest.md new file mode 100644 index 0000000000..a0784760a9 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinrequestedeventargs_joinrequest.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionJoinRequestedEventArgs.JoinRequest +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinRequestedEventArgs.JoinRequest + +## -description +Gets the [**RemoteSystemSessionJoinRequest**](RemoteSystemSessionJoinRequest.md) that represents this incoming request. + +## -property-value +The [**RemoteSystemSessionJoinRequest**](RemoteSystemSessionJoinRequest.md) that represents this incoming request. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinresult.md b/windows.system.remotesystems/remotesystemsessionjoinresult.md new file mode 100644 index 0000000000..ce3be72b56 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinresult.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionJoinResult +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinResult + +## -description +Represents the result of this device's attempt to join a remote session. + +## -remarks +See the code example below for the full process of discovering and joining a remote session. +TBD2 - other classes should have this same one. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinresult_session.md b/windows.system.remotesystems/remotesystemsessionjoinresult_session.md new file mode 100644 index 0000000000..c5f51ef240 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinresult_session.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionJoinResult.Session +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinResult.Session + +## -description +Gets the [**RemoteSystemSession**](RemoteSystemSession.md) object representing the session that was joined (if the join attempt was successful). + +## -property-value +The [**RemoteSystemSession**](RemoteSystemSession.md) object representing the session that was joined (if the join attempt was successful). If the attempt failed, this value is **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinresult_status.md b/windows.system.remotesystems/remotesystemsessionjoinresult_status.md new file mode 100644 index 0000000000..b0919e122c --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinresult_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionJoinResult.Status +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinResult.Status + +## -description +Represents the success status of this device's attempt to join a remote session. + +## -property-value +A [**RemoteSystemSessionJoinStatus**](RemoteSystemSessionJoinStatus.md) value representing the result. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionjoinstatus.md b/windows.system.remotesystems/remotesystemsessionjoinstatus.md new file mode 100644 index 0000000000..b2ebc094fd --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionjoinstatus.md @@ -0,0 +1,36 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionJoinStatus +-api-type: winrt enum +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionJoinStatus + +## -description +Contains values which describe the result of this device's attempt to join a remote session. + +## -enum-fields +### -field Success:0 +The join attempt was successful. + +### -field SessionUnavailable:3 +The connection to the remote session was lost. + +### -field SessionLimitsExceeded:1 +The join request failed because this device is already a participant in the maximum allowed number of sessions. + +### -field RejectedByController:4 +The join request was rejected by the device controlling this session. + +### -field OperationAborted:2 +The join attempt failed for an unknown reason. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel.md b/windows.system.remotesystems/remotesystemsessionmessagechannel.md new file mode 100644 index 0000000000..35da445b41 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel + +## -description +Handles a dedicated data transfer channel within a remote session. This class owns the functionality for both sending and receiving. + +## -remarks +Messages are sent and received over this channel asynchronously, so the chronological ordering of messages is not guaranteed. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel_broadcastvaluesetasync_1248482937.md b/windows.system.remotesystems/remotesystemsessionmessagechannel_broadcastvaluesetasync_1248482937.md new file mode 100644 index 0000000000..45b7426e16 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel_broadcastvaluesetasync_1248482937.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.BroadcastValueSetAsync(Windows.Foundation.Collections.ValueSet) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.BroadcastValueSetAsync + +## -description +Sends a message to all participants in this remote session messaging channel. + +## -parameters + +### -param messageData +A [**ValueSet**](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.ValueSet) object containing the data to be sent to all participants in the channel. + +## -returns +An asynchronous operation containing a boolean value: **true** if the send operation was a success, otherwise **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel_remotesystemsessionmessagechannel_1582916025.md b/windows.system.remotesystems/remotesystemsessionmessagechannel_remotesystemsessionmessagechannel_1582916025.md new file mode 100644 index 0000000000..fb5a031b4d --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel_remotesystemsessionmessagechannel_1582916025.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.#ctor(Windows.System.RemoteSystems.RemoteSystemSession,System.String,Windows.System.RemoteSystems.RemoteSystemSessionMessageChannelReliability) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.RemoteSystemSessionMessageChannel + +## -description +Initializes an instance of [**RemoteSystemSessionMessageChannel**](RemoteSystemSessionMessageChannel.md) to manage messaging for a given remote session, specifying the degree of channel reliability. + +## -parameters + +### -param session +The [**RemoteSystemSession**](RemoteSystemSession.md) to which this messaging channel will correspond. + +### -param channelName +The user-defined name of the messaging channel. It should be simple and descriptive, such as "Bob's 3D App messaging channel." + +### -param reliability +A [**RemoteSystemSessionMessageChannelReliability**](RemoteSystemSessionMessageChannelReliability.md) value describing the reliability of this channel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel_remotesystemsessionmessagechannel_1888847663.md b/windows.system.remotesystems/remotesystemsessionmessagechannel_remotesystemsessionmessagechannel_1888847663.md new file mode 100644 index 0000000000..0b6e5054ea --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel_remotesystemsessionmessagechannel_1888847663.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.#ctor(Windows.System.RemoteSystems.RemoteSystemSession,System.String) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.RemoteSystemSessionMessageChannel + +## -description +Initializes an instance of [**RemoteSystemSessionMessageChannel**](RemoteSystemSessionMessageChannel.md) to manage messaging for a given remote session + +## -parameters + +### -param session +The [**RemoteSystemSession**](RemoteSystemSession.md) to which this messaging channel will correspond. + +### -param channelName +The user-defined name of the messaging channel. It should be simple and descriptive, such as "Bob's 3D App session." + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel_sendvaluesetasync_499304046.md b/windows.system.remotesystems/remotesystemsessionmessagechannel_sendvaluesetasync_499304046.md new file mode 100644 index 0000000000..2935de3844 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel_sendvaluesetasync_499304046.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.SendValueSetAsync(Windows.Foundation.Collections.ValueSet,Windows.System.RemoteSystems.RemoteSystemSessionParticipant) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.SendValueSetAsync + +## -description +Sends a message to a participant in this remote session messaging channel. + +## -parameters + +### -param messageData +A [**ValueSet**](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.ValueSet) object containing the data to be sent to the specified participant. + +### -param participant +A [**RemoteSystemSessionParticipant**](RemoteSystemSessionParticipant.md) object corresponding to the participant to which the message should be sent. + +## -returns +An asynchronous operation containing a boolean value: **true** if the send operation was a success, otherwise **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel_sendvaluesettoparticipantsasync_1831543331.md b/windows.system.remotesystems/remotesystemsessionmessagechannel_sendvaluesettoparticipantsasync_1831543331.md new file mode 100644 index 0000000000..65a65f4694 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel_sendvaluesettoparticipantsasync_1831543331.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.SendValueSetToParticipantsAsync(Windows.Foundation.Collections.ValueSet,Windows.Foundation.Collections.IIterable{Windows.System.RemoteSystems.RemoteSystemSessionParticipant}) +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.SendValueSetToParticipantsAsync + +## -description +Sends a message to a specified set participants in this remote session messaging channel. + +## -parameters + +### -param messageData +A [**ValueSet**](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.ValueSet) object containing the data to be sent to the specified participants. + +### -param participants +An iterable collection of [**RemoteSystemSessionParticipant**](RemoteSystemSessionParticipant.md) objects corresponding to the participants to which the message should be sent. + +## -returns +An asynchronous operation containing a boolean value: **true** if the send operation was a success, otherwise **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel_session.md b/windows.system.remotesystems/remotesystemsessionmessagechannel_session.md new file mode 100644 index 0000000000..eb6fd369a9 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel_session.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.Session +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.Session + +## -description +Gets the remote session to which this messaging channel corresponds. + +## -property-value +A [**RemoteSystemSession**](RemoteSystemSession.md) object representing the remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannel_valuesetreceived.md b/windows.system.remotesystems/remotesystemsessionmessagechannel_valuesetreceived.md new file mode 100644 index 0000000000..82afedc298 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannel_valuesetreceived.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.ValueSetReceived +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannel.ValueSetReceived + +## -description +Raised when a message (in the form of a key-value pair) is received by the channel. The contents of the message are contained by the [**RemoteSystemSessionValueSetReceivedEventArgs**](RemoteSystemSessionValueSetReceivedEventArgs.md) object that is passed in. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionmessagechannelreliability.md b/windows.system.remotesystems/remotesystemsessionmessagechannelreliability.md new file mode 100644 index 0000000000..c026c3b961 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionmessagechannelreliability.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionMessageChannelReliability +-api-type: winrt enum +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionMessageChannelReliability + +## -description +Contains values that describe the reliability of a remote session messaging channel. + +## -enum-fields +### -field Unreliable:1 +The channel is unreliable. + +### -field Reliable:0 +The channel is reliable. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionoptions.md b/windows.system.remotesystems/remotesystemsessionoptions.md new file mode 100644 index 0000000000..d94bdd4667 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionoptions.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionOptions +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionOptions + +## -description +Contains additional options that a [**RemoteSystemSessionController**](RemoteSystemSessionController.md) instance can specify when attempting to create a remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionoptions_isinviteonly.md b/windows.system.remotesystems/remotesystemsessionoptions_isinviteonly.md new file mode 100644 index 0000000000..19111739e3 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionoptions_isinviteonly.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionOptions.IsInviteOnly +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionOptions.IsInviteOnly + +## -description +Indicates whether or not the session described by this [**RemoteSystemSessionOptions**](RemoteSystemSessionOptions.md) instance should be joinable by invite only. + +## -property-value +A value of **true** if the corresponding session will only be available to participants who receive an invitation, **false** if the session will be open to join requests from any participants. + +## -remarks + +## -see-also +[**RemoteSystemSessionInvitaitionListener**](RemoteSystemSessionInvitaitionListener.md) + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionoptions_remotesystemsessionoptions_1221375020.md b/windows.system.remotesystems/remotesystemsessionoptions_remotesystemsessionoptions_1221375020.md new file mode 100644 index 0000000000..057b2582b1 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionoptions_remotesystemsessionoptions_1221375020.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionOptions.#ctor +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionOptions.RemoteSystemSessionOptions + +## -description +Initializes an instance of the [**RemoteSystemSessionOptions**](RemoteSystemSessionOptions.md) class. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipant.md b/windows.system.remotesystems/remotesystemsessionparticipant.md new file mode 100644 index 0000000000..660cf9cf17 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipant.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionParticipant +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipant + +## -description +Represents a device that is a participant in a remote session. A session can have one or more participants. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipant_gethostnames_136280557.md b/windows.system.remotesystems/remotesystemsessionparticipant_gethostnames_136280557.md new file mode 100644 index 0000000000..50cfdcab13 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipant_gethostnames_136280557.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionParticipant.GetHostNames +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipant.GetHostNames + +## -description +Retrieves a list of host names for this remote session participant that are resolvable by the other remote systems in the session. + +## -returns +A list of [**HostName**](https://docs.microsoft.com/en-us/uwp/api/windows.networking.hostname) objects for the host names of this remote system. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipant_remotesystem.md b/windows.system.remotesystems/remotesystemsessionparticipant_remotesystem.md new file mode 100644 index 0000000000..b093abb276 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipant_remotesystem.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionParticipant.RemoteSystem +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipant.RemoteSystem + +## -description +Gets the remote system that is a participant in the session. + +## -property-value +A [**RemoteSystem**](RemoteSystem.md) object representing the participant device. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantaddedeventargs.md b/windows.system.remotesystems/remotesystemsessionparticipantaddedeventargs.md new file mode 100644 index 0000000000..363327e772 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantaddedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionParticipantAddedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantAddedEventArgs + +## -description +Contains information about a [**RemoteSystemSessionParticipantWatcher.Added**](RemoteSystemSessionParticipantWatcher_Added.md) event, namely the participant that was added to the session. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionParticipantWatcher.Added**](RemoteSystemSessionParticipantWatcher_Added.md) is raised, and it should be handled by the method(s) registered to this event. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantaddedeventargs_participant.md b/windows.system.remotesystems/remotesystemsessionparticipantaddedeventargs_participant.md new file mode 100644 index 0000000000..fca359a41a --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantaddedeventargs_participant.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionParticipantAddedEventArgs.Participant +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantAddedEventArgs.Participant + +## -description +Gets the participant that was added to the remote session. + +## -property-value +A [**RemoteSystemSessionParticipant**](RemoteSystemSessionParticipant.md) object corresponding to the participant added. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantremovedeventargs.md b/windows.system.remotesystems/remotesystemsessionparticipantremovedeventargs.md new file mode 100644 index 0000000000..2cd466592c --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantremovedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionParticipantRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantRemovedEventArgs + +## -description +Contains information about a [**RemoteSystemSessionParticipantWatcher.Removed**](RemoteSystemSessionParticipantWatcher_Removed.md) event, namely the participant that was removed from the session. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionParticipantWatcher.Removed**](RemoteSystemSessionParticipantWatcher_Removed.md) is raised, and it should be handled by the method(s) registered to this event. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantremovedeventargs_participant.md b/windows.system.remotesystems/remotesystemsessionparticipantremovedeventargs_participant.md new file mode 100644 index 0000000000..6c8308e07e --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantremovedeventargs_participant.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionParticipantRemovedEventArgs.Participant +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantRemovedEventArgs.Participant + +## -description +Gets the participant that was removed from the remote session. + +## -property-value +A [**RemoteSystemSessionParticipant**](RemoteSystemSessionParticipant.md) object corresponding to the participant removed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcher.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcher.md new file mode 100644 index 0000000000..816aeb881a --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcher.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher + +## -description +Handles the discovery and monitoring of remote session participants by raising the appropriate events. + +## -remarks +This class is instantiated when the [**CreateParticipantWatcher**](RemoteSystemSession_CreateParticipantWatcher.md) method is called on an instance of [**RemoteSystemSession**](RemoteSystemSession.md). Instances of this class each correspond to one instance of **RemoteSystemSession** (and therefore one remote session). + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcher_added.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_added.md new file mode 100644 index 0000000000..676d9d2e71 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_added.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Added +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Added + +## -description +Raised when a new participant has been added to the remote session. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcher_enumerationcompleted.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_enumerationcompleted.md new file mode 100644 index 0000000000..a0a6507027 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_enumerationcompleted.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.EnumerationCompleted +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.EnumerationCompleted + +## -description +Raised after the initial enumeration of participants has completed. + +## -remarks +An app may delay UI rendering for session participants until this point, so that the UI elements for many participant can be rendered at once. Participant discovery events can continue to be raised after this event. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcher_removed.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_removed.md new file mode 100644 index 0000000000..5f4c409041 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_removed.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Removed +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Removed + +## -description +Raised when a participant in the session has been removed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcher_start_1587696324.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_start_1587696324.md new file mode 100644 index 0000000000..fda1833b30 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_start_1587696324.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Start +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Start + +## -description +Starts watching for participants in the remote session. The discovery process runs for 30 seconds or until the **Stop** method is called. A [**RemoteSystemSessionParticipantWatcher**](RemoteSystemSessionParticipantWatcher.md) object can have its **Start** method called again at a later time. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcher_status.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_status.md new file mode 100644 index 0000000000..e139fdfd01 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Status +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Status + +## -description +Gets the operational status of this participant watcher. + +## -property-value +A [**RemoteSystemSessionParticipantWatcherStatus**](RemoteSystemSessionParticipantWatcherStatus.md) value describing the status of the watcher. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcher_stop_1201535524.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_stop_1201535524.md new file mode 100644 index 0000000000..6c34e241d8 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcher_stop_1201535524.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcher.Stop + +## -description +Stops watching for discoverable session participants. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionparticipantwatcherstatus.md b/windows.system.remotesystems/remotesystemsessionparticipantwatcherstatus.md new file mode 100644 index 0000000000..fbf8986675 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionparticipantwatcherstatus.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcherStatus +-api-type: winrt enum +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionParticipantWatcherStatus + +## -description +Contains values that describe the operational status of a participant watcher object. + +## -enum-fields +### -field Stopping:3 +The watcher is in the process of stopping. + +### -field Stopped:4 +The watcher has stopped looking for session participants. + +### -field Started:1 +The watcher has started looking for session participants. + +### -field EnumerationCompleted:2 +The initial enumeration of session participants has completed. + +### -field Created:0 +The watcher has been created but has not yet been started. + +### -field Aborted:5 +The watching operation was aborted for an unknown reason. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionremovedeventargs.md b/windows.system.remotesystems/remotesystemsessionremovedeventargs.md new file mode 100644 index 0000000000..a85e819f26 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionremovedeventargs.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionRemovedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionRemovedEventArgs + +## -description +Contains information about a [**RemoteSystemSessionWatcher.Removed**](RemoteSystemSessionWatcher_Removed.md) event that was raised, namely the remote session that has disappeared. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionWatcher.Removed**](RemoteSystemSessionWatcher_Removed.md) is raised, and it should be handled by the method(s) registered to this event. + + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionremovedeventargs_sessioninfo.md b/windows.system.remotesystems/remotesystemsessionremovedeventargs_sessioninfo.md new file mode 100644 index 0000000000..59eec5486b --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionremovedeventargs_sessioninfo.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionRemovedEventArgs.SessionInfo +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionRemovedEventArgs.SessionInfo + +## -description +Gets information about the remote session that disappeared. + +## -property-value +A [**RemoteSystemSessionInfo**](RemoteSystemSessionInfo.md) object describing the remote session that disappeared. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionupdatedeventargs.md b/windows.system.remotesystems/remotesystemsessionupdatedeventargs.md new file mode 100644 index 0000000000..bbb099a79c --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionupdatedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionUpdatedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionUpdatedEventArgs + +## -description +Contains information about a [**RemoteSystemSessionWatcher.Updated**](RemoteSystemSessionWatcher_updated.md) event that was raised, namely the remote session whose information was updated. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionWatcher.Updated**](RemoteSystemSessionWatcher_updated.md) is raised, and it should be handled by the method(s) registered to this event. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionupdatedeventargs_sessioninfo.md b/windows.system.remotesystems/remotesystemsessionupdatedeventargs_sessioninfo.md new file mode 100644 index 0000000000..f47bc66675 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionupdatedeventargs_sessioninfo.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionUpdatedEventArgs.SessionInfo +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionUpdatedEventArgs.SessionInfo + +## -description +Gets information about the remote session that was updated. + +## -property-value +A [**RemoteSystemSessionInfo**](RemoteSystemSessionInfo.md) object describing the remote session that was updated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs.md b/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs.md new file mode 100644 index 0000000000..eecbb3442f --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionValueSetReceivedEventArgs +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionValueSetReceivedEventArgs + +## -description +Contains information about a [**RemoteSystemSessionMessageChannel.ValueSetReceived**](RemoteSystemSessionMessageChannel_ValueSetReceived.md) event that was raised, namely the message that was received. + +## -remarks +This class is instantiated whenever the [**RemoteSystemSessionMessageChannel.ValueSetReceived**](RemoteSystemSessionMessageChannel_ValueSetReceived.md) event is raised, and it should be handled by the method(s) registered to this event. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs_message.md b/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs_message.md new file mode 100644 index 0000000000..84034e4782 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs_message.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionValueSetReceivedEventArgs.Message +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionValueSetReceivedEventArgs.Message + +## -description +Gets the contents of the message received by the channel. + +## -property-value +A [**ValueSet**](https://docs.microsoft.com/uwp/api/Windows.Foundation.Collections.ValueSet) object containing the data that was received from the channel. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs_sender.md b/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs_sender.md new file mode 100644 index 0000000000..eb5cb4dbba --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionvaluesetreceivedeventargs_sender.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionValueSetReceivedEventArgs.Sender +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionValueSetReceivedEventArgs.Sender + +## -description +Gets the remote session participant that sent the message to the channel and caused this [**ValueSetReceived**](remotesystemsessionmessagechannel_valuesetreceived.md) event to be raised. + +## -property-value +The [**RemoteSystemSessionParticipant**](RemoteSystemSessionParticipant.md) object corresponding to the sender participant. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcher.md b/windows.system.remotesystems/remotesystemsessionwatcher.md new file mode 100644 index 0000000000..8dd6a0d870 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcher.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionWatcher +-api-type: winrt class +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcher + +## -description +Watches for activity related to the discovery of remote sessions and raises the appropriate events. + +## -remarks +This class is instantiated when the [**RemoteSystemSession.CreateWatcher**](RemoteSystemSession_CreateWatcher_1506431823.md) method is called. + +See the code example below for the full process of discovering and joining a remote session. +TBD2 - other classes should have the same. + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcher_added.md b/windows.system.remotesystems/remotesystemsessionwatcher_added.md new file mode 100644 index 0000000000..06e3e6142c --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcher_added.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Added +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Added + +## -description +Raised when a new remote session has been discovered by the [**RemoteSystemSessionWatcher**](RemoteSystemSessionWatcher.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcher_removed.md b/windows.system.remotesystems/remotesystemsessionwatcher_removed.md new file mode 100644 index 0000000000..1351ebf764 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcher_removed.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Removed +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Removed + +## -description +Raised when a previously discovered remote session has disappeared. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcher_start_1587696324.md b/windows.system.remotesystems/remotesystemsessionwatcher_start_1587696324.md new file mode 100644 index 0000000000..7e28cae749 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcher_start_1587696324.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Start +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Start + +## -description +Starts watching for discoverable remote sessions. The discovery process runs for 30 seconds or until the **Stop** method is called. A [**RemoteSystemSessionWatcher**](RemoteSystemSessionWatcher.md) object can have its **Start** method called again at a later time. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcher_status.md b/windows.system.remotesystems/remotesystemsessionwatcher_status.md new file mode 100644 index 0000000000..c8b447e931 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcher_status.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Status +-api-type: winrt property +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Status + +## -description +Gets the operational status of this remote session watcher. + +## -property-value +A [**RemoteSystemSessionWatcherStatus**](RemoteSystemSessionWatcherStatus.md) value describing the status of the watcher. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcher_stop_1201535524.md b/windows.system.remotesystems/remotesystemsessionwatcher_stop_1201535524.md new file mode 100644 index 0000000000..fdc21c6c6f --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcher_stop_1201535524.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Stop +-api-type: winrt method +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Stop + +## -description +Stops watching for discoverable remote sessions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcher_updated.md b/windows.system.remotesystems/remotesystemsessionwatcher_updated.md new file mode 100644 index 0000000000..03db50dad4 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcher_updated.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Updated +-api-type: winrt event +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcher.Updated + +## -description +Raised when a previously discovered remote session has some part of its information updated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemsessionwatcherstatus.md b/windows.system.remotesystems/remotesystemsessionwatcherstatus.md new file mode 100644 index 0000000000..78b6b89863 --- /dev/null +++ b/windows.system.remotesystems/remotesystemsessionwatcherstatus.md @@ -0,0 +1,39 @@ +--- +-api-id: T:Windows.System.RemoteSystems.RemoteSystemSessionWatcherStatus +-api-type: winrt enum +--- + + + +# Windows.System.RemoteSystems.RemoteSystemSessionWatcherStatus + +## -description +Contains values that describe the operational status of a remote session watcher object. + +## -enum-fields +### -field Stopping:3 +The watcher is in the process of stopping. + +### -field Stopped:4 +The watcher has stopped looking for remote sessions. + +### -field Started:1 +The watcher has started looking for remote sessions. + +### -field EnumerationCompleted:2 +The initial enumeration of remote sessions has completed. + +### -field Created:0 +The watcher has been created but has not yet been started. + +### -field Aborted:5 +The watching operation was aborted for an unknown reason. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.remotesystems/remotesystemstatus.md b/windows.system.remotesystems/remotesystemstatus.md index cdcca3d1e0..4badfad4d1 100644 --- a/windows.system.remotesystems/remotesystemstatus.md +++ b/windows.system.remotesystems/remotesystemstatus.md @@ -31,7 +31,7 @@ The availability of the remote system is unknown. ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemstatustype.md b/windows.system.remotesystems/remotesystemstatustype.md index 410e7f1083..83da1c28cc 100644 --- a/windows.system.remotesystems/remotesystemstatustype.md +++ b/windows.system.remotesystems/remotesystemstatustype.md @@ -25,7 +25,7 @@ The remote system must have a [Status](remotesystem_status.md) property value of ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemstatustypefilter.md b/windows.system.remotesystems/remotesystemstatustypefilter.md index 044784b23e..64e5ddde2b 100644 --- a/windows.system.remotesystems/remotesystemstatustypefilter.md +++ b/windows.system.remotesystems/remotesystemstatustypefilter.md @@ -17,7 +17,7 @@ An [IRemoteSystemFilter](iremotesystemfilter.md) that limits the set of discover ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices), [IRemoteSystemFilter](iremotesystemfilter.md) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices), [IRemoteSystemFilter](iremotesystemfilter.md) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemupdatedeventargs.md b/windows.system.remotesystems/remotesystemupdatedeventargs.md index f3849292fa..3307f1c67f 100644 --- a/windows.system.remotesystems/remotesystemupdatedeventargs.md +++ b/windows.system.remotesystems/remotesystemupdatedeventargs.md @@ -18,7 +18,7 @@ This class is instantiated whenever the [RemoteSystemUpdated](remotesystemwatche ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemwatcher.md b/windows.system.remotesystems/remotesystemwatcher.md index d536f5afce..add6a5a703 100644 --- a/windows.system.remotesystems/remotesystemwatcher.md +++ b/windows.system.remotesystems/remotesystemwatcher.md @@ -18,7 +18,7 @@ This class is instantiated when the static method [CreateWatcher](remotesystem_c ## -examples ## -see-also -[Connected apps and devices (Project "Rome")](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) +[Connected apps and devices (Project Rome)](https://msdn.microsoft.com/en-us/windows/uwp/launch-resume/connected-apps-and-devices) ## -capabilities remoteSystem \ No newline at end of file diff --git a/windows.system.remotesystems/remotesystemwatcher_remotesystemupdated.md b/windows.system.remotesystems/remotesystemwatcher_remotesystemupdated.md index b66aaa312d..ffeb6af84e 100644 --- a/windows.system.remotesystems/remotesystemwatcher_remotesystemupdated.md +++ b/windows.system.remotesystems/remotesystemwatcher_remotesystemupdated.md @@ -10,7 +10,7 @@ public event Windows.Foundation.TypedEventHandler RemoteSystemUpdated + +# Windows.System.UserProfile.FeedbackAndDiagnosticsSettings + +## -description +Provides properties and methods to access the user's feedback and diagnostics settings. + +## -remarks +*Feedback & diagnostics* settings are per user and per device. + +Call **GetForUser** if your app supports multiple users. Call **GetDefault** if your app supports a single user. + +## -see-also + +## -examples + diff --git a/windows.system.userprofile/feedbackanddiagnosticssettings_getdefault_846721868.md b/windows.system.userprofile/feedbackanddiagnosticssettings_getdefault_846721868.md new file mode 100644 index 0000000000..81dd7ef261 --- /dev/null +++ b/windows.system.userprofile/feedbackanddiagnosticssettings_getdefault_846721868.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.GetDefault +-api-type: winrt method +--- + + + +# Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.GetDefault + +## -description +Retrieves the default feedback and diagnostics settings. + +## -returns +A settings object that contains the user's current feedback and diagnostics settings. + +## -remarks + +## -see-also + +## -examples + +```csharp +// From within a single user environment. +Windows.System.UserProfile.FeedbackAndDiagnosticsSettings defaultUser = + Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.GetDefault(); + +Log.Comment("Current user tailored experiences enabled: " + + defaultUser.IsAccessToDiagnosticDataForTailoringExperiencesEnabled); +``` \ No newline at end of file diff --git a/windows.system.userprofile/feedbackanddiagnosticssettings_getforuser_2058550280.md b/windows.system.userprofile/feedbackanddiagnosticssettings_getforuser_2058550280.md new file mode 100644 index 0000000000..2d5b254a6b --- /dev/null +++ b/windows.system.userprofile/feedbackanddiagnosticssettings_getforuser_2058550280.md @@ -0,0 +1,52 @@ +--- +-api-id: M:Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.GetForUser + +## -description +Retrieves the feedback and diagnostics settings for the specified user. + +## -parameters + +### -param user +The user to get settings for. + +## -returns +A settings object that contains the user's current feedback and diagnostics settings. + +## -remarks + +## -see-also + +## -examples + +```csharp +// From a multi-user environment. +// (This example queries for all users, but you presumably +// know the user you want to query in your app.) + +Task> getUsersTask = + Windows.System.User.FindAllAsync().AsTask(); +if (!getUsersTask.IsCompleted) +{ + getUsersTask.Wait(); +} + +IEnumerable users = getUsersTask.Result; + +foreach(Windows.System.User user in users) +{ + Windows.System.UserProfile.FeedbackAndDiagnosticsSettings userSettings = + Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.GetForUser(user); + + Log.Comment(user.NonRoamableId + " user tailored experiences enabled: " + + userSettings.IsAccessToDiagnosticDataForTailoringExperiencesEnabled); +} +``` + diff --git a/windows.system.userprofile/feedbackanddiagnosticssettings_isaccesstodiagnosticdatafortailoringexperiencesenabled.md b/windows.system.userprofile/feedbackanddiagnosticssettings_isaccesstodiagnosticdatafortailoringexperiencesenabled.md new file mode 100644 index 0000000000..26718b1520 --- /dev/null +++ b/windows.system.userprofile/feedbackanddiagnosticssettings_isaccesstodiagnosticdatafortailoringexperiencesenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.IsAccessToDiagnosticDataForTailoringExperiencesEnabled +-api-type: winrt property +--- + + + +# Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.IsAccessToDiagnosticDataForTailoringExperiencesEnabled + +## -description +Gets a value that indicates whether the user has turned on access to diagnostic data for tailored experiences in the Windows *Feedback & diagnostics* settings. + +## -property-value +**true** if access to diagnostic data is turned on; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system.userprofile/feedbackanddiagnosticssettings_user.md b/windows.system.userprofile/feedbackanddiagnosticssettings_user.md new file mode 100644 index 0000000000..fcc1e858ce --- /dev/null +++ b/windows.system.userprofile/feedbackanddiagnosticssettings_user.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.User +-api-type: winrt property +--- + + + +# Windows.System.UserProfile.FeedbackAndDiagnosticsSettings.User + +## -description +Gets the [User](./../windows.system/user.md) associated with this instance of feedback and diagnostics settings. + +## -property-value +The user associated with this instance of feedback and diagnostics settings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system/appdiagnosticinfo.md b/windows.system/appdiagnosticinfo.md new file mode 100644 index 0000000000..dda6b3719d --- /dev/null +++ b/windows.system/appdiagnosticinfo.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.System.AppDiagnosticInfo +-api-type: winrt class +--- + + + +# Windows.System.AppDiagnosticInfo + +## -description + +Contains APIs for getting a basic set of diagnostic information for all running apps. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system/appdiagnosticinfo_appinfo.md b/windows.system/appdiagnosticinfo_appinfo.md new file mode 100644 index 0000000000..50f41e0015 --- /dev/null +++ b/windows.system/appdiagnosticinfo_appinfo.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.System.AppDiagnosticInfo.AppInfo +-api-type: winrt property +--- + + + +# Windows.System.AppDiagnosticInfo.AppInfo + +## -description + +Provides info about the app's package family name and package-relative app name. + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system/appdiagnosticinfo_requestinfoasync_1918193949.md b/windows.system/appdiagnosticinfo_requestinfoasync_1918193949.md new file mode 100644 index 0000000000..796f89e70d --- /dev/null +++ b/windows.system/appdiagnosticinfo_requestinfoasync_1918193949.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.System.AppDiagnosticInfo.RequestInfoAsync +-api-type: winrt method +--- + + + +# Windows.System.AppDiagnosticInfo.RequestInfoAsync + +## -description + +Gets a collection of [AppDiagnosticInfo](appdiagnosticinfo.md) objects for all running apps that have a package family name. + +## -returns + +A list of [AppDiagnosticInfo](appdiagnosticinfo.md) objects for all running apps that have a package family name. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system/launcher_launchfileasync_1480137410.md b/windows.system/launcher_launchfileasync_1480137410.md index 67e0745129..ae9138ad18 100644 --- a/windows.system/launcher_launchfileasync_1480137410.md +++ b/windows.system/launcher_launchfileasync_1480137410.md @@ -1,167 +1,167 @@ ---- --api-id: M:Windows.System.Launcher.LaunchFileAsync(Windows.Storage.IStorageFile,Windows.System.LauncherOptions) --api-type: winrt method ---- - - - -# Windows.System.Launcher.LaunchFileAsync - -## -description -Starts the default app associated with the specified file, using the specified options. - -## -parameters -### -param file -The file. - -### -param options -The launch options for the app. - -## -returns -The launch operation. - -## -remarks -The calling app must be visible to the user when the API is invoked. - -This API must be called from within an ASTA thread (also known as a UI thread). - -This API also imposes several restrictions on what types of files it can launch. Many file types that contain executable code, for example .exe, .msi, and .js files, are blocked from launching. This restriction protects users from potentially malicious files that could modify the system. - -When the launch fails for any of the above reasons, the API succeeds and returns FALSE from its asynchronous operation. Since it has no ability to query whether the above restrictions apply to the current launch, the calling app should not assume that the launch succeeded, and should provide fallback mechanism in case it failed. A possible solution would be to ask the user to save the file and direct the user to open it in the desktop. - -To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. - -To display a warning that the file is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. - - - -The file is passed to the associated app. If the associated app is a desktop app, the file is passed using shell execution mechanisms. - -## -examples -Call the [Launcher.LaunchFileAsync(IStorageFile, LauncherOptions) | launchFileAsync(IStorageFile, LauncherOptions)](launcher_launchfileasync_1480137410.md) method with [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) set to **true** to launch the app that the user selects for the file from the **Open With** dialog box. - -```javascript - -// Path to the file in the app package to launch -var imageFile = "images\\test.png"; - -// Get the image file from the package's image directory -Windows.ApplicationModel.Package.current.installedLocation.getFileAsync(imageFile).then( - function (file) { - // Set the show picker option - var options = new Windows.System.LauncherOptions(); - options.displayApplicationPicker = true; - - // Launch the retrieved file using the selected app - Windows.System.Launcher.launchFileAsync(file, options).then( - function (success) { - if (success) { - // File launched - } else { - // File launch failed - } - }); - }); -``` - -```csharp -async void DefaultLaunch() -{ - // Path to the file in the app package to launch - string imageFile = @"images\test.png"; - - var file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile); - - if (file != null) - { - // Set the option to show the picker - var options = new Windows.System.LauncherOptions(); - options.DisplayApplicationPicker = true; - - // Launch the retrieved file - bool success = await Windows.System.Launcher.LaunchFileAsync(file, options); - if (success) - { - // File launched - } - else - { - // File launch failed - } - } - else - { - // Could not find file - } -} -``` - -```vbnet -async Sub DefaultLaunch() - - ' Path to the file in the app package to launch - Dim imageFile = "images\test.png" - - Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile) - - If file IsNot Nothing Then - ' Set the option to show the picker - Dim options = Windows.System.LauncherOptions() - options.DisplayApplicationPicker = True - - ' Launch the retrieved file - Dim success = await Windows.System.Launcher.LaunchFileAsync(file, options) - - If success Then - ' File launched - Else - ' File launch failed - End If - Else - ' Could not find file - End If -End Sub -``` - -```cpp -void MainPage::DefaultLaunch() -{ - auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation; - - concurrency::task getFileOperation(installFolder->GetFileAsync("images\\test.png")); - getFileOperation.then([](Windows::Storage::StorageFile^ file) - { - if (file != nullptr) - { - // Set the option to show the picker - auto launchOptions = ref new Windows::System::LauncherOptions(); - launchOptions->DisplayApplicationPicker = true; - - // Launch the retrieved file - concurrency::task launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file, launchOptions)); - launchFileOperation.then([](bool success) - { - if (success) - { - // File launched - } - else - { - // File launch failed - } - }); - } - else - { - // Could not find file - } - }); -} -``` - - - -## -see-also -[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a file (JavaScript)](XREF:TODO:m_activation.how_to_launch_the_default_handler_for_a_file), [Launch the default app for a file](http://msdn.microsoft.com/library/bb45fcaf-df93-4c99-a8b5-59b799c7bd98), [LaunchFileAsync(IStorageFile, LauncherOptions)](launcher_launchfileasync_1480137410.md) \ No newline at end of file +--- +-api-id: M:Windows.System.Launcher.LaunchFileAsync(Windows.Storage.IStorageFile,Windows.System.LauncherOptions) +-api-type: winrt method +--- + + + +# Windows.System.Launcher.LaunchFileAsync + +## -description +Starts the default app associated with the specified file, using the specified options. + +## -parameters +### -param file +The file. + +### -param options +The launch options for the app. + +## -returns +The launch operation. + +## -remarks +The calling app must be visible to the user when the API is invoked. + +This API must be called from within an ASTA thread (also known as a UI thread). + +This API also imposes several restrictions on what types of files it can launch. Many file types that contain executable code, for example .exe, .msi, and .js files, are blocked from launching. This restriction protects users from potentially malicious files that could modify the system. + +When the launch fails for any of the above reasons, the API succeeds and returns FALSE from its asynchronous operation. Since it has no ability to query whether the above restrictions apply to the current launch, the calling app should not assume that the launch succeeded, and should provide fallback mechanism in case it failed. A possible solution would be to ask the user to save the file and direct the user to open it in the desktop. + +To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. + +To display a warning that the file is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. + + + +The file is passed to the associated app. If the associated app is a desktop app, the file is passed using shell execution mechanisms. + +## -examples +Call the [Launcher.LaunchFileAsync(IStorageFile, LauncherOptions) | launchFileAsync(IStorageFile, LauncherOptions)](launcher_launchfileasync_1480137410.md) method with [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) set to **true** to launch the app that the user selects for the file from the **Open With** dialog box. + +```javascript + +// Path to the file in the app package to launch +var imageFile = "images\\test.png"; + +// Get the image file from the package's image directory +Windows.ApplicationModel.Package.current.installedLocation.getFileAsync(imageFile).then( + function (file) { + // Set the show picker option + var options = new Windows.System.LauncherOptions(); + options.displayApplicationPicker = true; + + // Launch the retrieved file using the selected app + Windows.System.Launcher.launchFileAsync(file, options).then( + function (success) { + if (success) { + // File launched + } else { + // File launch failed + } + }); + }); +``` + +```csharp +async void DefaultLaunch() +{ + // Path to the file in the app package to launch + string imageFile = @"images\test.png"; + + var file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile); + + if (file != null) + { + // Set the option to show the picker + var options = new Windows.System.LauncherOptions(); + options.DisplayApplicationPicker = true; + + // Launch the retrieved file + bool success = await Windows.System.Launcher.LaunchFileAsync(file, options); + if (success) + { + // File launched + } + else + { + // File launch failed + } + } + else + { + // Could not find file + } +} +``` + +```vbnet +async Sub DefaultLaunch() + + ' Path to the file in the app package to launch + Dim imageFile = "images\test.png" + + Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile) + + If file IsNot Nothing Then + ' Set the option to show the picker + Dim options = Windows.System.LauncherOptions() + options.DisplayApplicationPicker = True + + ' Launch the retrieved file + Dim success = await Windows.System.Launcher.LaunchFileAsync(file, options) + + If success Then + ' File launched + Else + ' File launch failed + End If + Else + ' Could not find file + End If +End Sub +``` + +```cpp +void MainPage::DefaultLaunch() +{ + auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation; + + concurrency::task getFileOperation(installFolder->GetFileAsync("images\\test.png")); + getFileOperation.then([](Windows::Storage::StorageFile^ file) + { + if (file != nullptr) + { + // Set the option to show the picker + auto launchOptions = ref new Windows::System::LauncherOptions(); + launchOptions->DisplayApplicationPicker = true; + + // Launch the retrieved file + concurrency::task launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file, launchOptions)); + launchFileOperation.then([](bool success) + { + if (success) + { + // File launched + } + else + { + // File launch failed + } + }); + } + else + { + // Could not find file + } + }); +} +``` + + + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a file (JavaScript)](http://msdn.microsoft.com/library/876edae5-f1a8-45f9-a1a6-50efb1025f96), [Launch the default app for a file](http://msdn.microsoft.com/library/bb45fcaf-df93-4c99-a8b5-59b799c7bd98), [LaunchFileAsync(IStorageFile, LauncherOptions)](launcher_launchfileasync_1480137410.md) \ No newline at end of file diff --git a/windows.system/launcher_launchfileasync_1594978114.md b/windows.system/launcher_launchfileasync_1594978114.md index 4868f062ee..abdb411b6f 100644 --- a/windows.system/launcher_launchfileasync_1594978114.md +++ b/windows.system/launcher_launchfileasync_1594978114.md @@ -1,149 +1,149 @@ ---- --api-id: M:Windows.System.Launcher.LaunchFileAsync(Windows.Storage.IStorageFile) --api-type: winrt method ---- - - - -# Windows.System.Launcher.LaunchFileAsync - -## -description -Starts the default app associated with the specified file. - -## -parameters -### -param file -The file. - -## -returns -The launch operation. - -## -remarks -The calling app must be visible to the user when the API is invoked. - -This API must be called from an ASTA thread (also known as a UI thread). - -This API also imposes several restrictions on what types of files it can launch. Many file types that contain executable code, for example .exe, .msi, and .js files, are blocked from launching. This restriction protects users from potentially malicious files that could modify the system. - -When the launch fails for any of the above reasons, the API succeeds and returns FALSE from its asynchronous operation. Since it has no ability to query whether the above restrictions apply to the current launch, the calling app should not assume that the launch succeeded, and should provide fallback mechanism in case it failed. A possible solution would be to ask the user to save the file and direct the user to open it in the desktop. - -To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. - -To display a warning that the file is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. - - - -The file is passed to the associated app. If the associated app is a desktop app, the file is passed using shell execution mechanisms. - -## -examples -This example uses [LaunchFileAsync(IStorageFile) | launchFileAsync(IStorageFile)](launcher_launchfileasync_1594978114.md) to launch a file contained in the app package. - -```javascript - -// Path to the file in the app package to launch -var imageFile = "images\\test.png"; - -// Get the image file from the package's image directory -Windows.ApplicationModel.Package.current.installedLocation.getFileAsync(imageFile).then( - function (file) { - // Launch the retrieved file using the default app - Windows.System.Launcher.launchFileAsync(file).then( - function (success) { - if (success) { - // File launched - } else { - // File launch failed - } - }); - }); -``` - -```csharp -async void DefaultLaunch() -{ - // Path to the file in the app package to launch - string imageFile = @"images\test.png"; - - var file = wait Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile); - - if (file != null) - { - // Launch the retrieved file - var success = await Windows.System.Launcher.LaunchFileAsync(file); - - if (success) - { - // File launched - } - else - { - // File launch failed - } - } - else - { - // Could not find file - } -} -``` - -```vbnet -async Sub DefaultLaunch() - - ' Path to the file in the app package to launch - Dim imageFile = "images\test.png" - - Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile) - - If file IsNot Nothing Then - ' Launch the retrieved file - Dim success = await Windows.System.Launcher.LaunchFileAsync(file) - - If success Then - ' File launched - Else - ' File launch failed - End If - Else - ' Could not find file - End If -End Sub -``` - -```cpp -void MainPage::DefaultLaunch() -{ - auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation; - - concurrency::task getFileOperation(installFolder->GetFileAsync("images\\test.png")); - getFileOperation.then([](Windows::Storage::StorageFile^ file) - { - if (file != nullptr) - { - // Launch the retrieved file - concurrency::task launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file)); - launchFileOperation.then([](bool success) - { - if (success) - { - // File launched - } - else - { - // File launch failed - } - }); - } - else - { - // Could not find file - } - }); -} -``` - - - -## -see-also -[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a file (JavaScript)](XREF:TODO:m_activation.how_to_launch_the_default_handler_for_a_file), [Launch the default app for a file](http://msdn.microsoft.com/library/bb45fcaf-df93-4c99-a8b5-59b799c7bd98), [LaunchFileAsync(IStorageFile, LauncherOptions)](launcher_launchfileasync_1480137410.md) \ No newline at end of file +--- +-api-id: M:Windows.System.Launcher.LaunchFileAsync(Windows.Storage.IStorageFile) +-api-type: winrt method +--- + + + +# Windows.System.Launcher.LaunchFileAsync + +## -description +Starts the default app associated with the specified file. + +## -parameters +### -param file +The file. + +## -returns +The launch operation. + +## -remarks +The calling app must be visible to the user when the API is invoked. + +This API must be called from an ASTA thread (also known as a UI thread). + +This API also imposes several restrictions on what types of files it can launch. Many file types that contain executable code, for example .exe, .msi, and .js files, are blocked from launching. This restriction protects users from potentially malicious files that could modify the system. + +When the launch fails for any of the above reasons, the API succeeds and returns FALSE from its asynchronous operation. Since it has no ability to query whether the above restrictions apply to the current launch, the calling app should not assume that the launch succeeded, and should provide fallback mechanism in case it failed. A possible solution would be to ask the user to save the file and direct the user to open it in the desktop. + +To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. + +To display a warning that the file is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. + + + +The file is passed to the associated app. If the associated app is a desktop app, the file is passed using shell execution mechanisms. + +## -examples +This example uses [LaunchFileAsync(IStorageFile) | launchFileAsync(IStorageFile)](launcher_launchfileasync_1594978114.md) to launch a file contained in the app package. + +```javascript + +// Path to the file in the app package to launch +var imageFile = "images\\test.png"; + +// Get the image file from the package's image directory +Windows.ApplicationModel.Package.current.installedLocation.getFileAsync(imageFile).then( + function (file) { + // Launch the retrieved file using the default app + Windows.System.Launcher.launchFileAsync(file).then( + function (success) { + if (success) { + // File launched + } else { + // File launch failed + } + }); + }); +``` + +```csharp +async void DefaultLaunch() +{ + // Path to the file in the app package to launch + string imageFile = @"images\test.png"; + + var file = wait Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile); + + if (file != null) + { + // Launch the retrieved file + var success = await Windows.System.Launcher.LaunchFileAsync(file); + + if (success) + { + // File launched + } + else + { + // File launch failed + } + } + else + { + // Could not find file + } +} +``` + +```vbnet +async Sub DefaultLaunch() + + ' Path to the file in the app package to launch + Dim imageFile = "images\test.png" + + Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile) + + If file IsNot Nothing Then + ' Launch the retrieved file + Dim success = await Windows.System.Launcher.LaunchFileAsync(file) + + If success Then + ' File launched + Else + ' File launch failed + End If + Else + ' Could not find file + End If +End Sub +``` + +```cpp +void MainPage::DefaultLaunch() +{ + auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation; + + concurrency::task getFileOperation(installFolder->GetFileAsync("images\\test.png")); + getFileOperation.then([](Windows::Storage::StorageFile^ file) + { + if (file != nullptr) + { + // Launch the retrieved file + concurrency::task launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file)); + launchFileOperation.then([](bool success) + { + if (success) + { + // File launched + } + else + { + // File launch failed + } + }); + } + else + { + // Could not find file + } + }); +} +``` + + + +## -see-also +[Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a file (JavaScript)](http://msdn.microsoft.com/library/876edae5-f1a8-45f9-a1a6-50efb1025f96), [Launch the default app for a file](http://msdn.microsoft.com/library/bb45fcaf-df93-4c99-a8b5-59b799c7bd98), [LaunchFileAsync(IStorageFile, LauncherOptions)](launcher_launchfileasync_1480137410.md) \ No newline at end of file diff --git a/windows.system/launcher_launchuriasync_53691900.md b/windows.system/launcher_launchuriasync_53691900.md index 03a940250d..69cacc91ab 100644 --- a/windows.system/launcher_launchuriasync_53691900.md +++ b/windows.system/launcher_launchuriasync_53691900.md @@ -1,135 +1,135 @@ ---- --api-id: M:Windows.System.Launcher.LaunchUriAsync(Windows.Foundation.Uri) --api-type: winrt method ---- - - - -# Windows.System.Launcher.LaunchUriAsync - -## -description -Starts the default app associated with the URI scheme name for the specified URI. - -## -parameters -### -param uri -The URI. - -## -returns -Returns **true** if the default app for the URI scheme was launched; **false** otherwise. - -## -remarks -Unless you are calling this API from a Windows desktop application, this API must be called from within an ASTA thread (also known as the UI thread). - -This API may also be called from a Windows desktop application. - -This API launches the default app for the scheme whether it be a Universal Windows Platform (UWP) app or Windows desktop application. - -The calling app must be visible to the user when the API is invoked. - -You must specify the **privateNetworkClientServer** capability in the manifest in order to launch intranet URIs, for example a file:/// URI pointing to a network location. - -You cannot use this method to launch a URI in the local zone. For example, apps cannot use the **file:///** protocol to access files on the local computer. Instead, you must use the [Storage APIs](../windows.storage/windows_storage.md) to access files. - -When the launch fails for any of the above reasons, the API will succeed and return FALSE from its asynchronous operation. - -To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. - -To display a warning that the URI is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. - - - -The URI is passed to the associated app. If the associated app is a desktop app, the URI is passed using shell execution mechanisms. - -## -examples -This example uses [LaunchUriAsync(Uri) | launchUriAsync(Uri)](launcher_launchuriasync_53691900.md) to launch a URI. - -```javascript - -// The URI to launch -var uriToLaunch = "http://www.bing.com"; - -// Create a Uri object from a URI string -var uri = new Windows.Foundation.Uri(uriToLaunch); - -// Launch the URI -Windows.System.Launcher.launchUriAsync(uri).then( - function (success) { - if (success) { - // URI launched - } else { - // URI launch failed - } - }); -``` - -```csharp -// The URI to launch -string uriToLaunch = @"http://www.bing.com"; - -// Create a Uri object from a URI string -var uri = new Uri(uriToLaunch); - -// Launch the URI -async void DefaultLaunch() -{ - // Launch the URI - var success = await Windows.System.Launcher.LaunchUriAsync(uri); - - if (success) - { - // URI launched - } - else - { - // URI launch failed - } -} - -``` - -```vbnet -' The URI to launch -Dim uri As New Uri("http://www.bing.com") - -async Sub DefaultLaunch() - - ' Launch the URI - Dim success = await Windows.System.Launcher.LaunchUriAsync(uri) - - If success Then - ' URI launched - Else - ' URI launch failed - End If - -End Sub -``` - -```cpp -// The URI to launch -auto uri = ref new Windows::Foundation::Uri("http://www.bing.com"); - -void MainPage::DefaultLaunch() -{ - // Launch the URI - concurrency::task launchUriOperation(Windows::System::Launcher::LaunchUriAsync(uri)); - launchUriOperation.then([](bool success) - { - if (success) - { - // URI launched - } - else - { - // URI launch failed - } - }); -} -``` - - - -## -see-also -[LaunchUriAsync(Uri, LauncherOptions)](launcher_launchuriasync_68890748.md), [LaunchUriAsync(Uri, LauncherOptions, ValueSet)](launcher_launchuriasync_569877360.md), [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a URI (JavaScript)](XREF:TODO:m_activation.how_to_launch_the_default_handler_for_a_protocol), [Launch the default app for a URI](http://msdn.microsoft.com/library/7b0d0af5-d89e-4db0-9b79-90201d79974f) \ No newline at end of file +--- +-api-id: M:Windows.System.Launcher.LaunchUriAsync(Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.System.Launcher.LaunchUriAsync + +## -description +Starts the default app associated with the URI scheme name for the specified URI. + +## -parameters +### -param uri +The URI. + +## -returns +Returns **true** if the default app for the URI scheme was launched; **false** otherwise. + +## -remarks +Unless you are calling this API from a Windows desktop application, this API must be called from within an ASTA thread (also known as the UI thread). + +This API may also be called from a Windows desktop application. + +This API launches the default app for the scheme whether it be a Universal Windows Platform (UWP) app or Windows desktop application. + +The calling app must be visible to the user when the API is invoked. + +You must specify the **privateNetworkClientServer** capability in the manifest in order to launch intranet URIs, for example a file:/// URI pointing to a network location. + +You cannot use this method to launch a URI in the local zone. For example, apps cannot use the **file:///** protocol to access files on the local computer. Instead, you must use the [Storage APIs](../windows.storage/windows_storage.md) to access files. + +When the launch fails for any of the above reasons, the API will succeed and return FALSE from its asynchronous operation. + +To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. + +To display a warning that the URI is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. + + + +The URI is passed to the associated app. If the associated app is a desktop app, the URI is passed using shell execution mechanisms. + +## -examples +This example uses [LaunchUriAsync(Uri) | launchUriAsync(Uri)](launcher_launchuriasync_53691900.md) to launch a URI. + +```javascript + +// The URI to launch +var uriToLaunch = "http://www.bing.com"; + +// Create a Uri object from a URI string +var uri = new Windows.Foundation.Uri(uriToLaunch); + +// Launch the URI +Windows.System.Launcher.launchUriAsync(uri).then( + function (success) { + if (success) { + // URI launched + } else { + // URI launch failed + } + }); +``` + +```csharp +// The URI to launch +string uriToLaunch = @"http://www.bing.com"; + +// Create a Uri object from a URI string +var uri = new Uri(uriToLaunch); + +// Launch the URI +async void DefaultLaunch() +{ + // Launch the URI + var success = await Windows.System.Launcher.LaunchUriAsync(uri); + + if (success) + { + // URI launched + } + else + { + // URI launch failed + } +} + +``` + +```vbnet +' The URI to launch +Dim uri As New Uri("http://www.bing.com") + +async Sub DefaultLaunch() + + ' Launch the URI + Dim success = await Windows.System.Launcher.LaunchUriAsync(uri) + + If success Then + ' URI launched + Else + ' URI launch failed + End If + +End Sub +``` + +```cpp +// The URI to launch +auto uri = ref new Windows::Foundation::Uri("http://www.bing.com"); + +void MainPage::DefaultLaunch() +{ + // Launch the URI + concurrency::task launchUriOperation(Windows::System::Launcher::LaunchUriAsync(uri)); + launchUriOperation.then([](bool success) + { + if (success) + { + // URI launched + } + else + { + // URI launch failed + } + }); +} +``` + + + +## -see-also +[LaunchUriAsync(Uri, LauncherOptions)](launcher_launchuriasync_68890748.md), [LaunchUriAsync(Uri, LauncherOptions, ValueSet)](launcher_launchuriasync_569877360.md), [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a URI (JavaScript)](http://msdn.microsoft.com/library/0f9fa8db-3e51-4cf8-879d-2b79a8ddbb7d), [Launch the default app for a URI](http://msdn.microsoft.com/library/7b0d0af5-d89e-4db0-9b79-90201d79974f) \ No newline at end of file diff --git a/windows.system/launcher_launchuriasync_68890748.md b/windows.system/launcher_launchuriasync_68890748.md index 72b0ba7428..0f65455780 100644 --- a/windows.system/launcher_launchuriasync_68890748.md +++ b/windows.system/launcher_launchuriasync_68890748.md @@ -1,166 +1,166 @@ ---- --api-id: M:Windows.System.Launcher.LaunchUriAsync(Windows.Foundation.Uri,Windows.System.LauncherOptions) --api-type: winrt method ---- - - - -# Windows.System.Launcher.LaunchUriAsync - -## -description -Starts the default app associated with the URI scheme name or the one specified by the [ContentType](launcheroptions_contenttype.md) for the specified URI, using the specified options. - -## -parameters -### -param uri -The URI. - -### -param options -The launch options for the app. - -## -returns -Returns **true** if the default app for the URI scheme was launched; **false** otherwise. - -## -remarks -Unless you are calling this API from a Windows desktop application, this API must be called from within an ASTA thread (also known as the UI thread). - -This API may also be called from a Windows desktop application. - -This API launches the default app for the scheme whether it be a Universal Windows Platform (UWP) app or Windows desktop application. - -The calling app must be visible to the user when this API is invoked. - -Unless you are calling this API from a Windows desktop application, this API must be called from within an ASTA thread (also known as a UI thread). - -You must specify the **privateNetworkClientServer** capability in the manifest in order to launch intranet URIs, for example a file:/// URI pointing to a network location. - -You cannot use this method to launch a URI in the local zone. For example, apps cannot use the **file:///** protocol to access files on the local computer. Instead, you must use the [Storage APIs](../windows.storage/windows_storage.md) to access files. - -The content type is used to compute a file extension, from the extension the default app is chosen. For example a content type value of ""application/vnd.ms-word.document.12"" is mapped to ".docx" and then the default application for ".docx" is launched. For example: - -```csharp - -// this specifies the file type, which is used to bind to Word. -launcherOptions.ContentType = "application/vnd.ms-word.document.12"; -// and then this launches the file using the application -Launcher.LaunchUriAsync("http://www.cloud.com/file.docx", options); -``` - - - -When the launch fails for any of the above reasons, the API will succeed and return FALSE from its asynchronous operation. - -To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. - -To display a warning that the URI is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. - - - -The URI is passed to the associated app. If the associated app is a desktop app, the URI is passed using shell execution mechanisms. - -## -examples -This sample uses [LaunchUriAsync(Uri, LauncherOptions) | launchUriAsync(Uri, LauncherOptions)](launcher_launchuriasync_68890748.md) to launch a URI with a warning. The [TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property indicates that the system should display a warning. - -> [!NOTE] -> For Windows app using JavaScript, call [preventDefault](XREF:TODO:wwa.IDOMEvent_preventDefault) in your event handler if the [treatAsUntrusted](launcheroptions_treatasuntrusted.md) property is set and you are using an [a](XREF:TODO:wwa.A_Element_A_Object) element to launch the URI. - -```javascript - -// The URI to launch -var uriToLaunch = "http://www.bing.com"; - -// Create a Uri object from a URI string -var uri = new Windows.Foundation.Uri(uriToLaunch); - -// Launch the URI with a warning prompt -var options = new Windows.System.LauncherOptions(); -options.treatAsUntrusted = true; - -Windows.System.Launcher.launchUriAsync(uri, options).then( - function (success) { - if (success) { - // URI launched - } else { - // URI launch failed - } - }); -``` - -```csharp -// The URI to launch -string uriToLaunch = @"http://www.bing.com"; -var uri = new Uri(uriToLaunch); - -async void DefaultLaunch() -{ - // Set the option to show a warning - var options = new Windows.System.LauncherOptions(); - options.TreatAsUntrusted = true; - - // Launch the URI with a warning prompt - var success = await Windows.System.Launcher.LaunchUriAsync(uri, options); - - if (success) - { - // URI launched - } - else - { - // URI launch failed - } -} -``` - -```vbnet -' The URI to launch -Dim uri As New Uri("http://www.bing.com") - -async Sub DefaultLaunch() - - ' Set the option to show a warning - Dim options = Windows.System.LauncherOptions() - options.TreatAsUntrusted = True - - ' Launch the URI with a warning prompt - Dim success = await Windows.System.Launcher.LaunchUriAsync(uri, options) - - If success Then - ' URI launched - Else - ' URI launch failed - End If - -End Sub -``` - -```cpp -// The URI to launch -auto uri = ref new Windows::Foundation::Uri("http://www.bing.com"); - -void MainPage::DefaultLaunch() -{ - // Set the option to show a warning - auto launchOptions = ref new Windows::System::LauncherOptions(); - launchOptions->TreatAsUntrusted = true; - - // Launch the URI with a warning prompt - concurrency::task launchUriOperation(Windows::System::Launcher::LaunchUriAsync(uri, launchOptions)); - launchUriOperation.then([](bool success) - { - if (success) - { - // URI launched - } - else - { - // URI launch failed - } - }); -} -``` - - - -## -see-also -[LaunchUriAsync(Uri)](launcher_launchuriasync_53691900.md), [LaunchUriAsync(Uri, LauncherOptions, ValueSet)](launcher_launchuriasync_569877360.md), [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a URI (JavaScript)](XREF:TODO:m_activation.how_to_launch_the_default_handler_for_a_protocol), [Launch the default app for a URI](http://msdn.microsoft.com/library/7b0d0af5-d89e-4db0-9b79-90201d79974f) \ No newline at end of file +--- +-api-id: M:Windows.System.Launcher.LaunchUriAsync(Windows.Foundation.Uri,Windows.System.LauncherOptions) +-api-type: winrt method +--- + + + +# Windows.System.Launcher.LaunchUriAsync + +## -description +Starts the default app associated with the URI scheme name or the one specified by the [ContentType](launcheroptions_contenttype.md) for the specified URI, using the specified options. + +## -parameters +### -param uri +The URI. + +### -param options +The launch options for the app. + +## -returns +Returns **true** if the default app for the URI scheme was launched; **false** otherwise. + +## -remarks +Unless you are calling this API from a Windows desktop application, this API must be called from within an ASTA thread (also known as the UI thread). + +This API may also be called from a Windows desktop application. + +This API launches the default app for the scheme whether it be a Universal Windows Platform (UWP) app or Windows desktop application. + +The calling app must be visible to the user when this API is invoked. + +Unless you are calling this API from a Windows desktop application, this API must be called from within an ASTA thread (also known as a UI thread). + +You must specify the **privateNetworkClientServer** capability in the manifest in order to launch intranet URIs, for example a file:/// URI pointing to a network location. + +You cannot use this method to launch a URI in the local zone. For example, apps cannot use the **file:///** protocol to access files on the local computer. Instead, you must use the [Storage APIs](../windows.storage/windows_storage.md) to access files. + +The content type is used to compute a file extension, from the extension the default app is chosen. For example a content type value of ""application/vnd.ms-word.document.12"" is mapped to ".docx" and then the default application for ".docx" is launched. For example: + +```csharp + +// this specifies the file type, which is used to bind to Word. +launcherOptions.ContentType = "application/vnd.ms-word.document.12"; +// and then this launches the file using the application +Launcher.LaunchUriAsync("http://www.cloud.com/file.docx", options); +``` + + + +When the launch fails for any of the above reasons, the API will succeed and return FALSE from its asynchronous operation. + +To enable the user to choose an app instead of launching the default app, set the [LauncherOptions.DisplayApplicationPicker | displayApplicationPicker](launcheroptions_displayapplicationpicker.md) property. + +To display a warning that the URI is potentially unsafe, set the [LauncherOptions.TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property. + + + +The URI is passed to the associated app. If the associated app is a desktop app, the URI is passed using shell execution mechanisms. + +## -examples +This sample uses [LaunchUriAsync(Uri, LauncherOptions) | launchUriAsync(Uri, LauncherOptions)](launcher_launchuriasync_68890748.md) to launch a URI with a warning. The [TreatAsUntrusted | treatAsUntrusted](launcheroptions_treatasuntrusted.md) property indicates that the system should display a warning. + +> [!NOTE] +> For Windows app using JavaScript, call [preventDefault](XREF:TODO:wwa.IDOMEvent_preventDefault) in your event handler if the [treatAsUntrusted](launcheroptions_treatasuntrusted.md) property is set and you are using an [a](XREF:TODO:wwa.A_Element_A_Object) element to launch the URI. + +```javascript + +// The URI to launch +var uriToLaunch = "http://www.bing.com"; + +// Create a Uri object from a URI string +var uri = new Windows.Foundation.Uri(uriToLaunch); + +// Launch the URI with a warning prompt +var options = new Windows.System.LauncherOptions(); +options.treatAsUntrusted = true; + +Windows.System.Launcher.launchUriAsync(uri, options).then( + function (success) { + if (success) { + // URI launched + } else { + // URI launch failed + } + }); +``` + +```csharp +// The URI to launch +string uriToLaunch = @"http://www.bing.com"; +var uri = new Uri(uriToLaunch); + +async void DefaultLaunch() +{ + // Set the option to show a warning + var options = new Windows.System.LauncherOptions(); + options.TreatAsUntrusted = true; + + // Launch the URI with a warning prompt + var success = await Windows.System.Launcher.LaunchUriAsync(uri, options); + + if (success) + { + // URI launched + } + else + { + // URI launch failed + } +} +``` + +```vbnet +' The URI to launch +Dim uri As New Uri("http://www.bing.com") + +async Sub DefaultLaunch() + + ' Set the option to show a warning + Dim options = Windows.System.LauncherOptions() + options.TreatAsUntrusted = True + + ' Launch the URI with a warning prompt + Dim success = await Windows.System.Launcher.LaunchUriAsync(uri, options) + + If success Then + ' URI launched + Else + ' URI launch failed + End If + +End Sub +``` + +```cpp +// The URI to launch +auto uri = ref new Windows::Foundation::Uri("http://www.bing.com"); + +void MainPage::DefaultLaunch() +{ + // Set the option to show a warning + auto launchOptions = ref new Windows::System::LauncherOptions(); + launchOptions->TreatAsUntrusted = true; + + // Launch the URI with a warning prompt + concurrency::task launchUriOperation(Windows::System::Launcher::LaunchUriAsync(uri, launchOptions)); + launchUriOperation.then([](bool success) + { + if (success) + { + // URI launched + } + else + { + // URI launch failed + } + }); +} +``` + + + +## -see-also +[LaunchUriAsync(Uri)](launcher_launchuriasync_53691900.md), [LaunchUriAsync(Uri, LauncherOptions, ValueSet)](launcher_launchuriasync_569877360.md), [Association launching sample](http://go.microsoft.com/fwlink/p/?linkid=231484), [Guidelines for file types and URIs](http://msdn.microsoft.com/library/a6653b8f-763f-4d67-9d12-6af73a673bc5), [How to launch the default app for a URI (JavaScript)](http://msdn.microsoft.com/library/0f9fa8db-3e51-4cf8-879d-2b79a8ddbb7d), [Launch the default app for a URI](http://msdn.microsoft.com/library/7b0d0af5-d89e-4db0-9b79-90201d79974f) \ No newline at end of file diff --git a/windows.system/launcheroptions_limitpickertocurrentappandappurihandlers.md b/windows.system/launcheroptions_limitpickertocurrentappandappurihandlers.md new file mode 100644 index 0000000000..851c50bcbc --- /dev/null +++ b/windows.system/launcheroptions_limitpickertocurrentappandappurihandlers.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.System.LauncherOptions.LimitPickerToCurrentAppAndAppUriHandlers +-api-type: winrt property +--- + + + +# Windows.System.LauncherOptions.LimitPickerToCurrentAppAndAppUriHandlers + +## -description + +Gets or sets whether to limit the picker for the launcher to the current app and its associated URI handlers. + +## -property-value + +True if the launcher should limit the picker to the current app and its associated URI handlers; otherwise, false. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system/powerstate.md b/windows.system/powerstate.md new file mode 100644 index 0000000000..fe65969c80 --- /dev/null +++ b/windows.system/powerstate.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.System.PowerState +-api-type: winrt enum +--- + + + +# Windows.System.PowerState + +## -description + +Represents power states for fixed-purpose devices. + +## -enum-fields +### -field SleepS3:1 + +Represents Sleep S3. + +### -field ConnectedStandby:0 + +Represents Connected Standby. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.system/protocolforresultsoperation.md b/windows.system/protocolforresultsoperation.md index c08babccf1..b6c8da20b2 100644 --- a/windows.system/protocolforresultsoperation.md +++ b/windows.system/protocolforresultsoperation.md @@ -13,7 +13,7 @@ public class ProtocolForResultsOperation : Windows.System.IProtocolForResultsOpe Represents the result to the application that launched the current application for results. ## -remarks -Use this class from an activated application launched via [Launcher.LaunchUriForResultsAndContinueAsync](launcher_launchuriforresultsandcontinueasync.md) to indicate when activation is complete and to return a result to the activating application. This class is passed to the activated application's [Application.OnActivated](../windows.ui.xaml/application_onactivated.md) () method via the [IActivatedEventArgs ](../windows.applicationmodel.activation/iactivatedeventargs.md) argument. +Use this class from an activated application launched via [Launcher.LaunchUriForResultsAsync](launcher_launchuriforresultsasync_148601521.md) to indicate when activation is complete and to return a result to the activating application. This class is passed to the activated application's [Application.OnActivated](../windows.ui.xaml/application_onactivated_603737819.md) method via the [IActivatedEventArgs](../windows.applicationmodel.activation/iactivatedeventargs.md) argument. ## -examples diff --git a/windows.system/shutdownmanager_enterpowerstate_1157290732.md b/windows.system/shutdownmanager_enterpowerstate_1157290732.md new file mode 100644 index 0000000000..d1128ebc81 --- /dev/null +++ b/windows.system/shutdownmanager_enterpowerstate_1157290732.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.System.ShutdownManager.EnterPowerState(Windows.System.PowerState,Windows.Foundation.TimeSpan) +-api-type: winrt method +--- + + + +# Windows.System.ShutdownManager.EnterPowerState + +## -description +Instructs a fixed-purpose device to enter the given power state, then wake up after the given period of time. + +## -parameters + +### -param powerState + +The power state to enter. + +### -param wakeUpAfter + +The amount of time to wake up after. + +## -remarks + +This API requires the use of the IoT **systemManagement** capability, and the inclusion of **iot** in the **IgnorableNamespaces** list. Users can add the following to their **Package.appmanifest**:` +`, and add **iot** to their existing list of **IgnorableNamespaces**. + +## -see-also + +## -examples + diff --git a/windows.system/shutdownmanager_enterpowerstate_777933300.md b/windows.system/shutdownmanager_enterpowerstate_777933300.md new file mode 100644 index 0000000000..ed5142713d --- /dev/null +++ b/windows.system/shutdownmanager_enterpowerstate_777933300.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.System.ShutdownManager.EnterPowerState(Windows.System.PowerState) +-api-type: winrt method +--- + + + +# Windows.System.ShutdownManager.EnterPowerState + +## -description +Instructs a fixed-purpose device to enter the given power state. + +## -parameters + +### -param powerState + +The power state to enter. + +## -remarks + +This API requires the use of the IoT **systemManagement** capability, and the inclusion of **iot** in the **IgnorableNamespaces** list. Users can add the following to their **Package.appmanifest**:` +`, and add **iot** to their existing list of **IgnorableNamespaces**. + +## -see-also + +## -examples + diff --git a/windows.system/shutdownmanager_ispowerstatesupported_922219943.md b/windows.system/shutdownmanager_ispowerstatesupported_922219943.md new file mode 100644 index 0000000000..9af1b96fee --- /dev/null +++ b/windows.system/shutdownmanager_ispowerstatesupported_922219943.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.System.ShutdownManager.IsPowerStateSupported(Windows.System.PowerState) +-api-type: winrt method +--- + + + +# Windows.System.ShutdownManager.IsPowerStateSupported + +## -description + +Gets whether a given [power state](powerstate.md) is supported on a fixed-purpose device. +## -parameters + +### -param powerState + +## -returns + +## -remarks + +This API requires the use of the IoT **systemManagement** capability, and the inclusion of **iot** in the **IgnorableNamespaces** list. Users can add the following to their **Package.appmanifest**:` +`, and add **iot** to their existing list of **IgnorableNamespaces**. + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/compositionconditionalvalue.md b/windows.ui.composition.interactions/compositionconditionalvalue.md new file mode 100644 index 0000000000..1aefa7ffcd --- /dev/null +++ b/windows.ui.composition.interactions/compositionconditionalvalue.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Composition.Interactions.CompositionConditionalValue +-api-type: winrt class +--- + + + +# Windows.UI.Composition.Interactions.CompositionConditionalValue + +## -description +Allows conditional modification of the position and scale of a visual interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/compositionconditionalvalue_condition.md b/windows.ui.composition.interactions/compositionconditionalvalue_condition.md new file mode 100644 index 0000000000..d68bf25f8f --- /dev/null +++ b/windows.ui.composition.interactions/compositionconditionalvalue_condition.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.CompositionConditionalValue.Condition +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.CompositionConditionalValue.Condition + +## -description +The condition expression that determines when to apply modifiers to the visual interaction source. + +## -property-value +The condition expression that determines when to apply modifiers to the visual interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/compositionconditionalvalue_create_996921895.md b/windows.ui.composition.interactions/compositionconditionalvalue_create_996921895.md new file mode 100644 index 0000000000..107808d7f6 --- /dev/null +++ b/windows.ui.composition.interactions/compositionconditionalvalue_create_996921895.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.CompositionConditionalValue.Create(Windows.UI.Composition.Compositor) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.CompositionConditionalValue.Create + +## -description +Creates an instance of CompositionConditionalValue. + +## -parameters + +### -param compositor + +## -returns +Returns the created CompositionConditionalValue. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/compositionconditionalvalue_value.md b/windows.ui.composition.interactions/compositionconditionalvalue_value.md new file mode 100644 index 0000000000..6158665fd6 --- /dev/null +++ b/windows.ui.composition.interactions/compositionconditionalvalue_value.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.CompositionConditionalValue.Value +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.CompositionConditionalValue.Value + +## -description +The modified input expression to be applied when the condition is true. + +## -property-value +The modified input expression to be applied when the condition is true. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontracker_configurecenterpointxinertiamodifiers_943992890.md b/windows.ui.composition.interactions/interactiontracker_configurecenterpointxinertiamodifiers_943992890.md new file mode 100644 index 0000000000..0e74dc8ac0 --- /dev/null +++ b/windows.ui.composition.interactions/interactiontracker_configurecenterpointxinertiamodifiers_943992890.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.InteractionTracker.ConfigureCenterPointXInertiaModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.CompositionConditionalValue}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.InteractionTracker.ConfigureCenterPointXInertiaModifiers + +## -description +Configures centerpoint inertia modifiers for the X direction. + +## -parameters + +### -param conditionalValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/interactiontracker_configurecenterpointyinertiamodifiers_947204263.md b/windows.ui.composition.interactions/interactiontracker_configurecenterpointyinertiamodifiers_947204263.md new file mode 100644 index 0000000000..744f0895ab --- /dev/null +++ b/windows.ui.composition.interactions/interactiontracker_configurecenterpointyinertiamodifiers_947204263.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.InteractionTracker.ConfigureCenterPointYInertiaModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.CompositionConditionalValue}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.InteractionTracker.ConfigureCenterPointYInertiaModifiers + +## -description +Configures centerpoint inertia modifiers for the Y direction. + +## -parameters + +### -param conditionalValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_configurecenterpointxmodifiers_1359731989.md b/windows.ui.composition.interactions/visualinteractionsource_configurecenterpointxmodifiers_1359731989.md new file mode 100644 index 0000000000..8040158590 --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_configurecenterpointxmodifiers_1359731989.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureCenterPointXModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.CompositionConditionalValue}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureCenterPointXModifiers + +## -description +Configures centerpoint modifiers for the X direction. +## -parameters + +### -param conditionalValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_configurecenterpointymodifiers_1359729238.md b/windows.ui.composition.interactions/visualinteractionsource_configurecenterpointymodifiers_1359729238.md new file mode 100644 index 0000000000..c7a21d80ba --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_configurecenterpointymodifiers_1359729238.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureCenterPointYModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.CompositionConditionalValue}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureCenterPointYModifiers + +## -description +Configures centerpoint modifiers for the Y direction. + +## -parameters + +### -param conditionalValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_configuredeltapositionxmodifiers_2021723623.md b/windows.ui.composition.interactions/visualinteractionsource_configuredeltapositionxmodifiers_2021723623.md new file mode 100644 index 0000000000..355c29479a --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_configuredeltapositionxmodifiers_2021723623.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureDeltaPositionXModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.CompositionConditionalValue}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureDeltaPositionXModifiers + +## -description +Configures position modifiers for the X direction. + +## -parameters + +### -param conditionalValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_configuredeltapositionymodifiers_702392550.md b/windows.ui.composition.interactions/visualinteractionsource_configuredeltapositionymodifiers_702392550.md new file mode 100644 index 0000000000..070061fe7c --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_configuredeltapositionymodifiers_702392550.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureDeltaPositionYModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.CompositionConditionalValue}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureDeltaPositionYModifiers + +## -description +Configures modifiers for the Y direction. + +## -parameters + +### -param conditionalValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_configuredeltascalemodifiers_56287112.md b/windows.ui.composition.interactions/visualinteractionsource_configuredeltascalemodifiers_56287112.md new file mode 100644 index 0000000000..2465a87137 --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_configuredeltascalemodifiers_56287112.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureDeltaScaleModifiers(Windows.Foundation.Collections.IIterable{Windows.UI.Composition.Interactions.CompositionConditionalValue}) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.ConfigureDeltaScaleModifiers + +## -description +Configures modifiers for scale. + +## -parameters + +### -param conditionalValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_deltaposition.md b/windows.ui.composition.interactions/visualinteractionsource_deltaposition.md new file mode 100644 index 0000000000..cd0c01a66c --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_deltaposition.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.VisualInteractionSource.DeltaPosition +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.DeltaPosition + +## -description +The change in position of the interaction source. + +## -property-value +The change in position of the interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_deltascale.md b/windows.ui.composition.interactions/visualinteractionsource_deltascale.md new file mode 100644 index 0000000000..7fb6b832c2 --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_deltascale.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.VisualInteractionSource.DeltaScale +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.DeltaScale + +## -description +The change in scale of the visual interaction source. + +## -property-value +The change in scale of the visual interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_position.md b/windows.ui.composition.interactions/visualinteractionsource_position.md new file mode 100644 index 0000000000..362eac09fd --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_position.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.VisualInteractionSource.Position +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.Position + +## -description +The position of the interaction source. + +## -property-value +The position of the interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_positionvelocity.md b/windows.ui.composition.interactions/visualinteractionsource_positionvelocity.md new file mode 100644 index 0000000000..695ca09cc2 --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_positionvelocity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.VisualInteractionSource.PositionVelocity +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.PositionVelocity + +## -description +The position velocity of the interaction source. + +## -property-value +The position velocity of the interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_scale.md b/windows.ui.composition.interactions/visualinteractionsource_scale.md new file mode 100644 index 0000000000..5685dbed76 --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_scale.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.VisualInteractionSource.Scale +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.Scale + +## -description +The scale of the interaction source. + +## -property-value +The scale of the interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition.interactions/visualinteractionsource_scalevelocity.md b/windows.ui.composition.interactions/visualinteractionsource_scalevelocity.md new file mode 100644 index 0000000000..aadaee01f5 --- /dev/null +++ b/windows.ui.composition.interactions/visualinteractionsource_scalevelocity.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.Interactions.VisualInteractionSource.ScaleVelocity +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Interactions.VisualInteractionSource.ScaleVelocity + +## -description +The scale velocity of the interaction source. + +## -property-value +The scale velocity of the interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/animationdelaybehavior.md b/windows.ui.composition/animationdelaybehavior.md new file mode 100644 index 0000000000..170cd29d4c --- /dev/null +++ b/windows.ui.composition/animationdelaybehavior.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.Composition.AnimationDelayBehavior +-api-type: winrt enum +--- + + + +# Windows.UI.Composition.AnimationDelayBehavior + +## -description +Specifies the animation delay behavior. + +## -enum-fields +### -field SetInitialValueBeforeDelay:1 +Applies the initial value of the animation (i.e. the value at Keyframe 0) to the object before the delay time is elapsed (when there is a DelayTime specified), it then delays starting the animation according to the DelayTime. + +### -field SetInitialValueAfterDelay:0 +Does not compute anything in animation nor holds the value of composition object property. If a DelayTime is specified, it delays starting the animation according to delay time and after delay has expired it applies animation to the object property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncapabilities.md b/windows.ui.composition/compositioncapabilities.md new file mode 100644 index 0000000000..9c7fb64f23 --- /dev/null +++ b/windows.ui.composition/compositioncapabilities.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Composition.CompositionCapabilities +-api-type: winrt class +--- + + + +# Windows.UI.Composition.CompositionCapabilities + +## -description +Allows ability to check system hardware capabilities in order to gracefully scale effects performantly. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncapabilities_areeffectsfast_2106182913.md b/windows.ui.composition/compositioncapabilities_areeffectsfast_2106182913.md new file mode 100644 index 0000000000..392ed174fd --- /dev/null +++ b/windows.ui.composition/compositioncapabilities_areeffectsfast_2106182913.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionCapabilities.AreEffectsFast +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionCapabilities.AreEffectsFast + +## -description +Indicates whether fast effects are supported. + +## -returns +Returns a boolean indicating whether fast effects are supported. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncapabilities_areeffectssupported_1729323850.md b/windows.ui.composition/compositioncapabilities_areeffectssupported_1729323850.md new file mode 100644 index 0000000000..b4b05f8018 --- /dev/null +++ b/windows.ui.composition/compositioncapabilities_areeffectssupported_1729323850.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionCapabilities.AreEffectsSupported +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionCapabilities.AreEffectsSupported + +## -description +Indicates whether effects are supported. + +## -returns +Returns a boolean indicating whether effects are supported. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncapabilities_changed.md b/windows.ui.composition/compositioncapabilities_changed.md new file mode 100644 index 0000000000..ed486458a6 --- /dev/null +++ b/windows.ui.composition/compositioncapabilities_changed.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.UI.Composition.CompositionCapabilities.Changed +-api-type: winrt event +--- + + + +# Windows.UI.Composition.CompositionCapabilities.Changed + +## -description +Event triggered when the supported composition capabilities changes. + +## -remarks +This event may be triggered in a variety of scenarios such as when dragging an application from a monitor attached to a GPU of capabilities 9.1 to one of higher level, or when initiating a device driver update. + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositioncapabilities_getforcurrentview_1363600702.md b/windows.ui.composition/compositioncapabilities_getforcurrentview_1363600702.md new file mode 100644 index 0000000000..a80a7229d4 --- /dev/null +++ b/windows.ui.composition/compositioncapabilities_getforcurrentview_1363600702.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionCapabilities.GetForCurrentView +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionCapabilities.GetForCurrentView + +## -description +Gets the supported composition capabilities for the current view. + +## -parameters + +## -returns +Returns the supported composition capabilities for the current view. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiondrawingsurface_resize_102971024.md b/windows.ui.composition/compositiondrawingsurface_resize_102971024.md new file mode 100644 index 0000000000..4918d4f133 --- /dev/null +++ b/windows.ui.composition/compositiondrawingsurface_resize_102971024.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionDrawingSurface.Resize(Windows.Graphics.SizeInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionDrawingSurface.Resize + +## -description +Resizes the drawing surface to the specified size. + +## -parameters + +### -param sizePixels +The new size in pixels for the drawing surface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiondrawingsurface_scroll_1489287671.md b/windows.ui.composition/compositiondrawingsurface_scroll_1489287671.md new file mode 100644 index 0000000000..0c586c9477 --- /dev/null +++ b/windows.ui.composition/compositiondrawingsurface_scroll_1489287671.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionDrawingSurface.Scroll(Windows.Graphics.PointInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionDrawingSurface.Scroll + +## -description +Scrolls the drawing surface. + +## -parameters + +### -param offset +The scrolling offset. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiondrawingsurface_scroll_2001735575.md b/windows.ui.composition/compositiondrawingsurface_scroll_2001735575.md new file mode 100644 index 0000000000..d2005d3dd8 --- /dev/null +++ b/windows.ui.composition/compositiondrawingsurface_scroll_2001735575.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionDrawingSurface.Scroll(Windows.Graphics.PointInt32,Windows.Graphics.RectInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionDrawingSurface.Scroll + +## -description +Scrolls the drawing surface. + +## -parameters + +### -param offset +The scrolling offset. + +### -param scrollRect +The scrolling rectangle. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiondrawingsurface_scrollwithclip_1836943664.md b/windows.ui.composition/compositiondrawingsurface_scrollwithclip_1836943664.md new file mode 100644 index 0000000000..3ac848516e --- /dev/null +++ b/windows.ui.composition/compositiondrawingsurface_scrollwithclip_1836943664.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionDrawingSurface.ScrollWithClip(Windows.Graphics.PointInt32,Windows.Graphics.RectInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionDrawingSurface.ScrollWithClip + +## -description +Scrolls the drawing surface using the specified clip rectangle. + +## -parameters + +### -param offset +The scrolling offset. + +### -param clipRect +The clipping rectangle to apply. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiondrawingsurface_scrollwithclip_844424688.md b/windows.ui.composition/compositiondrawingsurface_scrollwithclip_844424688.md new file mode 100644 index 0000000000..d65e3f49ee --- /dev/null +++ b/windows.ui.composition/compositiondrawingsurface_scrollwithclip_844424688.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionDrawingSurface.ScrollWithClip(Windows.Graphics.PointInt32,Windows.Graphics.RectInt32,Windows.Graphics.RectInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionDrawingSurface.ScrollWithClip + +## -description +Scrolls the drawing surface with the specified clip rectangle. + +## -parameters + +### -param offset +The scrolling offset. + +### -param clipRect +The clipping rectangle to apply. + +### -param scrollRect +The scrolling rectangle. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiondrawingsurface_sizeint32.md b/windows.ui.composition/compositiondrawingsurface_sizeint32.md new file mode 100644 index 0000000000..c466188c40 --- /dev/null +++ b/windows.ui.composition/compositiondrawingsurface_sizeint32.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.CompositionDrawingSurface.SizeInt32 +-api-type: winrt property +--- + + + +# Windows.UI.Composition.CompositionDrawingSurface.SizeInt32 + +## -description +The size of the drawing surface. + +## -property-value +The size of the drawing surface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongraphicsdevice_createdrawingsurface2_1137892861.md b/windows.ui.composition/compositiongraphicsdevice_createdrawingsurface2_1137892861.md new file mode 100644 index 0000000000..475730557a --- /dev/null +++ b/windows.ui.composition/compositiongraphicsdevice_createdrawingsurface2_1137892861.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionGraphicsDevice.CreateDrawingSurface2(Windows.Graphics.SizeInt32,Windows.Graphics.DirectX.DirectXPixelFormat,Windows.Graphics.DirectX.DirectXAlphaMode) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionGraphicsDevice.CreateDrawingSurface2 + +## -description +Creates an instance of CompositionDrawingSurface. + +## -parameters + +### -param sizePixels +The size of the drawing surface in pixels. + +### -param pixelFormat +The pixel format of the drawing surface. + +### -param alphaMode +The alpha mode of the drawing surface. + +## -returns +Returns the created CompositionDrawingSurface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositiongraphicsdevice_createvirtualdrawingsurface_1646636583.md b/windows.ui.composition/compositiongraphicsdevice_createvirtualdrawingsurface_1646636583.md new file mode 100644 index 0000000000..c248fa42ea --- /dev/null +++ b/windows.ui.composition/compositiongraphicsdevice_createvirtualdrawingsurface_1646636583.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionGraphicsDevice.CreateVirtualDrawingSurface(Windows.Graphics.SizeInt32,Windows.Graphics.DirectX.DirectXPixelFormat,Windows.Graphics.DirectX.DirectXAlphaMode) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionGraphicsDevice.CreateVirtualDrawingSurface + +## -description +Creates an instance of CompositionVirtualDrawingSurface. + +## -parameters + +### -param sizePixels +The size in pixels of the drawing surface. + +### -param pixelFormat +The pixel format of the drawing surface. + +### -param alphaMode +The alpha mode of the drawing surface. + +## -returns +Returns the created CompositionVirtualDrawingSurface. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositionvirtualdrawingsurface.md b/windows.ui.composition/compositionvirtualdrawingsurface.md new file mode 100644 index 0000000000..783363fc8e --- /dev/null +++ b/windows.ui.composition/compositionvirtualdrawingsurface.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Composition.CompositionVirtualDrawingSurface +-api-type: winrt class +--- + + + +# Windows.UI.Composition.CompositionVirtualDrawingSurface + +## -description +Represents sparsely allocated bitmaps that can be associated with visuals for composition in a visual tree. + +## -remarks +The virtual drawing surface is designed for usage in scenarios where an application needs to define a large amount of content but only expects a small portion of content to be visible to a user at a given time. For example, think of a long scrolling document or webpage. In such cases, the app only needs to draw the part of the surface that is currently visible to the user, and can defer drawing portions that are not visible until later when they become visible. + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositionvirtualdrawingsurface_trim_1820109420.md b/windows.ui.composition/compositionvirtualdrawingsurface_trim_1820109420.md new file mode 100644 index 0000000000..aba9e7157f --- /dev/null +++ b/windows.ui.composition/compositionvirtualdrawingsurface_trim_1820109420.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Composition.CompositionVirtualDrawingSurface.Trim(Windows.Graphics.RectInt32[]) +-api-type: winrt method +--- + + + +# Windows.UI.Composition.CompositionVirtualDrawingSurface.Trim + +## -description +Clears portions of a virtual drawing surface that were previously defined. Areas that are cleared will be treated as empty once again, and video memory that was previously backing them will be reclaimed. + + +## -parameters + +### -param rects +The region of the drawing surface to trim. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/compositor_createcontainervisual_1155667458.md b/windows.ui.composition/compositor_createcontainervisual_1155667458.md index 1c565aee34..8cc2cb4fb0 100644 --- a/windows.ui.composition/compositor_createcontainervisual_1155667458.md +++ b/windows.ui.composition/compositor_createcontainervisual_1155667458.md @@ -46,22 +46,36 @@ _root.Children.InsertAtTop(child); ```cpp -_compositor = ref new Compositor(); - -_root = _compositor->CreateContainerVisual(); -_view->CompositionRootVisual = _root; - -// -// Create a simple scene. -// - -auto child = _compositor->CreateSpriteVisual(); -child->Brush = _compositor.CreateColorBrush(ColorHelper::FromArgb(0xFF, 0x00, 0xCC, 0x00)); -child->Offset = float2(50.0f, 50.0f); -child->Size = float2(200, 200); - -_root->Children->InsertAtTop(child); - +ref class MyClass +{ +    Compositor ^ _compositor; +    CompositionTarget ^ _target; +    ContainerVisual ^ _root; +  +    void Initialize() +    { +        // +        // Set up Composition. +        // +  +        _compositor = ref new Compositor(); +        _target = _compositor->CreateTargetForCurrentView(); +        _root = _compositor->CreateContainerVisual(); +        _target->Root = _root; +  +        +        // +        // Create a simple scene. +        // +        +        auto child = _compositor->CreateSpriteVisual(); +        child->Brush = _compositor.CreateColorBrush(ColorHelper::FromArgb(0xFF, 0x00, 0xCC, 0x00)); +        child->Offset = float2(50.0f, 50.0f); +        child->Size = float2(200, 200); +        +        _root->Children->InsertAtTop(child); +    } +} ``` diff --git a/windows.ui.composition/compositor_createhostbackdropbrush_565383631.md b/windows.ui.composition/compositor_createhostbackdropbrush_565383631.md new file mode 100644 index 0000000000..aa68327e2e --- /dev/null +++ b/windows.ui.composition/compositor_createhostbackdropbrush_565383631.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Composition.Compositor.CreateHostBackdropBrush +-api-type: winrt method +--- + + + +# Windows.UI.Composition.Compositor.CreateHostBackdropBrush + +## -description +Creates an instance of CompositionBackdropBrush that samples from the area behind the visual, before the window is drawn. + +## -returns +Returns the created CompositionBackdropBrush. + +## -remarks +The standard backdrop brush samples the area immediately behind the visual where it is used. The host backdrop brush tells the compositor to sample from the area behind the visual, before the window is drawn. The host backdrop brush is translucent and it hit-tests as opaque. The app cannot read the pixel data back. + +## -see-also + +## -examples + diff --git a/windows.ui.composition/keyframeanimation_delaybehavior.md b/windows.ui.composition/keyframeanimation_delaybehavior.md new file mode 100644 index 0000000000..7a3e4b3b5b --- /dev/null +++ b/windows.ui.composition/keyframeanimation_delaybehavior.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Composition.KeyFrameAnimation.DelayBehavior +-api-type: winrt property +--- + + + +# Windows.UI.Composition.KeyFrameAnimation.DelayBehavior + +## -description +The delay behavior of the key frame animation. + +## -property-value +The delay behavior of the key frame animation. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.composition/visual_parentfortransform.md b/windows.ui.composition/visual_parentfortransform.md new file mode 100644 index 0000000000..219b543d51 --- /dev/null +++ b/windows.ui.composition/visual_parentfortransform.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Composition.Visual.ParentForTransform +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Visual.ParentForTransform + +## -description +Visual specifying the coordinate system in which this visual is composed. + +## -property-value +Visual specifying the coordinate system in which this visual is composed. + +## -remarks +ParentForTransform allows you to change the coordinate system in which a visual is composed. You can specify another visual that acts as a visual's "transform parent". That is, the visual in question will inherit accumulated transforms as though it were the child of that other visual. Note that this includes the effects of all properties that relate to transform, such as Visual.RotationAngle, or Visual.AnchorPoint, on the specified "transform parent" visual and all of its "transform ancestors". + +## -see-also + +## -examples + diff --git a/windows.ui.composition/visual_relativeoffsetadjustment.md b/windows.ui.composition/visual_relativeoffsetadjustment.md new file mode 100644 index 0000000000..40cd3a71f3 --- /dev/null +++ b/windows.ui.composition/visual_relativeoffsetadjustment.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Composition.Visual.RelativeOffsetAdjustment +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Visual.RelativeOffsetAdjustment + +## -description +Specifies the offset of the visual with respect to the size of its parent visual. + +## -property-value +The offset of the visual with respect to the size of its parent visual. + +## -remarks +Value is normalized with respect to the size of the visuals parent. For example, a value of (0.0, 0.5, 0.0) means that the +vertical position of the visual is at the midpoint between the top and bottom of its parent visuals bounds. This property is a Vector3 for consistency with the Offset property, however the Z component of the RelativeOffsetAdjustment property currently has no effect. + +## -see-also + +## -examples + diff --git a/windows.ui.composition/visual_relativesizeadjustment.md b/windows.ui.composition/visual_relativesizeadjustment.md new file mode 100644 index 0000000000..f970e660bb --- /dev/null +++ b/windows.ui.composition/visual_relativesizeadjustment.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Composition.Visual.RelativeSizeAdjustment +-api-type: winrt property +--- + + + +# Windows.UI.Composition.Visual.RelativeSizeAdjustment + +## -description +The size of the visual with respect to the size of its parent visual. + +## -property-value +The size of the visual with respect to the size of its parent visual. + +## -remarks +Value is normalized with respect to the size of the visual's parent. For example, a value of (1.0, 0.5) indicates that the visual should be the full width of its parent but only half the height. + +## -see-also + +## -examples + diff --git a/windows.ui.core/corewindow_resizecompleted.md b/windows.ui.core/corewindow_resizecompleted.md new file mode 100644 index 0000000000..7ed89297ed --- /dev/null +++ b/windows.ui.core/corewindow_resizecompleted.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.Core.CoreWindow.ResizeCompleted +-api-type: winrt event +--- + + + +# Windows.UI.Core.CoreWindow.ResizeCompleted + +## -description +Occurs when a user finishes resizing the window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/corewindow_resizestarted.md b/windows.ui.core/corewindow_resizestarted.md new file mode 100644 index 0000000000..2b70543324 --- /dev/null +++ b/windows.ui.core/corewindow_resizestarted.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.Core.CoreWindow.ResizeStarted +-api-type: winrt event +--- + + + +# Windows.UI.Core.CoreWindow.ResizeStarted + +## -description +Occurs when a user starts to resize the window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/systemnavigationcloserequestedeventargs.md b/windows.ui.core/systemnavigationcloserequestedeventargs.md new file mode 100644 index 0000000000..b85fac6289 --- /dev/null +++ b/windows.ui.core/systemnavigationcloserequestedeventargs.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Core.SystemNavigationCloseRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Core.SystemNavigationCloseRequestedEventArgs + +## -description +Provides event data for the [CloseRequested](systemnavigationmanager_closerequested.md) event. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/systemnavigationcloserequestedeventargs_getdeferral_254836512.md b/windows.ui.core/systemnavigationcloserequestedeventargs_getdeferral_254836512.md new file mode 100644 index 0000000000..eaf99a4761 --- /dev/null +++ b/windows.ui.core/systemnavigationcloserequestedeventargs_getdeferral_254836512.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Core.SystemNavigationCloseRequestedEventArgs.GetDeferral +-api-type: winrt method +--- + + + +# Windows.UI.Core.SystemNavigationCloseRequestedEventArgs.GetDeferral + +## -description +Provides an opportunity for the app to defer the closing of the window. + +## -returns +The deferral object you can call to defer the closing of the window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/systemnavigationcloserequestedeventargs_handled.md b/windows.ui.core/systemnavigationcloserequestedeventargs_handled.md new file mode 100644 index 0000000000..8fb3f3b34e --- /dev/null +++ b/windows.ui.core/systemnavigationcloserequestedeventargs_handled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Core.SystemNavigationCloseRequestedEventArgs.Handled +-api-type: winrt property +--- + + + +# Windows.UI.Core.SystemNavigationCloseRequestedEventArgs.Handled + +## -description +Gets or sets a value that can cancel the closing of the window. + +## -property-value +**true** to cancel the closing of the window. **false** to use default behavior. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/systemnavigationmanager_closerequested.md b/windows.ui.core/systemnavigationmanager_closerequested.md new file mode 100644 index 0000000000..05cd0e16a9 --- /dev/null +++ b/windows.ui.core/systemnavigationmanager_closerequested.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.Core.SystemNavigationManager.CloseRequested +-api-type: winrt event +--- + + + +# Windows.UI.Core.SystemNavigationManager.CloseRequested + +## -description +Occurs when a user initiates closing the app window using a UI affordance such as the system close button ('x'). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.core/touchhittestingeventargs_boundingbox.md b/windows.ui.core/touchhittestingeventargs_boundingbox.md index 1020d34e2d..9b0f299ef7 100644 --- a/windows.ui.core/touchhittestingeventargs_boundingbox.md +++ b/windows.ui.core/touchhittestingeventargs_boundingbox.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.UI.Core.TouchHitTestingEventArgs.BoundingBox --api-type: winrt property ---- - - - -# Windows.UI.Core.TouchHitTestingEventArgs.BoundingBox - -## -description -Gets the bounding rectangle of the touch contact area. - -## -property-value -Bounding rectangle of the touch contact area. - -## -remarks -The bounding rectangle is the area in which valid touch targets will be identified and ranked. - -> [!NOTE] -> This bounding box may differ from the contact area reported by the digitizer when: + The digitizer reports a touch contact area that is outside the maximum or minimum size threshold recognized by [Touch Hit Testing](XREF:TODO:touch_hittest.touch_hit_testing_portal). -+ A portion of the touch contact area is occluded by another object higher in the z-order. - - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Core.TouchHitTestingEventArgs.BoundingBox +-api-type: winrt property +--- + + + +# Windows.UI.Core.TouchHitTestingEventArgs.BoundingBox + +## -description +Gets the bounding rectangle of the touch contact area. + +## -property-value +Bounding rectangle of the touch contact area. + +## -remarks +The bounding rectangle is the area in which valid touch targets will be identified and ranked. + +> [!NOTE] +> This bounding box may differ from the contact area reported by the digitizer when: + The digitizer reports a touch contact area that is outside the maximum or minimum size threshold recognized by [Touch Hit Testing](http://msdn.microsoft.com/library/bdd7630c-b2d8-4080-a149-efec018f697d). ++ A portion of the touch contact area is occluded by another object higher in the z-order. + + +## -examples + +## -see-also diff --git a/windows.ui.input.core/radialcontrollerindependentinputsource.md b/windows.ui.input.core/radialcontrollerindependentinputsource.md new file mode 100644 index 0000000000..ca91be3beb --- /dev/null +++ b/windows.ui.input.core/radialcontrollerindependentinputsource.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Core.RadialControllerIndependentInputSource +-api-type: winrt class +--- + + + +# Windows.UI.Input.Core.RadialControllerIndependentInputSource + +## -description +Manages the radial controller input on the background thread. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.core/radialcontrollerindependentinputsource_controller.md b/windows.ui.input.core/radialcontrollerindependentinputsource_controller.md new file mode 100644 index 0000000000..3953d50712 --- /dev/null +++ b/windows.ui.input.core/radialcontrollerindependentinputsource_controller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Core.RadialControllerIndependentInputSource.Controller +-api-type: winrt property +--- + + + +# Windows.UI.Input.Core.RadialControllerIndependentInputSource.Controller + +## -description +Gets a reference to a wheel input device or accessory such as the Surface Dial. + +## -property-value +The wheel input device. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.core/radialcontrollerindependentinputsource_createforview_725120860.md b/windows.ui.input.core/radialcontrollerindependentinputsource_createforview_725120860.md new file mode 100644 index 0000000000..880570e542 --- /dev/null +++ b/windows.ui.input.core/radialcontrollerindependentinputsource_createforview_725120860.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Input.Core.RadialControllerIndependentInputSource.CreateForView(Windows.ApplicationModel.Core.CoreApplicationView) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Core.RadialControllerIndependentInputSource.CreateForView + +## -description +Gets an instance of [RadialControllerIndependentInputSource](radialcontrollerindependentinputsource.md) for the running app's current [CoreWindow](../windows.ui.core/corewindow.md). + +## -parameters + +### -param view +The app window and its thread. + +## -returns +The radial controller input manager. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.core/radialcontrollerindependentinputsource_dispatcher.md b/windows.ui.input.core/radialcontrollerindependentinputsource_dispatcher.md new file mode 100644 index 0000000000..3317b54e6b --- /dev/null +++ b/windows.ui.input.core/radialcontrollerindependentinputsource_dispatcher.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Core.RadialControllerIndependentInputSource.Dispatcher +-api-type: winrt property +--- + + + +# Windows.UI.Input.Core.RadialControllerIndependentInputSource.Dispatcher + +## -description +Gets the event message dispatcher associated with the current view. + +## -property-value +The event message dispatcher. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.core/windows_ui_input_core.md b/windows.ui.input.core/windows_ui_input_core.md new file mode 100644 index 0000000000..711acb80fe --- /dev/null +++ b/windows.ui.input.core/windows_ui_input_core.md @@ -0,0 +1,20 @@ +--- +-api-id: N:Windows.UI.Input.Core +-api-type: winrt namespace +--- + + + +# Windows.UI.Input.Core + +## -description +Provides support for processing input on a background thread. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode.md b/windows.ui.input.inking.analysis/iinkanalysisnode.md new file mode 100644 index 0000000000..292c59c62f --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode +-api-type: winrt interface +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode + +## -description +Represents a single node from the tree of objects generated by the ink analysis process. + +Ink analysis can categorize ink strokes into either writing or drawing strokes, and recognize text, shapes, and basic layout structures. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode_boundingrect.md b/windows.ui.input.inking.analysis/iinkanalysisnode_boundingrect.md new file mode 100644 index 0000000000..a497a4e28d --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode_boundingrect.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.BoundingRect + +## -description +Gets the position and size of a single node belonging to the IInkAnalysisNode object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the IInkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -remarks + +## -see-also +[IInkAnalysisNode.RotatedBoundingRect](iinkanalysisnode_rotatedboundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode_children.md b/windows.ui.input.inking.analysis/iinkanalysisnode_children.md new file mode 100644 index 0000000000..e1beae40c0 --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Children + +## -description +Gets all child nodes of a single node belonging to the IInkAnalysisNode object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/iinkanalysisnode_getstrokeids_1188995398.md new file mode 100644 index 0000000000..fcf30c9c92 --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode_getstrokeids_1188995398.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the IInkAnalysisNode object. + +## -params +This method has no parameters. + +## -returns +Type: IVectorView +The collection of node identifiers. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode_id.md b/windows.ui.input.inking.analysis/iinkanalysisnode_id.md new file mode 100644 index 0000000000..45b5f79802 --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Id + +## -description +Gets the unique identifier of a single node belonging to the IInkAnalysisNode object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode_kind.md b/windows.ui.input.inking.analysis/iinkanalysisnode_kind.md new file mode 100644 index 0000000000..ec64783015 --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by ink analysis for the IInkAnalysisNode object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode_parent.md b/windows.ui.input.inking.analysis/iinkanalysisnode_parent.md new file mode 100644 index 0000000000..6ea43540e5 --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.Parent + +## -description +Gets the parent node of the IInkAnalysisNode object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalysisnode_rotatedboundingrect.md b/windows.ui.input.inking.analysis/iinkanalysisnode_rotatedboundingrect.md new file mode 100644 index 0000000000..437fb809ec --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalysisnode_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalysisNode.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of a single node belonging to the IInkAnalysisNode object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the IInkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[IInkAnalysisNode.BoundingRect](iinkanalysisnode_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalyzerfactory.md b/windows.ui.input.inking.analysis/iinkanalyzerfactory.md new file mode 100644 index 0000000000..6e700264e5 --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalyzerfactory.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.IInkAnalyzerFactory +-api-type: winrt interface +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalyzerFactory + +## -description +Represents a factory for generating [InkAnalyzer](inkanalyzer.md) objects used in ink analysis. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/iinkanalyzerfactory_createanalyzer_541035770.md b/windows.ui.input.inking.analysis/iinkanalyzerfactory_createanalyzer_541035770.md new file mode 100644 index 0000000000..7d4780b6e0 --- /dev/null +++ b/windows.ui.input.inking.analysis/iinkanalyzerfactory_createanalyzer_541035770.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.IInkAnalyzerFactory.CreateAnalyzer +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.IInkAnalyzerFactory.CreateAnalyzer + +## -description +Retrieves a new instance of an [InkAnalyzer](inkanalyzer.md) object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisdrawingkind.md b/windows.ui.input.inking.analysis/inkanalysisdrawingkind.md new file mode 100644 index 0000000000..31bdf5eee8 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisdrawingkind.md @@ -0,0 +1,85 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisDrawingKind +-api-type: winrt enumeration +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisDrawingKind + +## -description +Specifies the shapes that an InkAnalyzer can recognize when [InkAnalysisNode.Kind](inkanalysisnode_kind.md) is set to [InkDrawing](inkanalysisnodekind.md). + +## -enum-fields + +## -field Triangle:3 +Drawing is recognized as a triangle. + +## -field Trapezoid:11 +Drawing is recognized as a trapezoid. + +## -field Square:9 +Drawing is recognized as a square. + +## -field RightTriangle:6 +Drawing is recognized as a right angle triangle. + +## -field Rectangle:8 +Drawing is recognized as a right rectangle. + +## -field Quadrilateral:7 +Drawing is recognized as a quadrilateral. + +## -field Pentagon:13 +Drawing is recognized as a pentagon. + +## -field Parallelogram:12 +Drawing is recognized as a parallelogram. + +## -field IsoscelesTriangle:4 +Drawing is recognized as an isosceles triangle. + +## -field Hexagon:14 +Drawing is recognized as a hexagon. + +## -field EquilateralTriangle:5 +Drawing is recognized as an equilateral triangle. + +## -field Ellipse:2 +Drawing is recognized as an ellipse. + +## -field Drawing:0 +Drawing is not recognized as one of the shapes listed. + +## -field Diamond:10 +Drawing is recognized as a diamond. + +## -field Circle:1 +Drawing is recognized as a circle. + +## -remarks + +## -see-also +[InkAnalysisNode.Kind](inkanalysisnode_kind.md) +[InkDrawing](inkanalysisnodekind.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet.md new file mode 100644 index 0000000000..a86e7b4609 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.InkBullet](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_boundingrect.md new file mode 100644 index 0000000000..1a73a3c557 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_boundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisInkBullet object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisInkBullet object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisInkBullet.RotatedBoundingRect](inkanalysisinkbullet_rotatedboundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_children.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_children.md new file mode 100644 index 0000000000..ea600080bc --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Children + +## -description +Gets all child nodes of the InkAnalysisInkBullet object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_getstrokeids_1188995398.md new file mode 100644 index 0000000000..4556900001 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisInkBullet object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_id.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_id.md new file mode 100644 index 0000000000..05fea5a8c7 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Id + +## -description +Gets the unique identifier of the InkAnalysisInkBullet object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_kind.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_kind.md new file mode 100644 index 0000000000..c6e9c536e9 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisInkBullet object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_parent.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_parent.md new file mode 100644 index 0000000000..47f35c6705 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.Parent + +## -description +Gets the parent node of the InkAnalysisInkBullet object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_recognizedtext.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_recognizedtext.md new file mode 100644 index 0000000000..e421871c19 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_recognizedtext.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.RecognizedText +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.RecognizedText + +## -description +Gets the recognized text associated with the InkAnalysisInkBullet object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkbullet_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysisinkbullet_rotatedboundingrect.md new file mode 100644 index 0000000000..1b07e7379c --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkbullet_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkBullet.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisInkBullet object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisInkBullet object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisInkBullet.BoundingRect](inkanalysisinkbullet_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing.md new file mode 100644 index 0000000000..7b4fa9b007 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.InkDrawing](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_boundingrect.md new file mode 100644 index 0000000000..c89db38d4f --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_boundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisInkDrawing object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisInkDrawing object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisInkDrawing.RotatedBoundingRect](inkanalysisinkdrawing_rotatedboundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_center.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_center.md new file mode 100644 index 0000000000..7637af021a --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_center.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Center +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Center + +## -description +Gets the X, Y coordinates of the of the InkAnalysisInkDrawing object, in device-independent pixel (DIP), relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_children.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_children.md new file mode 100644 index 0000000000..df681f4088 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Children + +## -description +Gets all child nodes of the InkAnalysisInkDrawing object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_drawingkind.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_drawingkind.md new file mode 100644 index 0000000000..7ddcca19df --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_drawingkind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.DrawingKind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.DrawingKind + +## -description +Gets the [shape](InkAnalysisDrawingKind.md) of the ink input identified by ink analysis of the InkAnalysisInkDrawing object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_getstrokeids_1188995398.md new file mode 100644 index 0000000000..efddcbad33 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisInkDrawing object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_id.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_id.md new file mode 100644 index 0000000000..af67ecee7d --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Id + +## -description +Gets the unique identifier of the InkAnalysisInkDrawing object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_kind.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_kind.md new file mode 100644 index 0000000000..e9b7d8ca4e --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisInkDrawing object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_parent.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_parent.md new file mode 100644 index 0000000000..60a3b4f6bd --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Parent + +## -description +Gets the parent node of the InkAnalysisInkDrawing object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_points.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_points.md new file mode 100644 index 0000000000..2f360d546e --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_points.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Points +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.Points + +## -description +Gets the collection of X, Y coordinates for all [points](../windows.foundation/point.md) used to specify the [shape](InkAnalysisDrawingKind.md) of the InkAnalysisInkDrawing object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkdrawing_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_rotatedboundingrect.md new file mode 100644 index 0000000000..349476df1b --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkdrawing_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkDrawing.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisInkDrawing object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisInkDrawing object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisInkDrawing.BoundingRect](inkanalysisinkdrawing_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword.md b/windows.ui.input.inking.analysis/inkanalysisinkword.md new file mode 100644 index 0000000000..183c15cb36 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.InkWord](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysisinkword_boundingrect.md new file mode 100644 index 0000000000..b383a837cf --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_boundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisInkWord object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisInkWord object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisInkWord.RotatedBoundingRect](inkanalysisinkword_rotatedboundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_children.md b/windows.ui.input.inking.analysis/inkanalysisinkword_children.md new file mode 100644 index 0000000000..a8aa59f7f0 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Children + +## -description +Gets all child nodes of the InkAnalysisInkWord object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysisinkword_getstrokeids_1188995398.md new file mode 100644 index 0000000000..49dc9c58d4 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisInkWord object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_id.md b/windows.ui.input.inking.analysis/inkanalysisinkword_id.md new file mode 100644 index 0000000000..3684d4a39b --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Id + +## -description +Gets the unique identifier of the InkAnalysisInkWord object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_kind.md b/windows.ui.input.inking.analysis/inkanalysisinkword_kind.md new file mode 100644 index 0000000000..01cc17951b --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisInkWord object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_parent.md b/windows.ui.input.inking.analysis/inkanalysisinkword_parent.md new file mode 100644 index 0000000000..f14b6668c3 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.Parent + +## -description +Gets the parent node of the InkAnalysisInkWord object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_recognizedtext.md b/windows.ui.input.inking.analysis/inkanalysisinkword_recognizedtext.md new file mode 100644 index 0000000000..cf7eee18a6 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_recognizedtext.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.RecognizedText +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.RecognizedText + +## -description +Gets the recognized text associated with the InkAnalysisInkWord object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysisinkword_rotatedboundingrect.md new file mode 100644 index 0000000000..ee596dae5d --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisInkWord object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisInkWord object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisInkWord.BoundingRect](inkanalysisinkword_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisinkword_textalternates.md b/windows.ui.input.inking.analysis/inkanalysisinkword_textalternates.md new file mode 100644 index 0000000000..92caa6abfc --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisinkword_textalternates.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.TextAlternates +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisInkWord.TextAlternates + +## -description +Gets the collection of strings identified as potential matches of the InkAnalysisInkWord object. + +## -property-value +The recognition matches as a collection of [String](https://msdn.microsoft.com/library/system.string.aspx) objects. The most likely candidate is topmost in the collection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline.md b/windows.ui.input.inking.analysis/inkanalysisline.md new file mode 100644 index 0000000000..15dd321031 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisLine +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.Line](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysisline_boundingrect.md new file mode 100644 index 0000000000..662d5dae5b --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_boundingrect.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisLine object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisLine object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisLine.RotatedBoundingRect](inkanalysisinkline_rotatedboundingrect.md) + +## -examples diff --git a/windows.ui.input.inking.analysis/inkanalysisline_children.md b/windows.ui.input.inking.analysis/inkanalysisline_children.md new file mode 100644 index 0000000000..e31a231cc4 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Children + +## -description +Gets all child nodes of the InkAnalysisLine object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysisline_getstrokeids_1188995398.md new file mode 100644 index 0000000000..cba5337716 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisLine object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_id.md b/windows.ui.input.inking.analysis/inkanalysisline_id.md new file mode 100644 index 0000000000..9a09c6e730 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Id + +## -description +Gets the unique identifier of the InkAnalysisLine object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_indentlevel.md b/windows.ui.input.inking.analysis/inkanalysisline_indentlevel.md new file mode 100644 index 0000000000..f55f00825a --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_indentlevel.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.IndentLevel +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.IndentLevel + +## -description +Gets the indent level (based on the number of levels from the ink input that are recognized by ink analysis) of the InkAnalysisLine object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_kind.md b/windows.ui.input.inking.analysis/inkanalysisline_kind.md new file mode 100644 index 0000000000..976b2400b9 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisLine object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_parent.md b/windows.ui.input.inking.analysis/inkanalysisline_parent.md new file mode 100644 index 0000000000..0280fd9759 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.Parent + +## -description +Gets the parent node of the InkAnalysisLine object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_recognizedtext.md b/windows.ui.input.inking.analysis/inkanalysisline_recognizedtext.md new file mode 100644 index 0000000000..34d82f2039 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_recognizedtext.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.RecognizedText +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.RecognizedText + +## -description +Gets the recognized text associated with the InkAnalysisLine object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisline_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysisline_rotatedboundingrect.md new file mode 100644 index 0000000000..03e13d5de6 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisline_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisLine.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisLine.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisLine object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisLine object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisInkLine.BoundingRect](inkanalysisinkline_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem.md b/windows.ui.input.inking.analysis/inkanalysislistitem.md new file mode 100644 index 0000000000..96781e679c --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.ListItem](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysislistitem_boundingrect.md new file mode 100644 index 0000000000..9e282fcfa7 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_boundingrect.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisListItem object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisListItem object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisListItem.RotatedBoundingRect](inkanalysisinklistitem_rotatedboundingrect.md) + +## -examples diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_children.md b/windows.ui.input.inking.analysis/inkanalysislistitem_children.md new file mode 100644 index 0000000000..f2cc5ea902 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Children + +## -description +Gets all child nodes of the InkAnalysisListItem object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysislistitem_getstrokeids_1188995398.md new file mode 100644 index 0000000000..c4760cb4d7 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisListItem object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_id.md b/windows.ui.input.inking.analysis/inkanalysislistitem_id.md new file mode 100644 index 0000000000..33d3b02734 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Id + +## -description +Gets the unique identifier of the InkAnalysisListItem object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_kind.md b/windows.ui.input.inking.analysis/inkanalysislistitem_kind.md new file mode 100644 index 0000000000..105078ba12 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisListItem object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_parent.md b/windows.ui.input.inking.analysis/inkanalysislistitem_parent.md new file mode 100644 index 0000000000..41a7ca49f6 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.Parent + +## -description +Gets the parent node of the InkAnalysisListItem object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_recognizedtext.md b/windows.ui.input.inking.analysis/inkanalysislistitem_recognizedtext.md new file mode 100644 index 0000000000..e1b2b9ee02 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_recognizedtext.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.RecognizedText +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.RecognizedText + +## -description +Gets the recognized text associated with the InkAnalysisListItem object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysislistitem_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysislistitem_rotatedboundingrect.md new file mode 100644 index 0000000000..b134cb0ff8 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysislistitem_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisListItem.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisListItem object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisListItem object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisListItem.BoundingRect](inkanalysisinklistitem_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnode.md b/windows.ui.input.inking.analysis/inkanalysisnode.md new file mode 100644 index 0000000000..8e1674c918 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode.md @@ -0,0 +1,22 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisNode +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode + +## -description +Provides access to a single node from the tree of objects generated by the ink analysis process. + +Ink analysis can categorize ink strokes into either writing or drawing strokes, and recognize text, shapes, and basic layout structures. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnode_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysisnode_boundingrect.md new file mode 100644 index 0000000000..d28a374a71 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode_boundingrect.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisNode.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisNode object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisNode.RotatedBoundingRect](inkanalysisnode_rotatedboundingrect.md) + +## -examples diff --git a/windows.ui.input.inking.analysis/inkanalysisnode_children.md b/windows.ui.input.inking.analysis/inkanalysisnode_children.md new file mode 100644 index 0000000000..ac51ae677b --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Children + +## -description +Gets all child nodes of the InkAnalysisNode object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnode_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysisnode_getstrokeids_1188995398.md new file mode 100644 index 0000000000..7b52496184 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisNode.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisNode object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnode_id.md b/windows.ui.input.inking.analysis/inkanalysisnode_id.md new file mode 100644 index 0000000000..a58cb70d58 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Id + +## -description +Gets the unique identifier of the InkAnalysisNode object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnode_kind.md b/windows.ui.input.inking.analysis/inkanalysisnode_kind.md new file mode 100644 index 0000000000..1ef5409d72 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisNode object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnode_parent.md b/windows.ui.input.inking.analysis/inkanalysisnode_parent.md new file mode 100644 index 0000000000..963f516ffe --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode.Parent + +## -description +Gets the parent node of the InkAnalysisListItem object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnode_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysisnode_rotatedboundingrect.md new file mode 100644 index 0000000000..eae1671350 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnode_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisNode.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNode.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisNode object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisNode.BoundingRect](inkanalysisnode_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisnodekind.md b/windows.ui.input.inking.analysis/inkanalysisnodekind.md new file mode 100644 index 0000000000..f27fd7bd6b --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisnodekind.md @@ -0,0 +1,60 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisNodeKind +-api-type: winrt enumeration +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisNodeKind +Specifies the shapes that an InkAnalyzer can recognize when [InkAnalysisNode.Kind](inkanalysisnode_kind.md) is set to [InkDrawing](inkanalysisnodekind.md). + +## -description +Specifies the types of nodes that ink analysis supports for categorizing ink input. + +## -enum-fields + +## -field WritingRegion:2 +Node is for a generic writing region. + +## -field UnclassifiedInk:0 +Node is for unrecognized ink. + +## -field Root:1 +Node is the first, or topmost, in the collection of nodes. + +## -field Paragraph:3 +Node is for a paragraph of text. + +## -field ListItem:8 +Node is for a list item. + +## -field Line:4 +Node is for a single line of text. + +## -field InkWord:5 +Node is for a single word of text. + +## -field InkDrawing:7 +Node is for one of the recognized shapes specified in [InkAnalysisDrawingKind](inkanalysisdrawingkind.md). + +## -field InkBullet:6 +Node is for a list item bullet. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph.md b/windows.ui.input.inking.analysis/inkanalysisparagraph.md new file mode 100644 index 0000000000..153163da36 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.Paragraph](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_boundingrect.md new file mode 100644 index 0000000000..48cb738f58 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_boundingrect.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisParagraph object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisParagraph object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisParagraph.RotatedBoundingRect](inkanalysisparagraph_rotatedboundingrect.md) + +## -examples diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_children.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_children.md new file mode 100644 index 0000000000..cc0b2485eb --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Children + +## -description +Gets all child nodes of the InkAnalysisParagraph object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_getstrokeids_1188995398.md new file mode 100644 index 0000000000..865190f13e --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisParagraph object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_id.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_id.md new file mode 100644 index 0000000000..8516be17f6 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Id + +## -description +Gets the unique identifier of the InkAnalysisParagraph object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_kind.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_kind.md new file mode 100644 index 0000000000..24aa6230ab --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisParagraph object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_parent.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_parent.md new file mode 100644 index 0000000000..6eba406924 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.Parent + +## -description +Gets the parent node of the InkAnalysisParagraph object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_recognizedtext.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_recognizedtext.md new file mode 100644 index 0000000000..213f40a56f --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_recognizedtext.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.RecognizedText +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.RecognizedText + +## -description +Gets the recognized text associated with the InkAnalysisParagraph object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisparagraph_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysisparagraph_rotatedboundingrect.md new file mode 100644 index 0000000000..d59bb3a95a --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisparagraph_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisParagraph.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisParagraph object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisParagraph object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisParagraph.BoundingRect](inkanalysisparagraph_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisresult.md b/windows.ui.input.inking.analysis/inkanalysisresult.md new file mode 100644 index 0000000000..e059a1abcd --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisresult.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisResult +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisResult + +## -description +Provides access to the results generated by the ink analysis process. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisresult_status.md b/windows.ui.input.inking.analysis/inkanalysisresult_status.md new file mode 100644 index 0000000000..b961d84b4d --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisresult_status.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisResult.Status +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisResult.Status +Gets the [status](inkanalysisstatus.md) of the ink analysis operation, such as whether any changes were applied. + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot.md b/windows.ui.input.inking.analysis/inkanalysisroot.md new file mode 100644 index 0000000000..6234a72053 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.Root](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysisroot_boundingrect.md new file mode 100644 index 0000000000..a787ec309c --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_boundingrect.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisRoot object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisRoot object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisRoot.RotatedBoundingRect](inkanalysisroot_rotatedboundingrect.md) + +## -examples diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_children.md b/windows.ui.input.inking.analysis/inkanalysisroot_children.md new file mode 100644 index 0000000000..54628dede3 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Children + +## -description +Gets all child nodes of the InkAnalysisRoot object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_findnodes_1929833995.md b/windows.ui.input.inking.analysis/inkanalysisroot_findnodes_1929833995.md new file mode 100644 index 0000000000..c1a60edfcc --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_findnodes_1929833995.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.FindNodes(Windows.UI.Input.Inking.Analysis.InkAnalysisNodeKind) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.FindNodes + +## -description +Retrieves the collection of child nodes belonging to the InkAnalysisRoot object. + +## -params + +## -param nodeKind + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysisroot_getstrokeids_1188995398.md new file mode 100644 index 0000000000..e2738d6f39 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisRoot object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_id.md b/windows.ui.input.inking.analysis/inkanalysisroot_id.md new file mode 100644 index 0000000000..04d80ce1a6 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Id + +## -description +Gets the unique identifier of the InkAnalysisRoot object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_kind.md b/windows.ui.input.inking.analysis/inkanalysisroot_kind.md new file mode 100644 index 0000000000..7b58e5c659 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisRoot object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_parent.md b/windows.ui.input.inking.analysis/inkanalysisroot_parent.md new file mode 100644 index 0000000000..a7ad528a24 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.Parent + +## -description +Gets the parent node of the InkAnalysisRoot object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_recognizedtext.md b/windows.ui.input.inking.analysis/inkanalysisroot_recognizedtext.md new file mode 100644 index 0000000000..c13324c028 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_recognizedtext.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.RecognizedText +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.RecognizedText + +## -description +Gets the recognized text associated with the InkAnalysisRoot object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisroot_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysisroot_rotatedboundingrect.md new file mode 100644 index 0000000000..ad7860ccdb --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisroot_rotatedboundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisRoot.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisRoot object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisRoot object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisRoot.BoundingRect](inkanalysisroot_boundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisstatus.md b/windows.ui.input.inking.analysis/inkanalysisstatus.md new file mode 100644 index 0000000000..f8c1b6b490 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisstatus.md @@ -0,0 +1,31 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisStatus +-api-type: winrt enumeration +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisStatus + +## -description +Specifies the various states of the ink analysis process. + +## -enum-fields + +## -field Updated:0 +Ink input has changed since last ink analysis. + +## -field Unchanged:1 +Ink input has not changed since last ink analysis. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysisstrokekind.md b/windows.ui.input.inking.analysis/inkanalysisstrokekind.md new file mode 100644 index 0000000000..f3e4f35aad --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysisstrokekind.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisStrokeKind +-api-type: winrt enumeration +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisStrokeKind + +## -description +Specifies the types of ink strokes that can be recognized by the ink analysis process. + +## -enum-fields + +## -field Writing:1 + +## -field Drawing:2 + +## -field Auto:0 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion.md new file mode 100644 index 0000000000..a49e861d54 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion + +## -description +Provides access to an [InkAnalysisNode](inkanalysisnode.md) of type [InkAnalysisNodeKind.WritingRegion](inkanalysisnodekind.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_boundingrect.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_boundingrect.md new file mode 100644 index 0000000000..953dd3a060 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_boundingrect.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.BoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.BoundingRect + +## -description +Gets the bounding rectangle of the InkAnalysisWritingRegion object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisWritingRegion object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -see-also +[InkAnalysisWritingRegion.RotatedBoundingRect](inkanalysiswritingregion_rotatedboundingrect.md) + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_children.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_children.md new file mode 100644 index 0000000000..e746dfacf9 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_children.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Children +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Children + +## -description +Gets all child nodes of the InkAnalysisWritingRegion object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_getstrokeids_1188995398.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_getstrokeids_1188995398.md new file mode 100644 index 0000000000..f3f830c288 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_getstrokeids_1188995398.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.GetStrokeIds +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.GetStrokeIds + +## -description +Retrieves the unique identifiers of all nodes belonging to the InkAnalysisWritingRegion object. + +## -params + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_id.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_id.md new file mode 100644 index 0000000000..00c0df9232 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_id.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Id + +## -description +Gets the unique identifier of the InkAnalysisWritingRegion object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_kind.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_kind.md new file mode 100644 index 0000000000..c3fa501e34 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_kind.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Kind + +## -description +Gets the [kind](InkAnalysisNodeKind.md) of ink input identified by the InkAnalysisWritingRegion object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_parent.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_parent.md new file mode 100644 index 0000000000..bdcaa20cb7 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_parent.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Parent +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.Parent + +## -description +Gets the parent node of the InkAnalysisWritingRegion object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_recognizedtext.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_recognizedtext.md new file mode 100644 index 0000000000..ba375010b2 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_recognizedtext.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.RecognizedText +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.RecognizedText + +## -description +Gets the recognized text associated with the InkAnalysisWritingRegion object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalysiswritingregion_rotatedboundingrect.md b/windows.ui.input.inking.analysis/inkanalysiswritingregion_rotatedboundingrect.md new file mode 100644 index 0000000000..86475f97ce --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalysiswritingregion_rotatedboundingrect.md @@ -0,0 +1,33 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.RotatedBoundingRect +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalysisWritingRegion.RotatedBoundingRect + +## -description +Gets the oriented and snapped, bounding rectangle of the InkAnalysisWritingRegion object. + +| Bounding rectangle | Rotated bounding rectangle | +| --- | --- | +| ![Bounding rectangle](images/boundingrect.png) | ![Rotated bounding rectangle](images/rotatedboundingrect.png) | + +## -property-value +The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisWritingRegion object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area. + +## -remarks + +## -examples + +## -see-also +[InkAnalysisWritingRegion.BoundingRect](inkanalysiswritingregion_boundingrect.md) + + + + + + diff --git a/windows.ui.input.inking.analysis/inkanalyzer.md b/windows.ui.input.inking.analysis/inkanalyzer.md new file mode 100644 index 0000000000..dfb7e23ea2 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Input.Inking.Analysis.InkAnalyzer +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer + +## -description +Provides access to an object that can categorize ink strokes into either writing or drawing strokes, and recognize text, shapes, and basic layout structures. + +## -remarks + +## -see-also + + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_adddataforstroke_1047695993.md b/windows.ui.input.inking.analysis/inkanalyzer_adddataforstroke_1047695993.md new file mode 100644 index 0000000000..e97be32c11 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_adddataforstroke_1047695993.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.AddDataForStroke(Windows.UI.Input.Inking.InkStroke) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.AddDataForStroke + +## -description + +## -params + +## -param stroke + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_adddataforstrokes_1728510866.md b/windows.ui.input.inking.analysis/inkanalyzer_adddataforstrokes_1728510866.md new file mode 100644 index 0000000000..bb142efb37 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_adddataforstrokes_1728510866.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.AddDataForStrokes(Windows.Foundation.Collections.IIterable{Windows.UI.Input.Inking.InkStroke}) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.AddDataForStrokes + +## -description + +## -params + +## -param strokes + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_analysisroot.md b/windows.ui.input.inking.analysis/inkanalyzer_analysisroot.md new file mode 100644 index 0000000000..f25944d890 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_analysisroot.md @@ -0,0 +1,19 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalyzer.AnalysisRoot +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.AnalysisRoot + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_analyzeasync_548410199.md b/windows.ui.input.inking.analysis/inkanalyzer_analyzeasync_548410199.md new file mode 100644 index 0000000000..c20f2f6f46 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_analyzeasync_548410199.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.AnalyzeAsync +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.AnalyzeAsync + +## -description +Aynchronously generates the tree of objects for the ink analysis process. + +## -params + +## -returns +The results of the analysis as an [InkAnalysisResult](inkanalysisresult.md) object. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_cleardataforallstrokes_680199447.md b/windows.ui.input.inking.analysis/inkanalyzer_cleardataforallstrokes_680199447.md new file mode 100644 index 0000000000..ba1a6e589b --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_cleardataforallstrokes_680199447.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.ClearDataForAllStrokes +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.ClearDataForAllStrokes + +## -description +Delete all nodes from the last ink analysis process. + +## -params + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_inkanalyzer_1221375020.md b/windows.ui.input.inking.analysis/inkanalyzer_inkanalyzer_1221375020.md new file mode 100644 index 0000000000..b85365e09e --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_inkanalyzer_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.InkAnalyzer + +## -description +Creates a new [InkAnalyzer](inkanalyzer.md) object to manage [InkAnalysisNode](inkanalysisnode.md) objects generated from ink analysis. + +## -params + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_isanalyzing.md b/windows.ui.input.inking.analysis/inkanalyzer_isanalyzing.md new file mode 100644 index 0000000000..aef08d8702 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_isanalyzing.md @@ -0,0 +1,20 @@ +--- +-api-id: P:Windows.UI.Input.Inking.Analysis.InkAnalyzer.IsAnalyzing +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.IsAnalyzing + +## -description +Gets the state of the ink analysis process. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_removedataforstroke_2022087216.md b/windows.ui.input.inking.analysis/inkanalyzer_removedataforstroke_2022087216.md new file mode 100644 index 0000000000..9490f07713 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_removedataforstroke_2022087216.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.RemoveDataForStroke(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.RemoveDataForStroke + +## -description +Delete all nodes for the specified ink stroke from the last ink analysis process. + +## -params + +## -param strokeId +The unique identifier of the ink stroke. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_removedataforstrokes_503039520.md b/windows.ui.input.inking.analysis/inkanalyzer_removedataforstrokes_503039520.md new file mode 100644 index 0000000000..7fd1439540 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_removedataforstrokes_503039520.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.RemoveDataForStrokes(Windows.Foundation.Collections.IIterable{System.UInt32}) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.RemoveDataForStrokes + +## -description +Delete all nodes for the specified ink strokes from the last ink analysis process. + +## -params + +## -param strokeIds +The collection of unique ink stroke identifiers. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_replacedataforstroke_505453546.md b/windows.ui.input.inking.analysis/inkanalyzer_replacedataforstroke_505453546.md new file mode 100644 index 0000000000..9a1996f812 --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_replacedataforstroke_505453546.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.ReplaceDataForStroke(Windows.UI.Input.Inking.InkStroke) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.ReplaceDataForStroke + +## -description +Update all nodes for the specified ink stroke from the last ink analysis process. + +## -params + +## -param stroke + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/inkanalyzer_setstrokedatakind_844006976.md b/windows.ui.input.inking.analysis/inkanalyzer_setstrokedatakind_844006976.md new file mode 100644 index 0000000000..4558d0dc3a --- /dev/null +++ b/windows.ui.input.inking.analysis/inkanalyzer_setstrokedatakind_844006976.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Input.Inking.Analysis.InkAnalyzer.SetStrokeDataKind(System.UInt32,Windows.UI.Input.Inking.Analysis.InkAnalysisStrokeKind) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.Analysis.InkAnalyzer.SetStrokeDataKind + +## -description +Sets the ink analysis category for the [InkAnalysisNode](inkanalysisnode.md) associated with the ink stroke. + +## -params + +## -param strokeId +The unique identifier for the ink stroke being categorized. + +## -param strokeKind +The [InkAnalysisStrokeKind](inkanalysisstrokekind.md) category to assign to the [InkAnalysisNode](inkanalysisnode.md. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.inking.analysis/windows_ui_input_inking_analysis.md b/windows.ui.input.inking.analysis/windows_ui_input_inking_analysis.md new file mode 100644 index 0000000000..9f36f13f38 --- /dev/null +++ b/windows.ui.input.inking.analysis/windows_ui_input_inking_analysis.md @@ -0,0 +1,29 @@ +--- +-api-id: N:Windows.UI.Input.Inking.Analysis +-api-type: winrt namespace +--- + + + +# Windows.UI.Input.Inking.Analysis + +## -description +Provides analysis of ink stroke input for Windows Ink apps. + +This includes: +- Shape detection and recognition +- Handwriting recognition +- Layout interpretation and classification + +## -remarks + +## -see-also +- [Windows.UI.Input.Inking](../windows.ui.input.inking/windows_ui_input_inking.md) +- [Windows.UI.Input.Inking.Core](../windows.ui.input.inking.core/windows_ui_input_inking_core.md) +- [Windows.UI.Xaml.Controls.InkCanvas](../windows.ui.xaml.controls/windows_ui_xaml_controls_inkcanvas.md) +- [Windows.UI.Xaml.Controls.InkToolbar](../windows.ui.xaml.controls/windows_ui_xaml_controls_inktoolbar.md) + +## -examples + diff --git a/windows.ui.input.inking/iinkpresenterstencil.md b/windows.ui.input.inking/iinkpresenterstencil.md index d192059bd8..605d74606f 100644 --- a/windows.ui.input.inking/iinkpresenterstencil.md +++ b/windows.ui.input.inking/iinkpresenterstencil.md @@ -19,7 +19,7 @@ The stencil transforms how an ink stroke is rendered: + It acts as a mask and prevents the drawing of an ink stroke within the area obscured by the stencil. -The [InkPresenterRuler](inkpresenterruler.md) can be manipulated both programmatically and by the user. It also scales and translates with the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). +The stencil can be manipulated both programmatically and by the user. It also scales and translates with the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). ## -remarks diff --git a/windows.ui.input.inking/inkdrawingattributes_ignoretilt.md b/windows.ui.input.inking/inkdrawingattributes_ignoretilt.md new file mode 100644 index 0000000000..a3e0df17b6 --- /dev/null +++ b/windows.ui.input.inking/inkdrawingattributes_ignoretilt.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkDrawingAttributes.IgnoreTilt +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkDrawingAttributes.IgnoreTilt + +## -description +Gets or sets a value that indicates whether the tilt ([tiltx](inkpoint_tiltx.md), [tilty](inkpoint_tilty.md)) of the contact on the digitizer surface is ignored when you draw an [InkStroke](inkstroke.md). + +## -property-value +**true** if tilt is ignored; otherwise **false**. The default value is **false**. + +## -remarks +This property is typically set for pencil strokes. + +## -examples + +## -see-also +- [tiltx](inkpoint_tiltx.md) +- [tilty](inkpoint_tilty.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkhighcontrastadjustment.md b/windows.ui.input.inking/inkhighcontrastadjustment.md new file mode 100644 index 0000000000..36261e99fd --- /dev/null +++ b/windows.ui.input.inking/inkhighcontrastadjustment.md @@ -0,0 +1,37 @@ +--- +-api-id: T:Windows.UI.Input.Inking.InkHighContrastAdjustment +-api-type: winrt enum +--- + + + +# InkHighContrastAdjustment + +## -description +Specifies how the [InkPresenter](inkpresenter.md) object handles input (standard and modified) from the associated [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control when system is in high contrast mode. + +## -enum-fields +### -field UseSystemColorsWhenNecessary:0 +For standard strokes, use selected color if contrast is sufficient against the background. Otherwise, use system color. + +For highlighter strokes ([InkDrawingAttributes.DrawAsHighlighter](inkdrawingattributes_drawashighlighter.md)), use selected color if contrast is sufficient against the background. Otherwise, use system color. + +### -field UseSystemColors:1 +For standard strokes, use system color. + +For highlighter strokes ([InkDrawingAttributes.DrawAsHighlighter](inkdrawingattributes_drawashighlighter.md)), use system highlighter color. + +### -field UseOriginalColors:2 +For standard strokes, use the selected color. + +For highlighter strokes ([InkDrawingAttributes.DrawAsHighlighter](inkdrawingattributes_drawashighlighter.md)), use the selected color. + + +## -remarks + +## -examples + +## -see-also +- [InkPresenter.InkHighContrastAdjustment](inkpresenter_highcontrastadjustment.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkmanipulationmode.md b/windows.ui.input.inking/inkmanipulationmode.md index f5c840d550..3db68ee7d1 100644 --- a/windows.ui.input.inking/inkmanipulationmode.md +++ b/windows.ui.input.inking/inkmanipulationmode.md @@ -10,7 +10,7 @@ public enum Windows.UI.Input.Inking.InkManipulationMode : int # InkManipulationMode ## -description -Identifies the ink input mode. +Specifies the modes of ink input. ## -enum-fields ### -field Inking:0 diff --git a/windows.ui.input.inking/inkpersistenceformat.md b/windows.ui.input.inking/inkpersistenceformat.md new file mode 100644 index 0000000000..acacab2997 --- /dev/null +++ b/windows.ui.input.inking/inkpersistenceformat.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.UI.Input.Inking.InkPersistenceFormat +-api-type: winrt enum +--- + + + +# InkPersistenceFormat + +## -description +Specifies the formats for saving ink input. + +## -enum-fields +### -field GifWithEmbeddedIsf:0 +Ink is saved as a GIF file with embedded Ink Serialized Format (ISF) format data. + +### -field Isf:1 +Ink is saved as Ink Serialized Format (ISF) format data. + +## -remarks + +## -examples + +## -see-also +- [InkStrokeContainer.SaveAsync(Windows.Storage.Streams.IOutputStream outputStream, Windows.UI.Input.Inking.InkPersistenceFormat inkPersistenceFormat)](inkstrokecontainer_saveasync_238248194.md) +- [InkStrokeContainer.SaveAsync(Windows.Storage.Streams.IOutputStream outputStream)](inkstrokecontainer_saveasync_1696379726.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpoint.md b/windows.ui.input.inking/inkpoint.md new file mode 100644 index 0000000000..edbbd24aa6 --- /dev/null +++ b/windows.ui.input.inking/inkpoint.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Inking.InkPoint +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.InkPoint + +## -description +Provides raw input data for a single point used in the construction of an [InkStroke](inkstroke.md). + +## -remarks + +## -examples + +## -see-also +[Windows.UI.Input.Inking Classes](windows_ui_input_inking_classes.md), [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpoint_inkpoint_1650927667.md b/windows.ui.input.inking/inkpoint_inkpoint_1650927667.md new file mode 100644 index 0000000000..d6853633f0 --- /dev/null +++ b/windows.ui.input.inking/inkpoint_inkpoint_1650927667.md @@ -0,0 +1,38 @@ +--- +-api-id: M:Windows.UI.Input.Inking.InkPoint.#ctor(Windows.Foundation.Point,System.Single,System.Single,System.Single,System.UInt64) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkPoint.InkPoint + +## -description +Creates a complex [InkPoint](inkpoint.md) object used in the construction of an [InkStroke](inkstroke.md). + +## -parameters +### -param position +The screen coordinates for the [InkPoint](inkpoint.md) object. + +### -param pressure +The pressure of the contact on the digitizer surface. The default is 0.5. + +### -param tiltX +The plane angle between the Y-Z plane and the plane containing the Y axis and the axis of the input device. The default is 0. + +### -param tiltY +The plane angle between the X-Z plane and the plane containing the X axis and the axis of the input device. The default is 0. + +### -param timestamp +The timestamp for the first [InkPoint](inkpoint.md) of an InkStroke, or when an entire InkStroke is pasted or loaded.  + +## -remarks + +## -examples + +## -see-also +- [InkPoint(Windows.Foundation.Point position, System.Single pressure)](inkpoint_inkpoint_1903734527.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpoint_inkpoint_1903734527.md b/windows.ui.input.inking/inkpoint_inkpoint_1903734527.md index e3dbde865d..8b8c0171f5 100644 --- a/windows.ui.input.inking/inkpoint_inkpoint_1903734527.md +++ b/windows.ui.input.inking/inkpoint_inkpoint_1903734527.md @@ -10,7 +10,7 @@ public InkPoint(Windows.Foundation.Point position, System.Single pressure) # Windows.UI.Input.Inking.InkPoint.InkPoint ## -description -Creates a new [InkPoint](inkpoint.md) object used in the construction of an [InkStroke](inkstroke.md). +Creates a basic [InkPoint](inkpoint.md) object used in the construction of an [InkStroke](inkstroke.md). ## -parameters ### -param position @@ -24,4 +24,6 @@ The pressure of the contact on the digitizer surface. The default is 0.5. ## -examples ## -see-also -[Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file +- [InkPoint(Windows.Foundation.Point position, System.Single pressure, System.Single tiltX, System.Single tiltY, System.UInt64 timestamp)](inkpoint_inkpoint_1650927667.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) diff --git a/windows.ui.input.inking/inkpoint_tiltx.md b/windows.ui.input.inking/inkpoint_tiltx.md new file mode 100644 index 0000000000..43ab5d16fa --- /dev/null +++ b/windows.ui.input.inking/inkpoint_tiltx.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPoint.TiltX +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPoint.TiltX + +## -description +Gets the plane angle between the Y-Z plane and the plane containing the Y axis and the axis of the input device. + +## -property-value +A value in the range of -90 to +90 degrees. A positive X tilt is to the right. + +## -remarks +This property is used in conjunction with [tilty](inkpoint_tilty.md) to represent the tilt away from normal of the input device. + +## -examples + +## -see-also +- [tilty](inkpoint_tilty.md) +- [ignoretilt](inkdrawingattributes_ignoretilt.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpoint_tilty.md b/windows.ui.input.inking/inkpoint_tilty.md new file mode 100644 index 0000000000..b520cc341a --- /dev/null +++ b/windows.ui.input.inking/inkpoint_tilty.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPoint.TiltY +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPoint.TiltY + +## -description +Gets the plane angle between the X-Z plane and the plane containing the X axis and the axis of the input device. + +## -property-value +A value in the range of -90 to +90 degrees. A positive Y tilt is toward the user. + +## -remarks +This property is used in conjunction with [tiltx](inkpoint_tiltx.md) to represent the tilt away from normal of the input device. + +## -examples + +## -see-also +- [tiltx](inkpoint_tiltx.md) +- [ignoretilt](inkdrawingattributes_ignoretilt.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpoint_timestamp.md b/windows.ui.input.inking/inkpoint_timestamp.md new file mode 100644 index 0000000000..0f35bae199 --- /dev/null +++ b/windows.ui.input.inking/inkpoint_timestamp.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPoint.Timestamp +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPoint.Timestamp + +## -description +Gets the timestamp for the first [InkPoint](inkpoint.md) of an InkStroke, or when an entire InkStroke is pasted or loaded.  + +## -property-value +The time, relative to the system boot time, in microseconds. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenter.md b/windows.ui.input.inking/inkpresenter.md index 5c09e2cf41..8f37d268fc 100644 --- a/windows.ui.input.inking/inkpresenter.md +++ b/windows.ui.input.inking/inkpresenter.md @@ -1,63 +1,63 @@ ---- --api-id: T:Windows.UI.Input.Inking.InkPresenter --api-type: winrt class ---- - - - -# Windows.UI.Input.Inking.InkPresenter - -## -description -> [!NOTE] -> For Universal Windows app using Extensible Application Markup Language (XAML), we recommend using [InkPresenter](inkpresenter.md) and the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control instead of [InkManager](inkmanager.md). - -Provides properties, methods, and events for managing the input, processing, and rendering of ink input (standard and modified) for an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. - -> [!NOTE] -> Standard ink input (pen tip or eraser tip/button) is not modified with a secondary affordance, such as a pen barrel button, right mouse button, or similar (see [RightDragAction](inkinputprocessingconfiguration_rightdragaction.md)). - -By default, both standard and modified ink input is managed entirely by the [InkPresenter](inkunprocessedinput_inkpresenter.md) and rendered to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) as either an ink stroke or an erase stroke, based on [InkInputProcessingConfiguration.Mode](inkinputprocessingconfiguration_mode.md). - -Modified input can be passed through to your app for processing by setting [InkInputProcessingConfiguration.RightDragAction](inkinputprocessingconfiguration_rightdragaction.md) to [InkInputRightDragAction.LeaveUnprocessed](inkinputrightdragaction.md). - -All input can be passed through to your app for processing by setting [InkInputProcessingConfiguration.Mode](inkinputprocessingconfiguration_mode.md) to [None](inkinputprocessingmode.md). - -Leaving input unprocessed by the [InkPresenter](inkunprocessedinput_inkpresenter.md) lets you support a customized ink experience and extended functionality such as selection. - -For complete control of ink input and to render it to the Direct2D device context of your Universal Windows app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control, call [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) prior to loading the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). This requires an [IInkD2DRenderer](XREF:TODO:input_ink.iinkd2drenderer) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). - -## -remarks -The [InkPresenter](inkpresenter.md) class cannot be instantiated directly. It is returned as a property of an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) object. - -## -examples -Here, we show how to overlay ink annotations on an image. For this example, ink data is not captured or saved by a corresponding [InkPresenter](inkpresenter.md). - -```xaml - - - - - - + +# Windows.UI.Input.Inking.InkPresenter + +## -description +> [!NOTE] +> For Universal Windows app using Extensible Application Markup Language (XAML), we recommend using [InkPresenter](inkpresenter.md) and the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control instead of [InkManager](inkmanager.md). + +Provides properties, methods, and events for managing the input, processing, and rendering of ink input (standard and modified) for an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. + +> [!NOTE] +> Standard ink input (pen tip or eraser tip/button) is not modified with a secondary affordance, such as a pen barrel button, right mouse button, or similar (see [RightDragAction](inkinputprocessingconfiguration_rightdragaction.md)). + +By default, both standard and modified ink input is managed entirely by the [InkPresenter](inkunprocessedinput_inkpresenter.md) and rendered to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) as either an ink stroke or an erase stroke, based on [InkInputProcessingConfiguration.Mode](inkinputprocessingconfiguration_mode.md). + +Modified input can be passed through to your app for processing by setting [InkInputProcessingConfiguration.RightDragAction](inkinputprocessingconfiguration_rightdragaction.md) to [InkInputRightDragAction.LeaveUnprocessed](inkinputrightdragaction.md). + +All input can be passed through to your app for processing by setting [InkInputProcessingConfiguration.Mode](inkinputprocessingconfiguration_mode.md) to [None](inkinputprocessingmode.md). + +Leaving input unprocessed by the [InkPresenter](inkunprocessedinput_inkpresenter.md) lets you support a customized ink experience and extended functionality such as selection. + +For complete control of ink input and to render it to the Direct2D device context of your Universal Windows app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control, call [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) prior to loading the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). This requires an [IInkD2DRenderer](http://msdn.microsoft.com/library/d1bd910d-ce64-4424-a0e1-4f55110b0265) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). + +## -remarks +The [InkPresenter](inkpresenter.md) class cannot be instantiated directly. It is returned as a property of an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) object. + +## -examples +Here, we show how to overlay ink annotations on an image. For this example, ink data is not captured or saved by a corresponding [InkPresenter](inkpresenter.md). + +```xaml + + + + + + - -# Windows.UI.Input.Inking.InkPresenter.ActivateCustomDrying - -## -description -Indicates that your app requires complete control of ink input rendering it to the Direct2D device context of your Universal Windows app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. This requires an [IInkD2DRenderer](XREF:TODO:input_ink.iinkd2drenderer) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). - -By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). - -By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. - -## -returns -The object used for custom ink stroke rendering. - -## -exceptions -### E_ILLEGAL_METHOD_CALL - -Thrown if [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) is called after [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded. - -## -remarks -This method must be called prior to loading the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). - -> **Custom drying and the InkToolbar** -> By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). The ink platform enables you to override this behavior and completely customize the inking experience by custom drying the ink input. - -If your app overrides the default ink rendering behavior of the [InkPresenter](inkpresenter.md) with a custom drying implementation, the rendered ink strokes are no longer available to the [InkToolbar](../windows.ui.xaml.controls/inktoolbar.md) and the built-in erase commands of the [InkToolbar](../windows.ui.xaml.controls/inktoolbar.md) do not work as expected. To provide erase functionality, you must handle all pointer events, perform hit-testing on each stroke, and override the built-in "Erase all ink" command. - -For more info on custom drying, see [Pen interactions and Windows Ink in UWP apps](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/pen-and-stylus-interactions#custom-ink-rendering). - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Inking.InkPresenter.ActivateCustomDrying +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkPresenter.ActivateCustomDrying + +## -description +Indicates that your app requires complete control of ink input rendering it to the Direct2D device context of your Universal Windows app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. This requires an [IInkD2DRenderer](http://msdn.microsoft.com/library/d1bd910d-ce64-4424-a0e1-4f55110b0265) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). + +By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). + +By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. + +## -returns +The object used for custom ink stroke rendering. + +## -exceptions +### E_ILLEGAL_METHOD_CALL + +Thrown if [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) is called after [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded. + +## -remarks +This method must be called prior to loading the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +> **Custom drying and the InkToolbar** +> By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). The ink platform enables you to override this behavior and completely customize the inking experience by custom drying the ink input. + +If your app overrides the default ink rendering behavior of the [InkPresenter](inkpresenter.md) with a custom drying implementation, the rendered ink strokes are no longer available to the [InkToolbar](../windows.ui.xaml.controls/inktoolbar.md) and the built-in erase commands of the [InkToolbar](../windows.ui.xaml.controls/inktoolbar.md) do not work as expected. To provide erase functionality, you must handle all pointer events, perform hit-testing on each stroke, and override the built-in "Erase all ink" command. + +For more info on custom drying, see [Pen interactions and Windows Ink in UWP apps](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/pen-and-stylus-interactions#custom-ink-rendering). + +## -examples + +## -see-also [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenter_highcontrastadjustment.md b/windows.ui.input.inking/inkpresenter_highcontrastadjustment.md new file mode 100644 index 0000000000..95e356281c --- /dev/null +++ b/windows.ui.input.inking/inkpresenter_highcontrastadjustment.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenter.HighContrastAdjustment +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenter.HighContrastAdjustment + +## -description +Gets or sets how the [InkPresenter](inkpresenter.md) object handles input (standard and modified) from the associated [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control when system is in high contrast mode. + +## -property-value +The ink color (selected or system) that works best against the background color. + +## -remarks + +## -examples + +## -see-also +- [InkHighContrastAdjustment](inkhighcontrastadjustment.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor.md b/windows.ui.input.inking/inkpresenterprotractor.md new file mode 100644 index 0000000000..998acf20fd --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor.md @@ -0,0 +1,28 @@ +--- +-api-id: T:Windows.UI.Input.Inking.InkPresenterProtractor +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor + +## -description +Represents a visual stencil, in the form of a protractor for drawing arcs and curves, displayed as a semi-transparent overlay on an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +The stencil transforms how an ink stroke is rendered: + +- It snaps the ink stroke to the stencil edge if the pen tip is within a distance threshold (gutter). +- It acts as a mask and prevents the drawing of an ink stroke within the area obscured by the stencil. + + +The [InkPresenterRuler](inkpresenterruler.md) can be manipulated both programmatically and by the user. It also scales and translates with the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +## -remarks +The opacity of the stencil is set at 75% when static, and 50% during manipulation. + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_accentcolor.md b/windows.ui.input.inking/inkpresenterprotractor_accentcolor.md new file mode 100644 index 0000000000..440c11f2f7 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_accentcolor.md @@ -0,0 +1,30 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.AccentColor +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.AccentColor + +## -description +Gets or sets the color of the rays and horizontal marks for the protractor stencil. + +![Protractor stencil](images\stencil-protractor.png) + +Rays represent the angle of the drawn arc. They are visible only when ink is snapped to the protractor and the protractor has not been moved. + +Horizontal marks represent a horizontal line bisecting the protractor. The default positions are 3 and 9 o’clock, but a rotation transform can be applied to the protractor, which also rotates the marks. + +## -property-value +The specified color. + +The default is system-defined. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_areraysvisible.md b/windows.ui.input.inking/inkpresenterprotractor_areraysvisible.md new file mode 100644 index 0000000000..1cb680f177 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_areraysvisible.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.AreRaysVisible +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.AreRaysVisible + +## -description +Gets or sets whether the rays are displayed on the protractor stencil. + +![Protractor stencil](images\stencil-protractor.png) + +Rays represent the angle of the drawn arc. They are visible only when ink is snapped to the protractor and the protractor has not been moved. + +## -property-value +**true**, if the rays are visible. Otherwise, **false**. + +The default is **true**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_aretickmarksvisible.md b/windows.ui.input.inking/inkpresenterprotractor_aretickmarksvisible.md new file mode 100644 index 0000000000..e3c0322da9 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_aretickmarksvisible.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.AreTickMarksVisible +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.AreTickMarksVisible + +## -description +Gets or sets whether the tick marks are displayed on the protractor stencil. + +![Protractor stencil](images\stencil-protractor.png) + +Tick marks represent the degree marks on the protractor. + +## -property-value +**true**, if the tick marks are visible. Otherwise, **false**. + +The default is **true**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_backgroundcolor.md b/windows.ui.input.inking/inkpresenterprotractor_backgroundcolor.md new file mode 100644 index 0000000000..55f25cb6ec --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_backgroundcolor.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.BackgroundColor +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.BackgroundColor + +## -description +Gets or sets the background color of the [InkPresenterProtractor](inkpresenterprotractor.md). + +## -property-value +The background color of the protractor as an ARGB value. The default is (255, 230, 230, 230). + +## -remarks + +## -examples + +## -see-also +- [ForegroundColor](inkpresenterprotractor_foregroundcolor.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_foregroundcolor.md b/windows.ui.input.inking/inkpresenterprotractor_foregroundcolor.md new file mode 100644 index 0000000000..1e31be0697 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_foregroundcolor.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.ForegroundColor +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.ForegroundColor + +## -description +Gets or sets the color of the foreground elements on an [InkPresenterProtractor](inkpresenterprotractor.md). + +## -property-value +The foreground color of the protractor as an ARGB value. The default is (255, 0, 0, 0). + +## -remarks + +## -examples + +## -see-also +- [BackgroundColor](inkpresenterprotractor_backgroundcolor.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_inkpresenterprotractor_1948583376.md b/windows.ui.input.inking/inkpresenterprotractor_inkpresenterprotractor_1948583376.md new file mode 100644 index 0000000000..b75c749233 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_inkpresenterprotractor_1948583376.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Input.Inking.InkPresenterProtractor.#ctor(Windows.UI.Input.Inking.InkPresenter) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.InkPresenterProtractor + +## -description +Initializes a new instance of the [InkPresenterProtractor](inkpresenterprotractor.md) class. + +## -parameters +### -param inkPresenter +The ink presenter associated with the pen input. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_isanglereadoutvisible.md b/windows.ui.input.inking/inkpresenterprotractor_isanglereadoutvisible.md new file mode 100644 index 0000000000..b7b8e061a6 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_isanglereadoutvisible.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.IsAngleReadoutVisible +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.IsAngleReadoutVisible + +## -description +Gets or sets whether the numerical angle is displayed on the protractor stencil. + +![Protractor stencil](images\stencil-protractor.png) + +The angle readout represents the numeric value for the angle of the drawn arc. + +## -property-value +**true**, if the angle readout is visible. Otherwise, **false**. + +The default is **true**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_iscentermarkervisible.md b/windows.ui.input.inking/inkpresenterprotractor_iscentermarkervisible.md new file mode 100644 index 0000000000..9c0ea8ea79 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_iscentermarkervisible.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.IsCenterMarkerVisible +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.IsCenterMarkerVisible + +## -description +Gets or sets whether the center mark is displayed on the protractor stencil. + +![Protractor stencil](images\stencil-protractor.png) + +The center mark represents the visual in the center of the protractor. + +## -property-value +**true**, if the center mark is visible. Otherwise, **false**. + +The default is **true**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_isresizable.md b/windows.ui.input.inking/inkpresenterprotractor_isresizable.md new file mode 100644 index 0000000000..c3f4fb090b --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_isresizable.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.IsResizable +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.IsResizable + +## -description +Gets or sets whether the protractor stencil can be resized. + +## -property-value +**true**, if the stencil can be resized. Otherwise, **false**. + +The default is **true**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_isvisible.md b/windows.ui.input.inking/inkpresenterprotractor_isvisible.md new file mode 100644 index 0000000000..5e67228265 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_isvisible.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.IsVisible +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.IsVisible + +## -description +Gets or sets whether the protractor stencil is visible. + +## -property-value +**true** if the ruler is visible. Otherwise, **false**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_kind.md b/windows.ui.input.inking/inkpresenterprotractor_kind.md new file mode 100644 index 0000000000..de142e3d3f --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_kind.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.Kind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.Kind + +## -description +Gets the type of stencil to display on the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +## -property-value +The type of stencil. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_radius.md b/windows.ui.input.inking/inkpresenterprotractor_radius.md new file mode 100644 index 0000000000..d93caa1399 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_radius.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.Radius +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.Radius + +## -description +Gets or sets the radial size of the protractor. + +## -property-value +The radial size, in Device Independent Pixels (DIPs). + +The default is 280 DIPs. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterprotractor_transform.md b/windows.ui.input.inking/inkpresenterprotractor_transform.md new file mode 100644 index 0000000000..bda47edf2b --- /dev/null +++ b/windows.ui.input.inking/inkpresenterprotractor_transform.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterProtractor.Transform +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterProtractor.Transform + +## -description +Gets or sets the position and rotation angle of the protractor stencil within the 2-D coordinate space of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +Both position and rotation are based on the top left corner of the stencil relative to the origin of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). + +## -property-value +The position and angle of the stencil as a 3*2 floating point matrix.The default position is the origin of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). The default rotation angle is 0 degrees. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterruler.md b/windows.ui.input.inking/inkpresenterruler.md index a2321297db..7f763ca1ea 100644 --- a/windows.ui.input.inking/inkpresenterruler.md +++ b/windows.ui.input.inking/inkpresenterruler.md @@ -10,8 +10,7 @@ public class InkPresenterRuler : Windows.UI.Input.Inking.IInkPresenterRuler, Win # Windows.UI.Input.Inking.InkPresenterRuler ## -description - -Represents a visual stencil, displayed as an semi-transparent overlay on an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). +Represents a visual stencil, in the form of a straight rule for drawing straight lines, displayed as a semi-transparent overlay on an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). The stencil transforms how an ink stroke is rendered: diff --git a/windows.ui.input.inking/inkpresenterruler_aretickmarksvisible.md b/windows.ui.input.inking/inkpresenterruler_aretickmarksvisible.md new file mode 100644 index 0000000000..35073f799f --- /dev/null +++ b/windows.ui.input.inking/inkpresenterruler_aretickmarksvisible.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterRuler.AreTickMarksVisible +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterRuler.AreTickMarksVisible + +## -description +Gets or sets whether the tick marks are displayed on the ruler stencil. + +![Ruler stencil](images\stencil-ruler.png) + +Tick marks represent the distance marks on the ruler. + +## -property-value +**true**, if the tick marks are visible. Otherwise, **false**. + +The default is **true**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterruler_iscompassvisible.md b/windows.ui.input.inking/inkpresenterruler_iscompassvisible.md new file mode 100644 index 0000000000..753f93bed3 --- /dev/null +++ b/windows.ui.input.inking/inkpresenterruler_iscompassvisible.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkPresenterRuler.IsCompassVisible +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkPresenterRuler.IsCompassVisible + +## -description +Gets or sets whether a compass is displayed on the ruler stencil. + +![Ruler stencil](images\stencil-ruler.png) + +## -property-value +**true**, if the compass is visible. Otherwise, **false**. + +The default is **true**. + +## -remarks + +## -examples + +## -see-also \ No newline at end of file diff --git a/windows.ui.input.inking/inkpresenterruler_transform.md b/windows.ui.input.inking/inkpresenterruler_transform.md index e20083e10f..574e0697ae 100644 --- a/windows.ui.input.inking/inkpresenterruler_transform.md +++ b/windows.ui.input.inking/inkpresenterruler_transform.md @@ -10,7 +10,7 @@ public Windows.Foundation.Numerics.Matrix3x2 Transform { get; set; } # Windows.UI.Input.Inking.InkPresenterRuler.Transform ## -description -Gets or sets the position and rotation angle of the [InkPresenterRuler](inkpresenterruler.md) within the 2-D coordinate space of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). +Gets or sets the position and rotation angle of the ruler stencil within the 2-D coordinate space of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). Both position and rotation are based on the top left corner of the ruler relative to the origin of the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). diff --git a/windows.ui.input.inking/inkpresenterruler_width.md b/windows.ui.input.inking/inkpresenterruler_width.md index 7efa86b8b3..1cb5bae78b 100644 --- a/windows.ui.input.inking/inkpresenterruler_width.md +++ b/windows.ui.input.inking/inkpresenterruler_width.md @@ -14,10 +14,10 @@ Gets or sets the width of the [InkPresenterRuler](inkpresenterruler.md). ## -property-value -The width in device-independent pixel (DIP). +The width in device-independent pixels (DIPs). -+ Default: 120 device-independent pixel (DIP) -+ Minimum: 120 device-independent pixel (DIP) ++ Default: 120 DIPs ++ Minimum: 120 DIPs ## -remarks diff --git a/windows.ui.input.inking/inkpresenterstencilkind.md b/windows.ui.input.inking/inkpresenterstencilkind.md index 0dadbb66e3..9e9c80d796 100644 --- a/windows.ui.input.inking/inkpresenterstencilkind.md +++ b/windows.ui.input.inking/inkpresenterstencilkind.md @@ -10,21 +10,23 @@ public enum Windows.UI.Input.Inking.InkPresenterStencilKind : int # InkPresenterStencilKind ## -description -Specifies the type of stencil exposed by an [InkPresenterRuler](inkpresenterruler.md) object. +Specifies the type of stencil that can be displayed on an [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md). ## -enum-fields ### -field Other:0 A custom stencil. ### -field Ruler:1 -A stencil in the form of a straightedge with measuring tick marks. +A stencil in the form of a straight rule for drawing straight lines. The ruler is metric with major tick marks every 10th position, and sub-major tick marks every 5th position. +### -field Protractor:2 +A stencil in the form of a protractor for drawing arcs and curves. ## -remarks ## -examples ## -see-also -[Windows.UI.Input.Inking Enumerations](windows_ui_input_inking_enumerations.md) \ No newline at end of file +[Windows.UI.Input.Inking Enumerations](windows_ui_input_inking_enumerations.md) diff --git a/windows.ui.input.inking/inkstroke_id.md b/windows.ui.input.inking/inkstroke_id.md new file mode 100644 index 0000000000..f24a9dc367 --- /dev/null +++ b/windows.ui.input.inking/inkstroke_id.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkStroke.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkStroke.Id + +## -description +Gets the Global Unique Identifier (GUID) that identifies the ink stroke. + +A GUID is assigned to each ink stroke managed by the [InkPresenter](inkpresenter.md). + +## -property-value +The unique identifier for the ink stroke. + +## -remarks +This GUID persists through serialization/deserialization of the ink stroke. + +## -examples + +## -see-also +- [InkStrokeContainer.GetStrokeById](inkstrokecontainer_getstrokebyid_91415375.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkstroke_strokeduration.md b/windows.ui.input.inking/inkstroke_strokeduration.md new file mode 100644 index 0000000000..26491b3f52 --- /dev/null +++ b/windows.ui.input.inking/inkstroke_strokeduration.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkStroke.StrokeDuration +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkStroke.StrokeDuration + +## -description +Gets or sets the time taken by the user to draw a single ink stroke. + +## -property-value +The time period expressed in 100-nanosecond units. + +## -remarks + +## -examples + +## -see-also +- [StrokeStartedTime](inkstroke_strokestartedtime.md) +- [CreateStrokeFromInkPoints(CreateStrokeFromInkPoints(IIterable inkPoints, Matrix3x2 transform, IReference strokeStartedTime, IReference strokeDuration)](inkstrokebuilder_createstrokefrominkpoints_2009821049.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308) +- [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312) +- [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) diff --git a/windows.ui.input.inking/inkstroke_strokestartedtime.md b/windows.ui.input.inking/inkstroke_strokestartedtime.md new file mode 100644 index 0000000000..2c0e4c3ef4 --- /dev/null +++ b/windows.ui.input.inking/inkstroke_strokestartedtime.md @@ -0,0 +1,28 @@ +--- +-api-id: P:Windows.UI.Input.Inking.InkStroke.StrokeStartedTime +-api-type: winrt property +--- + + + +# Windows.UI.Input.Inking.InkStroke.StrokeStartedTime + +## -description +Gets or sets the date and time when the InkStroke was started.  + +## -property-value +The date and time of day. + +## -remarks + +## -examples + +## -see-also +- [StrokeDuration](inkstroke_strokeduration.md) +- [CreateStrokeFromInkPoints(CreateStrokeFromInkPoints(IIterable inkPoints, Matrix3x2 transform, IReference strokeStartedTime, IReference strokeDuration)](inkstrokebuilder_createstrokefrominkpoints_2009821049.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308) +- [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312) +- [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) diff --git a/windows.ui.input.inking/inkstrokebuilder_createstrokefrominkpoints_2009821049.md b/windows.ui.input.inking/inkstrokebuilder_createstrokefrominkpoints_2009821049.md new file mode 100644 index 0000000000..a5e412d0ef --- /dev/null +++ b/windows.ui.input.inking/inkstrokebuilder_createstrokefrominkpoints_2009821049.md @@ -0,0 +1,44 @@ +--- +-api-id: M:Windows.UI.Input.Inking.InkStrokeBuilder.CreateStrokeFromInkPoints(Windows.Foundation.Collections.IIterable{Windows.UI.Input.Inking.InkPoint},Windows.Foundation.Numerics.Matrix3x2,Windows.Foundation.IReference{Windows.Foundation.DateTime},Windows.Foundation.IReference{Windows.Foundation.TimeSpan}) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkStrokeBuilder.CreateStrokeFromInkPoints + +## -description +Creates a rich ink stroke from collection of [InkPoint](inkpoint.md) objects. + +> [!NOTE] +> Use [CreateStrokeFromInkPoints](inkstrokebuilder_createstrokefrominkpoints.md) and [SetDefaultDrawingAttributes](inkstrokebuilder_setdefaultdrawingattributes.md) to programmatically build strokes for an [InkPresenter](inkpresenter.md). + +## -parameters + +### -param inkPoints +The collection of [InkPoint](inkpoint.md) objects. + +### -param transform +A 2-D transformation matrix. + +### -param strokeStartedTime +The date and time when the InkStroke was started.  + +### -param strokeDuration +Gets or sets the time taken by the user to draw a single ink stroke. + +## -returns +The ink stroke, including the Bézier curve parameters used for final rendering of the stroke. + +## -remarks + +## -see-also +- [CreateStrokeFromInkPoints(Windows.Foundation.Collections.IIterable inkPoints, Windows.Foundation.Numerics.Matrix3x2 transform)](inkstrokebuilder_createstrokefrominkpoints_712638281.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308) +- [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312) +- [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) +## -examples + diff --git a/windows.ui.input.inking/inkstrokebuilder_createstrokefrominkpoints_712638281.md b/windows.ui.input.inking/inkstrokebuilder_createstrokefrominkpoints_712638281.md index 0cf33f0d98..f6cd760fde 100644 --- a/windows.ui.input.inking/inkstrokebuilder_createstrokefrominkpoints_712638281.md +++ b/windows.ui.input.inking/inkstrokebuilder_createstrokefrominkpoints_712638281.md @@ -10,7 +10,7 @@ public Windows.UI.Input.Inking.InkStroke CreateStrokeFromInkPoints(Windows.Found # Windows.UI.Input.Inking.InkStrokeBuilder.CreateStrokeFromInkPoints ## -description -Creates a stroke from collection of [InkPoint](inkpoint.md) objects. +Creates a basic ink stroke from collection of [InkPoint](inkpoint.md) objects. > [!NOTE] > Use [CreateStrokeFromInkPoints](inkstrokebuilder_createstrokefrominkpoints.md) and [SetDefaultDrawingAttributes](inkstrokebuilder_setdefaultdrawingattributes.md) to programmatically build strokes for an [InkPresenter](inkpresenter.md). @@ -30,4 +30,8 @@ The ink stroke, including the Bézier curve parameters used for final rendering ## -examples ## -see-also -[Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file +- [CreateStrokeFromInkPoints(CreateStrokeFromInkPoints(IIterable inkPoints, Matrix3x2 transform, IReference strokeStartedTime, IReference strokeDuration)](inkstrokebuilder_createstrokefrominkpoints_2009821049.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308) +- [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312) +- [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inkstrokecontainer_getstrokebyid_91415375.md b/windows.ui.input.inking/inkstrokecontainer_getstrokebyid_91415375.md new file mode 100644 index 0000000000..02f16c3227 --- /dev/null +++ b/windows.ui.input.inking/inkstrokecontainer_getstrokebyid_91415375.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Input.Inking.InkStrokeContainer.GetStrokeById(System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkStrokeContainer.GetStrokeById + +## -description +Retrieves the single InkStroke with the specified ID. + +## -parameters +### -param id +The Global Unique Identifier (GUID) used to identify a single ink stroke. + +## -returns +The single ink stroke. + +## -remarks + +## -examples + +## -see-also +- [InkStroke.ID](inkstroke_id.md) \ No newline at end of file diff --git a/windows.ui.input.inking/inkstrokecontainer_saveasync_1696379726.md b/windows.ui.input.inking/inkstrokecontainer_saveasync_1696379726.md index 4385decf66..b33ca9010d 100644 --- a/windows.ui.input.inking/inkstrokecontainer_saveasync_1696379726.md +++ b/windows.ui.input.inking/inkstrokecontainer_saveasync_1696379726.md @@ -24,4 +24,6 @@ The status of the asynchronous operation as the number of bytes sent. For more i ## -examples ## -see-also -[Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file +- [InkStrokeContainer.SaveAsync(Windows.Storage.Streams.IOutputStream outputStream, Windows.UI.Input.Inking.InkPersistenceFormat inkPersistenceFormat)](inkstrokecontainer_saveasync_238248194.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) diff --git a/windows.ui.input.inking/inkstrokecontainer_saveasync_238248194.md b/windows.ui.input.inking/inkstrokecontainer_saveasync_238248194.md new file mode 100644 index 0000000000..ccf5303066 --- /dev/null +++ b/windows.ui.input.inking/inkstrokecontainer_saveasync_238248194.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.UI.Input.Inking.InkStrokeContainer.SaveAsync(Windows.Storage.Streams.IOutputStream,Windows.UI.Input.Inking.InkPersistenceFormat) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkStrokeContainer.SaveAsync + +## -description +Asynchronously saves all [InkStroke](inkstroke.md) objects in the [InkStroke](inkstroke.md) collection that is managed by the [InkStrokeContainer](inkstrokecontainer.md) to the specified stream and in the specified format. + +## -parameters +### -param outputStream +The target stream. An [IRandomAccessStream](../windows.storage.streams/irandomaccessstream.md) (requires [IOutputStream](../windows.storage.streams/ioutputstream.md)) object can be specified instead. + +### -param inkPersistenceFormat +The format in which to save the ink input. + +## -returns +The status of the asynchronous operation as the number of bytes sent. For more information, see [WriteAsync](http://msdn.microsoft.com/library/530f0755-c2f7-4b35-a641-039be007ba0f) method. + +## -remarks + +## -examples + +## -see-also +- [InkPersitenceFormat](inkpersistenceformat.md) +- [InkStrokeContainer.SaveAsync(Windows.Storage.Streams.IOutputStream outputStream)](inkstrokecontainer_saveasync_1696379726.md) +- [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43) +- [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inksynchronizer.md b/windows.ui.input.inking/inksynchronizer.md index aa7722c880..7e7929527b 100644 --- a/windows.ui.input.inking/inksynchronizer.md +++ b/windows.ui.input.inking/inksynchronizer.md @@ -1,24 +1,24 @@ ---- --api-id: T:Windows.UI.Input.Inking.InkSynchronizer --api-type: winrt class ---- - - - -# Windows.UI.Input.Inking.InkSynchronizer - -## -description -Manages the synchronization of ink input and provides methods for rendering it to the Direct2D device context of your Universal Windows app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. This requires an [IInkD2DRenderer](XREF:TODO:input_ink.iinkd2drenderer) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). - -By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). - -By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Inking.InkSynchronizer +-api-type: winrt class +--- + + + +# Windows.UI.Input.Inking.InkSynchronizer + +## -description +Manages the synchronization of ink input and provides methods for rendering it to the Direct2D device context of your Universal Windows app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. This requires an [IInkD2DRenderer](http://msdn.microsoft.com/library/d1bd910d-ce64-4424-a0e1-4f55110b0265) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). + +By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). + +By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. + +## -remarks + +## -examples + +## -see-also [Windows.UI.Input.Inking Classes](windows_ui_input_inking_classes.md), [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inksynchronizer_begindry_793652329.md b/windows.ui.input.inking/inksynchronizer_begindry_793652329.md index c3ab1cff10..bb75c3faf7 100644 --- a/windows.ui.input.inking/inksynchronizer_begindry_793652329.md +++ b/windows.ui.input.inking/inksynchronizer_begindry_793652329.md @@ -1,32 +1,32 @@ ---- --api-id: M:Windows.UI.Input.Inking.InkSynchronizer.BeginDry --api-type: winrt method ---- - - - -# Windows.UI.Input.Inking.InkSynchronizer.BeginDry - -## -description -Initiates a custom "dry" of ink input to the Direct2D device context of your app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. This requires an [IInkD2DRenderer](XREF:TODO:input_ink.iinkd2drenderer) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). - -By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). - -By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. - -## -returns -The collection of "wet" ink strokes to pass to the [IInkD2DRenderer](XREF:TODO:input_ink.iinkd2drenderer) object . - -## -exceptions -### E_ILLEGAL_METHOD_CALL - -Thrown if [BeginDry](inksynchronizer_begindry.md) is called again, before [EndDry](inksynchronizer_enddry.md) is called. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Inking.InkSynchronizer.BeginDry +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkSynchronizer.BeginDry + +## -description +Initiates a custom "dry" of ink input to the Direct2D device context of your app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control. This requires an [IInkD2DRenderer](http://msdn.microsoft.com/library/d1bd910d-ce64-4424-a0e1-4f55110b0265) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). + +By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). + +By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. + +## -returns +The collection of "wet" ink strokes to pass to the [IInkD2DRenderer](http://msdn.microsoft.com/library/d1bd910d-ce64-4424-a0e1-4f55110b0265) object . + +## -exceptions +### E_ILLEGAL_METHOD_CALL + +Thrown if [BeginDry](inksynchronizer_begindry.md) is called again, before [EndDry](inksynchronizer_enddry.md) is called. + +## -remarks + +## -examples + +## -see-also [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.inking/inksynchronizer_enddry_671680857.md b/windows.ui.input.inking/inksynchronizer_enddry_671680857.md index b183aa53a4..51244b780b 100644 --- a/windows.ui.input.inking/inksynchronizer_enddry_671680857.md +++ b/windows.ui.input.inking/inksynchronizer_enddry_671680857.md @@ -1,24 +1,24 @@ ---- --api-id: M:Windows.UI.Input.Inking.InkSynchronizer.EndDry --api-type: winrt method ---- - - - -# Windows.UI.Input.Inking.InkSynchronizer.EndDry - -## -description -Finalizes a custom "dry" of ink input to the Direct2D device context of your app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control, and notifies the system that "wet" ink can be removed. This requires an [IInkD2DRenderer](XREF:TODO:input_ink.iinkd2drenderer) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). - -By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). - -By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Inking.InkSynchronizer.EndDry +-api-type: winrt method +--- + + + +# Windows.UI.Input.Inking.InkSynchronizer.EndDry + +## -description +Finalizes a custom "dry" of ink input to the Direct2D device context of your app, instead of the default [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) control, and notifies the system that "wet" ink can be removed. This requires an [IInkD2DRenderer](http://msdn.microsoft.com/library/d1bd910d-ce64-4424-a0e1-4f55110b0265) object to manage the ink input (see the [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314)). + +By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer (above the application content and replacing the wet ink). + +By calling [ActivateCustomDrying](inkpresenter_activatecustomdrying.md) (before the [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) is loaded), an app creates an [InkSynchronizer](inksynchronizer.md) object to customize how an ink stroke is rendered dry to a [SurfaceImageSource](../windows.ui.xaml.media.imaging/surfaceimagesource.md) or [VirtualSurfaceImageSource](../windows.ui.xaml.media.imaging/virtualsurfaceimagesource.md). For example, an ink stroke could be rasterized and integrated into application content instead of as a separate [InkCanvas](../windows.ui.xaml.controls/inkcanvas.md) layer. + +## -remarks + +## -examples + +## -see-also [Pen and stylus interactions](http://msdn.microsoft.com/library/3da4f2d2-5405-42a1-9ed9-3a87bcd84c43), [Ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620308), [Simple ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620312), [Complex ink sample](http://go.microsoft.com/fwlink/p/?LinkID=620314) \ No newline at end of file diff --git a/windows.ui.input.preview.injection/injectedinputkeyboardinfo_injectedinputkeyboardinfo_1221375020.md b/windows.ui.input.preview.injection/injectedinputkeyboardinfo_injectedinputkeyboardinfo_1221375020.md new file mode 100644 index 0000000000..d3cc20e46c --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputkeyboardinfo_injectedinputkeyboardinfo_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InjectedInputKeyboardInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputKeyboardInfo.InjectedInputKeyboardInfo + +## -description +Creates a new [InjectedInputKeyboardInfo](injectedinputkeyboardinfo.md) object that is used to specify the keyboard input to inject. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputmouseinfo_injectedinputmouseinfo_1221375020.md b/windows.ui.input.preview.injection/injectedinputmouseinfo_injectedinputmouseinfo_1221375020.md new file mode 100644 index 0000000000..c8b60ac665 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputmouseinfo_injectedinputmouseinfo_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InjectedInputMouseInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputMouseInfo.InjectedInputMouseInfo + +## -description +Creates a new [InjectedInputMouseInfo](injectedinputmouseinfo.md) object that is used to specify the mouse input to inject. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputpeninfo_injectedinputpeninfo_1221375020.md b/windows.ui.input.preview.injection/injectedinputpeninfo_injectedinputpeninfo_1221375020.md new file mode 100644 index 0000000000..d1aa0a2ec7 --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputpeninfo_injectedinputpeninfo_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InjectedInputPenInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputPenInfo.InjectedInputPenInfo + +## -description +Creates a new [InjectedInputPenInfo](injectedinputpeninfo.md) object that is used to specify the pen input to inject. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/injectedinputtouchinfo_injectedinputtouchinfo_1221375020.md b/windows.ui.input.preview.injection/injectedinputtouchinfo_injectedinputtouchinfo_1221375020.md new file mode 100644 index 0000000000..be34274eab --- /dev/null +++ b/windows.ui.input.preview.injection/injectedinputtouchinfo_injectedinputtouchinfo_1221375020.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InjectedInputTouchInfo.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InjectedInputTouchInfo.InjectedInputTouchInfo + +## -description +Creates a new [InjectedInputTouchInfo](injectedinputtouchinfo.md) object that is used to specify the touch input to inject. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/inputinjector_trycreate_508033141.md b/windows.ui.input.preview.injection/inputinjector_trycreate_508033141.md new file mode 100644 index 0000000000..170e2fcaec --- /dev/null +++ b/windows.ui.input.preview.injection/inputinjector_trycreate_508033141.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Input.Preview.Injection.InputInjector.TryCreate +-api-type: winrt method +--- + + + +# Windows.UI.Input.Preview.Injection.InputInjector.TryCreate + +## -description +Creates a new instance of the [InputInjector](inputinjector.md) class. + +## -parameters + +## -returns +If successful, returns a new instance of the [InputInjector](inputinjector.md) class. Otherwise, returns null. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md b/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md index a5c41543de..1e5a14f96c 100644 --- a/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md +++ b/windows.ui.input.preview.injection/windows_ui_input_preview_injection.md @@ -6,7 +6,7 @@ # Windows.UI.Input.Preview.Injection ## -description -Provides support for programmatically generating and automating input from a variety of devices. +Provides support for programmatically generating and automating input from a variety of devices such as keyboard, mouse, touch, and pen. ## -remarks diff --git a/windows.ui.input.spatial/spatialgesturerecognizer.md b/windows.ui.input.spatial/spatialgesturerecognizer.md index d8189c3720..d76e585bf5 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer.md @@ -1,26 +1,32 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialGestureRecognizer --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer - -## -description -Interprets user interactions from hands, controllers, and system voice commands to surface spatial gesture events, which users target using their gaze. - -## -remarks -Spatial gestures are a key form of input for HoloLens. By routing interactions from the [SpatialInteractionManager](spatialinteractionmanager.md) to a hologram's [SpatialGestureRecognizer](spatialgesturerecognizer.md), apps can detect Tap, Hold, Manipulation, and Navigation events uniformly across hands, voice, and controllers. - -[SpatialGestureRecognizer](spatialgesturerecognizer.md) performs only the minimal disambiguation between the set of gestures that you request. For example, if you request just Tap, the user may hold their finger down as long as they like and a Tap will still occur. If you request both Tap and Hold, after about a second of holding down their finger, the gesture will promote to a Hold and a Tap will no longer occur. - -To use [SpatialGestureRecognizer](spatialgesturerecognizer.md) , handle the [SpatialInteractionManager](spatialinteractionmanager.md) 's InteractionDetected event and grab the SpatialPointerPose exposed there. Use the user's gaze ray from this pose to intersect with the holograms and surface meshes in the user's surroundings, in order to determine what the user is intending to interact with. Then, route the SpatialInteraction in the event arguments to the target hologram's [SpatialGestureRecognizer](spatialgesturerecognizer.md) , using its CaptureInteraction method. This starts interpreting that interaction according to the SpatialGestureSettings set on that recognizer at creation time or by TrySetGestureSettings. - -On HoloLens, interactions and gestures should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialGestureRecognizer +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer + +## -description +Interprets user interactions from hands, spatial controllers, and system voice commands to surface spatial gesture events, which users target using their gaze or a spatial controller's pointing ray. + +## -remarks +Spatial gestures are a key form of input for Mixed Reality headsets such as HoloLens. By routing interactions from the [SpatialInteractionManager](spatialinteractionmanager.md) to a hologram's [SpatialGestureRecognizer](spatialgesturerecognizer.md), apps can detect Tap, Hold, Manipulation, and Navigation events uniformly across hands, voice, and spatial controllers. + +Note that spatial gestures are not detected for input from gamepads, keyboards or mice. + +[SpatialGestureRecognizer](spatialgesturerecognizer.md) performs only the minimal disambiguation between the set of gestures that you request. For example, if you request just Tap, the user may hold their finger down as long as they like and a Tap will still occur. If you request both Tap and Hold, after about a second of holding down their finger, the gesture will promote to a Hold and a Tap will no longer occur. + +To use [SpatialGestureRecognizer](spatialgesturerecognizer.md), handle the SpatialInteractionManager's [InteractionDetected](spatialinteractionmanager_interactiondetected.md) event and grab the [SpatialPointerPose](spatialpointerpose.md) exposed there. Use the user's gaze ray from this pose to intersect with the holograms and surface meshes in the user's surroundings, in order to determine what the user is intending to interact with. Then, route the [SpatialInteraction](spatialinteraction.md) in the event arguments to the target hologram's [SpatialGestureRecognizer](spatialgesturerecognizer.md), using its [CaptureInteraction](spatialgesturerecognizer_captureinteraction_1961957315.md) method. This starts interpreting that interaction according to the [SpatialGestureSettings](spatialgesturesettings.md) set on that recognizer at creation time or by [TrySetGestureSettings](spatialgesturerecognizer_trysetgesturesettings_136776216.md). + +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_captureinteraction_1961957315.md b/windows.ui.input.spatial/spatialgesturerecognizer_captureinteraction_1961957315.md index 04ce585ca3..6169d1cb4e 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_captureinteraction_1961957315.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_captureinteraction_1961957315.md @@ -1,27 +1,26 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialGestureRecognizer.CaptureInteraction(Windows.UI.Input.Spatial.SpatialInteraction) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.CaptureInteraction - -## -description -Subscribe this SpatialGestureRecognizer to track all input events that occur as part of this interaction. - -To use SpatialGestureRecognizer, handle the SpatialInteractionManager's InteractionDetected event and get the SpatialPointerPose for that point in time by calling TryGetPointerPose on the event arguments. Grab the user's gaze ray from this SpatialPointerPose and intersect it with the holograms and surfaces in the user's surroundings, in order to determine what the user is intending to interact with. Then, route the SpatialInteraction in the event arguments to the target hologram's SpatialGestureRecognizer, using its CaptureInteraction method. This starts interpreting that interaction according to the SpatialGestureSettings set at creation time on that recognizer. - -Note that you may choose to have more than one SpatialGestureRecognizer capture the same interaction. In this case, events will surface from both recognizers according to the SpatialGestureSettings of each. This can be useful if, for example, you have one hologram that supports Tap that is logically contained within a hologram that supports NavigationRailsY for scrolling, and you want to allow either gesture when gazing at the inner hologram. - -## -parameters -### -param interaction -The SpatialInteraction to capture from the SpatialInteractionManager's InteractionDetected event. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialGestureRecognizer.CaptureInteraction(Windows.UI.Input.Spatial.SpatialInteraction) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.CaptureInteraction + +## -description +Subscribe this SpatialGestureRecognizer to track all input events that occur as part of this interaction. + +## -parameters +### -param interaction +The SpatialInteraction to capture from the SpatialInteractionManager's InteractionDetected event. + +## -remarks +To use SpatialGestureRecognizer, handle the SpatialInteractionManager's InteractionDetected event and get the SpatialPointerPose for that point in time by calling TryGetPointerPose on the event arguments. Grab the user's gaze ray from this SpatialPointerPose and intersect it with the holograms and surfaces in the user's surroundings, in order to determine what the user is intending to interact with. Then, route the SpatialInteraction in the event arguments to the target hologram's SpatialGestureRecognizer, using its CaptureInteraction method. This starts interpreting that interaction according to the SpatialGestureSettings set at creation time on that recognizer. + +Note that you may choose to have more than one SpatialGestureRecognizer capture the same interaction. In this case, events will surface from both recognizers according to the SpatialGestureSettings of each. This can be useful if, for example, you have one hologram that supports Tap that is logically contained within a hologram that supports NavigationRailsY for scrolling, and you want to allow either gesture when gazing at the inner hologram. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_holdcanceled.md b/windows.ui.input.spatial/spatialgesturerecognizer_holdcanceled.md index 45849d11f0..1ba6e0be7b 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_holdcanceled.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_holdcanceled.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCanceled --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCanceled - -## -description -Occurs when a Hold gesture is canceled. - -For hand interactions, this event fires when the relevant hand that had a HoldStarted is lost during the gesture. - -For voice interactions, this event does not fire. - -For controllers, this event fires when the relevant controller that had a HoldStarted is lost during the gesture. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCanceled +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCanceled + +## -description +Occurs when a Hold gesture is canceled. + +## -remarks +For hand interactions, this event fires when the relevant hand that had a HoldStarted is lost during the gesture. + +For voice interactions, this event does not fire. + +For spatial controllers, this event fires when the relevant controller that had a HoldStarted is lost during the gesture. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_holdcompleted.md b/windows.ui.input.spatial/spatialgesturerecognizer_holdcompleted.md index f55f8ee133..38ec2cb908 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_holdcompleted.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_holdcompleted.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCompleted --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCompleted - -## -description -Occurs when a Hold gesture completes. - -For hand interactions, this event fires when the finger is released after HoldStarted. - -For voice interactions, this event does not fire. - -For controllers, this event fires when the primary button is released after HoldStarted. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCompleted +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldCompleted + +## -description +Occurs when a Hold gesture completes. + +## -remarks +For hand interactions, this event fires when the finger is released after HoldStarted. + +For voice interactions, this event does not fire. + +For spatial controllers, this event fires when the Select trigger or button is released after HoldStarted. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_holdstarted.md b/windows.ui.input.spatial/spatialgesturerecognizer_holdstarted.md index 0faaebc226..2b1156cae2 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_holdstarted.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_holdstarted.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldStarted --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldStarted - -## -description -Occurs when an interaction becomes a Hold gesture. - -For hand interactions, this event fires when a finger is held pressed for longer than the Hold time threshold. - -For voice interactions, this event does not fire. - -For controllers, this event fires when the primary button is held pressed for longer than the Hold time threshold. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldStarted +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.HoldStarted + +## -description +Occurs when an interaction becomes a Hold gesture. + +## -remarks +For hand interactions, this event fires when a finger is held pressed for longer than the Hold time threshold. + +For voice interactions, this event does not fire. + +For spatial controllers, this event fires when the Select trigger or button is held pressed for longer than the Hold time threshold. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcanceled.md b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcanceled.md index 06865daa4e..fc0b30097f 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcanceled.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcanceled.md @@ -1,23 +1,22 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCanceled --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCanceled - -## -description -Occurs when a Manipulation gesture is canceled. - -For hand interactions, this event fires when the relevant hand that had a ManipulationStarted is lost during the gesture. - -For voice interactions and controllers, this event does not fire. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCanceled +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCanceled + +## -description +Occurs when a Manipulation gesture is canceled. + +## -remarks +For hand interactions, this event fires when the relevant hand that had a ManipulationStarted is lost during the gesture. + +For voice interactions and spatial controllers, this event does not fire. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcompleted.md b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcompleted.md index d8dda1040a..476b8cb8fa 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcompleted.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationcompleted.md @@ -1,23 +1,22 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCompleted --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCompleted - -## -description -Occurs when a Manipulation gesture is completed. - -For hand interactions, this event fires when the finger is released after ManipulationStarted. - -For voice interactions and controllers, this event does not fire. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCompleted +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationCompleted + +## -description +Occurs when a Manipulation gesture is completed. + +## -remarks +For hand interactions, this event fires when the finger is released after ManipulationStarted. + +For voice interactions and spatial controllers, this event does not fire. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationstarted.md b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationstarted.md index 3ceca5f21e..a6de0de7d4 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationstarted.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationstarted.md @@ -1,23 +1,22 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationStarted --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationStarted - -## -description -Occurs when an interaction becomes a Manipulation gesture. - -For hand interactions, this event fires when a finger is pressed and then moves outside of the small Manipulation deadzone. - -For voice interactions and controllers, this event does not fire. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationStarted +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationStarted + +## -description +Occurs when an interaction becomes a Manipulation gesture. + +## -remarks +For hand interactions, this event fires when a finger is pressed and then moves outside of the small Manipulation deadzone. + +For voice interactions and spatial controllers, this event does not fire. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationupdated.md b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationupdated.md index 739e3686b2..c74f235dca 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_manipulationupdated.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_manipulationupdated.md @@ -1,23 +1,22 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationUpdated --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationUpdated - -## -description -Occurs when a Manipulation gesture is updated due to hand movement. - -For hand interactions, this event fires when the relevant hand that had a ManipulationStarted updates its position. - -For voice interactions and controllers, this event does not fire. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationUpdated +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.ManipulationUpdated + +## -description +Occurs when a Manipulation gesture is updated due to hand movement. + +## -remarks +For hand interactions, this event fires when the relevant hand that had a ManipulationStarted updates its position. + +For voice interactions and spatial controllers, this event does not fire. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_navigationcanceled.md b/windows.ui.input.spatial/spatialgesturerecognizer_navigationcanceled.md index 2579b22240..8485ac3cb1 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_navigationcanceled.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_navigationcanceled.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCanceled --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCanceled - -## -description -Occurs when a Navigation gesture is canceled. - -For hand interactions, this event fires when the relevant hand that had a NavigationStarted is lost during the gesture. - -For voice interactions, this event does not fire. - -For controllers, this event fires when the relevant controller that had a NavigationStarted is lost during the gesture. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCanceled +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCanceled + +## -description +Occurs when a Navigation gesture is canceled. + +## -remarks +For hand interactions, this event fires when the relevant hand that had a NavigationStarted is lost during the gesture. + +For voice interactions, this event does not fire. + +For spatial controllers, this event fires when the relevant controller that had a NavigationStarted is lost during the gesture. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_navigationcompleted.md b/windows.ui.input.spatial/spatialgesturerecognizer_navigationcompleted.md index 20685bb6ef..b8d5284ba7 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_navigationcompleted.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_navigationcompleted.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCompleted --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCompleted - -## -description -Occurs when a Navigation gesture is completed. - -For hand interactions, this event fires when the finger is released after NavigationStarted. - -For voice interactions, this event does not fire. - -For controllers, this event fires when the primary button is released after NavigationStarted. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCompleted +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationCompleted + +## -description +Occurs when a Navigation gesture is completed. + +## -remarks +For hand interactions, this event fires when the finger is released after NavigationStarted. + +For voice interactions, this event does not fire. + +For spatial controllers, this event fires when the Select trigger or button is released after NavigationStarted. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_navigationstarted.md b/windows.ui.input.spatial/spatialgesturerecognizer_navigationstarted.md index b0de7d10dc..d22bfc1805 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_navigationstarted.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_navigationstarted.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationStarted --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationStarted - -## -description -Occurs when an interaction becomes a Navigation gesture. - -For hand interactions, this event fires when a finger is pressed and then moves outside of the small Navigation deadzone. - -For voice interactions, this event does not fire. - -For controllers, this event fires when the primary button is pressed and then the controller is moved outside of the small Navigation deadzone. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationStarted +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationStarted + +## -description +Occurs when an interaction becomes a Navigation gesture. + +## -remarks +For hand interactions, this event fires when a finger is pressed and then moves outside of the small Navigation deadzone. + +For voice interactions, this event does not fire. + +For spatial controllers, this event fires when the Select trigger or button is pressed and then the controller is moved outside of the small Navigation deadzone. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_navigationupdated.md b/windows.ui.input.spatial/spatialgesturerecognizer_navigationupdated.md index 5ea0eadbae..5ebfd35236 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_navigationupdated.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_navigationupdated.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationUpdated --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationUpdated - -## -description -Occurs when a Navigation gesture is updated due to hand or controller movement. - -For hand interactions, this event fires when the relevant hand that had a NavigationStarted updates its position. - -For voice interactions, this event does not fire. - -For controllers, this event fires when the relevant controller that had a NavigationStarted is moved. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationUpdated +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.NavigationUpdated + +## -description +Occurs when a Navigation gesture is updated due to hand or spatial controller movement. + +## -remarks +For hand interactions, this event fires when the relevant hand that had a NavigationStarted updates its position. + +For voice interactions, this event does not fire. + +For spatial controllers, this event fires when the relevant controller that had a NavigationStarted is moved. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_recognitionended.md b/windows.ui.input.spatial/spatialgesturerecognizer_recognitionended.md index 1872642a0f..9e25497b4c 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_recognitionended.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_recognitionended.md @@ -1,27 +1,26 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionEnded --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionEnded - -## -description -Occurs when recognition of gestures is done, either due to completion of a gesture or cancellation. This is the last event to fire. - -For hand interactions, this event fires on finger release. - -For voice interactions, this event fires after a system voice command like "Select" has been processed. - -For controllers, this event fires when the primary button is released. - -This also fires if the relevant interaction source is lost during recognition. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionEnded +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionEnded + +## -description +Occurs when recognition of gestures is done, either due to completion of a gesture or cancellation. This is the last event to fire. + +## -remarks +For hand interactions, this event fires on finger release. + +For voice interactions, this event fires after a system voice command like "Select" has been processed. + +For spatial controllers, this event fires when the Select trigger or button is released. + +This also fires if the relevant interaction source is lost during recognition. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_recognitionstarted.md b/windows.ui.input.spatial/spatialgesturerecognizer_recognitionstarted.md index 8524a033e9..d7ffc285db 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_recognitionstarted.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_recognitionstarted.md @@ -1,27 +1,26 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionStarted --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionStarted - -## -description -Occurs when recognition of gestures begins. This is the first event to fire. - -This event fires when there is no active gesture and the gesture recognizer is told to capture an interaction. Note that events will only fire if the interaction could possibly trigger at least one of the gestures requested in the SpatialGestureSettings. - -For hand interactions, this event fires on finger press. - -For voice interactions, this event fires when a system voice command like "Select" is spoken. - -For controllers, this event fires when the primary button is pressed. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionStarted +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.RecognitionStarted + +## -description +Occurs when recognition of gestures begins. This is the first event to fire. + +## -remarks +This event fires when there is no active gesture and the gesture recognizer is told to capture an interaction. Note that events will only fire if the interaction could possibly trigger at least one of the gestures requested in the SpatialGestureSettings. + +For hand interactions, this event fires on finger press. + +For voice interactions, this event fires when a system voice command like "Select" is spoken. + +For spatial controllers, this event fires when the Select trigger or button is pressed. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturerecognizer_tapped.md b/windows.ui.input.spatial/spatialgesturerecognizer_tapped.md index 97e60a04e4..bef3875c50 100644 --- a/windows.ui.input.spatial/spatialgesturerecognizer_tapped.md +++ b/windows.ui.input.spatial/spatialgesturerecognizer_tapped.md @@ -1,25 +1,24 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.Tapped --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialGestureRecognizer.Tapped - -## -description -Occurs when a Tap or DoubleTap gesture is recognized. - -For hand interactions, this event fires on finger release after a finger press. - -For voice interactions, this event fires after the system voice command "Select" has been processed. - -For controllers, this event fires when the primary button is released after it was pressed. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialGestureRecognizer.Tapped +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialGestureRecognizer.Tapped + +## -description +Occurs when a Tap or DoubleTap gesture is recognized. + +## -remarks +For hand interactions, this event fires on finger release after a finger press. + +For voice interactions, this event fires after the system voice command "Select" has been processed. + +For controllers, this event fires when the Select trigger or button is released after it was pressed. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialgesturesettings.md b/windows.ui.input.spatial/spatialgesturesettings.md index 51438cb293..55f5bd88c2 100644 --- a/windows.ui.input.spatial/spatialgesturesettings.md +++ b/windows.ui.input.spatial/spatialgesturesettings.md @@ -1,115 +1,115 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialGestureSettings --api-type: winrt enum ---- - - - -# SpatialGestureSettings - -## -description -This enumeration represents the set of gestures that may be recognized by a [SpatialGestureRecognizer](XREF:TODO:A version of Windows 10 built for the Internet of Things. Runs on Raspberry Pi 2/3, Intel Joule, and more.). - -## -enum-fields -### -field None:0 -Disable support for gestures. - -### -field Tap:1 -Enable support for the tap gesture. - -This represents either an air tap with a hand (finger press followed by finger release), saying the word "Select" with your voice, or pressing and releasing the primary button on a controller. - -This gesture can be used to activate the hologram or other object that the user is looking at. - -Handle the Tapped event to react to this gesture. - -### -field DoubleTap:2 -Enable support for the double-tap gesture. - -This represents two quick air taps with a hand (finger press followed by finger release) or two quick presses and releases of the primary button on a controller. - -Handle the Tapped event and check that TapCount is 2 to react to this gesture. - -### -field Hold:4 -Enable support for the hold gesture. - -This represents the user holding down either their finger or the primary button on a controller for longer than the system's hold threshold. - -This gesture can be used to take a secondary action, such as showing a menu. - -Handle the HoldStarted, HoldCompleted and/or HoldCanceled events to react to this gesture. - -### -field ManipulationTranslate:8 -Enable support for the manipulation gesture, tracking changes to the hand's position. - -This represents the user holding down their finger and moving their hand around in the world. - -This gesture can be used to move, resize or rotate a hologram when you want the hologram to react 1:1 to the user's hand movements. This can also be used to draw new holograms in the world. - -Handle the ManipulationStarted, ManipulationUpdated, ManipulationCompleted and/or ManipulationCanceled events to react to this gesture. - -### -field NavigationX:16 -Enable support for the navigation gesture, in the horizontal axis. - -This represents the user holding down their finger and moving their hand or a controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. - -This gesture can be used to navigate UI widgets, such as radial menus. This can also be used to build velocity-based continuous scrolling or zooming gestures, similar to scrolling a 2D UI by clicking the middle mouse button and then moving the mouse up and down. - -Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. - -### -field NavigationY:32 -Enable support for the navigation gesture, in the vertical axis. - -This represents the user holding down their finger and moving their hand or a controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. - -This gesture can be used to navigate UI widgets, such as radial menus. This can also be used to build velocity-based continuous scrolling or zooming gestures, similar to scrolling a 2D UI by clicking the middle mouse button and then moving the mouse up and down. - -Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. - -### -field NavigationZ:64 -Enable support for the navigation gesture, in the depth axis. - -This represents the user holding down their finger and moving their hand or a controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. - -This gesture can be used to navigate UI widgets, such as radial menus. This can also be used to build velocity-based continuous scrolling or zooming gestures, similar to scrolling a 2D UI by clicking the middle mouse button and then moving the mouse up and down. - -Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. - -### -field NavigationRailsX:128 -Enable support for the navigation gesture, in the horizontal axis using rails (guides). - -This represents the user holding down their finger and moving their hand or a controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. - -This gesture can be used to build velocity-based scrolling or zooming that locks to an axis if the user initiates the gesture primarily in that direction. - -Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. - -### -field NavigationRailsY:256 -Enable support for the navigation gesture, in the vertical axis using rails (guides). - -This represents the user holding down their finger and moving their hand or a controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. - -This gesture can be used to build velocity-based scrolling or zooming that locks to an axis if the user initiates the gesture primarily in that direction. - -Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. - -### -field NavigationRailsZ:512 -Enable support for the navigation gesture, in the depth axis using rails (guides). - -This represents the user holding down their finger and moving their hand or a controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. - -This gesture can be used to build velocity-based scrolling or zooming that locks to an axis if the user initiates the gesture primarily in that direction. - -Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. - - -## -remarks -[SpatialGestureRecognizer](XREF:TODO:A version of Windows 10 built for the Internet of Things. Runs on Raspberry Pi 2/3, Intel Joule, and more.) performs only the minimal disambiguation between the set of gestures that you request. For example, if you request just Tap, the user may hold their finger down as long as they like and a Tap will still occur when the user releases their finger. If you request both Tap and Hold, after about a second of holding down their finger, the gesture will resolve to a Hold and a Tap will no longer occur. - -Manipulation settings may not be combined with Navigation settings. - -## -examples - +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialGestureSettings +-api-type: winrt enum +--- + + + +# SpatialGestureSettings + +## -description +This enumeration represents the set of gestures that may be recognized by a [SpatialGestureRecognizer](spatialgesturerecognizer.md). + +## -enum-fields +### -field None:0 +Disable support for gestures. + +### -field Tap:1 +Enable support for the tap gesture. + +This represents either an air tap with a hand (finger press followed by finger release), saying the word "Select" with your voice, or pressing and releasing the Select trigger or button on a controller. + +This gesture can be used to activate the hologram or other object that the user is looking at. + +Handle the Tapped event to react to this gesture. + +### -field DoubleTap:2 +Enable support for the double-tap gesture. + +This represents two quick air taps with a hand (finger press followed by finger release) or two quick presses and releases of the Select trigger or button on a controller. + +Handle the Tapped event and check that TapCount is 2 to react to this gesture. + +### -field Hold:4 +Enable support for the hold gesture. + +This represents the user holding down either their finger or the Select trigger or button on a spatial controller for longer than the system's hold threshold. + +This gesture can be used to take a secondary action, such as showing a menu. + +Handle the HoldStarted, HoldCompleted and/or HoldCanceled events to react to this gesture. + +### -field ManipulationTranslate:8 +Enable support for the manipulation gesture, tracking changes to the hand's position. + +This represents the user holding down their finger and moving their hand around in the world. + +This gesture can be used to move, resize or rotate a hologram when you want the hologram to react 1:1 to the user's hand movements. This can also be used to draw new holograms in the world. + +Handle the ManipulationStarted, ManipulationUpdated, ManipulationCompleted and/or ManipulationCanceled events to react to this gesture. + +### -field NavigationX:16 +Enable support for the navigation gesture, in the horizontal axis. + +This represents the user holding down their finger and moving their hand or a spatial controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. + +This gesture can be used to navigate UI widgets, such as radial menus. This can also be used to build velocity-based continuous scrolling or zooming gestures, similar to scrolling a 2D UI by clicking the middle mouse button and then moving the mouse up and down. + +Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. + +### -field NavigationY:32 +Enable support for the navigation gesture, in the vertical axis. + +This represents the user holding down their finger and moving their hand or a spatial controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. + +This gesture can be used to navigate UI widgets, such as radial menus. This can also be used to build velocity-based continuous scrolling or zooming gestures, similar to scrolling a 2D UI by clicking the middle mouse button and then moving the mouse up and down. + +Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. + +### -field NavigationZ:64 +Enable support for the navigation gesture, in the depth axis. + +This represents the user holding down their finger and moving their hand or a spatial controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. + +This gesture can be used to navigate UI widgets, such as radial menus. This can also be used to build velocity-based continuous scrolling or zooming gestures, similar to scrolling a 2D UI by clicking the middle mouse button and then moving the mouse up and down. + +Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. + +### -field NavigationRailsX:128 +Enable support for the navigation gesture, in the horizontal axis using rails (guides). + +This represents the user holding down their finger and moving their hand or a spatial controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. + +This gesture can be used to build velocity-based scrolling or zooming that locks to an axis if the user initiates the gesture primarily in that direction. + +Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. + +### -field NavigationRailsY:256 +Enable support for the navigation gesture, in the vertical axis using rails (guides). + +This represents the user holding down their finger and moving their hand or a spatial controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. + +This gesture can be used to build velocity-based scrolling or zooming that locks to an axis if the user initiates the gesture primarily in that direction. + +Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. + +### -field NavigationRailsZ:512 +Enable support for the navigation gesture, in the depth axis using rails (guides). + +This represents the user holding down their finger and moving their hand or a spatial controller within a normalized cube with coordinates from -1.0 to 1.0. These are normalized values and do not represent any physical unit, such as meters. + +This gesture can be used to build velocity-based scrolling or zooming that locks to an axis if the user initiates the gesture primarily in that direction. + +Handle the NavigationStarted, NavigationUpdated, NavigationCompleted and/or NavigationCanceled events to react to this gesture. + + +## -remarks +[SpatialGestureRecognizer](spatialgesturerecognizer.md) performs only the minimal disambiguation between the set of gestures that you request. For example, if you request just Tap, the user may hold their finger down as long as they like and a Tap will still occur when the user releases their finger. If you request both Tap and Hold, after about a second of holding down their finger, the gesture will resolve to a Hold and a Tap will no longer occur. + +Manipulation settings may not be combined with Navigation settings. + +## -examples + ## -see-also \ No newline at end of file diff --git a/windows.ui.input.spatial/spatialholdstartedeventargs_trygetpointerpose_100002244.md b/windows.ui.input.spatial/spatialholdstartedeventargs_trygetpointerpose_100002244.md index caad7cc5e4..aa119b2da1 100644 --- a/windows.ui.input.spatial/spatialholdstartedeventargs_trygetpointerpose_100002244.md +++ b/windows.ui.input.spatial/spatialholdstartedeventargs_trygetpointerpose_100002244.md @@ -1,32 +1,37 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialHoldStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialHoldStartedEventArgs.TryGetPointerPose - -## -description -Gets the user's gaze for use in targeting this gesture. - -This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialHoldStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialHoldStartedEventArgs.TryGetPointerPose + +## -description +Gets the available pointing poses, such as the user's head gaze and each spatial controller's pointing ray, for use in targeting this gesture. + +## -remarks +This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. + +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +## -returns +The pointing poses. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteraction.md b/windows.ui.input.spatial/spatialinteraction.md index 52aa39f325..6881c6671a 100644 --- a/windows.ui.input.spatial/spatialinteraction.md +++ b/windows.ui.input.spatial/spatialinteraction.md @@ -1,20 +1,20 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteraction --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialInteraction - -## -description -Represents an interaction caused by a hand, controller, or the user's voice. - -## -remarks -SpatialInteraction objects are not generally meant to be interpreted directly. Instead, you should target the interaction to a particular hologram based on the SpatialPointerPose from the InteractionDetected event arguments. You can then route recognition of this interaction to that hologram's SpatialGestureRecognizer by calling its CaptureInteraction method. - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteraction +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteraction + +## -description +Represents an interaction caused by a hand, spatial controller, or the user's voice. + +## -remarks +SpatialInteraction objects are not generally meant to be interpreted directly. Instead, you should target the interaction to a particular hologram based on the SpatialPointerPose from the InteractionDetected event arguments. You can then route recognition of this interaction to that hologram's SpatialGestureRecognizer by calling its CaptureInteraction method. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractioncontroller.md b/windows.ui.input.spatial/spatialinteractioncontroller.md new file mode 100644 index 0000000000..4fadb9d722 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontroller.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionController +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionController + +## -description +Represents the specifics of a spatial controller. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontroller_hasthumbstick.md b/windows.ui.input.spatial/spatialinteractioncontroller_hasthumbstick.md new file mode 100644 index 0000000000..0b62734af1 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontroller_hasthumbstick.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionController.HasThumbstick +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionController.HasThumbstick + +## -description +Gets whether the spatial controller has a thumbstick. + +## -property-value +Whether the controller has a thumbstick. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontroller_hastouchpad.md b/windows.ui.input.spatial/spatialinteractioncontroller_hastouchpad.md new file mode 100644 index 0000000000..f07d4777c9 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontroller_hastouchpad.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionController.HasTouchpad +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionController.HasTouchpad + +## -description +Gets whether the spatial controller has a touchpad. + +## -property-value +Whether the controller has a touchpad. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontroller_productid.md b/windows.ui.input.spatial/spatialinteractioncontroller_productid.md new file mode 100644 index 0000000000..1dcd9fa8b8 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontroller_productid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionController.ProductId +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionController.ProductId + +## -description +Gets the product identifier for this spatial controller. + +## -property-value +The product identifier. + +## -remarks +The [VendorId](spatialinteractioncontroller_vendorid.md), [ProductId](spatialinteractioncontroller_productid.md) and [Version](spatialinteractioncontroller_version.md) properties can be used together to identify a particular controller design. This can then be used on occluded Mixed Reality headsets to choose a matching render model to display in the user's surroundings. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontroller_simplehapticscontroller.md b/windows.ui.input.spatial/spatialinteractioncontroller_simplehapticscontroller.md new file mode 100644 index 0000000000..1cded56b60 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontroller_simplehapticscontroller.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionController.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionController.SimpleHapticsController + +## -description +Provides access to the spatial controller's ability to vibrate in the user's hand. + +## -property-value +The simple haptics controller. + +## -remarks +If this spatial controller supports haptics, this property returns a [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object that provides access to the controller's vibration functionality. Otherwise, this property returns null. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontroller_vendorid.md b/windows.ui.input.spatial/spatialinteractioncontroller_vendorid.md new file mode 100644 index 0000000000..68ac770ea4 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontroller_vendorid.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionController.VendorId +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionController.VendorId + +## -description +Gets the vendor identifier for this spatial controller. + +## -property-value +The vendor identifier. + +## -remarks +The [VendorId](spatialinteractioncontroller_vendorid.md), [ProductId](spatialinteractioncontroller_productid.md) and [Version](spatialinteractioncontroller_version.md) properties can be used together to identify a particular controller design. This can then be used on occluded Mixed Reality headsets to choose a matching render model to display in the user's surroundings. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontroller_version.md b/windows.ui.input.spatial/spatialinteractioncontroller_version.md new file mode 100644 index 0000000000..ab2ca99c6e --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontroller_version.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionController.Version +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionController.Version + +## -description +Gets the version, or revision, number for this spatial controller. + +## -property-value +The version number. + +## -remarks +The [VendorId](spatialinteractioncontroller_vendorid.md), [ProductId](spatialinteractioncontroller_productid.md) and [Version](spatialinteractioncontroller_version.md) properties can be used together to identify a particular controller design. This can then be used on occluded Mixed Reality headsets to choose a matching render model to display in the user's surroundings. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties.md new file mode 100644 index 0000000000..fc168b2d95 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties + +## -description +Represents state specific to spatial controllers. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties_isthumbstickpressed.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_isthumbstickpressed.md new file mode 100644 index 0000000000..eeea1fba2b --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_isthumbstickpressed.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.IsThumbstickPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.IsThumbstickPressed + +## -description +Gets whether a spatial controller is experiencing a thumbstick press. + +## -property-value +Whether the source is experiencing a thumbstick press. + +## -remarks +A touchpad press represents the user clicking down on the thumbstick. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties_istouchpadpressed.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_istouchpadpressed.md new file mode 100644 index 0000000000..89272c2b9b --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_istouchpadpressed.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.IsTouchpadPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.IsTouchpadPressed + +## -description +Gets whether a spatial controller is experiencing a touchpad press. + +## -property-value +Whether the source is experiencing a touchpad press. + +## -remarks +A touchpad press represents the user clicking down on the touchpad. + +Inspect [TouchpadX](spatialinteractioncontrollerproperties_touchpadx.md) and [TouchpadY](spatialinteractioncontrollerproperties_touchpady.md) to determine where the user's finger is contacting the touchpad. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties_istouchpadtouched.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_istouchpadtouched.md new file mode 100644 index 0000000000..9d3c319fbf --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_istouchpadtouched.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.IsTouchpadTouched +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.IsTouchpadTouched + +## -description +Gets whether a spatial controller is experiencing a touchpad touch. + +## -property-value +Whether the source is experiencing a touchpad touch. + +## -remarks +A touchpad touch represents the user's finger being in contact with the touchpad. + +Inspect [TouchpadX](spatialinteractioncontrollerproperties_touchpadx.md) and [TouchpadY](spatialinteractioncontrollerproperties_touchpady.md) to determine where the user's finger is contacting the touchpad. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties_thumbstickx.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_thumbstickx.md new file mode 100644 index 0000000000..fabd09e7a3 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_thumbstickx.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.ThumbstickX +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.ThumbstickX + +## -description +Gets a value between -1.0 and 1.0 representing the horizontal position of the thumbstick. + +## -property-value +The thumbstick X value. + +## -remarks +This value ranges from -1.0 on the left to 1.0 on the right, with a center near 0.0. Note that there is no deadzone applied, so this value will not quite reach 0.0 when the thumbstick is released. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties_thumbsticky.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_thumbsticky.md new file mode 100644 index 0000000000..48a8bda6b2 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_thumbsticky.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.ThumbstickY +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.ThumbstickY + +## -description +Gets a value between -1.0 and 1.0 representing the vertical position of the thumbstick. + +## -property-value +The thumbstick Y value. + +## -remarks +This value ranges from -1.0 on the bottom to 1.0 on the top, with a center near 0.0. Note that there is no deadzone applied, so this value will not quite reach 0.0 when the thumbstick is released. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties_touchpadx.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_touchpadx.md new file mode 100644 index 0000000000..a77696409a --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_touchpadx.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.TouchpadX +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.TouchpadX + +## -description +Gets a value between -1.0 and 1.0 representing the horizontal position of the user's finger on the touchpad. + +## -property-value +The touchpad X value. + +## -remarks +This value ranges from -1.0 on the left to 1.0 on the right, with a center of 0.0. + +Inspect [IsTouchpadTouched](spatialinteractioncontrollerproperties_istouchpadtouched.md) before reading this value to ensure that the user is touching the touchpad. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractioncontrollerproperties_touchpady.md b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_touchpady.md new file mode 100644 index 0000000000..b493f74460 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractioncontrollerproperties_touchpady.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.TouchpadY +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionControllerProperties.TouchpadY + +## -description +Gets a value between -1.0 and 1.0 representing the vertical position of the user's finger on the touchpad. + +## -property-value +The touchpad Y value. + +## -remarks +This value ranges from -1.0 on the bottom to 1.0 on the top, with a center of 0.0. + +Inspect [IsTouchpadTouched](spatialinteractioncontrollerproperties_istouchpadtouched.md) before reading this value to ensure that the user is touching the touchpad. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interaction.md b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interaction.md index 256a7af2cf..78dee8ee42 100644 --- a/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interaction.md +++ b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interaction.md @@ -1,24 +1,23 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.Interaction --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.Interaction - -## -description -Gets the detected interaction, for routing to a SpatialGestureRecognizer. - -Pass this SpatialInteraction object to the SpatialGestureRecognizer.CaptureInteraction method to route this interaction to that gesture recognizer. - -## -property-value -The interaction. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.Interaction +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.Interaction + +## -description +Gets the detected interaction, for routing to a [SpatialGestureRecognizer](spatialgesturerecognizer.md). + +## -property-value +The interaction. + +## -remarks +Pass this SpatialInteraction object to the SpatialGestureRecognizer.CaptureInteraction method to route this interaction to that gesture recognizer. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interactionsource.md b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interactionsource.md new file mode 100644 index 0000000000..d942fa6c26 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interactionsource.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.InteractionSource +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.InteractionSource + +## -description +Gets the specific source associated with the detected interaction. + +## -property-value +The interaction source. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interactionsourcekind.md b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interactionsourcekind.md index 0d4d6d3cb7..2d7baa12ef 100644 --- a/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interactionsourcekind.md +++ b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_interactionsourcekind.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.InteractionSourceKind --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.InteractionSourceKind - -## -description -Gets the kind of source associated with this interaction. - -## -property-value -The interaction source kind. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.InteractionSourceKind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.InteractionSourceKind + +## -description +Gets the kind of source associated with the detected interaction. + +## -property-value +The interaction source kind. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractiondetectedeventargs_trygetpointerpose_100002244.md b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_trygetpointerpose_100002244.md index d41d83326b..c0d2bcfdd5 100644 --- a/windows.ui.input.spatial/spatialinteractiondetectedeventargs_trygetpointerpose_100002244.md +++ b/windows.ui.input.spatial/spatialinteractiondetectedeventargs_trygetpointerpose_100002244.md @@ -1,30 +1,35 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.TryGetPointerPose - -## -description -Gets the user's gaze for use in routing this interaction to a SpatialGestureRecognizer. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionDetectedEventArgs.TryGetPointerPose + +## -description +Gets the available pointing poses, such as the user's head gaze and each spatial controller's pointing pose, for use in routing this interaction to a SpatialGestureRecognizer. + +## -remarks +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +## -returns +The pointing poses. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionmanager.md b/windows.ui.input.spatial/spatialinteractionmanager.md index 49d5e5498f..83059266bf 100644 --- a/windows.ui.input.spatial/spatialinteractionmanager.md +++ b/windows.ui.input.spatial/spatialinteractionmanager.md @@ -1,22 +1,24 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteractionManager --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionManager - -## -description -Provides access to user input from hands, controllers, and system voice commands. - -## -remarks -Spatial gestures are a key form of input for HoloLens. By routing the interactions from the SpatialInteractionManager to a hologram's SpatialGestureRecognizer, apps can detect Tap, Hold, Manipulation, and Navigation events uniformly across hands, voice and controllers. - -Interactions are mostly opaque, with an event triggering only at the beginning, so the gesture recognizer you route it to can capture the interaction in its entirety. Apps can instead choose to use the low-level Source events or poll using GetDetectedSourcesAtTimestamp to manually process the Presses, Updates, and Releases surfaced by a given hand or controller. - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionManager +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionManager + +## -description +Provides access to user input from hands, spatial controllers, and system voice commands. + +## -remarks +Spatial gestures are a key form of input for HoloLens. By routing the interactions from the SpatialInteractionManager to a hologram's SpatialGestureRecognizer, apps can detect Tap, Hold, Manipulation, and Navigation events uniformly across hands, voice and controllers. + +Note that spatial interaction are not detected for input from gamepads, keyboards or mice. + +Interactions are mostly opaque, with an event triggering only at the beginning, so the gesture recognizer you route it to can capture the interaction in its entirety. Apps can instead choose to use the low-level Source events or poll using GetDetectedSourcesAtTimestamp to manually process the Presses, Updates, and Releases surfaced by a given hand or controller. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionmanager_interactiondetected.md b/windows.ui.input.spatial/spatialinteractionmanager_interactiondetected.md index 96ebe6133a..253dcf71a9 100644 --- a/windows.ui.input.spatial/spatialinteractionmanager_interactiondetected.md +++ b/windows.ui.input.spatial/spatialinteractionmanager_interactiondetected.md @@ -1,21 +1,21 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.InteractionDetected --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionManager.InteractionDetected - -## -description -Occurs when a new interaction is available for routing to a SpatialGestureRecognizer. - -Pass the SpatialInteraction object in the event arguments to the SpatialGestureRecognizer.CaptureInteraction method to route this interaction to that gesture recognizer. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.InteractionDetected +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionManager.InteractionDetected + +## -description +Occurs when a new interaction is available for routing to a SpatialGestureRecognizer. + +Pass the SpatialInteraction object in the event arguments to the SpatialGestureRecognizer.CaptureInteraction method to route this interaction to that gesture recognizer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionmanager_sourcedetected.md b/windows.ui.input.spatial/spatialinteractionmanager_sourcedetected.md index c44efd27ef..f7a3e5bc98 100644 --- a/windows.ui.input.spatial/spatialinteractionmanager_sourcedetected.md +++ b/windows.ui.input.spatial/spatialinteractionmanager_sourcedetected.md @@ -1,19 +1,19 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceDetected --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceDetected - -## -description -Occurs when a new hand, controller, or source of voice commands has been detected. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceDetected +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceDetected + +## -description +Occurs when a new hand, spatial controller, or source of voice commands has been detected. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionmanager_sourcelost.md b/windows.ui.input.spatial/spatialinteractionmanager_sourcelost.md index e366bc9f09..0c4d87df55 100644 --- a/windows.ui.input.spatial/spatialinteractionmanager_sourcelost.md +++ b/windows.ui.input.spatial/spatialinteractionmanager_sourcelost.md @@ -1,19 +1,19 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceLost --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceLost - -## -description -Occurs when a hand, controller, or source of voice commands is no longer available. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceLost +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceLost + +## -description +Occurs when a hand, spatial controller, or source of voice commands is no longer available. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionmanager_sourcepressed.md b/windows.ui.input.spatial/spatialinteractionmanager_sourcepressed.md index bdb4953398..408319977f 100644 --- a/windows.ui.input.spatial/spatialinteractionmanager_sourcepressed.md +++ b/windows.ui.input.spatial/spatialinteractionmanager_sourcepressed.md @@ -1,19 +1,20 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourcePressed --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionManager.SourcePressed - -## -description -Occurs when a hand or controller has entered the pressed state. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourcePressed +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionManager.SourcePressed + +## -description +Occurs when a hand, spatial controller, or source of voice commands has entered a pressed state. + +## -remarks +Inspect the [PressKind](spatialinteractionsourceeventargs_presskind.md) to determine the nature of the press. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionmanager_sourcereleased.md b/windows.ui.input.spatial/spatialinteractionmanager_sourcereleased.md index c314e9095d..5d16af48a9 100644 --- a/windows.ui.input.spatial/spatialinteractionmanager_sourcereleased.md +++ b/windows.ui.input.spatial/spatialinteractionmanager_sourcereleased.md @@ -1,19 +1,20 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceReleased --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceReleased - -## -description -Occurs when a hand or controller has exited the pressed state. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceReleased +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceReleased + +## -description +Occurs when a hand, spatial controller, or source of voice commands has exited a pressed state. + +## -remarks +Inspect the [PressKind](spatialinteractionsourceeventargs_presskind.md) to determine the nature of the release. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionmanager_sourceupdated.md b/windows.ui.input.spatial/spatialinteractionmanager_sourceupdated.md index 60ebc84d25..9bf84d59f2 100644 --- a/windows.ui.input.spatial/spatialinteractionmanager_sourceupdated.md +++ b/windows.ui.input.spatial/spatialinteractionmanager_sourceupdated.md @@ -1,19 +1,19 @@ ---- --api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceUpdated --api-type: winrt event ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceUpdated - -## -description -Occurs when a hand or controller has experienced a change to its SpatialInteractionSourceState. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.Spatial.SpatialInteractionManager.SourceUpdated +-api-type: winrt event +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionManager.SourceUpdated + +## -description +Occurs when a hand, spatial controller, or source of voice commands has experienced a change to its SpatialInteractionSourceState. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionpresskind.md b/windows.ui.input.spatial/spatialinteractionpresskind.md new file mode 100644 index 0000000000..0e269ddf0e --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionpresskind.md @@ -0,0 +1,42 @@ +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionPressKind +-api-type: winrt enum +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionPressKind + +## -description +Specifies the kind of press represented by a [SourcePressed](spatialinteractionmanager_sourcepressed.md) or [SourceReleased](spatialinteractionmanager_sourcereleased.md) event. + +## -enum-fields +### -field None:0 +This is a SourceDetected, SourceLost or SourceUpdated event, which does not represent a press or a release. + +### -field Select:1 +Select represents the primary press for a spatial interaction source: +* For hands, a Select press represents the user's index finger in the down position. +* For spatial controllers, a Select press represents the controller's index-finger trigger (or primary face button, if no trigger) being fully pressed. +* For voice, a Select press represents the user saying the system keyword "Select". + +### -field Menu:2 +For spatial controllers, a Menu press represents the controller's Menu button being pressed. + +### -field Grasp:3 +For spatial controllers, a grasp represents the user squeezing their fist tightly. This may be detected by grip buttons or a palm trigger. + +### -field Touchpad:4 +For spatial controllers, a touchpad press represents the user clicking down on the touchpad. + +### -field Thumbstick:5 +For spatial controllers, a thumbstick press represents the user clicking down on the thumbstick. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsource.md b/windows.ui.input.spatial/spatialinteractionsource.md index c3313188b9..10569a8854 100644 --- a/windows.ui.input.spatial/spatialinteractionsource.md +++ b/windows.ui.input.spatial/spatialinteractionsource.md @@ -1,22 +1,22 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSource --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSource - -## -description -Represents one detected instance of a hand, controller, or user's voice that can cause interactions and gestures. - -## -remarks -For hands and controllers, each detected hand or controller will get its own ID. For as long as the system can track that a hand is the same hand that was previously detected, it will share an ID. - -For the user's voice, a single ID will be used for all voice input. - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSource +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSource + +## -description +Represents one detected instance of a hand, spatial controller, or user's voice that can cause interactions and gestures. + +## -remarks +For hands and controllers, each detected hand or spatial controller will get its own ID. For as long as the system can track that a hand is the same hand that was previously detected, it will share an ID. + +For the user's voice, a single ID will be used for all voice input. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsource_controller.md b/windows.ui.input.spatial/spatialinteractionsource_controller.md new file mode 100644 index 0000000000..fc2d135db5 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsource_controller.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSource.Controller +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSource.Controller + +## -description +Represents the specifics of a detected spatial controller. + +## -property-value +The spatial controller. + +## -remarks +This property will return null if this source is not a spatial controller. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsource_id.md b/windows.ui.input.spatial/spatialinteractionsource_id.md index 30c1944cb9..d5bea45401 100644 --- a/windows.ui.input.spatial/spatialinteractionsource_id.md +++ b/windows.ui.input.spatial/spatialinteractionsource_id.md @@ -1,22 +1,25 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSource.Id --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSource.Id - -## -description -Gets the identifier for the hand, controller, or user's voice. - -## -property-value -The id. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSource.Id +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSource.Id + +## -description +Gets the identifier for the hand, spatial controller, or user's voice. + +## -property-value +The ID. + +## -remarks +For hands and spatial controllers, each detected hand or controller will get its own ID. For as long as the system can track that a hand is the same hand that was previously detected, it will share an ID. + +For the user's voice, a single ID will be used for all voice input. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsource_isgraspsupported.md b/windows.ui.input.spatial/spatialinteractionsource_isgraspsupported.md new file mode 100644 index 0000000000..530c32687e --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsource_isgraspsupported.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSource.IsGraspSupported +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSource.IsGraspSupported + +## -description +Gets whether the source supports detecting grasps. + +## -property-value +Whether the source supports grasps. + +## -remarks +This will be true for some spatial controllers and false for other interaction sources. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsource_ismenusupported.md b/windows.ui.input.spatial/spatialinteractionsource_ismenusupported.md new file mode 100644 index 0000000000..aa25b1f062 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsource_ismenusupported.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSource.IsMenuSupported +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSource.IsMenuSupported + +## -description +Gets whether the source supports Menu presses. + +## -property-value +Whether the source supports menu presses. + +## -remarks +This will be true for most spatial controllers and false for other interaction sources. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsource_ispointingsupported.md b/windows.ui.input.spatial/spatialinteractionsource_ispointingsupported.md new file mode 100644 index 0000000000..6989782263 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsource_ispointingsupported.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSource.IsPointingSupported +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSource.IsPointingSupported + +## -description +Gets whether the source can provide pointing poses. + +## -property-value +Whether the source can provide pointing poses. + +## -remarks +This will be true for spatial controllers that support positional tracking and false for other interaction sources. + +To get this source's pointing pose, pass the source to [SpatialPointingPose.TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md). Note that a pointing-capable spatial controller can still return a null pointing pose if the controller has lost positional tracking. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsource_trygetstateattimestamp_772735387.md b/windows.ui.input.spatial/spatialinteractionsource_trygetstateattimestamp_772735387.md new file mode 100644 index 0000000000..c27fd8e2a6 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsource_trygetstateattimestamp_772735387.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialInteractionSource.TryGetStateAtTimestamp(Windows.Perception.PerceptionTimestamp) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSource.TryGetStateAtTimestamp + +## -description +Get the state of this source as of the specified timestamp. + +## -parameters + +### -param timestamp +The time to query for the state of this interaction source. + +## -returns +The state. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsourceeventargs.md b/windows.ui.input.spatial/spatialinteractionsourceeventargs.md index f8cf47aa89..8b8522a1c9 100644 --- a/windows.ui.input.spatial/spatialinteractionsourceeventargs.md +++ b/windows.ui.input.spatial/spatialinteractionsourceeventargs.md @@ -1,19 +1,19 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceEventArgs --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceEventArgs - -## -description -Provides data for the SpatialInteractionSource Source events. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceEventArgs + +## -description +Provides data for the SpatialInteractionSource Source events. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourceeventargs_presskind.md b/windows.ui.input.spatial/spatialinteractionsourceeventargs_presskind.md new file mode 100644 index 0000000000..8c082f9ea0 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsourceeventargs_presskind.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceEventArgs.PressKind +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceEventArgs.PressKind + +## -description +Gets the kind of press or release associated with the event. + +## -property-value +The press kind. + +## -remarks +This property is only useful for the SourcePressed and SourceReleased events, as it represents the nature of that particular press or release. For all other Source events, the PressKind will be None. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsourcekind.md b/windows.ui.input.spatial/spatialinteractionsourcekind.md index b0c18c90ec..1d4621dffc 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcekind.md +++ b/windows.ui.input.spatial/spatialinteractionsourcekind.md @@ -1,34 +1,34 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceKind --api-type: winrt enum ---- - - - -# SpatialInteractionSourceKind - -## -description -Specifies the kind of an interaction source. - -## -enum-fields -### -field Other:0 -The interaction source is of a kind not known in this version of the API. - -### -field Hand:1 -The interaction source is one of the user's hands. - -### -field Voice:2 -The interaction source is the user's speech. - -### -field Controller:3 -The interaction source is a controller. - - -## -remarks -This only enumerates sources of interactions, such as hand gestures and voice commands. The user's head gaze is used for pointing and is represented separately by the [SpatialPointerPose](spatialpointerpose.md) type. - -## -examples - +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceKind +-api-type: winrt enum +--- + + + +# SpatialInteractionSourceKind + +## -description +Specifies the kind of an interaction source. + +## -enum-fields +### -field Other:0 +The interaction source is of a kind not known in this version of the API. + +### -field Hand:1 +The interaction source is one of the user's hands. + +### -field Voice:2 +The interaction source is the user's speech, when speaking a system command such as "Select". + +### -field Controller:3 +The interaction source is a spatial controller. + + +## -remarks +This only enumerates sources of interactions, such as hand gestures and voice commands. The user's head gaze is used for pointing and is represented separately by the [SpatialPointerPose](spatialpointerpose.md) type. + +## -examples + ## -see-also \ No newline at end of file diff --git a/windows.ui.input.spatial/spatialinteractionsourcelocation.md b/windows.ui.input.spatial/spatialinteractionsourcelocation.md index 32af1a1d18..3c00988623 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcelocation.md +++ b/windows.ui.input.spatial/spatialinteractionsourcelocation.md @@ -1,19 +1,19 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation - -## -description -Represents the position and velocity of a hand. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation + +## -description +Represents the position, orientation and velocity of a hand or spatial controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourcelocation_orientation.md b/windows.ui.input.spatial/spatialinteractionsourcelocation_orientation.md index 88b0a2b082..c90f415a9a 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcelocation_orientation.md +++ b/windows.ui.input.spatial/spatialinteractionsourcelocation_orientation.md @@ -1,22 +1,27 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Orientation --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Orientation - -## -description -Gets the orientation of a hand or controller. - -## -property-value -The orientation. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Orientation +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Orientation + +## -description +Gets the holding orientation of a spatial controller. + +## -property-value +The orientation. + +## -remarks +This property represents the orientation of the user's hand, either directly or as it holds a spatial controller. This orientation is distinct from a spatial controller's pointing ray, which points forward from the tip of the controller. The pointing ray for a controller is available through the [SpatialPointingPose.TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +Note that orientation is only available for an interaction source if it can correlated with the specified coordinate system. Spatial controllers that do not expose pointing poses do not expose orientation either. + +Interactions from interaction sources that do not support pointing should be targeted using gaze, not using the controller as an "air mouse". + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourcelocation_position.md b/windows.ui.input.spatial/spatialinteractionsourcelocation_position.md index 0d47b23d3c..8382ef79cb 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcelocation_position.md +++ b/windows.ui.input.spatial/spatialinteractionsourcelocation_position.md @@ -1,22 +1,27 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Position --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Position - -## -description -Gets the position of a hand or controller. - -## -property-value -The position. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Position +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Position + +## -description +Gets the position of a hand or the holding position of a spatial controller. + +## -property-value +The position. + +## -remarks +This property represents the position of the user's hand, either directly or where it holds the spatial controller. This position is distinct from the spatial controller's pointing ray, which has its origin at the tip of the controller. The pointing ray for a controller is available through the [SpatialPointingPose.TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +Note that position is only available for an interaction source if it can correlated with the specified coordinate system. + +Interactions from interaction sources that do not support pointing should be targeted using gaze, not using the controller as an "air mouse". + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourcelocation_velocity.md b/windows.ui.input.spatial/spatialinteractionsourcelocation_velocity.md index 77e4245923..61d64de2f9 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcelocation_velocity.md +++ b/windows.ui.input.spatial/spatialinteractionsourcelocation_velocity.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Velocity --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Velocity - -## -description -Gets the velocity of a hand or controller. - -## -property-value -The velocity. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Velocity +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceLocation.Velocity + +## -description +Gets the velocity of a hand or spatial controller. + +## -property-value +The velocity. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourceproperties.md b/windows.ui.input.spatial/spatialinteractionsourceproperties.md index 0d6fa7a8f3..68b365f58b 100644 --- a/windows.ui.input.spatial/spatialinteractionsourceproperties.md +++ b/windows.ui.input.spatial/spatialinteractionsourceproperties.md @@ -1,19 +1,19 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties - -## -description -Represents the set of properties available to explore the current state of a hand or controller. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties + +## -description +Represents advanced state of a hand or spatial controller. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourceproperties_sourcelossrisk.md b/windows.ui.input.spatial/spatialinteractionsourceproperties_sourcelossrisk.md index d617a2d7e3..9923c59e1c 100644 --- a/windows.ui.input.spatial/spatialinteractionsourceproperties_sourcelossrisk.md +++ b/windows.ui.input.spatial/spatialinteractionsourceproperties_sourcelossrisk.md @@ -1,22 +1,23 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.SourceLossRisk --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.SourceLossRisk - -## -description -Gets the risk that detection of the hand will be lost as a value from 0.0 to 1.0. As the value nears 1.0, you should suggest that the user moves their hand in the direction indicated by [TryGetSourceLossMitigationDirection](spatialinteractionsourceproperties_trygetsourcelossmitigationdirection.md). - -## -property-value -The source loss risk. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.SourceLossRisk +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.SourceLossRisk + +## -description +Gets the risk that detection of a hand or spatial controller will be lost as a value from 0.0 to 1.0. + +## -property-value +The source loss risk. + +## -remarks + As the value nears 1.0, you should suggest that the user moves this source in the direction indicated by [TryGetSourceLossMitigationDirection](spatialinteractionsourceproperties_trygetsourcelossmitigationdirection.md). + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetlocation_1434864230.md b/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetlocation_1434864230.md index 7d930f712d..693dae8cc1 100644 --- a/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetlocation_1434864230.md +++ b/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetlocation_1434864230.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetLocation(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetLocation - -## -description -Get the position and velocity of the hand, expressed in the specified coordinate system. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the hand's location. - -## -returns -The location. - -## -remarks -This method will return null if the specified coordinate system cannot be located at the moment. - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetLocation(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetLocation + +## -description +Get the position, orientation and velocity of the hand or spatial controller, expressed in the specified coordinate system. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the hand's location. + +## -returns +The location. + +## -remarks +This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetsourcelossmitigationdirection_282458382.md b/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetsourcelossmitigationdirection_282458382.md index e30bea5ae6..fe8e883405 100644 --- a/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetsourcelossmitigationdirection_282458382.md +++ b/windows.ui.input.spatial/spatialinteractionsourceproperties_trygetsourcelossmitigationdirection_282458382.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetSourceLossMitigationDirection(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetSourceLossMitigationDirection - -## -description -Gets the direction you should suggest that the user move their hand if it is nearing the edge of the detection area. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the mitigation direction. - -## -returns -The mitigation direction vector, or null if there is no mitigation direction. - -## -remarks -This method will return null if the specified coordinate system cannot be located at the moment. - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetSourceLossMitigationDirection(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceProperties.TryGetSourceLossMitigationDirection + +## -description +Gets the direction you should suggest that the user move their hand or spatial controller if it is nearing the edge of the detection area. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the mitigation direction. + +## -returns +The mitigation direction vector, or null if there is no mitigation direction. + +## -remarks +This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate.md b/windows.ui.input.spatial/spatialinteractionsourcestate.md index b25b6dff58..ebec0812b5 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcestate.md +++ b/windows.ui.input.spatial/spatialinteractionsourcestate.md @@ -1,19 +1,19 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceState --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceState - -## -description -Represents a snapshot of the state of a spatial interaction source (hand, voice or controller) at a given time. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialInteractionSourceState +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState + +## -description +Represents a snapshot of the state of a spatial interaction source (hand, spatial controller or voice) at a given time. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_controllerproperties.md b/windows.ui.input.spatial/spatialinteractionsourcestate_controllerproperties.md new file mode 100644 index 0000000000..47656f4a81 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_controllerproperties.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.ControllerProperties +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.ControllerProperties + +## -description +Gets state specific to spatial controllers. + +## -property-value +The spatial controller properties. + +## -remarks +This property will return null if this source is not a spatial controller. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_isgrasped.md b/windows.ui.input.spatial/spatialinteractionsourcestate_isgrasped.md new file mode 100644 index 0000000000..d32d672176 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_isgrasped.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsGrasped +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsGrasped + +## -description +Gets whether a spatial controller is experiencing a grasp. + +## -property-value +Whether the source is experiencing a grasp. + +## -remarks +For spatial controllers, a grasp represents the user squeezing their fist tightly. This may be detected by grip buttons or a palm trigger. + +For all other spatial interaction sources, IsGrasped will be false. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_ismenupressed.md b/windows.ui.input.spatial/spatialinteractionsourcestate_ismenupressed.md new file mode 100644 index 0000000000..f5c5b96e36 --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_ismenupressed.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsMenuPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsMenuPressed + +## -description +Gets whether a spatial controller is experiencing a Menu press. + +## -property-value +Whether the source is experiencing a Menu press. + +## -remarks +For spatial controllers, a Menu press represents the controller's Menu button being pressed. + +For all other spatial interaction sources, IsMenuPressed will be false. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_ispressed.md b/windows.ui.input.spatial/spatialinteractionsourcestate_ispressed.md index 260e18149a..aa24634fac 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcestate_ispressed.md +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_ispressed.md @@ -1,24 +1,27 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsPressed --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsPressed - -## -description -Gets whether the source is in the pressed state. - -This can be because the hand has a finger pressed or the controller has its primary button pressed. - -## -property-value -Whether the source is in the pressed state. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsPressed + +## -description +Gets whether a hand or spatial controller is experiencing any press. + +## -property-value +Whether the source is experiencing any press. + +## -remarks +This can be because a hand has a finger pressed or a spatial controller has any button pressed. + +To determine which specific presses are occurring, inspect the state's more specific properties such as [IsSelectPressed](spatialinteractionsourcestate_isselectpressed.md), [IsMenuPressed](spatialinteractionsourcestate_ismenupressed.md) or [IsGrasped](spatialinteractionsourcestate_isgrasped.md). If this source is a spatial controller, there are further controller-specific properties to inspect within the state's [ControllerProperties](spatialinteractionsourcestate_controllerproperties.md). + +Note that a voice "Select" causes an instant press and release, and so you cannot poll for a voice press using IsPressed, IsSelectPressed or SelectPressedValue. Instead, use a [SpatialGestureRecognizer](spatialgesturerecognizer.md) and handle the [Tapped](spatialgesturerecognizer_tapped.md) event, or handle the [SourcePressed](spatialinteractionmanager_sourcepressed.md) event. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_isselectpressed.md b/windows.ui.input.spatial/spatialinteractionsourcestate_isselectpressed.md new file mode 100644 index 0000000000..1d20cb026b --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_isselectpressed.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsSelectPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.IsSelectPressed + +## -description +Gets whether a hand or spatial controller is experiencing a primary Select press. + +## -property-value +Whether the source is experiencing a Select press. + +## -remarks +Select represents the primary press for a spatial interaction source: +* For hands, a Select press represents the user's index finger in the down position. +* For spatial controllers, a Select press represents the controller's index-finger trigger (or primary face button, if no trigger) being fully pressed. +* For voice, a Select press represents the user saying the system keyword "Select". + +Note that a voice "Select" causes an instant press and release, and so you cannot poll for a voice press using IsPressed, IsSelectPressed or SelectPressedValue. Instead, use a [SpatialGestureRecognizer](spatialgesturerecognizer.md) and handle the [Tapped](spatialgesturerecognizer_tapped.md) event, or handle the [SourcePressed](spatialinteractionmanager_sourcepressed.md) event. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_properties.md b/windows.ui.input.spatial/spatialinteractionsourcestate_properties.md index ff62e28bef..826355dd41 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcestate_properties.md +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_properties.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.Properties --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceState.Properties - -## -description -Gets the properties to explore to dig deeper into the state of the interaction source. - -## -property-value -The properties. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.Properties +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.Properties + +## -description +Gets advanced state of the interaction source. + +## -property-value +The properties. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_selectpressedvalue.md b/windows.ui.input.spatial/spatialinteractionsourcestate_selectpressedvalue.md new file mode 100644 index 0000000000..f8ea89ad0e --- /dev/null +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_selectpressedvalue.md @@ -0,0 +1,31 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialInteractionSourceState.SelectPressedValue +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.SelectPressedValue + +## -description +Gets the amount to which a hand or spatial controller is experiencing a primary Select press, as a value between 0.0 and 1.0. + +## -property-value +The amount to which the source is experiencing a Select press. + +## -remarks +SelectPressedValue ranges from 0.0 to 1.0, with 0.0 representing no Select press and 1.0 representing a full Select press. [IsPressed](spatialinteractionsourcestate_ispressed.md) will only return true once the SelectPressedValue reaches 1.0. If a given source can only detect an on/off state for Select presses, the value will always be 0.0 or 1.0. + +Select represents the primary press for a spatial interaction source: +* For hands, a Select press represents the user's index finger in the down position. +* For spatial controllers, a Select press represents the controller's index-finger trigger (or primary face button, if no trigger) being fully pressed. +* For voice, a Select press represents the user saying the system keyword "Select". + +Note that a voice "Select" causes an instant press and release, and so you cannot poll for a voice press using IsPressed, IsSelectPressed or SelectPressedValue. Instead, use a [SpatialGestureRecognizer](spatialgesturerecognizer.md) and handle the [Tapped](spatialgesturerecognizer_tapped.md) event, or handle the [SourcePressed](spatialinteractionmanager_sourcepressed.md) event. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialinteractionsourcestate_trygetpointerpose_100002244.md b/windows.ui.input.spatial/spatialinteractionsourcestate_trygetpointerpose_100002244.md index 874061f84e..51fe9c9910 100644 --- a/windows.ui.input.spatial/spatialinteractionsourcestate_trygetpointerpose_100002244.md +++ b/windows.ui.input.spatial/spatialinteractionsourcestate_trygetpointerpose_100002244.md @@ -1,30 +1,35 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialInteractionSourceState.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialInteractionSourceState.TryGetPointerPose - -## -description -Gets the user's gaze for the timestamp when this state was taken. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialInteractionSourceState.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialInteractionSourceState.TryGetPointerPose + +## -description +Gets the available pointing poses, such as the user's head gaze and each spatial controller's pointing pose, for the timestamp when this state snapshot was taken. + +## -remarks +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +## -returns +The pointing poses. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialmanipulationcompletedeventargs_trygetcumulativedelta_1462945548.md b/windows.ui.input.spatial/spatialmanipulationcompletedeventargs_trygetcumulativedelta_1462945548.md index 30d1bae748..ec92461ade 100644 --- a/windows.ui.input.spatial/spatialmanipulationcompletedeventargs_trygetcumulativedelta_1462945548.md +++ b/windows.ui.input.spatial/spatialmanipulationcompletedeventargs_trygetcumulativedelta_1462945548.md @@ -1,28 +1,27 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialManipulationCompletedEventArgs.TryGetCumulativeDelta(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialManipulationCompletedEventArgs.TryGetCumulativeDelta - -## -description -Get the relative motion of the hand since the start of the Manipulation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the delta. - -## -returns -The delta. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialManipulationCompletedEventArgs.TryGetCumulativeDelta(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialManipulationCompletedEventArgs.TryGetCumulativeDelta + +## -description +Get the relative motion of the hand since the start of the Manipulation gesture. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the delta. + +## -returns +The delta. + +## -remarks +This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialmanipulationstartedeventargs_trygetpointerpose_100002244.md b/windows.ui.input.spatial/spatialmanipulationstartedeventargs_trygetpointerpose_100002244.md index 09cd01b5f1..c548a7de1a 100644 --- a/windows.ui.input.spatial/spatialmanipulationstartedeventargs_trygetpointerpose_100002244.md +++ b/windows.ui.input.spatial/spatialmanipulationstartedeventargs_trygetpointerpose_100002244.md @@ -1,32 +1,37 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialManipulationStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialManipulationStartedEventArgs.TryGetPointerPose - -## -description -Gets the user's gaze for use in targeting this gesture. - -This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialManipulationStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialManipulationStartedEventArgs.TryGetPointerPose + +## -description +Gets the available pointing poses, such as the user's head gaze and each spatial controller's pointing pose, for use in targeting this gesture. + +## -remarks +This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. + +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +## -returns +The pointing poses. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialmanipulationupdatedeventargs_trygetcumulativedelta_1462945548.md b/windows.ui.input.spatial/spatialmanipulationupdatedeventargs_trygetcumulativedelta_1462945548.md index 6d85c123cd..95512305ed 100644 --- a/windows.ui.input.spatial/spatialmanipulationupdatedeventargs_trygetcumulativedelta_1462945548.md +++ b/windows.ui.input.spatial/spatialmanipulationupdatedeventargs_trygetcumulativedelta_1462945548.md @@ -1,30 +1,29 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialManipulationUpdatedEventArgs.TryGetCumulativeDelta(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialManipulationUpdatedEventArgs.TryGetCumulativeDelta - -## -description -Get the relative motion of the hand since the start of the Manipulation gesture. - -This motion is expressed in the specified coordinate system. If you want the path followed by the manipulation to represent translation through the world as the user walks around, specify an anchored or stationary coordinate system. If you want the path to stay relative to the user and ignore the user's translation, specify a locator-attached coordinate system. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the delta. - -## -returns -The delta. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialManipulationUpdatedEventArgs.TryGetCumulativeDelta(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialManipulationUpdatedEventArgs.TryGetCumulativeDelta + +## -description +Get the relative motion of the hand since the start of the Manipulation gesture. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the delta. + +## -returns +The delta. + +## -remarks +This motion is expressed in the specified coordinate system. If you want the path followed by the manipulation to represent translation through the world as the user walks around, specify an anchored or stationary coordinate system. If you want the path to stay relative to the user and ignore the user's translation, specify a locator-attached coordinate system. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialnavigationcompletedeventargs_normalizedoffset.md b/windows.ui.input.spatial/spatialnavigationcompletedeventargs_normalizedoffset.md index fb0f297ae9..becef1d172 100644 --- a/windows.ui.input.spatial/spatialnavigationcompletedeventargs_normalizedoffset.md +++ b/windows.ui.input.spatial/spatialnavigationcompletedeventargs_normalizedoffset.md @@ -1,26 +1,25 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialNavigationCompletedEventArgs.NormalizedOffset --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialNavigationCompletedEventArgs.NormalizedOffset - -## -description -Gets the normalized offset of the hand or controller within the unit cube for all axes for this Navigation gesture. - -For hand interactions, the unit cube is oriented relative to the user's head at the time of the finger press. - -The NormalizedOffset is returned as a vector along three axes within the cube: Horizontal, Vertical, and Depth, respectively. For each axis, the value ranges from -1.0 to 1.0 as motion in that axis reaches its extent. A value of 0.0 means no motion in that axis. These are normalized values and do not represent any physical unit, such as meters. It's up to an app to assign meaning, such as scroll velocity, to motion of the hand or controller within the unit cube. - -## -property-value -The normalized offset. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialNavigationCompletedEventArgs.NormalizedOffset +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialNavigationCompletedEventArgs.NormalizedOffset + +## -description +Gets the normalized offset of the hand or spatial controller within the unit cube for all axes for this Navigation gesture. + +## -property-value +The normalized offset. + +## -remarks +For hand interactions, the unit cube is oriented relative to the user's head at the time of the finger press. + +The NormalizedOffset is returned as a vector along three axes within the cube: Horizontal, Vertical, and Depth, respectively. For each axis, the value ranges from -1.0 to 1.0 as motion in that axis reaches its extent. A value of 0.0 means no motion in that axis. These are normalized values and do not represent any physical unit, such as meters. It's up to an app to assign meaning, such as scroll velocity, to motion of the hand or controller within the unit cube. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingx.md b/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingx.md index d1112f412c..79e25495b6 100644 --- a/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingx.md +++ b/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingx.md @@ -1,24 +1,23 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingX --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingX - -## -description -Gets whether the navigation gesture the user is performing involves motion on the horizontal axis. - -If the user has moved their hand so as to snap to vertical rails, for example, this will return false. - -## -property-value -Whether the gesture involves horizontal navigation. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingX +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingX + +## -description +Gets whether the navigation gesture the user is performing involves motion on the horizontal axis. + +## -property-value +Whether the gesture involves horizontal navigation. + +## -remarks +If the user has moved their hand or spatial controller so as to snap to vertical rails, for example, this will return false. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingy.md b/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingy.md index cd561240dc..d9ae7e22c6 100644 --- a/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingy.md +++ b/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingy.md @@ -1,24 +1,23 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingY --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingY - -## -description -Gets whether the navigation gesture the user is performing involves motion on the vertical axis. - -If the user has moved their hand so as to snap to horizontal rails, for example, this will return false. - -## -property-value -Whether the gesture involves vertical navigation. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingY +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingY + +## -description +Gets whether the navigation gesture the user is performing involves motion on the vertical axis. + +## -property-value +Whether the gesture involves vertical navigation. + +## -remarks +If the user has moved their hand or spatial controller so as to snap to horizontal rails, for example, this will return false. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingz.md b/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingz.md index 708bfbc7e4..e1e97c0673 100644 --- a/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingz.md +++ b/windows.ui.input.spatial/spatialnavigationstartedeventargs_isnavigatingz.md @@ -1,24 +1,23 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingZ --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingZ - -## -description -Gets whether the navigation gesture the user is performing involves motion on the depth axis. - -If the user has moved their hand so as to snap to vertical rails, for example, this will return false. - -## -property-value -Whether the gesture involves depth navigation. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingZ +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.IsNavigatingZ + +## -description +Gets whether the navigation gesture the user is performing involves motion on the depth axis. + +## -property-value +Whether the gesture involves depth navigation. + +## -remarks +If the user has moved their hand or spatial controller so as to snap to vertical rails, for example, this will return false. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialnavigationstartedeventargs_trygetpointerpose_100002244.md b/windows.ui.input.spatial/spatialnavigationstartedeventargs_trygetpointerpose_100002244.md index f5e3e00c84..9ce177c1c0 100644 --- a/windows.ui.input.spatial/spatialnavigationstartedeventargs_trygetpointerpose_100002244.md +++ b/windows.ui.input.spatial/spatialnavigationstartedeventargs_trygetpointerpose_100002244.md @@ -1,32 +1,37 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.TryGetPointerPose - -## -description -Gets the user's gaze for use in targeting this gesture. - -This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialNavigationStartedEventArgs.TryGetPointerPose + +## -description +Gets the available pointing poses, such as the user's head gaze and each spatial controller's pointing pose, for use in targeting this gesture. + +## -remarks +This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. + +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +## -returns +The pointing poses. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialnavigationupdatedeventargs_normalizedoffset.md b/windows.ui.input.spatial/spatialnavigationupdatedeventargs_normalizedoffset.md index 197c13c50c..42a2127ebe 100644 --- a/windows.ui.input.spatial/spatialnavigationupdatedeventargs_normalizedoffset.md +++ b/windows.ui.input.spatial/spatialnavigationupdatedeventargs_normalizedoffset.md @@ -1,26 +1,25 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialNavigationUpdatedEventArgs.NormalizedOffset --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialNavigationUpdatedEventArgs.NormalizedOffset - -## -description -Gets the normalized offset of the hand or controller within the unit cube for all axes for this Navigation gesture. - -For hand interactions, the unit cube is oriented relative to the user's head at the time of the finger press. - -The NormalizedOffset is returned as a vector along three axes within the cube: Horizontal, Vertical, and Depth, respectively. For each axis, the value ranges from -1.0 to 1.0 as motion in that axis reaches its extent. A value of 0.0 means no motion in that axis. These are normalized values and do not represent any physical unit, such as meters. It's up to an app to assign meaning, such as scroll velocity, to motion of the hand or controller within the unit cube. - -## -property-value -The normalized offset. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialNavigationUpdatedEventArgs.NormalizedOffset +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialNavigationUpdatedEventArgs.NormalizedOffset + +## -description +Gets the normalized offset of the hand or spatial controller within the unit cube for all axes for this Navigation gesture. + +## -property-value +The normalized offset. + +## -remarks +For hand interactions, the unit cube is oriented relative to the user's head at the time of the finger press. + +The NormalizedOffset is returned as a vector along three axes within the cube: Horizontal, Vertical, and Depth, respectively. For each axis, the value ranges from -1.0 to 1.0 as motion in that axis reaches its extent. A value of 0.0 means no motion in that axis. These are normalized values and do not represent any physical unit, such as meters. It's up to an app to assign meaning, such as scroll velocity, to motion of the hand or controller within the unit cube. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialpointerinteractionsourcepose.md b/windows.ui.input.spatial/spatialpointerinteractionsourcepose.md new file mode 100644 index 0000000000..3b869e61c9 --- /dev/null +++ b/windows.ui.input.spatial/spatialpointerinteractionsourcepose.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose + +## -description +Represents a spatial controller's pointer pose in relation to its surroundings. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialpointerinteractionsourcepose_forwarddirection.md b/windows.ui.input.spatial/spatialpointerinteractionsourcepose_forwarddirection.md new file mode 100644 index 0000000000..29f205e3ba --- /dev/null +++ b/windows.ui.input.spatial/spatialpointerinteractionsourcepose_forwarddirection.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose.ForwardDirection +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose.ForwardDirection + +## -description +Gets the forward direction of the spatial controller's pointer pose in the specified coordinate system, as a unit vector. + +## -property-value +The forward direction unit vector. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialpointerinteractionsourcepose_position.md b/windows.ui.input.spatial/spatialpointerinteractionsourcepose_position.md new file mode 100644 index 0000000000..b113c86c65 --- /dev/null +++ b/windows.ui.input.spatial/spatialpointerinteractionsourcepose_position.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose.Position +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose.Position + +## -description +Gets the position of the spatial controller's pointer pose in the specified coordinate system. + +## -property-value +The position. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialpointerinteractionsourcepose_updirection.md b/windows.ui.input.spatial/spatialpointerinteractionsourcepose_updirection.md new file mode 100644 index 0000000000..c94d385f05 --- /dev/null +++ b/windows.ui.input.spatial/spatialpointerinteractionsourcepose_updirection.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose.UpDirection +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerInteractionSourcePose.UpDirection + +## -description +Gets the up direction that orients the spatial controller's pointer pose in the specified coordinate system, as a unit vector. + +## -property-value +The up direction unit vector. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialpointerpose.md b/windows.ui.input.spatial/spatialpointerpose.md index 84252c25ba..696406b5ea 100644 --- a/windows.ui.input.spatial/spatialpointerpose.md +++ b/windows.ui.input.spatial/spatialpointerpose.md @@ -1,22 +1,28 @@ ---- --api-id: T:Windows.UI.Input.Spatial.SpatialPointerPose --api-type: winrt class ---- - - - -# Windows.UI.Input.Spatial.SpatialPointerPose - -## -description -Represents spatial pointing information, such as the user's head gaze, for use in targeting gestures and voice interactions. - -## -remarks -Apps should intersect the user's head gaze ray with their holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -## -examples - -## -see-also +--- +-api-id: T:Windows.UI.Input.Spatial.SpatialPointerPose +-api-type: winrt class +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerPose + +## -description +Represents the available spatial pointing poses, such as the user's head gaze and each spatial controller's pointing pose, for use in targeting hand gestures, spatial controller presses, and voice interactions. + +## -remarks +The SpatialPointingPose provides the set of pointing rays available at the time represented by the [Timestamp](spatialpointerpose_timestamp.md) property. + +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialpointerpose_head.md b/windows.ui.input.spatial/spatialpointerpose_head.md index 4e3517e579..c094171678 100644 --- a/windows.ui.input.spatial/spatialpointerpose_head.md +++ b/windows.ui.input.spatial/spatialpointerpose_head.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialPointerPose.Head --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialPointerPose.Head - -## -description -Gets the user's head gaze for this timestamp. - -## -property-value -The head gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialPointerPose.Head +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerPose.Head + +## -description +Gets the user's head gaze for this timestamp. + +## -property-value +The head gaze. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialpointerpose_timestamp.md b/windows.ui.input.spatial/spatialpointerpose_timestamp.md index 3b820b6d1a..cd365a0179 100644 --- a/windows.ui.input.spatial/spatialpointerpose_timestamp.md +++ b/windows.ui.input.spatial/spatialpointerpose_timestamp.md @@ -1,22 +1,22 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialPointerPose.Timestamp --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialPointerPose.Timestamp - -## -description -Gets the timestamp at which the user's gaze has been determined. - -## -property-value -The timestamp. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialPointerPose.Timestamp +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerPose.Timestamp + +## -description +Gets the timestamp at which the pointing rays have been determined. + +## -property-value +The timestamp. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialpointerpose_trygetattimestamp_809081853.md b/windows.ui.input.spatial/spatialpointerpose_trygetattimestamp_809081853.md index bd40d56253..5bf0d37d5d 100644 --- a/windows.ui.input.spatial/spatialpointerpose_trygetattimestamp_809081853.md +++ b/windows.ui.input.spatial/spatialpointerpose_trygetattimestamp_809081853.md @@ -1,33 +1,32 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialPointerPose.TryGetAtTimestamp(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Perception.PerceptionTimestamp) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialPointerPose.TryGetAtTimestamp - -## -description -Gets the user's gaze at the specified timestamp. - -This will either be a timestamp from the past (when correlating with input events) or a timestamp from the future (when rendering a cursor along the user's predicted gaze for a HolographicFramePrediction). - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -### -param timestamp -The timestamp, past or future. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialPointerPose.TryGetAtTimestamp(Windows.Perception.Spatial.SpatialCoordinateSystem,Windows.Perception.PerceptionTimestamp) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerPose.TryGetAtTimestamp + +## -description +Gets the head gaze and spatial controller pointing poses for the specified timestamp. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +### -param timestamp +The timestamp, past or future. + +## -returns +The pointing poses. + +## -remarks +This will either be a timestamp from the past (when correlating with input events) or a timestamp from the future (when rendering a cursor along the user's predicted gaze for a HolographicFramePrediction). + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialpointerpose_trygetinteractionsourcepose_1162732260.md b/windows.ui.input.spatial/spatialpointerpose_trygetinteractionsourcepose_1162732260.md new file mode 100644 index 0000000000..c752faead4 --- /dev/null +++ b/windows.ui.input.spatial/spatialpointerpose_trygetinteractionsourcepose_1162732260.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialPointerPose.TryGetInteractionSourcePose(Windows.UI.Input.Spatial.SpatialInteractionSource) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialPointerPose.TryGetInteractionSourcePose + +## -description +Gets the pointing pose for a particular spatial interaction source, such as a spatial controller, at a given timestamp. + +## -parameters + +### -param source +The spatial interaction source for which a pointing pose should be determined. + +## -returns +The interaction source pointing pose. + +## -remarks +This method will return null if the specified spatial interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false) or if the source did not have positional tracking at that moment. + +## -see-also + +## -examples + diff --git a/windows.ui.input.spatial/spatialrecognitionstartedeventargs_trygetpointerpose_100002244.md b/windows.ui.input.spatial/spatialrecognitionstartedeventargs_trygetpointerpose_100002244.md index b801b8d100..56c0e1c193 100644 --- a/windows.ui.input.spatial/spatialrecognitionstartedeventargs_trygetpointerpose_100002244.md +++ b/windows.ui.input.spatial/spatialrecognitionstartedeventargs_trygetpointerpose_100002244.md @@ -1,32 +1,37 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialRecognitionStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialRecognitionStartedEventArgs.TryGetPointerPose - -## -description -Gets the user's gaze for use in targeting this gesture. - -This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialRecognitionStartedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialRecognitionStartedEventArgs.TryGetPointerPose + +## -description +Gets the available pointing poses, such as the user's head gaze and each spatial controller's pointing pose, for use in targeting this gesture. + +## -remarks +This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. + +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +## -returns +The pointing poses. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialtappedeventargs_tapcount.md b/windows.ui.input.spatial/spatialtappedeventargs_tapcount.md index 40466a34df..8736052faf 100644 --- a/windows.ui.input.spatial/spatialtappedeventargs_tapcount.md +++ b/windows.ui.input.spatial/spatialtappedeventargs_tapcount.md @@ -1,22 +1,23 @@ ---- --api-id: P:Windows.UI.Input.Spatial.SpatialTappedEventArgs.TapCount --api-type: winrt property ---- - - - -# Windows.UI.Input.Spatial.SpatialTappedEventArgs.TapCount - -## -description -The tap number represented by this gesture, either 1 or 2. A TapCount of 2 requires setting a SpatialGestureSettings value of DoubleTap. - -## -property-value -The tap count. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.Input.Spatial.SpatialTappedEventArgs.TapCount +-api-type: winrt property +--- + + + +# Windows.UI.Input.Spatial.SpatialTappedEventArgs.TapCount + +## -description +The tap number represented by this gesture, either 1 or 2. + +## -property-value +The tap count. + +## -remarks +A TapCount of 2 requires setting a SpatialGestureSettings value of DoubleTap. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/spatialtappedeventargs_trygetpointerpose_100002244.md b/windows.ui.input.spatial/spatialtappedeventargs_trygetpointerpose_100002244.md index addacfd73c..af4dbe62bc 100644 --- a/windows.ui.input.spatial/spatialtappedeventargs_trygetpointerpose_100002244.md +++ b/windows.ui.input.spatial/spatialtappedeventargs_trygetpointerpose_100002244.md @@ -1,32 +1,37 @@ ---- --api-id: M:Windows.UI.Input.Spatial.SpatialTappedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) --api-type: winrt method ---- - - - -# Windows.UI.Input.Spatial.SpatialTappedEventArgs.TryGetPointerPose - -## -description -Gets the user's gaze for use in targeting this gesture. - -This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. - -On HoloLens, interactions should generally derive their targeting from the user's gaze, rather than trying to render or interact at the hand's location directly. Once an interaction has started, relative motions of the hand may be used to control the gesture, as with the Manipulation or Navigation gesture. - -This method will return null if the specified coordinate system cannot be located at the moment. - -## -parameters -### -param coordinateSystem -The coordinate system in which to express the gaze. - -## -returns -The gaze. - -## -remarks - -## -examples - -## -see-also +--- +-api-id: M:Windows.UI.Input.Spatial.SpatialTappedEventArgs.TryGetPointerPose(Windows.Perception.Spatial.SpatialCoordinateSystem) +-api-type: winrt method +--- + + + +# Windows.UI.Input.Spatial.SpatialTappedEventArgs.TryGetPointerPose + +## -description +Gets the available pointing poses, such as the user's head gaze and each spatial controller's pointing pose, for use in targeting this gesture. + +## -remarks +This pose is from the timestamp of the initial SpatialInteraction routed to this recognizer to begin the active gesture. + +When targeting a spatial interaction, such as a hand gesture, spatial controller press or voice interaction, apps should choose a pointing ray available from the interaction's SpatialPointerPose, based on the nature of the interaction's [SpatialInteractionSource](spatialinteractionsource.md): +* If the interaction source does not support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is false), the app should target based on the user's gaze, available through the [Head](spatialpointerpose_head.md) property. +* If the interaction source does support pointing ([IsPointingSupported](spatialinteractionsource_ispointingsupported.md) is true), the app may instead target based on the source's pointing pose, available through the [TryGetInteractionSourcePose](spatialpointerpose_trygetinteractionsourcepose_1162732260.md) method. + +The app should then intersect the chosen pointing ray with its own holograms or with the spatial mapping mesh to render cursors and determine what the user is intending to interact with. + +Once an interaction has started, relative motions of the hand or controller may be used to control the gesture, as with the [Manipulation](spatialgesturerecognizer_gesturesettings.md) or [Navigation](spatialgesturerecognizer_gesturesettings.md) gesture. + +This method will return null if the specified coordinate system cannot be located at the moment. + +## -parameters +### -param coordinateSystem +The coordinate system in which to express the pointing poses. + +## -returns +The pointing poses. + +## -examples + +## -see-also diff --git a/windows.ui.input.spatial/windows_ui_input_spatial.md b/windows.ui.input.spatial/windows_ui_input_spatial.md index d6d7d9b9c8..918660f9b3 100644 --- a/windows.ui.input.spatial/windows_ui_input_spatial.md +++ b/windows.ui.input.spatial/windows_ui_input_spatial.md @@ -1,15 +1,15 @@ ---- --api-id: N:Windows.UI.Input.Spatial --api-type: winrt namespace ---- - -# Windows.UI.Input.Spatial - -## -description -Contains classes that let apps react naturally to your gaze, gestures, and voice in the world around you. - -## -remarks - -## -examples - +--- +-api-id: N:Windows.UI.Input.Spatial +-api-type: winrt namespace +--- + +# Windows.UI.Input.Spatial + +## -description +Contains classes that let apps react naturally to your gaze, hand gestures, spatial controllers and voice in the world around you. + +## -remarks + +## -examples + ## -see-also \ No newline at end of file diff --git a/windows.ui.input/crossslidethresholds.md b/windows.ui.input/crossslidethresholds.md index 07ec9a921c..0ad4fb2421 100644 --- a/windows.ui.input/crossslidethresholds.md +++ b/windows.ui.input/crossslidethresholds.md @@ -31,7 +31,7 @@ The distance, in device-independent pixel (DIP), from the initial point of conta ## -remarks -A speed bump is a [CrossSliding](gesturerecognizer_crosssliding.md) region in which the user experiences a slight drag (or friction) during the [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture. +A speed bump is a [CrossSliding](gesturerecognizer_crosssliding.md) region in which the user experiences a slight drag (or friction) during the [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture. The following diagram shows the [CrossSliding](gesturerecognizer_crosssliding.md) regions and thresholds. The areas highlighted in blue are the selection/speed bump regions. (The region on the left shows the distance the tile must travel while the region on the right shows the equivalent distance that the touch contact must travel due to the speed bump behavior). diff --git a/windows.ui.input/crossslidingstate.md b/windows.ui.input/crossslidingstate.md index 2f7e5ae77b..09274f588e 100644 --- a/windows.ui.input/crossslidingstate.md +++ b/windows.ui.input/crossslidingstate.md @@ -17,25 +17,25 @@ Specifies the possible states of the [CrossSliding](gesturerecognizer_crossslidi A [CrossSliding](gesturerecognizer_crosssliding.md) interaction has been detected. ### -field Dragging:1 -A [CrossSliding](gesturerecognizer_crosssliding.md) interaction has started but the [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture has not crossed the minimum distance threshold for a selection action. (See the Remarks section for a diagram showing the [CrossSliding](gesturerecognizer_crosssliding.md) distance thresholds.) +A [CrossSliding](gesturerecognizer_crosssliding.md) interaction has started but the [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture has not crossed the minimum distance threshold for a selection action. (See the Remarks section for a diagram showing the [CrossSliding](gesturerecognizer_crosssliding.md) distance thresholds.) > [!NOTE] > There is no correlation between **Dragging** in [CrossSlidingState](crossslidingstate.md) (touch) and [DraggingState](draggingstate.md) (mouse or pen/stylus). ### -field Selecting:2 -The [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture has crossed the minimum distance threshold for a selection action but has not crossed the minimum distance threshold of the rearrange action. This state is valid only when [SpeedBumpStart](crossslidethresholds.md) is disabled in a [GestureRecognizer](gesturerecognizer.md). +The [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture has crossed the minimum distance threshold for a selection action but has not crossed the minimum distance threshold of the rearrange action. This state is valid only when [SpeedBumpStart](crossslidethresholds.md) is disabled in a [GestureRecognizer](gesturerecognizer.md). ### -field SelectSpeedBumping:3 -The [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture has crossed the minimum distance threshold for a selection action (and the selection speed bump) but has not crossed the maximum distance threshold of the selection speed bump. This state is valid only when both [SpeedBumpStart](crossslidethresholds.md) and [SelectionStart](crossslidethresholds.md) are enabled in a [GestureRecognizer](gesturerecognizer.md). +The [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture has crossed the minimum distance threshold for a selection action (and the selection speed bump) but has not crossed the maximum distance threshold of the selection speed bump. This state is valid only when both [SpeedBumpStart](crossslidethresholds.md) and [SelectionStart](crossslidethresholds.md) are enabled in a [GestureRecognizer](gesturerecognizer.md). ### -field SpeedBumping:4 -The [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture has crossed the minimum distance threshold for a selection action (and the selection speed bump) but has not crossed the maximum distance threshold of the selection speed bump. This state is valid only when [SpeedBumpStart](crossslidethresholds.md) is enabled and [SelectionStart](crossslidethresholds.md) is disabled in a [GestureRecognizer](gesturerecognizer.md). +The [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture has crossed the minimum distance threshold for a selection action (and the selection speed bump) but has not crossed the maximum distance threshold of the selection speed bump. This state is valid only when [SpeedBumpStart](crossslidethresholds.md) is enabled and [SelectionStart](crossslidethresholds.md) is disabled in a [GestureRecognizer](gesturerecognizer.md). ### -field Rearranging:5 -The [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture has crossed the minimum distance threshold of the rearrange action. This state is valid only when [RearrangeStart](crossslidethresholds.md) is enabled in a [GestureRecognizer](gesturerecognizer.md). +The [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture has crossed the minimum distance threshold of the rearrange action. This state is valid only when [RearrangeStart](crossslidethresholds.md) is enabled in a [GestureRecognizer](gesturerecognizer.md). ### -field Completed:6 -The [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture has stopped, the [CrossSliding](gesturerecognizer_crosssliding.md) interaction has been completed, and the touch contact lifted. +The [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture has stopped, the [CrossSliding](gesturerecognizer_crosssliding.md) interaction has been completed, and the touch contact lifted. ## -remarks @@ -44,18 +44,18 @@ The [CrossSlidingState](crossslidingeventargs_crossslidingstate.md) property is These distance thresholds are used to determine whether the [CrossSliding](gesturerecognizer_crosssliding.md) interaction results in a select action or a rearrange action. The following diagram shows the [CrossSliding](gesturerecognizer_crosssliding.md) regions and thresholds. The areas highlighted in blue are the selection/speed bump regions. (The region on the left shows the distance the tile must travel while the region on the right shows the equivalent distance that the touch contact must travel due to the speed bump behavior). > [!NOTE] -> A speed bump is a [CrossSliding](gesturerecognizer_crosssliding.md) region in which the user experiences a slight drag (or friction) during the [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture. +> A speed bump is a [CrossSliding](gesturerecognizer_crosssliding.md) region in which the user experiences a slight drag (or friction) during the [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture. Screen shot showing CrossSlide regions and distance thresholds. Selection, rearrange, and speed-bumps can be enabled or disabled in any combination through the [CrossSlideThresholds](gesturerecognizer_crossslidethresholds.md) property of a [GestureRecognizer](gesturerecognizer.md). -If **SelectionStart** and **SpeedBumpStart** are both enabled then **SpeedBumpStart** is ignored (friction is still experienced) and **SelectSpeedBumping** is returned when the [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture is detected within the selection/speed bumping region. +If **SelectionStart** and **SpeedBumpStart** are both enabled then **SpeedBumpStart** is ignored (friction is still experienced) and **SelectSpeedBumping** is returned when the [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture is detected within the selection/speed bumping region. -If **SelectionStart** is enabled and **SpeedBumpStart** is disabled then **Selecting** is returned when the [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture is detected within the selection/speed bump region. +If **SelectionStart** is enabled and **SpeedBumpStart** is disabled then **Selecting** is returned when the [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture is detected within the selection/speed bump region. If **SpeedBumpStart** and **RearrangeStart** are both enabled then **SpeedBumpEnd** is ignored and friction continues until the **RearrangeStart** threshold is reached. -If **RearrangeStart** is enabled then **Rearranging** is returned when the [swipe](XREF:TODO:m_ux_principles.cross-slide) or [slide](XREF:TODO:m_ux_principles.cross-slide) gesture is detected outside the selection/speed bumping region. +If **RearrangeStart** is enabled then **Rearranging** is returned when the [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture is detected outside the selection/speed bumping region. diff --git a/windows.ui.input/gesturerecognizer_crosssliding.md b/windows.ui.input/gesturerecognizer_crosssliding.md index 9a9b3ea959..9cb7a7b23f 100644 --- a/windows.ui.input/gesturerecognizer_crosssliding.md +++ b/windows.ui.input/gesturerecognizer_crosssliding.md @@ -1,30 +1,30 @@ ---- --api-id: E:Windows.UI.Input.GestureRecognizer.CrossSliding --api-type: winrt event ---- - - - -# Windows.UI.Input.GestureRecognizer.CrossSliding - -## -description -Occurs when a user performs a [slide](XREF:TODO:m_ux_principles.cross-slide) or [swipe](XREF:TODO:m_ux_principles.cross-slide) gesture (through a single touch contact) within a content area that supports panning along a single axis only. The gesture must occur in a direction that is perpendicular to this panning axis. - -> [!NOTE] -> A swipe is a short sliding gesture that results in a selection action while the longer slide gesture crosses a distance threshold and results in a rearrange action. The swipe and slide gestures are demonstrated in the following diagram. -Diagram showing the select and drag actions. - - - - -## -remarks -[CrossSlide](gesturesettings.md) must be set in the [GestureSettings](gesturerecognizer_gesturesettings.md) property to support [CrossSliding](gesturerecognizer_crosssliding.md). - -[CrossSliding](gesturerecognizer_crosssliding.md) distance thresholds are disabled by default. Use [CrossSlideThresholds](gesturerecognizer_crossslidethresholds.md) to set these values. - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.GestureRecognizer.CrossSliding +-api-type: winrt event +--- + + + +# Windows.UI.Input.GestureRecognizer.CrossSliding + +## -description +Occurs when a user performs a [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture (through a single touch contact) within a content area that supports panning along a single axis only. The gesture must occur in a direction that is perpendicular to this panning axis. + +> [!NOTE] +> A swipe is a short sliding gesture that results in a selection action while the longer slide gesture crosses a distance threshold and results in a rearrange action. The swipe and slide gestures are demonstrated in the following diagram. +Diagram showing the select and drag actions. + + + + +## -remarks +[CrossSlide](gesturesettings.md) must be set in the [GestureSettings](gesturerecognizer_gesturesettings.md) property to support [CrossSliding](gesturerecognizer_crosssliding.md). + +[CrossSliding](gesturerecognizer_crosssliding.md) distance thresholds are disabled by default. Use [CrossSlideThresholds](gesturerecognizer_crossslidethresholds.md) to set these values. + +## -examples + +## -see-also [TypedEventHandler](../windows.foundation/typedeventhandler_2.md), [CrossSlidingEventArgs](crossslidingeventargs.md) \ No newline at end of file diff --git a/windows.ui.input/gesturerecognizer_dragging.md b/windows.ui.input/gesturerecognizer_dragging.md index 71d01a8c62..1e8509595f 100644 --- a/windows.ui.input/gesturerecognizer_dragging.md +++ b/windows.ui.input/gesturerecognizer_dragging.md @@ -1,21 +1,21 @@ ---- --api-id: E:Windows.UI.Input.GestureRecognizer.Dragging --api-type: winrt event ---- - - - -# Windows.UI.Input.GestureRecognizer.Dragging - -## -description -Occurs when a user performs a [slide](XREF:TODO:m_ux_principles.cross-slide) or [swipe](XREF:TODO:m_ux_principles.cross-slide) gesture with a mouse or pen/stylus (single contact). - -## -remarks -[Drag](gesturesettings.md) must be set in the [GestureSettings](gesturerecognizer_gesturesettings.md) property to support [Dragging](gesturerecognizer_dragging.md). - -## -examples - -## -see-also +--- +-api-id: E:Windows.UI.Input.GestureRecognizer.Dragging +-api-type: winrt event +--- + + + +# Windows.UI.Input.GestureRecognizer.Dragging + +## -description +Occurs when a user performs a [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture with a mouse or pen/stylus (single contact). + +## -remarks +[Drag](gesturesettings.md) must be set in the [GestureSettings](gesturerecognizer_gesturesettings.md) property to support [Dragging](gesturerecognizer_dragging.md). + +## -examples + +## -see-also [TypedEventHandler](../windows.foundation/typedeventhandler_2.md), [DraggingEventArgs](draggingeventargs.md) \ No newline at end of file diff --git a/windows.ui.input/gesturesettings.md b/windows.ui.input/gesturesettings.md index 92ed5880a8..c16ed5f0f7 100644 --- a/windows.ui.input/gesturesettings.md +++ b/windows.ui.input/gesturesettings.md @@ -47,12 +47,12 @@ Enable support for a right-tap interaction. The [RightTapped](gesturerecognizer_ This gesture can be used to display a context menu. ### -field Drag:32 -Enable support for the [slide](XREF:TODO:m_ux_principles.cross-slide) or [swipe](XREF:TODO:m_ux_principles.cross-slide) gesture with a mouse or pen/stylus (single contact). The [Dragging](gesturerecognizer_dragging.md) event is raised when either gesture is detected.This gesture can be used for text selection, selecting or rearranging objects, or scrolling and panning. +Enable support for the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture with a mouse or pen/stylus (single contact). The [Dragging](gesturerecognizer_dragging.md) event is raised when either gesture is detected.This gesture can be used for text selection, selecting or rearranging objects, or scrolling and panning. > [!NOTE] > Mouse and pen/stylus input does not raise manipulation events ([ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md)) during the course of this interaction. -Specifying support for **Drag** and one or more of the manipulation settings enables a single device to perform multiple actions. For example, the [slide](XREF:TODO:m_ux_principles.cross-slide) or [swipe](XREF:TODO:m_ux_principles.cross-slide) gesture can be performed with the left mouse button to select text while the wheel button can be rolled to scroll content. +Specifying support for **Drag** and one or more of the manipulation settings enables a single device to perform multiple actions. For example, the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture can be performed with the left mouse button to select text while the wheel button can be rolled to scroll content. @@ -60,16 +60,16 @@ Specifying support for **Drag** and one or more of the manipulation settings ena ### -field ManipulationTranslateX:64 -Enable support for the [slide](XREF:TODO:m_ux_principles.cross-slide) gesture through pointer input, on the horizontal axis. The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. +Enable support for the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture through pointer input, on the horizontal axis. The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. ### -field ManipulationTranslateY:128 -Enable support for the [slide](XREF:TODO:m_ux_principles.cross-slide) gesture through pointer input, on the vertical axis. The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. +Enable support for the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture through pointer input, on the vertical axis. The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. ### -field ManipulationTranslateRailsX:256 -Enable support for the [slide](XREF:TODO:m_ux_principles.cross-slide) gesture through pointer input, on the horizontal axis using rails (guides). The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. +Enable support for the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture through pointer input, on the horizontal axis using rails (guides). The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. ### -field ManipulationTranslateRailsY:512 -Enable support for the [slide](XREF:TODO:m_ux_principles.cross-slide) gesture through pointer input, on the vertical axis using rails (guides). The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. +Enable support for the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture through pointer input, on the vertical axis using rails (guides). The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction.This gesture can be used for rearranging objects. ### -field ManipulationRotate:1024 Enable support for the rotation gesture through pointer input. The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction. @@ -78,7 +78,7 @@ Enable support for the rotation gesture through pointer input. The [Manipulation Enable support for the pinch or stretch gesture through pointer input.These gestures can be used for optical or semantic zoom and resizing an object. The [ManipulationStarted](gesturerecognizer_manipulationstarted.md), [ManipulationUpdated](gesturerecognizer_manipulationupdated.md), and [ManipulationCompleted](gesturerecognizer_manipulationcompleted.md) events are all raised during the course of this interaction. ### -field ManipulationTranslateInertia:4096 -Enable support for translation inertia after the [slide](XREF:TODO:m_ux_principles.cross-slide) gesture (through pointer input) is complete. The [ManipulationInertiaStarting](gesturerecognizer_manipulationinertiastarting.md) event is raised if inertia is enabled. +Enable support for translation inertia after the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture (through pointer input) is complete. The [ManipulationInertiaStarting](gesturerecognizer_manipulationinertiastarting.md) event is raised if inertia is enabled. ### -field ManipulationRotateInertia:8192 Enable support for rotation inertia after the rotate gesture (through pointer input) is complete. The [ManipulationInertiaStarting](gesturerecognizer_manipulationinertiastarting.md) event is raised if inertia is enabled. @@ -87,7 +87,7 @@ Enable support for rotation inertia after the rotate gesture (through pointer in Enable support for scaling inertia after the pinch or stretch gesture (through pointer input) is complete. The [ManipulationInertiaStarting](gesturerecognizer_manipulationinertiastarting.md) event is raised if inertia is enabled. ### -field CrossSlide:32768 -Enable support for the [CrossSliding](gesturerecognizer_crosssliding.md) interaction when using the [slide](XREF:TODO:m_ux_principles.cross-slide) or [swipe](XREF:TODO:m_ux_principles.cross-slide) gesture through a single touch contact.This gesture can be used for selecting or rearranging objects. +Enable support for the [CrossSliding](gesturerecognizer_crosssliding.md) interaction when using the [slide](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) or [swipe](http://msdn.microsoft.com/library/897555e2-c567-4bbe-b600-553daeb223d5) gesture through a single touch contact.This gesture can be used for selecting or rearranging objects. ### -field ManipulationMultipleFingerPanning:65536 Enable panning and disable zoom when two or more touch contacts are detected.Prevents unintentional zoom interactions when panning with multiple fingers. diff --git a/windows.ui.input/mousewheelparameters.md b/windows.ui.input/mousewheelparameters.md index 01ce87538c..842908b8fa 100644 --- a/windows.ui.input/mousewheelparameters.md +++ b/windows.ui.input/mousewheelparameters.md @@ -13,7 +13,6 @@ public class MouseWheelParameters : Windows.UI.Input.IMouseWheelParameters Provides properties associated with the button wheel of a mouse device. ## -remarks - The properties exposed through [MouseWheelParameters](mousewheelparameters.md) are used in conjunction with the **Wheel** settings in the **Mouse** control panel to define the UI experience when using the button wheel. The mouse wheel button has discrete, evenly spaced notches or distance thresholds (also called detents). When you rotate or tilt the wheel, a wheel message is sent as each detent is encountered. diff --git a/windows.ui.input/pointerpoint.md b/windows.ui.input/pointerpoint.md index 0360059bf3..acd08e666d 100644 --- a/windows.ui.input/pointerpoint.md +++ b/windows.ui.input/pointerpoint.md @@ -43,3 +43,4 @@ In the following example, we query various pointer properties using a [PointerPo ## -see-also [Windows.UI.Input Classes](windows_ui_input_classes.md), [Windows.Devices.Input](../windows.devices.input/windows_devices_input.md), [Windows.UI.Core](../windows.ui.core/windows_ui_core.md), [Windows.UI.Input](windows_ui_input.md), [Windows.UI.Input.Inking](../windows.ui.input.inking/windows_ui_input_inking.md), [Windows.UI.Xaml.Input](../windows.ui.xaml.input/windows_ui_xaml_input.md), [TypedEventHandler](../windows.foundation/typedeventhandler_2.md), [Custom user interactions](http://msdn.microsoft.com/library/9403c46c-60da-4c13-a381-6fbd069dd9ce), [UX guidelines for custom user interactions](http://msdn.microsoft.com/library/52f9607d-e2d0-44e4-9e1c-f856f7072a1e), [Touch design guidelines](http://msdn.microsoft.com/library/3250f729-4fdd-4ad4-b856-b8ba575c3375), [User interaction mode sample](http://go.microsoft.com/fwlink/p/?LinkID=619894), [Focus visuals sample](http://go.microsoft.com/fwlink/p/?LinkID=619895), [Input: Device capabilities sample](http://go.microsoft.com/fwlink/p/?linkid=231530), [Input: Ink sample](http://go.microsoft.com/fwlink/p/?linkid=231622), [Input: Manipulations and gestures (JavaScript) sample](http://go.microsoft.com/fwlink/p/?linkid=231638), [Input: Simplified ink sample](http://go.microsoft.com/fwlink/p/?linkid=246570), [Input: Windows 8 gestures sample](http://go.microsoft.com/fwlink/p/?LinkId=264995), [Input: XAML user input events sample](http://go.microsoft.com/fwlink/p/?linkid=226855), [XAML scrolling, panning, and zooming sample](http://go.microsoft.com/fwlink/p/?linkid=251717), [DirectX touch input sample](http://go.microsoft.com/fwlink/p/?LinkID=231627), [Input: Manipulations and gestures (C++) sample](http://go.microsoft.com/fwlink/p/?linkid=231605), [Input: Touch hit testing sample](http://go.microsoft.com/fwlink/p/?linkid=231590), [Input source identification sample](http://go.microsoft.com/fwlink/p/?LinkID=267908), [Touch injection sample](http://go.microsoft.com/fwlink/p/?LinkID=267906), [Win32 touch hit-testing sample](http://go.microsoft.com/fwlink/p/?LinkID=267915), [Basic input sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620514) +soft.com/fwlink/p/?LinkId=620514) diff --git a/windows.ui.input/pointerpointproperties.md b/windows.ui.input/pointerpointproperties.md index 1c797bcc36..4d8e76b6a9 100644 --- a/windows.ui.input/pointerpointproperties.md +++ b/windows.ui.input/pointerpointproperties.md @@ -49,3 +49,4 @@ In the following example, we query various extended pointer properties using a [ ## -see-also [Windows.UI.Input Classes](windows_ui_input_classes.md), [Windows.UI.Input.PointerPoint.properties](pointerpoint_properties.md), [Windows.Devices.Input](../windows.devices.input/windows_devices_input.md), [Windows.UI.Core](../windows.ui.core/windows_ui_core.md), [Windows.UI.Input](windows_ui_input.md), [Windows.UI.Input.Inking](../windows.ui.input.inking/windows_ui_input_inking.md), [Windows.UI.Xaml.Input](../windows.ui.xaml.input/windows_ui_xaml_input.md), [TypedEventHandler](../windows.foundation/typedeventhandler_2.md), [Custom user interactions](http://msdn.microsoft.com/library/9403c46c-60da-4c13-a381-6fbd069dd9ce), [UX guidelines for custom user interactions](http://msdn.microsoft.com/library/52f9607d-e2d0-44e4-9e1c-f856f7072a1e), [Touch design guidelines](http://msdn.microsoft.com/library/3250f729-4fdd-4ad4-b856-b8ba575c3375), [User interaction mode sample](http://go.microsoft.com/fwlink/p/?LinkID=619894), [Focus visuals sample](http://go.microsoft.com/fwlink/p/?LinkID=619895), [Input: Device capabilities sample](http://go.microsoft.com/fwlink/p/?linkid=231530), [Input: Ink sample](http://go.microsoft.com/fwlink/p/?linkid=231622), [Input: Manipulations and gestures (JavaScript) sample](http://go.microsoft.com/fwlink/p/?linkid=231638), [Input: Simplified ink sample](http://go.microsoft.com/fwlink/p/?linkid=246570), [Input: Windows 8 gestures sample](http://go.microsoft.com/fwlink/p/?LinkId=264995), [Input: XAML user input events sample](http://go.microsoft.com/fwlink/p/?linkid=226855), [XAML scrolling, panning, and zooming sample](http://go.microsoft.com/fwlink/p/?linkid=251717), [DirectX touch input sample](http://go.microsoft.com/fwlink/p/?LinkID=231627), [Input: Manipulations and gestures (C++) sample](http://go.microsoft.com/fwlink/p/?linkid=231605), [Input: Touch hit testing sample](http://go.microsoft.com/fwlink/p/?linkid=231590), [Input source identification sample](http://go.microsoft.com/fwlink/p/?LinkID=267908), [Touch injection sample](http://go.microsoft.com/fwlink/p/?LinkID=267906), [Win32 touch hit-testing sample](http://go.microsoft.com/fwlink/p/?LinkID=267915) +soft.com/fwlink/p/?LinkID=267915) diff --git a/windows.ui.input/radialcontroller_buttonclicked.md b/windows.ui.input/radialcontroller_buttonclicked.md index d0085cfed0..e1d12971ab 100644 --- a/windows.ui.input/radialcontroller_buttonclicked.md +++ b/windows.ui.input/radialcontroller_buttonclicked.md @@ -10,7 +10,7 @@ public event Windows.Foundation.TypedEventHandler ButtonClicked +--> + +# Windows.UI.Input.RadialController.ButtonHolding + +## -description +Occurs when the user presses and holds down the wheel device. + +## -remarks +Your app does not receive this event when: + ++ The [IsMenuSuppressed](radialcontrollerconfiguration_ismenusuppressed.md) is **false**. ++ The [ActiveControllerWhenMenuIsSuppressed](radialcontrollerconfiguration_activecontrollerwhenmenuissuppressed.md) is not set to the appropriate [RadialController](radialcontroller.md). + +## -see-also +- [RadialControllerButtonHoldingEventArgs](radialcontrollerbuttonholdingeventargs.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontroller_buttonpressed.md b/windows.ui.input/radialcontroller_buttonpressed.md new file mode 100644 index 0000000000..f5e756c566 --- /dev/null +++ b/windows.ui.input/radialcontroller_buttonpressed.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.UI.Input.RadialController.ButtonPressed +-api-type: winrt event +--- + + + +# Windows.UI.Input.RadialController.ButtonPressed + +## -description +Occurs when the wheel device is pressed. + +## -remarks + +## -see-also +- [ButtonReleased](buttonreleased.md) + +## -examples + diff --git a/windows.ui.input/radialcontroller_buttonreleased.md b/windows.ui.input/radialcontroller_buttonreleased.md new file mode 100644 index 0000000000..3800aa4025 --- /dev/null +++ b/windows.ui.input/radialcontroller_buttonreleased.md @@ -0,0 +1,21 @@ +--- +-api-id: E:Windows.UI.Input.RadialController.ButtonReleased +-api-type: winrt event +--- + + + +# Windows.UI.Input.RadialController.ButtonReleased + +## -description +Occurs when the wheel device is pressed and then released. + +## -remarks + +## -see-also +- [ButtonPressed](buttonpressed.md) + +## -examples + diff --git a/windows.ui.input/radialcontroller_issupported_930300905.md b/windows.ui.input/radialcontroller_issupported_930300905.md index 2304169e51..e950290c1b 100644 --- a/windows.ui.input/radialcontroller_issupported_930300905.md +++ b/windows.ui.input/radialcontroller_issupported_930300905.md @@ -13,8 +13,7 @@ public bool IsSupported() Retrieves a value that indicates whether wheel devices are supported by the system. ## -returns -** - true** if wheel devices are supported by the system; otherwise **false**. +**true** if wheel devices are supported by the system; otherwise **false**. ## -remarks diff --git a/windows.ui.input/radialcontroller_rotationchanged.md b/windows.ui.input/radialcontroller_rotationchanged.md index 6e56cef612..81e5b45d94 100644 --- a/windows.ui.input/radialcontroller_rotationchanged.md +++ b/windows.ui.input/radialcontroller_rotationchanged.md @@ -12,13 +12,11 @@ public event Windows.Foundation.TypedEventHandler RotationChanged + +# Windows.UI.Input.RadialControllerButtonClickedEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonholdingeventargs.md b/windows.ui.input/radialcontrollerbuttonholdingeventargs.md new file mode 100644 index 0000000000..7a3c413170 --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonholdingeventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.UI.Input.RadialControllerButtonHoldingEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Input.RadialControllerButtonHoldingEventArgs + +## -description +Contains event data for the [ButtonHolding](radialcontroller_buttonholding.md) event (fired only when [IsMenuSuppressed](radialcontrollerconfiguration_ismenusuppressed.md) is **true**). + +## -remarks + +## -see-also +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonholdingeventargs_contact.md b/windows.ui.input/radialcontrollerbuttonholdingeventargs_contact.md new file mode 100644 index 0000000000..dd16493084 --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonholdingeventargs_contact.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerButtonHoldingEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerButtonHoldingEventArgs.Contact + +## -description +Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active. + +## -property-value +The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface. + +**null**, if contact is not detected. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonholdingeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollerbuttonholdingeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..472c1fb47f --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonholdingeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerButtonHoldingEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerButtonHoldingEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonpressedeventargs.md b/windows.ui.input/radialcontrollerbuttonpressedeventargs.md new file mode 100644 index 0000000000..44b04e835f --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonpressedeventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.UI.Input.RadialControllerButtonPressedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Input.RadialControllerButtonPressedEventArgs + +## -description +Contains event data for the [ButtonPressed](radialcontroller_buttonpressed.md) event. + +## -remarks + +## -see-also +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonpressedeventargs_contact.md b/windows.ui.input/radialcontrollerbuttonpressedeventargs_contact.md new file mode 100644 index 0000000000..cd21e306e0 --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonpressedeventargs_contact.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerButtonPressedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerButtonPressedEventArgs.Contact + +## -description +Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active. + +## -property-value +The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface. + +**null**, if contact is not detected. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonpressedeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollerbuttonpressedeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..4a624fd6e8 --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonpressedeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerButtonPressedEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerButtonPressedEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonreleasedeventargs.md b/windows.ui.input/radialcontrollerbuttonreleasedeventargs.md new file mode 100644 index 0000000000..fdfd4440f0 --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonreleasedeventargs.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.UI.Input.RadialControllerButtonReleasedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Input.RadialControllerButtonReleasedEventArgs + +## -description +Contains event data for the [ButtonReleased](radialcontroller_buttonreleased.md) event. + +## -remarks + +## -see-also +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonreleasedeventargs_contact.md b/windows.ui.input/radialcontrollerbuttonreleasedeventargs_contact.md new file mode 100644 index 0000000000..9b6620cb84 --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonreleasedeventargs_contact.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerButtonReleasedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerButtonReleasedEventArgs.Contact + +## -description +Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active. + +## -property-value +The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface. + +**null**, if contact is not detected. + + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerbuttonreleasedeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollerbuttonreleasedeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..3d2fe0e646 --- /dev/null +++ b/windows.ui.input/radialcontrollerbuttonreleasedeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerButtonReleasedEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerButtonReleasedEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerconfiguration_activecontrollerwhenmenuissuppressed.md b/windows.ui.input/radialcontrollerconfiguration_activecontrollerwhenmenuissuppressed.md new file mode 100644 index 0000000000..ac5f8c8a40 --- /dev/null +++ b/windows.ui.input/radialcontrollerconfiguration_activecontrollerwhenmenuissuppressed.md @@ -0,0 +1,29 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerConfiguration.ActiveControllerWhenMenuIsSuppressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerConfiguration.ActiveControllerWhenMenuIsSuppressed + +## -description +Gets or sets the [RadialController](radialcontroller.md) to activate when the [RadialController](radialcontroller.md) menu is suppressed. + +## -property-value + +## -remarks +When the menu is suppressed, the press-and-hold gesture does not cause it to be displayed. + +Listen for the [ButtonHolding](radialcontroller_buttonholding.md) event to implement custom handling of the press-and-hold gesture. + +## -see-also +- [IsMenuSuppressed](radialcontrollerconfiguration_ismenusuppressed.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontrollerconfiguration_ismenusuppressed.md b/windows.ui.input/radialcontrollerconfiguration_ismenusuppressed.md new file mode 100644 index 0000000000..f47181322f --- /dev/null +++ b/windows.ui.input/radialcontrollerconfiguration_ismenusuppressed.md @@ -0,0 +1,30 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerConfiguration.IsMenuSuppressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerConfiguration.IsMenuSuppressed + +## -description +Gets or sets whether the [RadialController](radialcontroller.md) menu can be displayed. + +## -property-value +**true** if the menu is suppressed. Otherwise, **false**. + +## -remarks +When the menu is suppressed, the press-and-hold gesture does not cause it to be displayed. + +Listen for the [ButtonHolding](radialcontroller_buttonholding.md) event to implement custom handling of the press-and-hold gesture. + +## -see-also +- [ActiveControllerWhenMenuIsSuppressed](radialcontrollerconfiguration_activecontrollerwhenmenuissuppressed.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md b/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md index b01e855cce..c72887ef02 100644 --- a/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md +++ b/windows.ui.input/radialcontrollerconfiguration_tryselectdefaultmenuitem_1342621095.md @@ -17,8 +17,7 @@ Attempts to select and activate a tool from the collection of built-in [RadialCo The built-in tool to select and activate. ## -returns -** - true** if the tool can be selected; otherwise **false**. +**true** if the tool can be selected; otherwise **false**. ## -remarks diff --git a/windows.ui.input/radialcontrollercontrolacquiredeventargs_isbuttonpressed.md b/windows.ui.input/radialcontrollercontrolacquiredeventargs_isbuttonpressed.md new file mode 100644 index 0000000000..11d2a8b121 --- /dev/null +++ b/windows.ui.input/radialcontrollercontrolacquiredeventargs_isbuttonpressed.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerControlAcquiredEventArgs.IsButtonPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerControlAcquiredEventArgs.IsButtonPressed + +## -description +Gets whether the wheel device is pressed. + +## -property-value +**true** if pressed. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollercontrolacquiredeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollercontrolacquiredeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..35bf9d7e40 --- /dev/null +++ b/windows.ui.input/radialcontrollercontrolacquiredeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerControlAcquiredEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerControlAcquiredEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollermenu_isenabled.md b/windows.ui.input/radialcontrollermenu_isenabled.md index 414c50da92..fba5352fdb 100644 --- a/windows.ui.input/radialcontrollermenu_isenabled.md +++ b/windows.ui.input/radialcontrollermenu_isenabled.md @@ -13,8 +13,7 @@ public bool IsEnabled { get; set; } Gets or sets whether custom tools are displayed on the [RadialController](radialcontroller.md) menu. ## -property-value -** - true** if the menu displays custom tools; otherwise **false**. +**true** if the menu displays custom tools; otherwise **false**. If **false**, no custom tools are displayed, and [Items](radialcontrollermenu_items.md) is empty. diff --git a/windows.ui.input/radialcontrollermenu_tryselectpreviouslyselectedmenuitem_1178851342.md b/windows.ui.input/radialcontrollermenu_tryselectpreviouslyselectedmenuitem_1178851342.md index 4aaa3bc394..202966c92f 100644 --- a/windows.ui.input/radialcontrollermenu_tryselectpreviouslyselectedmenuitem_1178851342.md +++ b/windows.ui.input/radialcontrollermenu_tryselectpreviouslyselectedmenuitem_1178851342.md @@ -15,8 +15,7 @@ Attempts to select and activate the previously selected tool from the [RadialCon This method does not differentiate between built-in and custom tools. ## -returns -** - true** if the previously selected tool can be selected and activated; otherwise **false**. +**true** if the previously selected tool can be selected and activated; otherwise **false**. ## -remarks diff --git a/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_63723173.md b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_63723173.md new file mode 100644 index 0000000000..9f4d9ecd33 --- /dev/null +++ b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_63723173.md @@ -0,0 +1,47 @@ +--- +-api-id: M:Windows.UI.Input.RadialControllerMenuItem.CreateFromFontGlyph(System.String,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Input.RadialControllerMenuItem.CreateFromFontGlyph + +## -description +Creates a custom tool (using the specified text string and font glyph) on the [RadialController](radialcontroller.md) menu. + +## -parameters + +### -param displayText +The text string to display for the custom tool. + +### -param glyph +The font glyph to display for the custom tool. + +### -param fontFamily +The font family that contains the glyph to display for the custom tool. + +## -returns +The custom tool. + +## -remarks +[UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: + +**Text** ++ Names should be short to fit inside the central circle of the wheel menu ++ Names should clearly identify the primary action (a complementary action can be implied) ++ Scroll indicates the effect of both rotation directions ++ Undo specifies a primary action, but redo (the complementary action) can be inferred and easily discovered by the user + +## -see-also +- [CreateFromFontGlyph(String displayText, String glyph, String fontFamily, Uri fontUri)](radialcontrollermenuitem_createfromfontglyph_679326837.md) +- [CreateFromIcon](radialcontrollermenuitem_createfromicon.md) +- [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_679326837.md b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_679326837.md new file mode 100644 index 0000000000..a6e6a81792 --- /dev/null +++ b/windows.ui.input/radialcontrollermenuitem_createfromfontglyph_679326837.md @@ -0,0 +1,51 @@ +--- +-api-id: M:Windows.UI.Input.RadialControllerMenuItem.CreateFromFontGlyph(System.String,System.String,System.String,Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.UI.Input.RadialControllerMenuItem.CreateFromFontGlyph + +## -description +Creates a custom tool (using the specified text string and font glyph) on the [RadialController](radialcontroller.md) menu. + +## -parameters + +### -param displayText +The text string to display for the custom tool. + +### -param glyph +The font glyph to display for the custom tool. + +### -param fontFamily +The font family that contains the glyph to display for the custom tool. + +### -param fontUri +The Uniform Resource Identifier (URI) that identifies the location of the font used for rendering the glyph. + +## -returns +The custom tool. + +## -remarks +[UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: + +**Text** ++ Names should be short to fit inside the central circle of the wheel menu ++ Names should clearly identify the primary action (a complementary action can be implied) ++ Scroll indicates the effect of both rotation directions ++ Undo specifies a primary action, but redo (the complementary action) can be inferred and easily discovered by the user + +## -see-also +- [CreateFromFontGlyph(String displayText, String glyph, String fontFamily)](radialcontrollermenuitem_createfromfontglyph_63723173.md) +- [CreateFromIcon](radialcontrollermenuitem_createfromicon.md) +- [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + + +## -examples + diff --git a/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md b/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md index f40c051673..81cd234e9f 100644 --- a/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md +++ b/windows.ui.input/radialcontrollermenuitem_createfromicon_2066467533.md @@ -24,15 +24,14 @@ The custom tool. ## -remarks [UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: -Text +**Text** + Names should be short to fit inside the central circle of the wheel menu -+ Names should clearly identify the primary action (a complementary action can be implied) + Scroll indicates the effect of both rotation directions - + Undo specifies a primary action, but redo (the complementary action) can be inferred and easily discovered by the user - - -Icons ++ Names should clearly identify the primary action (a complementary action can be implied) ++ Scroll indicates the effect of both rotation directions ++ Undo specifies a primary action, but redo (the complementary action) can be inferred and easily discovered by the user +**Icons** + Provide a high-quality 64 x 64 pixel PNG image (44 x 44 is the smallest supported) + Ensure the background is transparent + The icon should fill most of the image @@ -42,4 +41,9 @@ Icons ## -examples ## -see-also -[CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon.md), [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions), [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713), [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) \ No newline at end of file +- [CreateFromKnownIcon](radialcontrollermenuitem_createfromknownicon.md) +- [CreateFromFontGlyph(String displayText, String glyph, String fontFamily)](radialcontrollermenuitem_createfromfontglyph_63723173.md) +- [CreateFromFontGlyph(String displayText, String glyph, String fontFamily, Uri fontUri)](radialcontrollermenuitem_createfromfontglyph_679326837.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) \ No newline at end of file diff --git a/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md b/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md index 8df9e97b57..6c1b7bc19c 100644 --- a/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md +++ b/windows.ui.input/radialcontrollermenuitem_createfromknownicon_1665769620.md @@ -24,15 +24,19 @@ The custom tool. ## -remarks [UX guidelines](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) for the Surface Dial recommend the following: -Text +**Text** + Names should be short to fit inside the central circle of the wheel menu -+ Names should clearly identify the primary action (a complementary action can be implied) + Scroll indicates the effect of both rotation directions - + Undo specifies a primary action, but redo (the complementary action) can be inferred and easily discovered by the user - - ++ Names should clearly identify the primary action (a complementary action can be implied) ++ Scroll indicates the effect of both rotation directions ++ Undo specifies a primary action, but redo (the complementary action) can be inferred and easily discovered by the user ## -examples ## -see-also -[CreateFromIcon](radialcontrollermenuitem_createfromicon.md), [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions), [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713), [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) \ No newline at end of file +- [CreateFromIcon](radialcontrollermenuitem_createfromicon.md) +- [CreateFromFontGlyph(String displayText, String glyph, String fontFamily)](radialcontrollermenuitem_createfromfontglyph_63723173.md) +- [CreateFromFontGlyph(String displayText, String glyph, String fontFamily, Uri fontUri)](radialcontrollermenuitem_createfromfontglyph_679326837.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) \ No newline at end of file diff --git a/windows.ui.input/radialcontrollerrotationchangedeventargs_isbuttonpressed.md b/windows.ui.input/radialcontrollerrotationchangedeventargs_isbuttonpressed.md new file mode 100644 index 0000000000..7bfd529c09 --- /dev/null +++ b/windows.ui.input/radialcontrollerrotationchangedeventargs_isbuttonpressed.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerRotationChangedEventArgs.IsButtonPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerRotationChangedEventArgs.IsButtonPressed + +## -description +Gets whether the wheel device is pressed. + +## -property-value +**true** if pressed. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerrotationchangedeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollerrotationchangedeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..29f3f9f30b --- /dev/null +++ b/windows.ui.input/radialcontrollerrotationchangedeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerRotationChangedEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerRotationChangedEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerscreencontactcontinuedeventargs_isbuttonpressed.md b/windows.ui.input/radialcontrollerscreencontactcontinuedeventargs_isbuttonpressed.md new file mode 100644 index 0000000000..12e8a2b75d --- /dev/null +++ b/windows.ui.input/radialcontrollerscreencontactcontinuedeventargs_isbuttonpressed.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerScreenContactContinuedEventArgs.IsButtonPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerScreenContactContinuedEventArgs.IsButtonPressed + +## -description +Gets whether the wheel device is pressed. + +## -property-value +**true** if pressed. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerscreencontactcontinuedeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollerscreencontactcontinuedeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..9b7eaeebbf --- /dev/null +++ b/windows.ui.input/radialcontrollerscreencontactcontinuedeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerScreenContactContinuedEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerScreenContactContinuedEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerscreencontactendedeventargs.md b/windows.ui.input/radialcontrollerscreencontactendedeventargs.md new file mode 100644 index 0000000000..eb7af054ca --- /dev/null +++ b/windows.ui.input/radialcontrollerscreencontactendedeventargs.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.UI.Input.RadialControllerScreenContactEndedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Input.RadialControllerScreenContactEndedEventArgs + +## -description +Contains event data for the [ScreenContactEnded](radialcontroller_screencontactended.md) event (fired only while a custom [RadialController](radialcontroller.md) tool is active). + + +Your app does not receive this event when: + ++ The [RadialController](radialcontroller.md) menu is active ++ A built-in tool is active + +## -remarks + +## -see-also +- [Windows.UI.Input Classes](windows_ui_input_classes.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) + +## -examples + diff --git a/windows.ui.input/radialcontrollerscreencontactendedeventargs_isbuttonpressed.md b/windows.ui.input/radialcontrollerscreencontactendedeventargs_isbuttonpressed.md new file mode 100644 index 0000000000..897e1ea0c2 --- /dev/null +++ b/windows.ui.input/radialcontrollerscreencontactendedeventargs_isbuttonpressed.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerScreenContactEndedEventArgs.IsButtonPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerScreenContactEndedEventArgs.IsButtonPressed + +## -description +Gets whether the wheel device is pressed. + +## -property-value +**true** if pressed. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerscreencontactendedeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollerscreencontactendedeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..10fb5d4d4d --- /dev/null +++ b/windows.ui.input/radialcontrollerscreencontactendedeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerScreenContactEndedEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerScreenContactEndedEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerscreencontactstartedeventargs.md b/windows.ui.input/radialcontrollerscreencontactstartedeventargs.md index b96c2fb5a0..6eb495de90 100644 --- a/windows.ui.input/radialcontrollerscreencontactstartedeventargs.md +++ b/windows.ui.input/radialcontrollerscreencontactstartedeventargs.md @@ -24,4 +24,7 @@ Your app does not receive this event when: ## -examples ## -see-also -[Windows.UI.Input Classes](windows_ui_input_classes.md), [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions), [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713), [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) \ No newline at end of file +- [Windows.UI.Input Classes](windows_ui_input_classes.md) +- [Surface Dial interactions](https://msdn.microsoft.com/en-us/windows/uwp/input-and-devices/windows-wheel-interactions) +- [Universal Windows Platform samples (C# and C++)](https://go.microsoft.com/fwlink/?linkid=832713) +- [Windows classic desktop sample](https://aka.ms/radialcontrollerclassicsample) \ No newline at end of file diff --git a/windows.ui.input/radialcontrollerscreencontactstartedeventargs_isbuttonpressed.md b/windows.ui.input/radialcontrollerscreencontactstartedeventargs_isbuttonpressed.md new file mode 100644 index 0000000000..969879b1a5 --- /dev/null +++ b/windows.ui.input/radialcontrollerscreencontactstartedeventargs_isbuttonpressed.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerScreenContactStartedEventArgs.IsButtonPressed +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerScreenContactStartedEventArgs.IsButtonPressed + +## -description +Gets whether the wheel device is pressed. + +## -property-value +**true** if pressed. Otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.input/radialcontrollerscreencontactstartedeventargs_simplehapticscontroller.md b/windows.ui.input/radialcontrollerscreencontactstartedeventargs_simplehapticscontroller.md new file mode 100644 index 0000000000..9b09c48ae2 --- /dev/null +++ b/windows.ui.input/radialcontrollerscreencontactstartedeventargs_simplehapticscontroller.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Input.RadialControllerScreenContactStartedEventArgs.SimpleHapticsController +-api-type: winrt property +--- + + + +# Windows.UI.Input.RadialControllerScreenContactStartedEventArgs.SimpleHapticsController + +## -description +Gets a reference to the [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -property-value +The [SimpleHapticsController](../windows.devices.haptics/simplehapticscontroller.md) object associated with the [RadialController](radialcontroller.md). + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/badgenotification.md b/windows.ui.notifications/badgenotification.md index efcd9562ab..66531aa4af 100644 --- a/windows.ui.notifications/badgenotification.md +++ b/windows.ui.notifications/badgenotification.md @@ -46,4 +46,4 @@ var badgeNotification = new Notifications.badgeNotification(badgeXml); ## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root) \ No newline at end of file +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/badgenotification_badgenotification_93177318.md b/windows.ui.notifications/badgenotification_badgenotification_93177318.md index a7555c76f4..4db50da30f 100644 --- a/windows.ui.notifications/badgenotification_badgenotification_93177318.md +++ b/windows.ui.notifications/badgenotification_badgenotification_93177318.md @@ -1,40 +1,40 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeNotification.BadgeNotification - -## -description -Creates and initializes a new instance of the [BadgeNotification](badgenotification.md). - -## -parameters -### -param content -The XML content that defines the badge update. - -## -remarks -The value attribute can be a number from 1-99 or a status glyph. See the [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) for a complete list of available images. - -## -examples -The following example code uses the [BadgeNotification](badgenotification_badgenotification.md) method to create a numeric badge notification. - -```javascript - -var Notifications = Windows.UI.Notifications; - -var badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); -var badgeAttributes = badgeXml.getElementsByTagName("badge"); -badgeAttributes[0].setAttribute("value", "26"); - -// Create a badge notification from XML -var badgeNotification = new Notifications.badgeNotification(badgeXml); -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeNotification.BadgeNotification + +## -description +Creates and initializes a new instance of the [BadgeNotification](badgenotification.md). + +## -parameters +### -param content +The XML content that defines the badge update. + +## -remarks +The value attribute can be a number from 1-99 or a status glyph. See the [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) for a complete list of available images. + +## -examples +The following example code uses the [BadgeNotification](badgenotification_badgenotification.md) method to create a numeric badge notification. + +```javascript + +var Notifications = Windows.UI.Notifications; + +var badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); +var badgeAttributes = badgeXml.getElementsByTagName("badge"); +badgeAttributes[0].setAttribute("value", "26"); + +// Create a badge notification from XML +var badgeNotification = new Notifications.badgeNotification(badgeXml); +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/badgenotification_content.md b/windows.ui.notifications/badgenotification_content.md index 5e8546c06b..819bb2594c 100644 --- a/windows.ui.notifications/badgenotification_content.md +++ b/windows.ui.notifications/badgenotification_content.md @@ -1,24 +1,24 @@ ---- --api-id: P:Windows.UI.Notifications.BadgeNotification.Content --api-type: winrt property ---- - - - -# Windows.UI.Notifications.BadgeNotification.Content - -## -description -Gets the XML that defines the value or glyph used as the tile's badge. - -## -property-value -The object that contains the XML. - -## -remarks -The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions to customize the badge content. See [badge schema](XREF:TODO:badge.schema_root) for an explanation of badge elements and attributes. - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.BadgeNotification.Content +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.BadgeNotification.Content + +## -description +Gets the XML that defines the value or glyph used as the tile's badge. + +## -property-value +The object that contains the XML. + +## -remarks +The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions to customize the badge content. See [badge schema](XREF:TODO:badge.schema_root) for an explanation of badge elements and attributes. + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgenotification_expirationtime.md b/windows.ui.notifications/badgenotification_expirationtime.md index 5c15be52a8..f3beaf38d2 100644 --- a/windows.ui.notifications/badgenotification_expirationtime.md +++ b/windows.ui.notifications/badgenotification_expirationtime.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.Notifications.BadgeNotification.ExpirationTime --api-type: winrt property ---- - - - -# Windows.UI.Notifications.BadgeNotification.ExpirationTime - -## -description -Gets or sets the time that Windows will remove the badge from the tile. By default, local badge notifications do not expire and push, periodic, and scheduled badge notifications expire after three days. It is a best practice to explicitly set an expiration time to avoid stale content. - -## -property-value -The date and time that the notification should be removed. - -## -remarks - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.BadgeNotification.ExpirationTime +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.BadgeNotification.ExpirationTime + +## -description +Gets or sets the time that Windows will remove the badge from the tile. By default, local badge notifications do not expire and push, periodic, and scheduled badge notifications expire after three days. It is a best practice to explicitly set an expiration time to avoid stale content. + +## -property-value +The date and time that the notification should be removed. + +## -remarks + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgetemplatetype.md b/windows.ui.notifications/badgetemplatetype.md index e8cc6f0e66..2d83880e0e 100644 --- a/windows.ui.notifications/badgetemplatetype.md +++ b/windows.ui.notifications/badgetemplatetype.md @@ -25,4 +25,4 @@ A numerical value from 1 to 99. Values greater than 99 are accepted, but in thos ## -examples ## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdatemanager.md b/windows.ui.notifications/badgeupdatemanager.md index 51d0f6585e..432d4ba40d 100644 --- a/windows.ui.notifications/badgeupdatemanager.md +++ b/windows.ui.notifications/badgeupdatemanager.md @@ -40,4 +40,4 @@ function sendBadgeNotification() { ## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md b/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md index d38fea6493..d776c145f0 100644 --- a/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md +++ b/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md @@ -1,46 +1,46 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication - -## -description -Creates and initializes a new instance of the [BadgeUpdater](badgeupdater.md), which lets you change the appearance or content of the badge on the calling app's tile. - -## -returns -The object you will use to send changes to the app tile's badge. - -## -remarks - -## -examples -The following example shows [CreateBadgeUpdaterForApplication](badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md) used to send a numeric badge update to the calling app's tile. - -```javascript - -function sendBadgeNotification() { - var Notifications = Windows.UI.Notifications; - var badgeXml; - var badgeAttributes; - - // Get an XML DOM version of a specific template by using getTemplateContent. - badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); - badgeAttributes = badgeXml.getElementsByTagName("badge"); - badgeAttributes[0].setAttribute("value", "7"); - - // Create a badge notification from the XML content. - var badgeNotification = new Notifications.BadgeNotification(badgeXml); - - // Send the badge notification to the app's tile. - Notifications.BadgeUpdateManager.createBadgeUpdaterForApplication().update(badgeNotification); -} -``` - - - -## -see-also -[CreateBadgeUpdaterForApplication(String)](badgeupdatemanager_createbadgeupdaterforapplication_315230511.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication + +## -description +Creates and initializes a new instance of the [BadgeUpdater](badgeupdater.md), which lets you change the appearance or content of the badge on the calling app's tile. + +## -returns +The object you will use to send changes to the app tile's badge. + +## -remarks + +## -examples +The following example shows [CreateBadgeUpdaterForApplication](badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md) used to send a numeric badge update to the calling app's tile. + +```javascript + +function sendBadgeNotification() { + var Notifications = Windows.UI.Notifications; + var badgeXml; + var badgeAttributes; + + // Get an XML DOM version of a specific template by using getTemplateContent. + badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); + badgeAttributes = badgeXml.getElementsByTagName("badge"); + badgeAttributes[0].setAttribute("value", "7"); + + // Create a badge notification from the XML content. + var badgeNotification = new Notifications.BadgeNotification(badgeXml); + + // Send the badge notification to the app's tile. + Notifications.BadgeUpdateManager.createBadgeUpdaterForApplication().update(badgeNotification); +} +``` + + + +## -see-also +[CreateBadgeUpdaterForApplication(String)](badgeupdatemanager_createbadgeupdaterforapplication_315230511.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_315230511.md b/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_315230511.md index 601d3b0bfe..c1c72f9bf0 100644 --- a/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_315230511.md +++ b/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforapplication_315230511.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication(System.String) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication - -## -description -Creates and initializes a new instance of the [BadgeUpdater](badgeupdater.md) for a specified app tile's badge, usually the tile of another app in the package. The [BadgeUpdater](badgeupdater.md) lets you change the appearance or content of that badge. - -## -parameters -### -param applicationId -The unique ID of the tile whose badge you want to update. - -## -returns -The object you will use to send changes to the application tile's badge. - -## -remarks -The app identified by *applicationId* must belong to the same package as the caller. - -## -examples - -## -see-also -[CreateBadgeUpdaterForApplication](badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication + +## -description +Creates and initializes a new instance of the [BadgeUpdater](badgeupdater.md) for a specified app tile's badge, usually the tile of another app in the package. The [BadgeUpdater](badgeupdater.md) lets you change the appearance or content of that badge. + +## -parameters +### -param applicationId +The unique ID of the tile whose badge you want to update. + +## -returns +The object you will use to send changes to the application tile's badge. + +## -remarks +The app identified by *applicationId* must belong to the same package as the caller. + +## -examples + +## -see-also +[CreateBadgeUpdaterForApplication](badgeupdatemanager_createbadgeupdaterforapplication_1263267855.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforsecondarytile_131286133.md b/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforsecondarytile_131286133.md index 7036c8df80..3fda893941 100644 --- a/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforsecondarytile_131286133.md +++ b/windows.ui.notifications/badgeupdatemanager_createbadgeupdaterforsecondarytile_131286133.md @@ -1,49 +1,49 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForSecondaryTile(System.String) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForSecondaryTile - -## -description -Creates and initializes a new instance of the [BadgeUpdater](badgeupdater.md), which enables you to change the appearance or content of a badge on a [secondary tile](../windows.ui.startscreen/secondarytile.md). The tile can belong to the calling app or any other app in the same package. - -## -parameters -### -param tileId -The unique ID of the tile. - -## -returns -The object you will use to send badge updates to the tile identified by *tileID*. - -## -remarks - -## -examples -The following example demonstrates how to send a numeric badge notification to a secondary tile with an ID of "SecondaryTile.Dynamic". - -```javascript - -var Notifications = Windows.UI.Notifications; - -// Define the badge content -var badgeNotification = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); -var badgeAttributes = badgeNotification.getElementsByTagName("badge"); -badgeAttributes[0].setAttribute("value", "6"); - -// Create the notification based on the XML content. -var badge = new Notifications.BadgeNotification(badgeNotification); - -// Create a secondary tile updater, passing it the ID of the tile. -Notifications.BadgeUpdateManager.createBadgeUpdaterForSecondaryTile("SecondaryTile.Dynamic"); - -// Send the notification to the secondary tile. -tileUpdater.update(tileNotification); -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForSecondaryTile(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForSecondaryTile + +## -description +Creates and initializes a new instance of the [BadgeUpdater](badgeupdater.md), which enables you to change the appearance or content of a badge on a [secondary tile](../windows.ui.startscreen/secondarytile.md). The tile can belong to the calling app or any other app in the same package. + +## -parameters +### -param tileId +The unique ID of the tile. + +## -returns +The object you will use to send badge updates to the tile identified by *tileID*. + +## -remarks + +## -examples +The following example demonstrates how to send a numeric badge notification to a secondary tile with an ID of "SecondaryTile.Dynamic". + +```javascript + +var Notifications = Windows.UI.Notifications; + +// Define the badge content +var badgeNotification = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); +var badgeAttributes = badgeNotification.getElementsByTagName("badge"); +badgeAttributes[0].setAttribute("value", "6"); + +// Create the notification based on the XML content. +var badge = new Notifications.BadgeNotification(badgeNotification); + +// Create a secondary tile updater, passing it the ID of the tile. +Notifications.BadgeUpdateManager.createBadgeUpdaterForSecondaryTile("SecondaryTile.Dynamic"); + +// Send the notification to the secondary tile. +tileUpdater.update(tileNotification); +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdatemanager_getforuser_2058550280.md b/windows.ui.notifications/badgeupdatemanager_getforuser_2058550280.md new file mode 100644 index 0000000000..4e6788faff --- /dev/null +++ b/windows.ui.notifications/badgeupdatemanager_getforuser_2058550280.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdateManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdateManager.GetForUser + +## -description +Creates and initializes a new instance of the [BadgeUpdateManagerForUser](badgeupdatemanagerforuser.md) for a specific user, which lets you change the appearance or content of the badge on a tile for a specific user. + +## -parameters + +### -param user +The user who will recieve the tile badge updates. + +## -returns +An object that will update tile badges for the specified user. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/badgeupdatemanager_gettemplatecontent_2049200015.md b/windows.ui.notifications/badgeupdatemanager_gettemplatecontent_2049200015.md index f46efc6f18..d4ac48166f 100644 --- a/windows.ui.notifications/badgeupdatemanager_gettemplatecontent_2049200015.md +++ b/windows.ui.notifications/badgeupdatemanager_gettemplatecontent_2049200015.md @@ -1,42 +1,42 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdateManager.GetTemplateContent(Windows.UI.Notifications.BadgeTemplateType) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdateManager.GetTemplateContent - -## -description -Gets the XML content of one of the predefined badge templates so that you can customize it for a badge update. - -## -parameters -### -param type -The type of badge template, either a glyph or a number. - -## -returns -The object that contains the template XML. - -## -remarks -Instead of creating the full XML payload yourself, you can get the default template and then use Document Object Model (DOM) manipulation functions to customize the part of the content that you want to change. You package this XML in a [BadgeNotification](badgenotification.md) and send it to the tile through the [BadgeUpdater](badgeupdater.md) that you create through the other methods of this class. - -See [badge schema](XREF:TODO:badge.schema_root) for an explanation of badge elements and attributes. - -## -examples -The following example shows the use of [GetTemplateContent](badgeupdatemanager_gettemplatecontent.md) to get the content for a numeric badge. - -```javascript - -var Notifications = Windows.UI.Notifications; - -var badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); -var badgeAttributes = badgeXml.getElementsByTagName("badge"); -badgeAttributes[0].setAttribute("value", "7"); -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdateManager.GetTemplateContent(Windows.UI.Notifications.BadgeTemplateType) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdateManager.GetTemplateContent + +## -description +Gets the XML content of one of the predefined badge templates so that you can customize it for a badge update. + +## -parameters +### -param type +The type of badge template, either a glyph or a number. + +## -returns +The object that contains the template XML. + +## -remarks +Instead of creating the full XML payload yourself, you can get the default template and then use Document Object Model (DOM) manipulation functions to customize the part of the content that you want to change. You package this XML in a [BadgeNotification](badgenotification.md) and send it to the tile through the [BadgeUpdater](badgeupdater.md) that you create through the other methods of this class. + +See [badge schema](XREF:TODO:badge.schema_root) for an explanation of badge elements and attributes. + +## -examples +The following example shows the use of [GetTemplateContent](badgeupdatemanager_gettemplatecontent.md) to get the content for a numeric badge. + +```javascript + +var Notifications = Windows.UI.Notifications; + +var badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); +var badgeAttributes = badgeXml.getElementsByTagName("badge"); +badgeAttributes[0].setAttribute("value", "7"); +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdater.md b/windows.ui.notifications/badgeupdater.md index c7199d6955..e991eb8f34 100644 --- a/windows.ui.notifications/badgeupdater.md +++ b/windows.ui.notifications/badgeupdater.md @@ -43,4 +43,4 @@ function sendBadgeNotification() { ## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdater_clear_556466.md b/windows.ui.notifications/badgeupdater_clear_556466.md index 55dd75fd75..6384851d63 100644 --- a/windows.ui.notifications/badgeupdater_clear_556466.md +++ b/windows.ui.notifications/badgeupdater_clear_556466.md @@ -1,24 +1,24 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdater.Clear --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdater.Clear - -## -description -Removes the badge from the tile that the updater is bound to. - -## -remarks -The badge can also be cleared by setting the badge value to "0" or "none". - -> [!NOTE] -> If your badge is using periodic updates, you must also call [StopPeriodicUpdate](badgeupdater_stopperiodicupdate.md) or the badge will reappear at the next polling interval. - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdater.Clear +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdater.Clear + +## -description +Removes the badge from the tile that the updater is bound to. + +## -remarks +The badge can also be cleared by setting the badge value to "0" or "none". + +> [!NOTE] +> If your badge is using periodic updates, you must also call [StopPeriodicUpdate](badgeupdater_stopperiodicupdate.md) or the badge will reappear at the next polling interval. + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdater_startperiodicupdate_1369986471.md b/windows.ui.notifications/badgeupdater_startperiodicupdate_1369986471.md index 3450a5efb1..24f79c1e57 100644 --- a/windows.ui.notifications/badgeupdater_startperiodicupdate_1369986471.md +++ b/windows.ui.notifications/badgeupdater_startperiodicupdate_1369986471.md @@ -1,31 +1,31 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.Foundation.DateTime,Windows.UI.Notifications.PeriodicUpdateRecurrence) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate - -## -description -Begins a series of timed updates for the badge from a web resource that the updater is bound to. Updates begin at a specified time. Note that only web resources (http/https) are allowed in a periodic update. - - -## -parameters -### -param badgeContent -The Uniform Resource Identifier (URI) from which the XML content of the badge update will be retrieved. - -### -param startTime -The time at which the Uniform Resource Identifier (URI) should first be polled for new badge content. - -### -param requestedInterval -The frequency with which the Uniform Resource Identifier (URI) is polled for new badge content, following the initial update at *startTime*. - -## -remarks - -## -examples - -## -see-also -[StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence)](badgeupdater_startperiodicupdate_1967457783.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.Foundation.DateTime,Windows.UI.Notifications.PeriodicUpdateRecurrence) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate + +## -description +Begins a series of timed updates for the badge from a web resource that the updater is bound to. Updates begin at a specified time. Note that only web resources (http/https) are allowed in a periodic update. + + +## -parameters +### -param badgeContent +The Uniform Resource Identifier (URI) from which the XML content of the badge update will be retrieved. + +### -param startTime +The time at which the Uniform Resource Identifier (URI) should first be polled for new badge content. + +### -param requestedInterval +The frequency with which the Uniform Resource Identifier (URI) is polled for new badge content, following the initial update at *startTime*. + +## -remarks + +## -examples + +## -see-also +[StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence)](badgeupdater_startperiodicupdate_1967457783.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdater_startperiodicupdate_1967457783.md b/windows.ui.notifications/badgeupdater_startperiodicupdate_1967457783.md index 6137e3b425..a1c9c3008d 100644 --- a/windows.ui.notifications/badgeupdater_startperiodicupdate_1967457783.md +++ b/windows.ui.notifications/badgeupdater_startperiodicupdate_1967457783.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.UI.Notifications.PeriodicUpdateRecurrence) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate - -## -description -Begins a series of timed updates for the badge from a web resource that the updater is bound to, beginning immediately. Note that only web resources (http/https) are allowed in a periodic update. - -## -parameters -### -param badgeContent -The Uniform Resource Identifier (URI) from which the XML content of the badge update will be retrieved. - -### -param requestedInterval -The frequency with which the Uniform Resource Identifier (URI) is polled for new badge content. - -## -remarks - -## -examples - -## -see-also -[StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)](badgeupdater_startperiodicupdate_1369986471.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.UI.Notifications.PeriodicUpdateRecurrence) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdater.StartPeriodicUpdate + +## -description +Begins a series of timed updates for the badge from a web resource that the updater is bound to, beginning immediately. Note that only web resources (http/https) are allowed in a periodic update. + +## -parameters +### -param badgeContent +The Uniform Resource Identifier (URI) from which the XML content of the badge update will be retrieved. + +### -param requestedInterval +The frequency with which the Uniform Resource Identifier (URI) is polled for new badge content. + +## -remarks + +## -examples + +## -see-also +[StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)](badgeupdater_startperiodicupdate_1369986471.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdater_stopperiodicupdate_376301793.md b/windows.ui.notifications/badgeupdater_stopperiodicupdate_376301793.md index a949c69c40..b6a54f9b9b 100644 --- a/windows.ui.notifications/badgeupdater_stopperiodicupdate_376301793.md +++ b/windows.ui.notifications/badgeupdater_stopperiodicupdate_376301793.md @@ -1,20 +1,20 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdater.StopPeriodicUpdate --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdater.StopPeriodicUpdate - -## -description -Cancels the current series of timed updates for the badge that the updater is bound to. - -## -remarks - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdater.StopPeriodicUpdate +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdater.StopPeriodicUpdate + +## -description +Cancels the current series of timed updates for the badge that the updater is bound to. + +## -remarks + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/badgeupdater_update_1826834066.md b/windows.ui.notifications/badgeupdater_update_1826834066.md index cb020f8021..2130e64c3e 100644 --- a/windows.ui.notifications/badgeupdater_update_1826834066.md +++ b/windows.ui.notifications/badgeupdater_update_1826834066.md @@ -1,47 +1,47 @@ ---- --api-id: M:Windows.UI.Notifications.BadgeUpdater.Update(Windows.UI.Notifications.BadgeNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.BadgeUpdater.Update - -## -description -Applies a change to the badge's glyph or number. - -## -parameters -### -param notification -The object that supplies the new XML definition for the badge. - -## -remarks - -## -examples -The following example shows the use of [Update](badgeupdater_update.md) to send a numeric badge update to the calling app's tile. - -```javascript - -function sendBadgeNotification() { - var Notifications = Windows.UI.Notifications; - var badgeXml; - var badgeAttributes; - - // Get an XML DOM version of a specific template by using getTemplateContent. - badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); - badgeAttributes = badgeXml.getElementsByTagName("badge"); - badgeAttributes[0].setAttribute("value", "7"); - - // Create a badge notification from the XML content. - var badgeNotification = new Notifications.BadgeNotification(badgeXml); - - // Send the badge notification to the app's tile. - Notifications.BadgeUpdateManager.createBadgeUpdaterForApplication().update(badgeNotification); -} -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](XREF:TODO:m_ui_tiles.howto_clear_a_badge), [How to send a glyph or numeric badge in a local notification](XREF:TODO:m_ui_tiles.howto_send_local_badge_notifications), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [How to update a badge through push notifications](XREF:TODO:m_ui_tiles.howto_update_badges_push), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.BadgeUpdater.Update(Windows.UI.Notifications.BadgeNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.BadgeUpdater.Update + +## -description +Applies a change to the badge's glyph or number. + +## -parameters +### -param notification +The object that supplies the new XML definition for the badge. + +## -remarks + +## -examples +The following example shows the use of [Update](badgeupdater_update.md) to send a numeric badge update to the calling app's tile. + +```javascript + +function sendBadgeNotification() { + var Notifications = Windows.UI.Notifications; + var badgeXml; + var badgeAttributes; + + // Get an XML DOM version of a specific template by using getTemplateContent. + badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber); + badgeAttributes = badgeXml.getElementsByTagName("badge"); + badgeAttributes[0].setAttribute("value", "7"); + + // Create a badge notification from the XML content. + var badgeNotification = new Notifications.BadgeNotification(badgeXml); + + // Send the badge notification to the app's tile. + Notifications.BadgeUpdateManager.createBadgeUpdaterForApplication().update(badgeNotification); +} +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to clear a badge](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to send a glyph or numeric badge in a local notification](http://msdn.microsoft.com/library/6b2d57e0-51aa-4bce-894e-fa3fd32d77bb), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to update a badge through push notifications](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Badge XML schema](XREF:TODO:badge.Schema_Root), [Badge overview](http://msdn.microsoft.com/library/a64c58bb-d9c9-4c09-a685-4df94fa7dfdd) \ No newline at end of file diff --git a/windows.ui.notifications/notificationdata.md b/windows.ui.notifications/notificationdata.md new file mode 100644 index 0000000000..37f687e23a --- /dev/null +++ b/windows.ui.notifications/notificationdata.md @@ -0,0 +1,21 @@ +--- +-api-id: T:Windows.UI.Notifications.NotificationData +-api-type: winrt class +--- + + + +# Windows.UI.Notifications.NotificationData + +## -description +Stores data for display in a [toast notification](toastnotification.md). + +## -remarks + +## -see-also +[ToastNotification.Data](toastnotification_data.md) + +## -examples + diff --git a/windows.ui.notifications/notificationdata_notificationdata_1221375020.md b/windows.ui.notifications/notificationdata_notificationdata_1221375020.md new file mode 100644 index 0000000000..1c03c60fba --- /dev/null +++ b/windows.ui.notifications/notificationdata_notificationdata_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Notifications.NotificationData.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.NotificationData.NotificationData + +## -description + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/notificationdata_notificationdata_421378091.md b/windows.ui.notifications/notificationdata_notificationdata_421378091.md new file mode 100644 index 0000000000..df23421cdf --- /dev/null +++ b/windows.ui.notifications/notificationdata_notificationdata_421378091.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.NotificationData.#ctor(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}},System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.NotificationData.NotificationData + +## -description + +## -parameters + +### -param initialValues + +### -param sequenceNumber + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/notificationdata_notificationdata_518694361.md b/windows.ui.notifications/notificationdata_notificationdata_518694361.md new file mode 100644 index 0000000000..c8b267ba30 --- /dev/null +++ b/windows.ui.notifications/notificationdata_notificationdata_518694361.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Notifications.NotificationData.#ctor(Windows.Foundation.Collections.IIterable{Windows.Foundation.Collections.IKeyValuePair{System.String,System.String}}) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.NotificationData.NotificationData + +## -description + +## -parameters + +### -param initialValues + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/notificationdata_sequencenumber.md b/windows.ui.notifications/notificationdata_sequencenumber.md new file mode 100644 index 0000000000..e1708a50db --- /dev/null +++ b/windows.ui.notifications/notificationdata_sequencenumber.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.NotificationData.SequenceNumber +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.NotificationData.SequenceNumber + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/notificationdata_values.md b/windows.ui.notifications/notificationdata_values.md new file mode 100644 index 0000000000..f937de4462 --- /dev/null +++ b/windows.ui.notifications/notificationdata_values.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.NotificationData.Values +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.NotificationData.Values + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/notificationupdateresult.md b/windows.ui.notifications/notificationupdateresult.md new file mode 100644 index 0000000000..b334f64766 --- /dev/null +++ b/windows.ui.notifications/notificationupdateresult.md @@ -0,0 +1,26 @@ +--- +-api-id: T:Windows.UI.Notifications.NotificationUpdateResult +-api-type: winrt enum +--- + + + +# Windows.UI.Notifications.NotificationUpdateResult + +## -description + +## -enum-fields +### -field NotificationNotFound:2 + +### -field Failed:1 + +### -field Succeeded:0 + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/periodicupdaterecurrence.md b/windows.ui.notifications/periodicupdaterecurrence.md index b41134ca7d..e1cc2d158e 100644 --- a/windows.ui.notifications/periodicupdaterecurrence.md +++ b/windows.ui.notifications/periodicupdaterecurrence.md @@ -37,4 +37,4 @@ Windows can delay the polling of your URL by up to 15 minutes if necessary to op ## -examples ## -see-also -[BadgeUpdater.startPeriodicUpdate](badgeupdater_startperiodicupdate.md), [TileUpdater.startPeriodicUpdate](tileupdater_startperiodicupdate.md), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [How to set up periodic notifications for badges](XREF:TODO:m_ui_tiles.howto_setup_badge_polling), [Choose a notification delivery method](http://msdn.microsoft.com/library/fdb43ede-c5f2-493f-952c-55401ec5172b) \ No newline at end of file +[BadgeUpdater.startPeriodicUpdate](badgeupdater_startperiodicupdate.md), [TileUpdater.startPeriodicUpdate](tileupdater_startperiodicupdate.md), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [How to set up periodic notifications for badges](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Choose a notification delivery method](http://msdn.microsoft.com/library/fdb43ede-c5f2-493f-952c-55401ec5172b) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtilenotification.md b/windows.ui.notifications/scheduledtilenotification.md index 01e643500d..aeaeb2b1b0 100644 --- a/windows.ui.notifications/scheduledtilenotification.md +++ b/windows.ui.notifications/scheduledtilenotification.md @@ -52,4 +52,4 @@ Notifications.TileUpdateManager.createTileUpdaterForApplication().addToSchedule( ## -see-also -[ScheduledTileNotification](scheduledtilenotification.md), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Tile schema](XREF:TODO:tile.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +[ScheduledTileNotification](scheduledtilenotification.md), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Tile schema](XREF:TODO:tile.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtilenotification_content.md b/windows.ui.notifications/scheduledtilenotification_content.md index 9f24d4e82c..89c53aca80 100644 --- a/windows.ui.notifications/scheduledtilenotification_content.md +++ b/windows.ui.notifications/scheduledtilenotification_content.md @@ -1,29 +1,29 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledTileNotification.Content --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledTileNotification.Content - -## -description -Gets the XML description of the content of the scheduled tile update. - -## -property-value -The object that contains the notification content. - -## -remarks -This information is set when the [ScheduledTileNotification](scheduledtilenotification.md) is created. - -The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions. See [Tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes found in the XML document. - - - - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Tile schema](XREF:TODO:tile.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledTileNotification.Content +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledTileNotification.Content + +## -description +Gets the XML description of the content of the scheduled tile update. + +## -property-value +The object that contains the notification content. + +## -remarks +This information is set when the [ScheduledTileNotification](scheduledtilenotification.md) is created. + +The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions. See [Tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes found in the XML document. + + + + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Tile schema](XREF:TODO:tile.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtilenotification_deliverytime.md b/windows.ui.notifications/scheduledtilenotification_deliverytime.md index 3445ff78fb..a674386aae 100644 --- a/windows.ui.notifications/scheduledtilenotification_deliverytime.md +++ b/windows.ui.notifications/scheduledtilenotification_deliverytime.md @@ -1,24 +1,24 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledTileNotification.DeliveryTime --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledTileNotification.DeliveryTime - -## -description -Gets the time at which the tile is scheduled to be updated. - -## -property-value -The date and time that the notification will be updated. - -## -remarks -This value is set when the [ScheduledTileNotification](scheduledtilenotification.md) is created. For the tile to be updated at the specified time, the notification must be added to the schedule through the [TileUpdater.addToSchedule](tileupdater_addtoschedule.md) method. - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledTileNotification.DeliveryTime +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledTileNotification.DeliveryTime + +## -description +Gets the time at which the tile is scheduled to be updated. + +## -property-value +The date and time that the notification will be updated. + +## -remarks +This value is set when the [ScheduledTileNotification](scheduledtilenotification.md) is created. For the tile to be updated at the specified time, the notification must be added to the schedule through the [TileUpdater.addToSchedule](tileupdater_addtoschedule.md) method. + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtilenotification_expirationtime.md b/windows.ui.notifications/scheduledtilenotification_expirationtime.md index 44a5ff169d..73e9d6e80f 100644 --- a/windows.ui.notifications/scheduledtilenotification_expirationtime.md +++ b/windows.ui.notifications/scheduledtilenotification_expirationtime.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledTileNotification.ExpirationTime --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledTileNotification.ExpirationTime - -## -description -Gets or sets the time after which the tile notification should no longer be shown. By default, a tile notification does not expire. It is a best practice to explicitly set an expiration time to avoid stale content. - -## -property-value -The time after which the tile update should no longer be shown. - -## -remarks - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledTileNotification.ExpirationTime +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledTileNotification.ExpirationTime + +## -description +Gets or sets the time after which the tile notification should no longer be shown. By default, a tile notification does not expire. It is a best practice to explicitly set an expiration time to avoid stale content. + +## -property-value +The time after which the tile update should no longer be shown. + +## -remarks + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtilenotification_scheduledtilenotification_1677895932.md b/windows.ui.notifications/scheduledtilenotification_scheduledtilenotification_1677895932.md index 373b80d21c..6c7290c89a 100644 --- a/windows.ui.notifications/scheduledtilenotification_scheduledtilenotification_1677895932.md +++ b/windows.ui.notifications/scheduledtilenotification_scheduledtilenotification_1677895932.md @@ -1,62 +1,62 @@ ---- --api-id: M:Windows.UI.Notifications.ScheduledTileNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument,Windows.Foundation.DateTime) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ScheduledTileNotification.ScheduledTileNotification - -## -description -Creates and initializes a new instance of the [ScheduledTileNotification](scheduledtilenotification.md) object for use with a [TileUpdater](tileupdater.md). - -## -parameters -### -param content -The object that provides the content for the tile notification. - -### -param deliveryTime -The time at which the tile should be updated with the notification information. - -## -remarks - -## -examples -The following example, which shows a tile scheduled to display in one hour, includes the use of the [ScheduledTileNotification](scheduledtilenotification_scheduledtilenotification.md) constructor to create the notification object. - -```javascript - -var Notifications = Windows.UI.Notifications; -var currentTime = new Date(); -var seconds = 60; -var dueTime = new Date(currentTime.getTime() + seconds * 60 * 1000); -var idNumber = 123456789; - -var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text09); - -// Set up the wide tile text. -var tileTextAttributes = tileXml.getElementsByTagName("text"); -tileTextAttributes[0].appendChild(tileXml.createTextNode("This is a scheduled notification")); -tileTextAttributes[1].appendChild(tileXml.createTextNode("Received: " + dueTime.toLocaleTimeString())); - -// Set up the medium tile text. -var squareTileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileSquare150x150Text04); -var squareTileTextAttributes = squareTileXml.getElementsByTagName("text"); -squareTileTextAttributes[0].appendChild(squareTileXml.createTextNode("This is a scheduled notification")); - -// Include the medium tile in the notification. -var node = tileXml.importNode(squareTileXml.getElementsByTagName("binding").item(0), true); -tileXml.getElementsByTagName("visual").item(0).appendChild(node); - -// Create the notification object. -var futureTile = new Notifications.ScheduledTileNotification(tileXml, dueTime); -futureTile.id = "Tile" + idNumber; - -// Add to the schedule. -Notifications.TileUpdateManager.createTileUpdaterForApplication().addToSchedule(futureTile); -``` - - - -## -see-also -[Tile schema](XREF:TODO:tile.Schema_Root), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ScheduledTileNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ScheduledTileNotification.ScheduledTileNotification + +## -description +Creates and initializes a new instance of the [ScheduledTileNotification](scheduledtilenotification.md) object for use with a [TileUpdater](tileupdater.md). + +## -parameters +### -param content +The object that provides the content for the tile notification. + +### -param deliveryTime +The time at which the tile should be updated with the notification information. + +## -remarks + +## -examples +The following example, which shows a tile scheduled to display in one hour, includes the use of the [ScheduledTileNotification](scheduledtilenotification_scheduledtilenotification.md) constructor to create the notification object. + +```javascript + +var Notifications = Windows.UI.Notifications; +var currentTime = new Date(); +var seconds = 60; +var dueTime = new Date(currentTime.getTime() + seconds * 60 * 1000); +var idNumber = 123456789; + +var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text09); + +// Set up the wide tile text. +var tileTextAttributes = tileXml.getElementsByTagName("text"); +tileTextAttributes[0].appendChild(tileXml.createTextNode("This is a scheduled notification")); +tileTextAttributes[1].appendChild(tileXml.createTextNode("Received: " + dueTime.toLocaleTimeString())); + +// Set up the medium tile text. +var squareTileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileSquare150x150Text04); +var squareTileTextAttributes = squareTileXml.getElementsByTagName("text"); +squareTileTextAttributes[0].appendChild(squareTileXml.createTextNode("This is a scheduled notification")); + +// Include the medium tile in the notification. +var node = tileXml.importNode(squareTileXml.getElementsByTagName("binding").item(0), true); +tileXml.getElementsByTagName("visual").item(0).appendChild(node); + +// Create the notification object. +var futureTile = new Notifications.ScheduledTileNotification(tileXml, dueTime); +futureTile.id = "Tile" + idNumber; + +// Add to the schedule. +Notifications.TileUpdateManager.createTileUpdaterForApplication().addToSchedule(futureTile); +``` + + + +## -see-also +[Tile schema](XREF:TODO:tile.Schema_Root), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtilenotification_tag.md b/windows.ui.notifications/scheduledtilenotification_tag.md index 28cf257b60..642805f5cb 100644 --- a/windows.ui.notifications/scheduledtilenotification_tag.md +++ b/windows.ui.notifications/scheduledtilenotification_tag.md @@ -1,28 +1,28 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledTileNotification.Tag --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledTileNotification.Tag - -## -description -Gets or sets a string that Windows can use to prevent duplicate notification content from appearing in the queue. - -## -property-value -A string of 16 characters or less (plus a terminating null character) that identifies the notification in the stack. While there is no set form for the string content, we recommend that it should relate to the content of the notification. - -## -remarks -[ScheduledTileNotification.tag](scheduledtilenotification_tag.md) and [ScheduledTileNotification.id](scheduledtilenotification_id.md) serve similar purposes: -+ The [ScheduledTileNotification.tag](scheduledtilenotification_tag.md) property is used by Windows to prevent duplicate notification content from appearing in the queue at the same time. It allows the notification to be updated in-place in the queue to prevent it from containing out-of-date information. -+ The [ScheduledTileNotification.id](scheduledtilenotification_id.md) property identifies the notification in the schedule. This allows the notification to be identified or removed from the schedule. - - - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledTileNotification.Tag +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledTileNotification.Tag + +## -description +Gets or sets a string that Windows can use to prevent duplicate notification content from appearing in the queue. + +## -property-value +A string of 16 characters or less (plus a terminating null character) that identifies the notification in the stack. While there is no set form for the string content, we recommend that it should relate to the content of the notification. + +## -remarks +[ScheduledTileNotification.tag](scheduledtilenotification_tag.md) and [ScheduledTileNotification.id](scheduledtilenotification_id.md) serve similar purposes: ++ The [ScheduledTileNotification.tag](scheduledtilenotification_tag.md) property is used by Windows to prevent duplicate notification content from appearing in the queue at the same time. It allows the notification to be updated in-place in the queue to prevent it from containing out-of-date information. ++ The [ScheduledTileNotification.id](scheduledtilenotification_id.md) property identifies the notification in the schedule. This allows the notification to be identified or removed from the schedule. + + + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification.md b/windows.ui.notifications/scheduledtoastnotification.md index 4f8458dd6c..ab7d8fddd7 100644 --- a/windows.ui.notifications/scheduledtoastnotification.md +++ b/windows.ui.notifications/scheduledtoastnotification.md @@ -43,4 +43,4 @@ Notifications.ToastNotificationManager.createToastNotifier().addToSchedule(toast ## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification_content.md b/windows.ui.notifications/scheduledtoastnotification_content.md index 35ad1fb136..56801b3522 100644 --- a/windows.ui.notifications/scheduledtoastnotification_content.md +++ b/windows.ui.notifications/scheduledtoastnotification_content.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledToastNotification.Content --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledToastNotification.Content - -## -description -Gets the XML that defines this scheduled toast notification. - -## -property-value -The object that contains the XML. - -## -remarks - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledToastNotification.Content +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledToastNotification.Content + +## -description +Gets the XML that defines this scheduled toast notification. + +## -property-value +The object that contains the XML. + +## -remarks + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification_deliverytime.md b/windows.ui.notifications/scheduledtoastnotification_deliverytime.md index 247a60312e..11f735e830 100644 --- a/windows.ui.notifications/scheduledtoastnotification_deliverytime.md +++ b/windows.ui.notifications/scheduledtoastnotification_deliverytime.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledToastNotification.DeliveryTime --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledToastNotification.DeliveryTime - -## -description -Gets the time that this toast notification is scheduled to be displayed. - -## -property-value -The time that this toast notification is scheduled to be displayed. - -## -remarks - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledToastNotification.DeliveryTime +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledToastNotification.DeliveryTime + +## -description +Gets the time that this toast notification is scheduled to be displayed. + +## -property-value +The time that this toast notification is scheduled to be displayed. + +## -remarks + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification_id.md b/windows.ui.notifications/scheduledtoastnotification_id.md index ac1ff2573f..1fbef9beee 100644 --- a/windows.ui.notifications/scheduledtoastnotification_id.md +++ b/windows.ui.notifications/scheduledtoastnotification_id.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledToastNotification.Id --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledToastNotification.Id - -## -description -Gets a developer-specified value used to identify a specific scheduled toast. - -## -property-value -The identifier. This string is limited to 16 characters. - -## -remarks - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledToastNotification.Id +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledToastNotification.Id + +## -description +Gets a developer-specified value used to identify a specific scheduled toast. + +## -property-value +The identifier. This string is limited to 16 characters. + +## -remarks + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification_maximumsnoozecount.md b/windows.ui.notifications/scheduledtoastnotification_maximumsnoozecount.md index 6d1e6ebf49..bd570dcddb 100644 --- a/windows.ui.notifications/scheduledtoastnotification_maximumsnoozecount.md +++ b/windows.ui.notifications/scheduledtoastnotification_maximumsnoozecount.md @@ -1,24 +1,24 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledToastNotification.MaximumSnoozeCount --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledToastNotification.MaximumSnoozeCount - -## -description -Gets the maximum number of times to display this notification. - -## -property-value -The maximum number of times to display this notification. This will be a value between 1 and 5, inclusive. - -## -remarks -Note that this is the number of repeat showings specified when the [ScheduledToastNotification](scheduledtoastnotification.md) is created. It is not the number of showings remaining if the toast has already been shown. There is no method to directly retrieve that information. - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledToastNotification.MaximumSnoozeCount +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledToastNotification.MaximumSnoozeCount + +## -description +Gets the maximum number of times to display this notification. + +## -property-value +The maximum number of times to display this notification. This will be a value between 1 and 5, inclusive. + +## -remarks +Note that this is the number of repeat showings specified when the [ScheduledToastNotification](scheduledtoastnotification.md) is created. It is not the number of showings remaining if the toast has already been shown. There is no method to directly retrieve that information. + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1365784316.md b/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1365784316.md index decee1beb6..8d91766a9d 100644 --- a/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1365784316.md +++ b/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1365784316.md @@ -1,74 +1,74 @@ ---- --api-id: M:Windows.UI.Notifications.ScheduledToastNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,System.UInt32) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ScheduledToastNotification.ScheduledToastNotification - -## -description -Creates and initializes a new instance of a recurring [ScheduledToastNotification](scheduledtoastnotification.md). - -## -parameters -### -param content -The XML that defines the toast notification content. - -### -param deliveryTime -The date and time that Windows should first display the toast notification. You must call [AddToSchedule](toastnotifier_addtoschedule.md) before this time. - -### -param snoozeInterval -The amount of time between occurrences of the notification. To be valid, this value must be no less than 60 seconds and no more than 60 minutes. - -### -param maximumSnoozeCount -The maximum number of times to display this notification. Valid values range from 1 to 5. - -## -remarks -This type of recurring scheduled toast notification is good for a snooze alarm-like functionality. For instance, the notification could be displayed every five minutes until the maximum snooze count is reached, unless the notification is explicitly removed from the schedule in response to a user action. - - - -> [!IMPORTANT] -> The sender is responsible for removing the notification from the schedule once the user activates the notification through a touch or click. Failure to do so can see the notification recurring until the maximum snooze count is reached, even if the user has already dealt with it. - -If you want to schedule long recurrence intervals like months or years, we recommend that you use individual scheduled toasts rather than this method. That will avoid timing errors caused by daylight savings time or leap years. - -The following code shows a call to this method that displays a toast beginning at *myData* every five minutes for a maximum of three times. - -```javascript -new ScheduledToastNotification(toast1, myDate, 60000, 3) -``` - - - -## -examples -The following example shows a toast notification scheduled to display in one hour, including the use of this constructor to create the notification, specifying a snooze interval of 60 seconds and a maximum of five times to show the notification. - -```javascript - -var Notifications = Windows.UI.Notifications; -var currentTime = new Date(); -var seconds = 60; -var dueTime = new Date(currentTime.getTime() + seconds * 60 * 1000); -var idNumber = Math.floor(Math.random() * 100000000); // Generates a unique ID number for the notification. - -// Set up the notification text. -var toastXml = Notifications.ToastNotificationManager.getTemplateContent(Notifications.ToastTemplateType.toastText02); -var strings = toastXml.getElementsByTagName("text"); -strings[0].appendChild(toastXml.createTextNode(This is a scheduled toast notification)); -strings[1].appendChild(toastXml.createTextNode("Received: " + dueTime.toLocaleTimeString())); - -// Create the toast notification object. -var toast = new Notifications.ScheduledToastNotification(toastXml, dueTime, 60 * 1000, 5); -toast.id = "Toast" + idNumber; - -// Add to the schedule. -Notifications.ToastNotificationManager.createToastNotifier().addToSchedule(toast); -``` - - - -## -see-also -[ScheduledToastNotification(XmlDocument, DateTime)](scheduledtoastnotification_scheduledtoastnotification_1677895932.md), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ScheduledToastNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument,Windows.Foundation.DateTime,Windows.Foundation.TimeSpan,System.UInt32) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ScheduledToastNotification.ScheduledToastNotification + +## -description +Creates and initializes a new instance of a recurring [ScheduledToastNotification](scheduledtoastnotification.md). + +## -parameters +### -param content +The XML that defines the toast notification content. + +### -param deliveryTime +The date and time that Windows should first display the toast notification. You must call [AddToSchedule](toastnotifier_addtoschedule.md) before this time. + +### -param snoozeInterval +The amount of time between occurrences of the notification. To be valid, this value must be no less than 60 seconds and no more than 60 minutes. + +### -param maximumSnoozeCount +The maximum number of times to display this notification. Valid values range from 1 to 5. + +## -remarks +This type of recurring scheduled toast notification is good for a snooze alarm-like functionality. For instance, the notification could be displayed every five minutes until the maximum snooze count is reached, unless the notification is explicitly removed from the schedule in response to a user action. + + + +> [!IMPORTANT] +> The sender is responsible for removing the notification from the schedule once the user activates the notification through a touch or click. Failure to do so can see the notification recurring until the maximum snooze count is reached, even if the user has already dealt with it. + +If you want to schedule long recurrence intervals like months or years, we recommend that you use individual scheduled toasts rather than this method. That will avoid timing errors caused by daylight savings time or leap years. + +The following code shows a call to this method that displays a toast beginning at *myData* every five minutes for a maximum of three times. + +```javascript +new ScheduledToastNotification(toast1, myDate, 60000, 3) +``` + + + +## -examples +The following example shows a toast notification scheduled to display in one hour, including the use of this constructor to create the notification, specifying a snooze interval of 60 seconds and a maximum of five times to show the notification. + +```javascript + +var Notifications = Windows.UI.Notifications; +var currentTime = new Date(); +var seconds = 60; +var dueTime = new Date(currentTime.getTime() + seconds * 60 * 1000); +var idNumber = Math.floor(Math.random() * 100000000); // Generates a unique ID number for the notification. + +// Set up the notification text. +var toastXml = Notifications.ToastNotificationManager.getTemplateContent(Notifications.ToastTemplateType.toastText02); +var strings = toastXml.getElementsByTagName("text"); +strings[0].appendChild(toastXml.createTextNode(This is a scheduled toast notification)); +strings[1].appendChild(toastXml.createTextNode("Received: " + dueTime.toLocaleTimeString())); + +// Create the toast notification object. +var toast = new Notifications.ScheduledToastNotification(toastXml, dueTime, 60 * 1000, 5); +toast.id = "Toast" + idNumber; + +// Add to the schedule. +Notifications.ToastNotificationManager.createToastNotifier().addToSchedule(toast); +``` + + + +## -see-also +[ScheduledToastNotification(XmlDocument, DateTime)](scheduledtoastnotification_scheduledtoastnotification_1677895932.md), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1677895932.md b/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1677895932.md index 6fd1d40dac..28ae3d63fb 100644 --- a/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1677895932.md +++ b/windows.ui.notifications/scheduledtoastnotification_scheduledtoastnotification_1677895932.md @@ -1,52 +1,52 @@ ---- --api-id: M:Windows.UI.Notifications.ScheduledToastNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument,Windows.Foundation.DateTime) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ScheduledToastNotification.ScheduledToastNotification - -## -description -Creates and initializes a new instance of a [ScheduledToastNotification](scheduledtoastnotification.md) that will be displayed only once. - -## -parameters -### -param content -The XML that defines the toast notification content. - -### -param deliveryTime -The date and time that Windows should display the toast notification. You must call [AddToSchedule](toastnotifier_addtoschedule.md) before this time. - -## -remarks - -## -examples -The following example shows a toast notification scheduled to display in one hour, including the use of this constructor to create the notification. - -```javascript - -var Notifications = Windows.UI.Notifications; -var currentTime = new Date(); -var seconds = 60; -var dueTime = new Date(currentTime.getTime() + seconds * 60 * 1000); -var idNumber = Math.floor(Math.random() * 100000000); // Generates a unique ID number for the notification. - -// Set up the notification text. -var toastXml = Notifications.ToastNotificationManager.getTemplateContent(Notifications.ToastTemplateType.toastText02); -var strings = toastXml.getElementsByTagName("text"); -strings[0].appendChild(toastXml.createTextNode(This is a scheduled toast notification)); -strings[1].appendChild(toastXml.createTextNode("Received: " + dueTime.toLocaleTimeString())); - -// Create the toast notification object. -var toast = new Notifications.ScheduledToastNotification(toastXml, dueTime); -toast.id = "Toast" + idNumber; - -// Add to the schedule. -Notifications.ToastNotificationManager.createToastNotifier().addToSchedule(toast); -``` - - - -## -see-also -[ScheduledToastNotification(XmlDocument, DateTime, TimeSpan, UInt32)](scheduledtoastnotification_scheduledtoastnotification_1365784316.md), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ScheduledToastNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument,Windows.Foundation.DateTime) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ScheduledToastNotification.ScheduledToastNotification + +## -description +Creates and initializes a new instance of a [ScheduledToastNotification](scheduledtoastnotification.md) that will be displayed only once. + +## -parameters +### -param content +The XML that defines the toast notification content. + +### -param deliveryTime +The date and time that Windows should display the toast notification. You must call [AddToSchedule](toastnotifier_addtoschedule.md) before this time. + +## -remarks + +## -examples +The following example shows a toast notification scheduled to display in one hour, including the use of this constructor to create the notification. + +```javascript + +var Notifications = Windows.UI.Notifications; +var currentTime = new Date(); +var seconds = 60; +var dueTime = new Date(currentTime.getTime() + seconds * 60 * 1000); +var idNumber = Math.floor(Math.random() * 100000000); // Generates a unique ID number for the notification. + +// Set up the notification text. +var toastXml = Notifications.ToastNotificationManager.getTemplateContent(Notifications.ToastTemplateType.toastText02); +var strings = toastXml.getElementsByTagName("text"); +strings[0].appendChild(toastXml.createTextNode(This is a scheduled toast notification)); +strings[1].appendChild(toastXml.createTextNode("Received: " + dueTime.toLocaleTimeString())); + +// Create the toast notification object. +var toast = new Notifications.ScheduledToastNotification(toastXml, dueTime); +toast.id = "Toast" + idNumber; + +// Add to the schedule. +Notifications.ToastNotificationManager.createToastNotifier().addToSchedule(toast); +``` + + + +## -see-also +[ScheduledToastNotification(XmlDocument, DateTime, TimeSpan, UInt32)](scheduledtoastnotification_scheduledtoastnotification_1365784316.md), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/scheduledtoastnotification_snoozeinterval.md b/windows.ui.notifications/scheduledtoastnotification_snoozeinterval.md index 90295c7c0a..f38a13b11b 100644 --- a/windows.ui.notifications/scheduledtoastnotification_snoozeinterval.md +++ b/windows.ui.notifications/scheduledtoastnotification_snoozeinterval.md @@ -1,24 +1,24 @@ ---- --api-id: P:Windows.UI.Notifications.ScheduledToastNotification.SnoozeInterval --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ScheduledToastNotification.SnoozeInterval - -## -description -Gets the amount of time between occurrences of the notification. - -## -property-value -The time between occurrences of the notification. This value will be between 60 seconds and 60 minutes, inclusive. - -## -remarks -This value is set when the [ScheduledToastNotification](scheduledtoastnotification.md) object is created. - -## -examples - -## -see-also -[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ScheduledToastNotification.SnoozeInterval +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ScheduledToastNotification.SnoozeInterval + +## -description +Gets the amount of time between occurrences of the notification. + +## -property-value +The time between occurrences of the notification. This value will be between 60 seconds and 60 minutes, inclusive. + +## -remarks +This value is set when the [ScheduledToastNotification](scheduledtoastnotification.md) object is created. + +## -examples + +## -see-also +[Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Toast schema](XREF:TODO:toast.Schema_Root), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca) \ No newline at end of file diff --git a/windows.ui.notifications/tilenotification.md b/windows.ui.notifications/tilenotification.md index 54f1f055d4..f6d974f516 100644 --- a/windows.ui.notifications/tilenotification.md +++ b/windows.ui.notifications/tilenotification.md @@ -42,4 +42,4 @@ function tileNotificationExpiration() { ## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tilenotification_content.md b/windows.ui.notifications/tilenotification_content.md index fd65db3f81..569a4f7dae 100644 --- a/windows.ui.notifications/tilenotification_content.md +++ b/windows.ui.notifications/tilenotification_content.md @@ -1,24 +1,24 @@ ---- --api-id: P:Windows.UI.Notifications.TileNotification.Content --api-type: winrt property ---- - - - -# Windows.UI.Notifications.TileNotification.Content - -## -description -Gets the XML description of the notification content, which you can then manipulate to alter the notification. - -## -property-value -The object that contains the notification content. - -## -remarks -The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions to customize the tile content. See [tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes found in the XML document. - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.TileNotification.Content +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.TileNotification.Content + +## -description +Gets the XML description of the notification content, which you can then manipulate to alter the notification. + +## -property-value +The object that contains the notification content. + +## -remarks +The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions to customize the tile content. See [tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes found in the XML document. + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tilenotification_expirationtime.md b/windows.ui.notifications/tilenotification_expirationtime.md index f9c80fbe52..2d20b82d81 100644 --- a/windows.ui.notifications/tilenotification_expirationtime.md +++ b/windows.ui.notifications/tilenotification_expirationtime.md @@ -1,48 +1,48 @@ ---- --api-id: P:Windows.UI.Notifications.TileNotification.ExpirationTime --api-type: winrt property ---- - - - -# Windows.UI.Notifications.TileNotification.ExpirationTime - -## -description -Gets or sets the time that Windows will remove the notification from the tile. By default, a tile update does not expire. It is a best practice to explicitly set an expiration time to avoid stale content. - -## -property-value -The date and time that the notification should be removed. - -## -remarks - -## -examples -The following example uses [ExpirationTime](tilenotification_expirationtime.md) to show a tile notification for 30 seconds. - -```javascript - -function tileNotificationExpiration() { - var Notifications = Windows.UI.Notifications; - var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text04); - - var currentTime = new Date(); - var seconds = 30; - - var tileTextAttributes = tileXml.getElementsByTagName("text"); - tileTextAttributes[0].appendChild(tileXml.createTextNode("This notification will expire at " + new Date(currentTime.getTime() + seconds * 1000))); - - var tileNotification = new Notifications.TileNotification(tileXml); - - // Set the expiration time on the notification - var expiryTime = new Date(currentTime.getTime() + seconds * 1000); - - tileNotification.expirationTime = expiryTime; - Notifications.TileUpdateManager.createTileUpdaterForApplication().update(tileNotification); -} -``` - - - -## -see-also -[How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.TileNotification.ExpirationTime +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.TileNotification.ExpirationTime + +## -description +Gets or sets the time that Windows will remove the notification from the tile. By default, a tile update does not expire. It is a best practice to explicitly set an expiration time to avoid stale content. + +## -property-value +The date and time that the notification should be removed. + +## -remarks + +## -examples +The following example uses [ExpirationTime](tilenotification_expirationtime.md) to show a tile notification for 30 seconds. + +```javascript + +function tileNotificationExpiration() { + var Notifications = Windows.UI.Notifications; + var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text04); + + var currentTime = new Date(); + var seconds = 30; + + var tileTextAttributes = tileXml.getElementsByTagName("text"); + tileTextAttributes[0].appendChild(tileXml.createTextNode("This notification will expire at " + new Date(currentTime.getTime() + seconds * 1000))); + + var tileNotification = new Notifications.TileNotification(tileXml); + + // Set the expiration time on the notification + var expiryTime = new Date(currentTime.getTime() + seconds * 1000); + + tileNotification.expirationTime = expiryTime; + Notifications.TileUpdateManager.createTileUpdaterForApplication().update(tileNotification); +} +``` + + + +## -see-also +[How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tilenotification_tag.md b/windows.ui.notifications/tilenotification_tag.md index cbab02a338..d5f79da272 100644 --- a/windows.ui.notifications/tilenotification_tag.md +++ b/windows.ui.notifications/tilenotification_tag.md @@ -1,30 +1,30 @@ ---- --api-id: P:Windows.UI.Notifications.TileNotification.Tag --api-type: winrt property ---- - - - -# Windows.UI.Notifications.TileNotification.Tag - -## -description -Gets or sets a string that Windows can use to prevent duplicate notification content from appearing in the queue. - -## -property-value -A string of 16 characters or less (plus a terminating null character) that identifies the notification in the stack. While there is no set form to the string content, we recommend that it should relate to the content of the notification. - -## -remarks -Use tags to replace notifications in the stack. If a new notification arrives with the same tag as an existing notification, the new notification replaces the old. For instance, if your tile shows stock prices, you want to show the most up-to-date info. An existing stock price update waiting in the queue to be displayed should be replaced by the latest quotes rather than showing them one after the other. - -A new notification with a matching tag replaces any existing notification with the same tag, but the new notification does not necessarily inherit the older notification's place in the queue. - - - -The tag should relate to the content of the notification. For example, a notification in a stock quote app could use the stock symbol (such as "msft") while a weather app notification could be tagged with the zip code (such as "98052") of the forecast. Do not simply number your notifications as "notification1", "notification2" and so on. - -## -examples - -## -see-also -[How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.TileNotification.Tag +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.TileNotification.Tag + +## -description +Gets or sets a string that Windows can use to prevent duplicate notification content from appearing in the queue. + +## -property-value +A string of 16 characters or less (plus a terminating null character) that identifies the notification in the stack. While there is no set form to the string content, we recommend that it should relate to the content of the notification. + +## -remarks +Use tags to replace notifications in the stack. If a new notification arrives with the same tag as an existing notification, the new notification replaces the old. For instance, if your tile shows stock prices, you want to show the most up-to-date info. An existing stock price update waiting in the queue to be displayed should be replaced by the latest quotes rather than showing them one after the other. + +A new notification with a matching tag replaces any existing notification with the same tag, but the new notification does not necessarily inherit the older notification's place in the queue. + + + +The tag should relate to the content of the notification. For example, a notification in a stock quote app could use the stock symbol (such as "msft") while a weather app notification could be tagged with the zip code (such as "98052") of the forecast. Do not simply number your notifications as "notification1", "notification2" and so on. + +## -examples + +## -see-also +[How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tilenotification_tilenotification_93177318.md b/windows.ui.notifications/tilenotification_tilenotification_93177318.md index b03cf1dd42..4aed43f78a 100644 --- a/windows.ui.notifications/tilenotification_tilenotification_93177318.md +++ b/windows.ui.notifications/tilenotification_tilenotification_93177318.md @@ -1,24 +1,24 @@ ---- --api-id: M:Windows.UI.Notifications.TileNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileNotification.TileNotification - -## -description -Creates and initializes a new instance of the [TileNotification](tilenotification.md) object for use with a [TileUpdater](tileupdater.md). - -## -parameters -### -param content -The object that provides the content for the tile notification. - -## -remarks - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileNotification.TileNotification + +## -description +Creates and initializes a new instance of the [TileNotification](tilenotification.md) object for use with a [TileUpdater](tileupdater.md). + +## -parameters +### -param content +The object that provides the content for the tile notification. + +## -remarks + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdatemanager.md b/windows.ui.notifications/tileupdatemanager.md index 544eeef746..441f05b56f 100644 --- a/windows.ui.notifications/tileupdatemanager.md +++ b/windows.ui.notifications/tileupdatemanager.md @@ -42,4 +42,4 @@ function sendTileTextNotification() { ## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_1541898748.md b/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_1541898748.md index f0679675fd..eef2ce774e 100644 --- a/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_1541898748.md +++ b/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_1541898748.md @@ -1,23 +1,23 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication - -## -description -Creates and initializes a new instance of the [TileUpdater](tileupdater.md), which lets you change the appearance of the calling app's tile. - -## -returns -The object you will use to send changes to the app's tile. - -## -remarks - -## -examples - -## -see-also -[CreateTileUpdaterForApplication(String)](tileupdatemanager_createtileupdaterforapplication_40270044.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication + +## -description +Creates and initializes a new instance of the [TileUpdater](tileupdater.md), which lets you change the appearance of the calling app's tile. + +## -returns +The object you will use to send changes to the app's tile. + +## -remarks + +## -examples + +## -see-also +[CreateTileUpdaterForApplication(String)](tileupdatemanager_createtileupdaterforapplication_40270044.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_40270044.md b/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_40270044.md index 75922284fc..bfd100d4a3 100644 --- a/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_40270044.md +++ b/windows.ui.notifications/tileupdatemanager_createtileupdaterforapplication_40270044.md @@ -1,30 +1,30 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication(System.String) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication - -## -description -Creates and initializes a new instance of the [TileUpdater](tileupdater.md) for a tile that belongs to another app in the same package as the calling app. The [TileUpdater](tileupdater.md) lets a developer change the appearance of that tile. - -## -parameters -### -param applicationId -The Package Relative Application ID (PRAID) of the tile. - -## -returns -The object you will use to send changes to the tile identified by *applicationId*. - -## -remarks -This method is used only in conjunction with multi-app packages. The app identified by *applicationId* must belong to the same package as the caller. - -Although you can specify the calling application's tile in this method, [createTileUpdaterForApplication](tileupdatemanager_createtileupdaterforapplication_1541898748.md) is the preferred method to use with single-app packages. - -## -examples - -## -see-also -[CreateTileUpdaterForApplication](tileupdatemanager_createtileupdaterforapplication_1541898748.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForApplication + +## -description +Creates and initializes a new instance of the [TileUpdater](tileupdater.md) for a tile that belongs to another app in the same package as the calling app. The [TileUpdater](tileupdater.md) lets a developer change the appearance of that tile. + +## -parameters +### -param applicationId +The Package Relative Application ID (PRAID) of the tile. + +## -returns +The object you will use to send changes to the tile identified by *applicationId*. + +## -remarks +This method is used only in conjunction with multi-app packages. The app identified by *applicationId* must belong to the same package as the caller. + +Although you can specify the calling application's tile in this method, [createTileUpdaterForApplication](tileupdatemanager_createtileupdaterforapplication_1541898748.md) is the preferred method to use with single-app packages. + +## -examples + +## -see-also +[CreateTileUpdaterForApplication](tileupdatemanager_createtileupdaterforapplication_1541898748.md), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdatemanager_createtileupdaterforsecondarytile_445640521.md b/windows.ui.notifications/tileupdatemanager_createtileupdaterforsecondarytile_445640521.md index bd62d9a877..9089fd1f55 100644 --- a/windows.ui.notifications/tileupdatemanager_createtileupdaterforsecondarytile_445640521.md +++ b/windows.ui.notifications/tileupdatemanager_createtileupdaterforsecondarytile_445640521.md @@ -1,59 +1,59 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForSecondaryTile(System.String) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForSecondaryTile - -## -description -Creates and initializes a new instance of the [TileUpdater](tileupdater.md), which enables you to change the appearance of a [secondary tile](../windows.ui.startscreen/secondarytile.md). The tile can belong to the calling app or any other app in the same package. - -## -parameters -### -param tileId -A unique ID for the tile. - -## -returns -The object you will use to send updates to the tile identified by *tileID*. - -## -remarks - -## -examples -The following example demonstrates how to send a notification to a secondary tile. - -```javascript - -var Notifications = Windows.UI.Notifications; - -// Define the notification content. -var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text04); -var tileTextAttributes = tileXml.getElementsByTagName("text"); -tileTextAttributes[0].appendChild(tileXml.createTextNode("Sent to a secondary tile!")); - -// Provide a medium version of the notification as well, remembering that the user has control -// over whether the tile is displaying as wide or square. -var squareTileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileSquare150x150Text04); -var squareTileTextAttributes = squareTileXml.getElementsByTagName("text"); -squareTileTextAttributes[0].appendChild(squareTileXml.createTextNode("Sent to a secondary tile!")); - -// Add the medium tile to the notification. -var node = tileXml.importNode(squareTileXml.getElementsByTagName("binding").item(0), true); -tileXml.getElementsByTagName("visual").item(0).appendChild(node); - -// Create the notification based on the XML content. -var tileNotification = new Notifications.TileNotification(tileXml); - -// Create a secondary tile updater and pass it the secondary tileId -var tileUpdater = Notifications.TileUpdateManager.createTileUpdaterForSecondaryTile("SecondaryTile.Dynamic"); - -// Send the notification to the secondary tile. -tileUpdater.update(tileNotification); -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForSecondaryTile(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdateManager.CreateTileUpdaterForSecondaryTile + +## -description +Creates and initializes a new instance of the [TileUpdater](tileupdater.md), which enables you to change the appearance of a [secondary tile](../windows.ui.startscreen/secondarytile.md). The tile can belong to the calling app or any other app in the same package. + +## -parameters +### -param tileId +A unique ID for the tile. + +## -returns +The object you will use to send updates to the tile identified by *tileID*. + +## -remarks + +## -examples +The following example demonstrates how to send a notification to a secondary tile. + +```javascript + +var Notifications = Windows.UI.Notifications; + +// Define the notification content. +var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text04); +var tileTextAttributes = tileXml.getElementsByTagName("text"); +tileTextAttributes[0].appendChild(tileXml.createTextNode("Sent to a secondary tile!")); + +// Provide a medium version of the notification as well, remembering that the user has control +// over whether the tile is displaying as wide or square. +var squareTileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileSquare150x150Text04); +var squareTileTextAttributes = squareTileXml.getElementsByTagName("text"); +squareTileTextAttributes[0].appendChild(squareTileXml.createTextNode("Sent to a secondary tile!")); + +// Add the medium tile to the notification. +var node = tileXml.importNode(squareTileXml.getElementsByTagName("binding").item(0), true); +tileXml.getElementsByTagName("visual").item(0).appendChild(node); + +// Create the notification based on the XML content. +var tileNotification = new Notifications.TileNotification(tileXml); + +// Create a secondary tile updater and pass it the secondary tileId +var tileUpdater = Notifications.TileUpdateManager.createTileUpdaterForSecondaryTile("SecondaryTile.Dynamic"); + +// Send the notification to the secondary tile. +tileUpdater.update(tileNotification); +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdatemanager_getforuser_2058550280.md b/windows.ui.notifications/tileupdatemanager_getforuser_2058550280.md new file mode 100644 index 0000000000..9109f1c4ea --- /dev/null +++ b/windows.ui.notifications/tileupdatemanager_getforuser_2058550280.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.TileUpdateManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdateManager.GetForUser + +## -description + +## -parameters + +### -param user + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/tileupdatemanager_gettemplatecontent_43644918.md b/windows.ui.notifications/tileupdatemanager_gettemplatecontent_43644918.md index aa2cc4b145..497d068ce2 100644 --- a/windows.ui.notifications/tileupdatemanager_gettemplatecontent_43644918.md +++ b/windows.ui.notifications/tileupdatemanager_gettemplatecontent_43644918.md @@ -1,42 +1,42 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdateManager.GetTemplateContent(Windows.UI.Notifications.TileTemplateType) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdateManager.GetTemplateContent - -## -description -Gets the XML content of one of the predefined tile templates so that you can customize it for a tile update. - -> [!NOTE] -> When this method is called on a Windows 8 system, it returns a [version 1 template](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f). When this method is called on a Windows 8.1 system, it returns a [version 2 template](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f). However, if an app specifies Windows 8 compatibility in its manifest, this method returns a [version 1 template](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f). - -## -parameters -### -param type -The name of the template. - -## -returns -The object that contains the XML. - -## -remarks -You can use Document Object Model (DOM) manipulation functions to customize the template content for use in a [TileNotification](tilenotification.md) update that you will send to the tile through the [TileUpdater](tileupdater.md) that you create through the other methods of this class. - -See [tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes. - -## -examples -The following example shows [GetTemplateContent](tileupdatemanager_gettemplatecontent.md) used to retrieve the XML content of a tile template. - -```javascript - -var tileTemplate = Windows.UI.Notifications.TileTemplateType.tileWide310x150Text03; -var tileXml = Windows.UI.Notifications.TileUpdateManager.getTemplateContent(tileTemplate); -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdateManager.GetTemplateContent(Windows.UI.Notifications.TileTemplateType) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdateManager.GetTemplateContent + +## -description +Gets the XML content of one of the predefined tile templates so that you can customize it for a tile update. + +> [!NOTE] +> When this method is called on a Windows 8 system, it returns a [version 1 template](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f). When this method is called on a Windows 8.1 system, it returns a [version 2 template](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f). However, if an app specifies Windows 8 compatibility in its manifest, this method returns a [version 1 template](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f). + +## -parameters +### -param type +The name of the template. + +## -returns +The object that contains the XML. + +## -remarks +You can use Document Object Model (DOM) manipulation functions to customize the template content for use in a [TileNotification](tilenotification.md) update that you will send to the tile through the [TileUpdater](tileupdater.md) that you create through the other methods of this class. + +See [tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes. + +## -examples +The following example shows [GetTemplateContent](tileupdatemanager_gettemplatecontent.md) used to retrieve the XML content of a tile template. + +```javascript + +var tileTemplate = Windows.UI.Notifications.TileTemplateType.tileWide310x150Text03; +var tileXml = Windows.UI.Notifications.TileUpdateManager.getTemplateContent(tileTemplate); +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_addtoschedule_1446725541.md b/windows.ui.notifications/tileupdater_addtoschedule_1446725541.md index 750fdcafc5..085f245695 100644 --- a/windows.ui.notifications/tileupdater_addtoschedule_1446725541.md +++ b/windows.ui.notifications/tileupdater_addtoschedule_1446725541.md @@ -1,32 +1,32 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.AddToSchedule(Windows.UI.Notifications.ScheduledTileNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.AddToSchedule - -## -description -Adds a [ScheduledTileNotification](scheduledtilenotification.md) to the schedule. - -## -parameters -### -param scheduledTile -The scheduled tile update object. - -## -remarks -If your call to this method returns a failure code, examine these possible causes: -+ **Possible cause**: You've exceeded the maximum allowed number of scheduled notifications. - -**Fix**: [TileUpdater.addToSchedule](tileupdater_addtoschedule.md) will fail if you attempt to schedule more than 4096 notifications. Reduce your number of scheduled notifications. -+ **Possible cause**: Your notification is scheduled for a time in the past relative to the current system clock time. - -**Fix**: Make sure that the scheduled notification time is in the future. Examine the system clock time. - - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.AddToSchedule(Windows.UI.Notifications.ScheduledTileNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.AddToSchedule + +## -description +Adds a [ScheduledTileNotification](scheduledtilenotification.md) to the schedule. + +## -parameters +### -param scheduledTile +The scheduled tile update object. + +## -remarks +If your call to this method returns a failure code, examine these possible causes: ++ **Possible cause**: You've exceeded the maximum allowed number of scheduled notifications. + +**Fix**: [TileUpdater.addToSchedule](tileupdater_addtoschedule.md) will fail if you attempt to schedule more than 4096 notifications. Reduce your number of scheduled notifications. ++ **Possible cause**: Your notification is scheduled for a time in the past relative to the current system clock time. + +**Fix**: Make sure that the scheduled notification time is in the future. Examine the system clock time. + + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_clear_556466.md b/windows.ui.notifications/tileupdater_clear_556466.md index 88d1c82583..91e9144497 100644 --- a/windows.ui.notifications/tileupdater_clear_556466.md +++ b/windows.ui.notifications/tileupdater_clear_556466.md @@ -1,22 +1,22 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.Clear --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.Clear - -## -description -Removes all updates and causes the tile to display its default content as declared in the app's manifest. - -## -remarks -> [!NOTE] -> This method does not stop periodic updates. If your tile is using periodic updates, you must also call [StopPeriodicUpdate](tileupdater_stopperiodicupdate.md) to prevent further updates. - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.Clear +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.Clear + +## -description +Removes all updates and causes the tile to display its default content as declared in the app's manifest. + +## -remarks +> [!NOTE] +> This method does not stop periodic updates. If your tile is using periodic updates, you must also call [StopPeriodicUpdate](tileupdater_stopperiodicupdate.md) to prevent further updates. + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_enablenotificationqueue_1798421599.md b/windows.ui.notifications/tileupdater_enablenotificationqueue_1798421599.md index 3f86e25974..c5cc677d5d 100644 --- a/windows.ui.notifications/tileupdater_enablenotificationqueue_1798421599.md +++ b/windows.ui.notifications/tileupdater_enablenotificationqueue_1798421599.md @@ -1,49 +1,49 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.EnableNotificationQueue(System.Boolean) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.EnableNotificationQueue - -## -description -Enables the tile to queue up to five notifications. This enables the notification queue on all tile sizes. - -## -parameters -### -param enable -**True** to enable queuing; otherwise **false**. - -## -remarks -When queuing is enabled, a maximum of five tile notifications can automatically cycle on the tile. Be careful about enabling cycling unless your app explicitly wants to use it, otherwise you can potentially have outdated notifications cycling through. Generally, the queue is FIFO (first in, first out), so that when it is full and a new notification arrives, the oldest notification is removed. However, notifications can be given a [Tag](tilenotification_tag.md), which allows a new notification with that same [Tag](tilenotification_tag.md) to replace its older notification in the queue, regardless of its position. - -When your tile is based on a peek template, notification cycling is timed so that the full content is always shown before the tile cycles to the next notification. - -As of Windows 8.1, you can also enable the notification queue for only specific tile sizes. See the following topics: -+ [EnableNotificationQueueForSquare150x150](tileupdater_enablenotificationqueueforsquare150x150.md) -+ [EnableNotificationQueueForSquare310x310](tileupdater_enablenotificationqueueforsquare310x310.md) -+ [EnableNotificationQueueForWide310x150](tileupdater_enablenotificationqueueforwide310x150.md) -We recommend that you disable the notification queu when using a large tile with one of the following templates, which already show three notifications simultaneously. This avoids a tile that's distractingly busy to the user. In that case, you may want to use the size-specific enable methods instead of [EnableNotificationQueue](tileupdater_enablenotificationqueue.md). -+ [TileSquare310x310SmallImagesAndTextList01](tiletemplatetype.md) -+ [TileSquare310x310SmallImagesAndTextList02](tiletemplatetype.md) -+ [TileSquare310x310SmallImagesAndTextList03](tiletemplatetype.md) -+ [TileSquare310x310SmallImagesAndTextList04](tiletemplatetype.md) -+ [TileSquare310x310TextList01](tiletemplatetype.md) -+ [TileSquare310x310TextList02](tiletemplatetype.md) -+ [TileSquare310x310TextList03](tiletemplatetype.md) - - -## -examples -The following line of code enables the notification queue for the calling app's tile. - -```javascript - -Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true); -``` - - - -## -see-also -[How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.EnableNotificationQueue(System.Boolean) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.EnableNotificationQueue + +## -description +Enables the tile to queue up to five notifications. This enables the notification queue on all tile sizes. + +## -parameters +### -param enable +**True** to enable queuing; otherwise **false**. + +## -remarks +When queuing is enabled, a maximum of five tile notifications can automatically cycle on the tile. Be careful about enabling cycling unless your app explicitly wants to use it, otherwise you can potentially have outdated notifications cycling through. Generally, the queue is FIFO (first in, first out), so that when it is full and a new notification arrives, the oldest notification is removed. However, notifications can be given a [Tag](tilenotification_tag.md), which allows a new notification with that same [Tag](tilenotification_tag.md) to replace its older notification in the queue, regardless of its position. + +When your tile is based on a peek template, notification cycling is timed so that the full content is always shown before the tile cycles to the next notification. + +As of Windows 8.1, you can also enable the notification queue for only specific tile sizes. See the following topics: ++ [EnableNotificationQueueForSquare150x150](tileupdater_enablenotificationqueueforsquare150x150.md) ++ [EnableNotificationQueueForSquare310x310](tileupdater_enablenotificationqueueforsquare310x310.md) ++ [EnableNotificationQueueForWide310x150](tileupdater_enablenotificationqueueforwide310x150.md) +We recommend that you disable the notification queu when using a large tile with one of the following templates, which already show three notifications simultaneously. This avoids a tile that's distractingly busy to the user. In that case, you may want to use the size-specific enable methods instead of [EnableNotificationQueue](tileupdater_enablenotificationqueue.md). ++ [TileSquare310x310SmallImagesAndTextList01](tiletemplatetype.md) ++ [TileSquare310x310SmallImagesAndTextList02](tiletemplatetype.md) ++ [TileSquare310x310SmallImagesAndTextList03](tiletemplatetype.md) ++ [TileSquare310x310SmallImagesAndTextList04](tiletemplatetype.md) ++ [TileSquare310x310TextList01](tiletemplatetype.md) ++ [TileSquare310x310TextList02](tiletemplatetype.md) ++ [TileSquare310x310TextList03](tiletemplatetype.md) + + +## -examples +The following line of code enables the notification queue for the calling app's tile. + +```javascript + +Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true); +``` + + + +## -see-also +[How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_getscheduledtilenotifications_1894006304.md b/windows.ui.notifications/tileupdater_getscheduledtilenotifications_1894006304.md index 376fe93f13..be9d56da59 100644 --- a/windows.ui.notifications/tileupdater_getscheduledtilenotifications_1894006304.md +++ b/windows.ui.notifications/tileupdater_getscheduledtilenotifications_1894006304.md @@ -1,23 +1,23 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.GetScheduledTileNotifications --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.GetScheduledTileNotifications - -## -description -Retrieves a list of scheduled updates to the tile. - -## -returns -The collection of scheduled updates for this tile. - -## -remarks - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.GetScheduledTileNotifications +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.GetScheduledTileNotifications + +## -description +Retrieves a list of scheduled updates to the tile. + +## -returns +The collection of scheduled updates for this tile. + +## -remarks + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_removefromschedule_928610118.md b/windows.ui.notifications/tileupdater_removefromschedule_928610118.md index 61fa391f98..ab2529b7b2 100644 --- a/windows.ui.notifications/tileupdater_removefromschedule_928610118.md +++ b/windows.ui.notifications/tileupdater_removefromschedule_928610118.md @@ -1,43 +1,43 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.RemoveFromSchedule(Windows.UI.Notifications.ScheduledTileNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.RemoveFromSchedule - -## -description -Removes an upcoming tile update from the schedule. - -## -parameters -### -param scheduledTile -The notification to remove from the schedule. - - -## -remarks - -## -examples -The following example shows the use of the [RemoveFromSchedule](tileupdater_removefromschedule.md) method. - -```javascript - -var notifier = Notifications.TileUpdateManager.createTileUpdaterForApplication(); -var scheduled = notifier.getScheduledTileNotifications(); - -for (var i = 0, len = scheduled.length; i < len; i++) { - - // The itemId value is the unique ScheduledTileNotification.Id assigned to the - // notification when it was created. - if (scheduled[i].id === itemId) { - notifier.removeFromSchedule(scheduled[i]); - } -} -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](XREF:TODO:m_ui_tiles.guidelines_for_scheduled_notifications), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.RemoveFromSchedule(Windows.UI.Notifications.ScheduledTileNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.RemoveFromSchedule + +## -description +Removes an upcoming tile update from the schedule. + +## -parameters +### -param scheduledTile +The notification to remove from the schedule. + + +## -remarks + +## -examples +The following example shows the use of the [RemoveFromSchedule](tileupdater_removefromschedule.md) method. + +```javascript + +var notifier = Notifications.TileUpdateManager.createTileUpdaterForApplication(); +var scheduled = notifier.getScheduledTileNotifications(); + +for (var i = 0, len = scheduled.length; i < len; i++) { + + // The itemId value is the unique ScheduledTileNotification.Id assigned to the + // notification when it was created. + if (scheduled[i].id === itemId) { + notifier.removeFromSchedule(scheduled[i]); + } +} +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Scheduled notifications sample](http://go.microsoft.com/fwlink/p/?linkid=241614), [Guidelines and checklist for scheduled notifications](http://msdn.microsoft.com/library/ca9e9121-d1b1-461f-9c7e-b25225d917ca), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_setting.md b/windows.ui.notifications/tileupdater_setting.md index f1cf43b39c..21ce3aca45 100644 --- a/windows.ui.notifications/tileupdater_setting.md +++ b/windows.ui.notifications/tileupdater_setting.md @@ -1,55 +1,55 @@ ---- --api-id: P:Windows.UI.Notifications.TileUpdater.Setting --api-type: winrt property ---- - - - -# Windows.UI.Notifications.TileUpdater.Setting - -## -description -Gets a value that specifies whether a tile can be updated through notifications. - -## -property-value -A value that indicates either that the tile can be updated through notifications, or who disabled them: developer, user, or administrator. - -## -remarks - - - - - - - - - - - - -## -examples - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.TileUpdater.Setting +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.TileUpdater.Setting + +## -description +Gets a value that specifies whether a tile can be updated through notifications. + +## -property-value +A value that indicates either that the tile can be updated through notifications, or who disabled them: developer, user, or administrator. + +## -remarks + + + + + + + + + + + + +## -examples + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_startperiodicupdate_1369986471.md b/windows.ui.notifications/tileupdater_startperiodicupdate_1369986471.md index c5c79c8f3a..5c448a3782 100644 --- a/windows.ui.notifications/tileupdater_startperiodicupdate_1369986471.md +++ b/windows.ui.notifications/tileupdater_startperiodicupdate_1369986471.md @@ -1,30 +1,30 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.Foundation.DateTime,Windows.UI.Notifications.PeriodicUpdateRecurrence) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate - -## -description -Begins a series of timed updates for the tile that the updater is bound to. Update content is retrieved from a specified Uniform Resource Identifier (URI). Updates begin at a specified time. - -## -parameters -### -param tileContent -The Uniform Resource Identifier (URI) from which the XML content of the tile update will be retrieved. - -### -param startTime -The time at which the Uniform Resource Identifier (URI) should first be polled for new tile content. - -### -param requestedInterval -The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. - -## -remarks - -## -examples - -## -see-also -[StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence)](tileupdater_startperiodicupdate_1967457783.md), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Guidelines and checklist for periodic notifications](XREF:TODO:m_ui_tiles.guidelines_for_polling), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.Foundation.DateTime,Windows.UI.Notifications.PeriodicUpdateRecurrence) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate + +## -description +Begins a series of timed updates for the tile that the updater is bound to. Update content is retrieved from a specified Uniform Resource Identifier (URI). Updates begin at a specified time. + +## -parameters +### -param tileContent +The Uniform Resource Identifier (URI) from which the XML content of the tile update will be retrieved. + +### -param startTime +The time at which the Uniform Resource Identifier (URI) should first be polled for new tile content. + +### -param requestedInterval +The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. + +## -remarks + +## -examples + +## -see-also +[StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence)](tileupdater_startperiodicupdate_1967457783.md), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Guidelines and checklist for periodic notifications](http://msdn.microsoft.com/library/4be95d67-2adf-4d0e-83e1-4ad25e0f4c0b), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_startperiodicupdate_1967457783.md b/windows.ui.notifications/tileupdater_startperiodicupdate_1967457783.md index 12425b3cd1..6eecd48d1f 100644 --- a/windows.ui.notifications/tileupdater_startperiodicupdate_1967457783.md +++ b/windows.ui.notifications/tileupdater_startperiodicupdate_1967457783.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.UI.Notifications.PeriodicUpdateRecurrence) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate - -## -description -Begins a series of timed content changes for the tile that the updater is bound to, beginning immediately. - -## -parameters -### -param tileContent -The Uniform Resource Identifier (URI) from which the XML content of the tile update will be retrieved. - -### -param requestedInterval -The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. - -## -remarks - -## -examples - -## -see-also -[StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)](tileupdater_startperiodicupdate_1369986471.md), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Guidelines and checklist for periodic notifications](XREF:TODO:m_ui_tiles.guidelines_for_polling), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate(Windows.Foundation.Uri,Windows.UI.Notifications.PeriodicUpdateRecurrence) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdate + +## -description +Begins a series of timed content changes for the tile that the updater is bound to, beginning immediately. + +## -parameters +### -param tileContent +The Uniform Resource Identifier (URI) from which the XML content of the tile update will be retrieved. + +### -param requestedInterval +The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. + +## -remarks + +## -examples + +## -see-also +[StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)](tileupdater_startperiodicupdate_1369986471.md), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Guidelines and checklist for periodic notifications](http://msdn.microsoft.com/library/4be95d67-2adf-4d0e-83e1-4ad25e0f4c0b), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1331011351.md b/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1331011351.md index d2f3f62229..2edab63ef2 100644 --- a/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1331011351.md +++ b/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1331011351.md @@ -1,80 +1,80 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch(Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.UI.Notifications.PeriodicUpdateRecurrence) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch - -## -description -Begins a series of timed updates that cycle on the tile that the updater is bound to. Update content is retrieved from an array of specified Uniform Resource Identifier (URI), the first update happening immediately and subsequent updates occurring at the periodic interval thereafter. - -> [!NOTE] -> To use this feature, you must first enable the tile's notification queue by calling [EnableNotificationQueue](tileupdater_enablenotificationqueue.md). - -## -parameters -### -param tileContents -An array of up to five Uniform Resource Identifier (URI) from which the XML content of the cycling tile updates will be retrieved. If the array contains more than five Uniform Resource Identifier (URI), the method will fail. - -### -param requestedInterval -The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. - -## -remarks -### Using the notification queue with periodic updates - -To use the notification queue, you must first enable it for your tile with this line of code: - - - -```javascript -Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true); -``` - - - -This API only needs to be called once in your app's lifetime, but there is no harm in calling it each time the app launches. - -In the case of periodic notifications, a unique URL is provided for each notification. Each URL is polled on a periodic basis by Windows for updated notification content. The content payload returned from each URL should contain versions of the notification XML for all supported tile sizes. Each polled URL also can optionally return its own unique expiration time and tag value. - -### Tagging notifications for periodic updates - -With the notification queue enabled, your tile can cycle through a maximum of five queued notifications. Generally, the oldest notification is replaced in the queue when a new notification arrives. However, notifications can be given a tag so that a new notification with a specific tag will replace an older notification with the same tag, regardless of its place in the queue. - -Tags are optional strings of up to 16 characters that can be set on a notification as an identifier. If a new notification arrives with the same tag as a notification already in the queue, the new notification replaces the old one rather than falling under the default first-in, first-out queue behavior. This prevents the case where two versions of the same notification— one of them out-of-date— are present in the queue at the same time. - -In the case of periodic notifications, tags are provided in the X-WNS-Tag header of the notification's HTTP response message, which also includes the notification's content. This message is sent in response to the system's periodic call to the notification's Uniform Resource Identifier (URI). The header name and the tag value are case-insensitive. - -An example is shown here: - -```html -X-WNS-Tag: stockMSFT -``` - - - -### Setting an expiration time for periodic updates - -Periodic notifications expire by default after three days. If your notification content has a significantly different useful lifespan— shorter or longer— you should explicitly set an expiration time for each notification. This prevents stale or irrelevant content from remaining in the queue. This is especially important if the user's machine loses Internet connectivity for a long period of time. - - -For example, during active trading, it would be advisable for a stock app to set the expiration on a stock price notification to twice that of your polling interval, such as a notification that expires one hour after it is sent if you poll for an update every half-hour. In the case of a news app, an expiration of one day for a tile that shows the top daily news would be appropriate. - -For periodic notifications, the expiration time is set in the X-WNS-Expires header of the notification's HTTP response message. The expiration time is expressed as an HTTP-date, which uses one of the formats shown in these examples: - - -+ Sun, 06 Nov 1994 08:49:37 GMT -+ Sunday, 06-Nov-94 08:49:37 GMT -+ Sun Nov 6 08:49:37 1994 - - -For more information on the HTTP-date format, see the World Wide Web Consortium (W3C) [3 Protocol Parameters](http://go.microsoft.com/fwlink/p/?linkid=133333) document. - -For an example of a full implementation of periodic notifications used in conjunction with the notification queue, see Scenario 3 in the [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476). - -## -examples - -## -see-also -[StartPeriodicUpdateBatch(IIterable(Uri), DateTime, PeriodicUpdateRecurrence)](tileupdater_startperiodicupdatebatch_1807273799.md), [StartPeriodicUpdate](tileupdater_startperiodicupdate.md), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Guidelines and checklist for periodic notifications](XREF:TODO:m_ui_tiles.guidelines_for_polling), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch(Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.UI.Notifications.PeriodicUpdateRecurrence) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch + +## -description +Begins a series of timed updates that cycle on the tile that the updater is bound to. Update content is retrieved from an array of specified Uniform Resource Identifier (URI), the first update happening immediately and subsequent updates occurring at the periodic interval thereafter. + +> [!NOTE] +> To use this feature, you must first enable the tile's notification queue by calling [EnableNotificationQueue](tileupdater_enablenotificationqueue.md). + +## -parameters +### -param tileContents +An array of up to five Uniform Resource Identifier (URI) from which the XML content of the cycling tile updates will be retrieved. If the array contains more than five Uniform Resource Identifier (URI), the method will fail. + +### -param requestedInterval +The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. + +## -remarks +### Using the notification queue with periodic updates + +To use the notification queue, you must first enable it for your tile with this line of code: + + + +```javascript +Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true); +``` + + + +This API only needs to be called once in your app's lifetime, but there is no harm in calling it each time the app launches. + +In the case of periodic notifications, a unique URL is provided for each notification. Each URL is polled on a periodic basis by Windows for updated notification content. The content payload returned from each URL should contain versions of the notification XML for all supported tile sizes. Each polled URL also can optionally return its own unique expiration time and tag value. + +### Tagging notifications for periodic updates + +With the notification queue enabled, your tile can cycle through a maximum of five queued notifications. Generally, the oldest notification is replaced in the queue when a new notification arrives. However, notifications can be given a tag so that a new notification with a specific tag will replace an older notification with the same tag, regardless of its place in the queue. + +Tags are optional strings of up to 16 characters that can be set on a notification as an identifier. If a new notification arrives with the same tag as a notification already in the queue, the new notification replaces the old one rather than falling under the default first-in, first-out queue behavior. This prevents the case where two versions of the same notification— one of them out-of-date— are present in the queue at the same time. + +In the case of periodic notifications, tags are provided in the X-WNS-Tag header of the notification's HTTP response message, which also includes the notification's content. This message is sent in response to the system's periodic call to the notification's Uniform Resource Identifier (URI). The header name and the tag value are case-insensitive. + +An example is shown here: + +```html +X-WNS-Tag: stockMSFT +``` + + + +### Setting an expiration time for periodic updates + +Periodic notifications expire by default after three days. If your notification content has a significantly different useful lifespan— shorter or longer— you should explicitly set an expiration time for each notification. This prevents stale or irrelevant content from remaining in the queue. This is especially important if the user's machine loses Internet connectivity for a long period of time. + + +For example, during active trading, it would be advisable for a stock app to set the expiration on a stock price notification to twice that of your polling interval, such as a notification that expires one hour after it is sent if you poll for an update every half-hour. In the case of a news app, an expiration of one day for a tile that shows the top daily news would be appropriate. + +For periodic notifications, the expiration time is set in the X-WNS-Expires header of the notification's HTTP response message. The expiration time is expressed as an HTTP-date, which uses one of the formats shown in these examples: + + ++ Sun, 06 Nov 1994 08:49:37 GMT ++ Sunday, 06-Nov-94 08:49:37 GMT ++ Sun Nov 6 08:49:37 1994 + + +For more information on the HTTP-date format, see the World Wide Web Consortium (W3C) [3 Protocol Parameters](http://go.microsoft.com/fwlink/p/?linkid=133333) document. + +For an example of a full implementation of periodic notifications used in conjunction with the notification queue, see Scenario 3 in the [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476). + +## -examples + +## -see-also +[StartPeriodicUpdateBatch(IIterable(Uri), DateTime, PeriodicUpdateRecurrence)](tileupdater_startperiodicupdatebatch_1807273799.md), [StartPeriodicUpdate](tileupdater_startperiodicupdate.md), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Guidelines and checklist for periodic notifications](http://msdn.microsoft.com/library/4be95d67-2adf-4d0e-83e1-4ad25e0f4c0b), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1807273799.md b/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1807273799.md index be7757f631..0d7ee86627 100644 --- a/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1807273799.md +++ b/windows.ui.notifications/tileupdater_startperiodicupdatebatch_1807273799.md @@ -1,83 +1,83 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch(Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Foundation.DateTime,Windows.UI.Notifications.PeriodicUpdateRecurrence) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch - -## -description -Begins a series of timed updates that cycle on the tile that the updater is bound to. Update content is retrieved from an array of specified Uniform Resource Identifier (URI) with updates beginning at a specified time and subsequent updates occurring at the periodic interval thereafter. - -> [!NOTE] -> To use this feature, you must first enable the tile's notification queue by calling [EnableNotificationQueue](tileupdater_enablenotificationqueue.md). - -## -parameters -### -param tileContents -An array of up to five Uniform Resource Identifier (URI) from which the XML content of the cycling tile updates will be retrieved. If the array contains more than five Uniform Resource Identifier (URI), the method will fail. - -### -param startTime -The time at which the initial Uniform Resource Identifier (URI) should first be polled for new content. - -### -param requestedInterval -The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. - -## -remarks -### Using the notification queue with periodic updates - -To use the notification queue, you must first enable it for your tile with this line of code: - - - -```javascript -Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true); -``` - - - -This API only needs to be called once in your app's lifetime, but there is no harm in calling it each time the app launches. - -In the case of periodic notifications, a unique URL is provided for each notification. Each URL is polled on a periodic basis by Windows for updated notification content. The content payload returned from each URL should contain versions of the notification XML for all supported tile sizes. Each polled URL also can optionally return its own unique expiration time and tag value. - -### Tagging notifications for periodic updates - -With the notification queue enabled, your tile can cycle through a maximum of five queued notifications. Generally, the oldest notification is replaced in the queue when a new notification arrives. However, notifications can be given a tag so that a new notification with a specific tag will replace an older notification with the same tag, regardless of its place in the queue. - -Tags are optional strings of up to 16 characters that can be set on a notification as an identifier. If a new notification arrives with the same tag as a notification already in the queue, the new notification replaces the old one rather than falling under the default first-in, first-out queue behavior. This prevents the case where two versions of the same notification— one of them out-of-date— are present in the queue at the same time. - -In the case of periodic notifications, tags are provided in the X-WNS-Tag header of the notification's HTTP response message, which also includes the notification's content. This message is sent in response to the system's periodic call to the notification's Uniform Resource Identifier (URI). The header name and the tag value are case-insensitive. - -An example is shown here: - -```html -X-WNS-Tag: stockMSFT -``` - - - -### Setting an expiration time for periodic updates - -Tiles expire by default after three days. If your notification content has a significantly different useful lifespan— shorter or longer— you should explicitly set an expiration time for each notification. This prevents stale or irrelevant content from remaining in the queue. This is especially important if the user's machine loses Internet connectivity for a long period of time. - - -For example, during active trading, it would be advisable for a stock app to set the expiration on a stock price notification to twice that of your polling interval, such as a notification that expires one hour after it is sent if you poll for an update every half-hour. In the case of a news app, an expiration of one day for a tile that shows the top daily news would be appropriate. - -For periodic notifications, the expiration time is set in the X-WNS-Expires header of the notification's HTTP response message. The expiration time is expressed as an HTTP-date, which uses one of the formats shown in these examples: - - -+ Sun, 06 Nov 1994 08:49:37 GMT -+ Sunday, 06-Nov-94 08:49:37 GMT -+ Sun Nov 6 08:49:37 1994 - - -For more information on the HTTP-date format, see the World Wide Web Consortium (W3C) [3 Protocol Parameters](http://go.microsoft.com/fwlink/p/?linkid=133333) document. - -For an example of a full implementation of periodic notifications used in conjunction with the notification queue, see Scenario 3 in the [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476). - -## -examples - -## -see-also -[StartPeriodicUpdateBatch(IIterable(Uri), PeriodicUpdateRecurrence)](tileupdater_startperiodicupdatebatch_1331011351.md), [StartPeriodicUpdate](tileupdater_startperiodicupdate.md), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Guidelines and checklist for periodic notifications](XREF:TODO:m_ui_tiles.guidelines_for_polling), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch(Windows.Foundation.Collections.IIterable{Windows.Foundation.Uri},Windows.Foundation.DateTime,Windows.UI.Notifications.PeriodicUpdateRecurrence) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.StartPeriodicUpdateBatch + +## -description +Begins a series of timed updates that cycle on the tile that the updater is bound to. Update content is retrieved from an array of specified Uniform Resource Identifier (URI) with updates beginning at a specified time and subsequent updates occurring at the periodic interval thereafter. + +> [!NOTE] +> To use this feature, you must first enable the tile's notification queue by calling [EnableNotificationQueue](tileupdater_enablenotificationqueue.md). + +## -parameters +### -param tileContents +An array of up to five Uniform Resource Identifier (URI) from which the XML content of the cycling tile updates will be retrieved. If the array contains more than five Uniform Resource Identifier (URI), the method will fail. + +### -param startTime +The time at which the initial Uniform Resource Identifier (URI) should first be polled for new content. + +### -param requestedInterval +The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*. + +## -remarks +### Using the notification queue with periodic updates + +To use the notification queue, you must first enable it for your tile with this line of code: + + + +```javascript +Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true); +``` + + + +This API only needs to be called once in your app's lifetime, but there is no harm in calling it each time the app launches. + +In the case of periodic notifications, a unique URL is provided for each notification. Each URL is polled on a periodic basis by Windows for updated notification content. The content payload returned from each URL should contain versions of the notification XML for all supported tile sizes. Each polled URL also can optionally return its own unique expiration time and tag value. + +### Tagging notifications for periodic updates + +With the notification queue enabled, your tile can cycle through a maximum of five queued notifications. Generally, the oldest notification is replaced in the queue when a new notification arrives. However, notifications can be given a tag so that a new notification with a specific tag will replace an older notification with the same tag, regardless of its place in the queue. + +Tags are optional strings of up to 16 characters that can be set on a notification as an identifier. If a new notification arrives with the same tag as a notification already in the queue, the new notification replaces the old one rather than falling under the default first-in, first-out queue behavior. This prevents the case where two versions of the same notification— one of them out-of-date— are present in the queue at the same time. + +In the case of periodic notifications, tags are provided in the X-WNS-Tag header of the notification's HTTP response message, which also includes the notification's content. This message is sent in response to the system's periodic call to the notification's Uniform Resource Identifier (URI). The header name and the tag value are case-insensitive. + +An example is shown here: + +```html +X-WNS-Tag: stockMSFT +``` + + + +### Setting an expiration time for periodic updates + +Tiles expire by default after three days. If your notification content has a significantly different useful lifespan— shorter or longer— you should explicitly set an expiration time for each notification. This prevents stale or irrelevant content from remaining in the queue. This is especially important if the user's machine loses Internet connectivity for a long period of time. + + +For example, during active trading, it would be advisable for a stock app to set the expiration on a stock price notification to twice that of your polling interval, such as a notification that expires one hour after it is sent if you poll for an update every half-hour. In the case of a news app, an expiration of one day for a tile that shows the top daily news would be appropriate. + +For periodic notifications, the expiration time is set in the X-WNS-Expires header of the notification's HTTP response message. The expiration time is expressed as an HTTP-date, which uses one of the formats shown in these examples: + + ++ Sun, 06 Nov 1994 08:49:37 GMT ++ Sunday, 06-Nov-94 08:49:37 GMT ++ Sun Nov 6 08:49:37 1994 + + +For more information on the HTTP-date format, see the World Wide Web Consortium (W3C) [3 Protocol Parameters](http://go.microsoft.com/fwlink/p/?linkid=133333) document. + +For an example of a full implementation of periodic notifications used in conjunction with the notification queue, see Scenario 3 in the [Push and periodic notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231476). + +## -examples + +## -see-also +[StartPeriodicUpdateBatch(IIterable(Uri), PeriodicUpdateRecurrence)](tileupdater_startperiodicupdatebatch_1331011351.md), [StartPeriodicUpdate](tileupdater_startperiodicupdate.md), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Guidelines and checklist for periodic notifications](http://msdn.microsoft.com/library/4be95d67-2adf-4d0e-83e1-4ad25e0f4c0b), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_stopperiodicupdate_376301793.md b/windows.ui.notifications/tileupdater_stopperiodicupdate_376301793.md index d5c346b963..3f90c5a1b8 100644 --- a/windows.ui.notifications/tileupdater_stopperiodicupdate_376301793.md +++ b/windows.ui.notifications/tileupdater_stopperiodicupdate_376301793.md @@ -1,20 +1,20 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.StopPeriodicUpdate --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.StopPeriodicUpdate - -## -description -Cancels the current series of timed updates for the tile that the updater is bound to. - -## -remarks - -## -examples - -## -see-also -[How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Guidelines and checklist for periodic notifications](XREF:TODO:m_ui_tiles.guidelines_for_polling), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.StopPeriodicUpdate +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.StopPeriodicUpdate + +## -description +Cancels the current series of timed updates for the tile that the updater is bound to. + +## -remarks + +## -examples + +## -see-also +[How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Guidelines and checklist for periodic notifications](http://msdn.microsoft.com/library/4be95d67-2adf-4d0e-83e1-4ad25e0f4c0b), [App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/tileupdater_update_673402202.md b/windows.ui.notifications/tileupdater_update_673402202.md index 71f61b70f0..d3b6d8e89c 100644 --- a/windows.ui.notifications/tileupdater_update_673402202.md +++ b/windows.ui.notifications/tileupdater_update_673402202.md @@ -1,48 +1,48 @@ ---- --api-id: M:Windows.UI.Notifications.TileUpdater.Update(Windows.UI.Notifications.TileNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.TileUpdater.Update - -## -description -Applies a change in content or appearance to the tile. - -## -parameters -### -param notification -The object that supplies the new XML definition for the tile's content. - -## -remarks - -## -examples -The following example shows [Update](tileupdater_update.md) used to send a notification to the app's tile. - -```javascript - -function sendTileTextNotification() { - var Notifications = Windows.UI.Notifications; - - // Get an XML DOM version of a specific template by using getTemplateContent. - var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text03); - - // You will need to look at the template documentation to know how many text fields a particular template has. - // Get the text attribute for this template and fill it in. - var tileAttributes = tileXml.getElementsByTagName("text"); - tileAttributes[0].appendChild(tileXml.createTextNode("Hello World!")); - - // Create the notification from the XML. - var tileNotification = new Notifications.TileNotification(tileXml); - - // Send the notification to the calling app's tile. - Notifications.TileUpdateManager.createTileUpdaterForApplication().update(tileNotification); -} -``` - - - -## -see-also -[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [How to set up periodic notifications for tiles](XREF:TODO:m_ui_tiles.howto_setup_tile_polling), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.TileUpdater.Update(Windows.UI.Notifications.TileNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.TileUpdater.Update + +## -description +Applies a change in content or appearance to the tile. + +## -parameters +### -param notification +The object that supplies the new XML definition for the tile's content. + +## -remarks + +## -examples +The following example shows [Update](tileupdater_update.md) used to send a notification to the app's tile. + +```javascript + +function sendTileTextNotification() { + var Notifications = Windows.UI.Notifications; + + // Get an XML DOM version of a specific template by using getTemplateContent. + var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text03); + + // You will need to look at the template documentation to know how many text fields a particular template has. + // Get the text attribute for this template and fill it in. + var tileAttributes = tileXml.getElementsByTagName("text"); + tileAttributes[0].appendChild(tileXml.createTextNode("Hello World!")); + + // Create the notification from the XML. + var tileNotification = new Notifications.TileNotification(tileXml); + + // Send the notification to the calling app's tile. + Notifications.TileUpdateManager.createTileUpdaterForApplication().update(tileNotification); +} +``` + + + +## -see-also +[App tiles and badges sample](http://go.microsoft.com/fwlink/p/?linkid=231469), [Quickstart: Sending a tile update](http://msdn.microsoft.com/library/d4b2cebf-9dec-4c8f-bc6d-23edca7aaf83), [Tile and tile notification overview](http://msdn.microsoft.com/library/10a05b52-42c4-4f85-9310-57663e378b9e), [The tile template catalog](http://msdn.microsoft.com/library/2d3dd627-9a34-493c-bda4-ff7b80817e4f), [Guidelines and checklist for tiles](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [How to schedule a tile notification](http://msdn.microsoft.com/library/56b0c3e3-be90-4461-a8b1-79e88072b37c), [How to use the notification queue with local notifications](http://msdn.microsoft.com/library/614a784e-f418-46f7-b961-cef128779fea), [How to set up periodic notifications for tiles](http://msdn.microsoft.com/library/96c67773-2e5b-4278-b16d-2f813b16580c), [Tiles XML schema](XREF:TODO:tile.Schema_Root) \ No newline at end of file diff --git a/windows.ui.notifications/toastcollection.md b/windows.ui.notifications/toastcollection.md new file mode 100644 index 0000000000..8e51cf16d6 --- /dev/null +++ b/windows.ui.notifications/toastcollection.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Notifications.ToastCollection +-api-type: winrt class +--- + + + +# Windows.UI.Notifications.ToastCollection + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollection_displayname.md b/windows.ui.notifications/toastcollection_displayname.md new file mode 100644 index 0000000000..921c795b3e --- /dev/null +++ b/windows.ui.notifications/toastcollection_displayname.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastCollection.DisplayName +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastCollection.DisplayName + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollection_icon.md b/windows.ui.notifications/toastcollection_icon.md new file mode 100644 index 0000000000..354ded94bd --- /dev/null +++ b/windows.ui.notifications/toastcollection_icon.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastCollection.Icon +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastCollection.Icon + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollection_id.md b/windows.ui.notifications/toastcollection_id.md new file mode 100644 index 0000000000..659222436d --- /dev/null +++ b/windows.ui.notifications/toastcollection_id.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastCollection.Id +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastCollection.Id + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollection_launchargs.md b/windows.ui.notifications/toastcollection_launchargs.md new file mode 100644 index 0000000000..dd495ebb98 --- /dev/null +++ b/windows.ui.notifications/toastcollection_launchargs.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastCollection.LaunchArgs +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastCollection.LaunchArgs + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollection_toastcollection_268912356.md b/windows.ui.notifications/toastcollection_toastcollection_268912356.md new file mode 100644 index 0000000000..d7f6769763 --- /dev/null +++ b/windows.ui.notifications/toastcollection_toastcollection_268912356.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastCollection.#ctor(System.String,System.String,System.String,Windows.Foundation.Uri) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastCollection.ToastCollection + +## -description + +## -parameters + +### -param collectionId + +### -param displayName + +### -param launchArgs + +### -param iconUri + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager.md b/windows.ui.notifications/toastcollectionmanager.md new file mode 100644 index 0000000000..d40aa34263 --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Notifications.ToastCollectionManager +-api-type: winrt class +--- + + + +# Windows.UI.Notifications.ToastCollectionManager + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager_appid.md b/windows.ui.notifications/toastcollectionmanager_appid.md new file mode 100644 index 0000000000..67c533d610 --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager_appid.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastCollectionManager.AppId +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastCollectionManager.AppId + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager_findalltoastcollectionsasync_586141598.md b/windows.ui.notifications/toastcollectionmanager_findalltoastcollectionsasync_586141598.md new file mode 100644 index 0000000000..64f2845594 --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager_findalltoastcollectionsasync_586141598.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastCollectionManager.FindAllToastCollectionsAsync +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastCollectionManager.FindAllToastCollectionsAsync + +## -description + +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager_gettoastcollectionasync_768283177.md b/windows.ui.notifications/toastcollectionmanager_gettoastcollectionasync_768283177.md new file mode 100644 index 0000000000..87946b799e --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager_gettoastcollectionasync_768283177.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastCollectionManager.GetToastCollectionAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastCollectionManager.GetToastCollectionAsync + +## -description + +## -parameters + +### -param collectionId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager_removealltoastcollectionsasync_672530661.md b/windows.ui.notifications/toastcollectionmanager_removealltoastcollectionsasync_672530661.md new file mode 100644 index 0000000000..25ddeedf00 --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager_removealltoastcollectionsasync_672530661.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastCollectionManager.RemoveAllToastCollectionsAsync +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastCollectionManager.RemoveAllToastCollectionsAsync + +## -description + +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager_removetoastcollectionasync_1821853246.md b/windows.ui.notifications/toastcollectionmanager_removetoastcollectionasync_1821853246.md new file mode 100644 index 0000000000..f30cce1e3e --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager_removetoastcollectionasync_1821853246.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastCollectionManager.RemoveToastCollectionAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastCollectionManager.RemoveToastCollectionAsync + +## -description + +## -parameters + +### -param collectionId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager_savetoastcollectionasync_414846713.md b/windows.ui.notifications/toastcollectionmanager_savetoastcollectionasync_414846713.md new file mode 100644 index 0000000000..e56bd7407e --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager_savetoastcollectionasync_414846713.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastCollectionManager.SaveToastCollectionAsync(Windows.UI.Notifications.ToastCollection) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastCollectionManager.SaveToastCollectionAsync + +## -description + +## -parameters + +### -param collection + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastcollectionmanager_user.md b/windows.ui.notifications/toastcollectionmanager_user.md new file mode 100644 index 0000000000..dd7745614f --- /dev/null +++ b/windows.ui.notifications/toastcollectionmanager_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastCollectionManager.User +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastCollectionManager.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastdismissalreason.md b/windows.ui.notifications/toastdismissalreason.md index cef77b8bf0..5fd645d8ae 100644 --- a/windows.ui.notifications/toastdismissalreason.md +++ b/windows.ui.notifications/toastdismissalreason.md @@ -30,4 +30,4 @@ The toast notification had been shown for the maximum allowed time and was faded ## -examples ## -see-also -[ToastDismissedEventArgs.Reason](toastdismissedeventargs_reason.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +[ToastDismissedEventArgs.Reason](toastdismissedeventargs_reason.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastdismissedeventargs.md b/windows.ui.notifications/toastdismissedeventargs.md index 442841ca1a..304a724918 100644 --- a/windows.ui.notifications/toastdismissedeventargs.md +++ b/windows.ui.notifications/toastdismissedeventargs.md @@ -18,4 +18,4 @@ Your app receives this class when processing the [ToastNotification.Dismissed](t ## -examples ## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastdismissedeventargs_reason.md b/windows.ui.notifications/toastdismissedeventargs_reason.md index 575d44cff4..85e6ea5ca9 100644 --- a/windows.ui.notifications/toastdismissedeventargs_reason.md +++ b/windows.ui.notifications/toastdismissedeventargs_reason.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.Notifications.ToastDismissedEventArgs.Reason --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ToastDismissedEventArgs.Reason - -## -description -Gets the reason that a toast notification is no longer displayed on-screen. - -## -property-value -One of the enumeration values that specify why a toast is no longer being shown. - -## -remarks - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ToastDismissedEventArgs.Reason +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastDismissedEventArgs.Reason + +## -description +Gets the reason that a toast notification is no longer displayed on-screen. + +## -property-value +One of the enumeration values that specify why a toast is no longer being shown. + +## -remarks + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastfailedeventargs.md b/windows.ui.notifications/toastfailedeventargs.md index 0c42e90a5a..e982cc065c 100644 --- a/windows.ui.notifications/toastfailedeventargs.md +++ b/windows.ui.notifications/toastfailedeventargs.md @@ -18,4 +18,4 @@ Your app receives this class when processing the [ToastNotification.Failed](toas ## -examples ## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastfailedeventargs_errorcode.md b/windows.ui.notifications/toastfailedeventargs_errorcode.md index 9b002ca434..21db62fa6c 100644 --- a/windows.ui.notifications/toastfailedeventargs_errorcode.md +++ b/windows.ui.notifications/toastfailedeventargs_errorcode.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.Notifications.ToastFailedEventArgs.ErrorCode --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ToastFailedEventArgs.ErrorCode - -## -description -Gets the error code that was generated in the process of raising a toast notification. - -## -property-value -One of the standard system error codes. - -## -remarks - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ToastFailedEventArgs.ErrorCode +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastFailedEventArgs.ErrorCode + +## -description +Gets the error code that was generated in the process of raising a toast notification. + +## -property-value +One of the standard system error codes. + +## -remarks + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotification.md b/windows.ui.notifications/toastnotification.md index 612947d234..3914ed280a 100644 --- a/windows.ui.notifications/toastnotification.md +++ b/windows.ui.notifications/toastnotification.md @@ -75,4 +75,4 @@ yourToastNotification.addEventListener("dismissed", function (e) { ## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotification_activated.md b/windows.ui.notifications/toastnotification_activated.md index 3f13782ca9..5e40eb7e13 100644 --- a/windows.ui.notifications/toastnotification_activated.md +++ b/windows.ui.notifications/toastnotification_activated.md @@ -1,23 +1,23 @@ ---- --api-id: E:Windows.UI.Notifications.ToastNotification.Activated --api-type: winrt event ---- - - - -# Windows.UI.Notifications.ToastNotification.Activated - -## -description -Occurs when user activates a toast notification through a click or touch. Apps that are running subscribe to this event - -. - -## -remarks -In the case of toast raised by a desktop app, that app must subscribe to at least the [Activated](toastnotification_activated.md) event so that it can handle the expected activation of the app from the toast when the user selects it. - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: E:Windows.UI.Notifications.ToastNotification.Activated +-api-type: winrt event +--- + + + +# Windows.UI.Notifications.ToastNotification.Activated + +## -description +Occurs when user activates a toast notification through a click or touch. Apps that are running subscribe to this event + +. + +## -remarks +In the case of toast raised by a desktop app, that app must subscribe to at least the [Activated](toastnotification_activated.md) event so that it can handle the expected activation of the app from the toast when the user selects it. + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotification_content.md b/windows.ui.notifications/toastnotification_content.md index bcc5c5bce5..4d2823d090 100644 --- a/windows.ui.notifications/toastnotification_content.md +++ b/windows.ui.notifications/toastnotification_content.md @@ -1,24 +1,24 @@ ---- --api-id: P:Windows.UI.Notifications.ToastNotification.Content --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ToastNotification.Content - -## -description -Gets the XML that defines the current toast notification. - -## -property-value -The object that contains the XML. - -## -remarks -The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions to customize the toast content. See [toast schema](XREF:TODO:toast.Schema_Root) for an explanation of toast elements and attributes. - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ToastNotification.Content +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastNotification.Content + +## -description +Gets the XML that defines the current toast notification. + +## -property-value +The object that contains the XML. + +## -remarks +The retrieved elements and their attributes are manipulated through Document Object Model (DOM) manipulation functions to customize the toast content. See [toast schema](XREF:TODO:toast.Schema_Root) for an explanation of toast elements and attributes. + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotification_data.md b/windows.ui.notifications/toastnotification_data.md new file mode 100644 index 0000000000..0830834865 --- /dev/null +++ b/windows.ui.notifications/toastnotification_data.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastNotification.Data +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastNotification.Data + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotification_dismissed.md b/windows.ui.notifications/toastnotification_dismissed.md index 7a3a3e7a0a..71fc9370a3 100644 --- a/windows.ui.notifications/toastnotification_dismissed.md +++ b/windows.ui.notifications/toastnotification_dismissed.md @@ -1,44 +1,44 @@ ---- --api-id: E:Windows.UI.Notifications.ToastNotification.Dismissed --api-type: winrt event ---- - - - -# Windows.UI.Notifications.ToastNotification.Dismissed - -## -description -Occurs when a toast notification leaves the screen, either by expiring or being explicitly dismissed by the user. Apps that are running subscribe to this event. - - -## -remarks -The [ToastDismissalReason](toastdismissalreason.md) is included in the [ToastDismissedEventArgs](toastdismissedeventargs.md) parameter. - -## -examples -The following example shows how to listen for and handle the [Dismissed](toastnotification_dismissed.md) event. - -```javascript - -var notifications = Windows.UI.Notifications; - -yourToastNotification.addEventListener("dismissed", function (e) { - switch (e.reason) { - case notifications.ToastDismissalReason.applicationHidden: - // The application hid the toast using ToastNotifier.hide. - break; - case notifications.ToastDismissalReason.userCanceled: - // The user dismissed the toast. - break; - case notifications.ToastDismissalReason.timedOut: - // The toast has expired. - break; - } -} -``` - - - -## -see-also -[ToastDismissedEventArgs](toastdismissedeventargs.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: E:Windows.UI.Notifications.ToastNotification.Dismissed +-api-type: winrt event +--- + + + +# Windows.UI.Notifications.ToastNotification.Dismissed + +## -description +Occurs when a toast notification leaves the screen, either by expiring or being explicitly dismissed by the user. Apps that are running subscribe to this event. + + +## -remarks +The [ToastDismissalReason](toastdismissalreason.md) is included in the [ToastDismissedEventArgs](toastdismissedeventargs.md) parameter. + +## -examples +The following example shows how to listen for and handle the [Dismissed](toastnotification_dismissed.md) event. + +```javascript + +var notifications = Windows.UI.Notifications; + +yourToastNotification.addEventListener("dismissed", function (e) { + switch (e.reason) { + case notifications.ToastDismissalReason.applicationHidden: + // The application hid the toast using ToastNotifier.hide. + break; + case notifications.ToastDismissalReason.userCanceled: + // The user dismissed the toast. + break; + case notifications.ToastDismissalReason.timedOut: + // The toast has expired. + break; + } +} +``` + + + +## -see-also +[ToastDismissedEventArgs](toastdismissedeventargs.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotification_expirationtime.md b/windows.ui.notifications/toastnotification_expirationtime.md index f3f94d7626..4fa10c61f9 100644 --- a/windows.ui.notifications/toastnotification_expirationtime.md +++ b/windows.ui.notifications/toastnotification_expirationtime.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.UI.Notifications.ToastNotification.ExpirationTime --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ToastNotification.ExpirationTime - -## -description -Gets or sets the time after which a toast notification should not be displayed. - -## -property-value -The date and time after which the toast is no longer considered current or valid and should not be displayed. - -## -remarks -Windows attempts to raise toast notifications immediately after you call [Show](toastnotifier_show.md), so this property is rarely used. - -> For Windows Phone Store app: this property also causes the toast notification to be removed from the action center once the specified date and time is reached. - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ToastNotification.ExpirationTime +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastNotification.ExpirationTime + +## -description +Gets or sets the time after which a toast notification should not be displayed. + +## -property-value +The date and time after which the toast is no longer considered current or valid and should not be displayed. + +## -remarks +Windows attempts to raise toast notifications immediately after you call [Show](toastnotifier_show.md), so this property is rarely used. + +> For Windows Phone Store app: this property also causes the toast notification to be removed from the action center once the specified date and time is reached. + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotification_failed.md b/windows.ui.notifications/toastnotification_failed.md index 8051141028..a6b3947008 100644 --- a/windows.ui.notifications/toastnotification_failed.md +++ b/windows.ui.notifications/toastnotification_failed.md @@ -1,25 +1,25 @@ ---- --api-id: E:Windows.UI.Notifications.ToastNotification.Failed --api-type: winrt event ---- - - - -# Windows.UI.Notifications.ToastNotification.Failed - -## -description -Occurs when an error is caused when Windows attempts to raise a toast notification. Apps that are running subscribe to this event - -. - -## -remarks -The reason for the toast's failure can be found in the [ErrorCode](toastfailedeventargs_errorcode.md) property of the [ToastFailedEventArgs](toastfailedeventargs.md) parameter. - -The most common failure that you'll see when you raise a toast is a [settings](notificationsetting.md) error, for instance a block on toast notifications for this user. We recommend that you call [ToastNotifier.Setting](toastnotifier_setting.md) before you call [Show](toastnotifier_show.md) instead of handling that situation through this event. - -## -examples - -## -see-also -[ToastFailedEventArgs](toastfailedeventargs.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: E:Windows.UI.Notifications.ToastNotification.Failed +-api-type: winrt event +--- + + + +# Windows.UI.Notifications.ToastNotification.Failed + +## -description +Occurs when an error is caused when Windows attempts to raise a toast notification. Apps that are running subscribe to this event + +. + +## -remarks +The reason for the toast's failure can be found in the [ErrorCode](toastfailedeventargs_errorcode.md) property of the [ToastFailedEventArgs](toastfailedeventargs.md) parameter. + +The most common failure that you'll see when you raise a toast is a [settings](notificationsetting.md) error, for instance a block on toast notifications for this user. We recommend that you call [ToastNotifier.Setting](toastnotifier_setting.md) before you call [Show](toastnotifier_show.md) instead of handling that situation through this event. + +## -examples + +## -see-also +[ToastFailedEventArgs](toastfailedeventargs.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotification_toastnotification_93177318.md b/windows.ui.notifications/toastnotification_toastnotification_93177318.md index 74ab444fc2..7071cd8f54 100644 --- a/windows.ui.notifications/toastnotification_toastnotification_93177318.md +++ b/windows.ui.notifications/toastnotification_toastnotification_93177318.md @@ -1,60 +1,60 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotification.ToastNotification - -## -description -Creates and initializes a new instance of the [ToastNotification](toastnotification.md). - -## -parameters -### -param content -The XML content that defines the toast notification. - -## -remarks - -## -examples -The following example shows how to create and send a toast notification that includes text and images, including use of the [ToastNotification](toastnotification_toastnotification.md) constructor. - -```javascript - -var notifications = Windows.UI.Notifications; - -// Get the toast notification manager for the current app. -var notificationManager = notifications.ToastNotificationManager; - -// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object -// that contains the toast notification XML content. -var template = notifications.toastTemplateType.toastImageAndText01; -var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); - -// You can use the methods from the XML document to specify the required elements for the toast. -var images = toastXml.getElementsByTagName("image"); -images[0].setAttribute("src", "images/toastImageAndText.png"); - -var textNodes = toastXml.getElementsByTagName("text"); -textNodes.forEach(function (value, index) { - var textNumber = index + 1; - var text = ""; - for (var j = 0; j < 10; j++) { - text += "Text input " + /*@static_cast(String)*/textNumber + " "; - } - value.appendChild(toastXml.createTextNode(text)); -}); - -// Create a toast notification from the XML, then create a ToastNotifier object -// to send the toast. -var toast = new notifications.ToastNotification(toastXml); - -notificationManager.createToastNotifier().show(toast); -``` - - - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotification.#ctor(Windows.Data.Xml.Dom.XmlDocument) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotification.ToastNotification + +## -description +Creates and initializes a new instance of the [ToastNotification](toastnotification.md). + +## -parameters +### -param content +The XML content that defines the toast notification. + +## -remarks + +## -examples +The following example shows how to create and send a toast notification that includes text and images, including use of the [ToastNotification](toastnotification_toastnotification.md) constructor. + +```javascript + +var notifications = Windows.UI.Notifications; + +// Get the toast notification manager for the current app. +var notificationManager = notifications.ToastNotificationManager; + +// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object +// that contains the toast notification XML content. +var template = notifications.toastTemplateType.toastImageAndText01; +var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); + +// You can use the methods from the XML document to specify the required elements for the toast. +var images = toastXml.getElementsByTagName("image"); +images[0].setAttribute("src", "images/toastImageAndText.png"); + +var textNodes = toastXml.getElementsByTagName("text"); +textNodes.forEach(function (value, index) { + var textNumber = index + 1; + var text = ""; + for (var j = 0; j < 10; j++) { + text += "Text input " + /*@static_cast(String)*/textNumber + " "; + } + value.appendChild(toastXml.createTextNode(text)); +}); + +// Create a toast notification from the XML, then create a ToastNotifier object +// to send the toast. +var toast = new notifications.ToastNotification(toastXml); + +notificationManager.createToastNotifier().show(toast); +``` + + + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Tiles, badges, and notifications](http://msdn.microsoft.com/library/48ee4328-7999-40c2-9354-7ea7d488c538), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotificationhistorychangedtriggerdetail_collectionid.md b/windows.ui.notifications/toastnotificationhistorychangedtriggerdetail_collectionid.md new file mode 100644 index 0000000000..71b4a68c99 --- /dev/null +++ b/windows.ui.notifications/toastnotificationhistorychangedtriggerdetail_collectionid.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.Notifications.ToastNotificationHistoryChangedTriggerDetail.CollectionId +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastNotificationHistoryChangedTriggerDetail.CollectionId + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotificationmanager.md b/windows.ui.notifications/toastnotificationmanager.md index fdb18fb5cf..74d61a3fdb 100644 --- a/windows.ui.notifications/toastnotificationmanager.md +++ b/windows.ui.notifications/toastnotificationmanager.md @@ -66,4 +66,4 @@ notificationManager.createToastNotifier().show(toast); ## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_1346219381.md b/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_1346219381.md index 67293d13b4..65444f2f23 100644 --- a/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_1346219381.md +++ b/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_1346219381.md @@ -1,62 +1,62 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier - -## -description -Creates and initializes a new instance of the [ToastNotification](toastnotification.md), bound to the calling application, that lets you raise a toast notification to that app. - -## -returns -The object you will use to send the toast notification to the app. - -## -remarks -Do not use this overload when creating a toast notifier for a desktop app. Use [CreateToastNotifier(appID)](toastnotificationmanager_createtoastnotifier_163337301.md) to supply the required [AppUserModelID](http://msdn.microsoft.com/library/ebce2d99-6f20-4545-9f12-d79cd8d0828f). - -If your app uses a [background voice-over-Internet protocol (VOIP) agent](XREF:TODO:405cff28-3276-49d8-ab73-87c01ce0258d), it must specify the app ID to show a toast. Use the [CreateToastNotifier(appID)](toastnotificationmanager_createtoastnotifier_163337301.md) method overload. - -## -examples -The following example shows how to create and send a toast notification that includes text and images, including the use of the [CreateToastNotifier](toastnotificationmanager_createtoastnotifier_1346219381.md) method. - -```javascript - -var notifications = Windows.UI.Notifications; - -// Get the toast notification manager for the current app. -var notificationManager = notifications.ToastNotificationManager; - -// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object -// that contains the toast notification XML content. -var template = notifications.toastTemplateType.toastImageAndText01; -var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); - -// You can use the methods from the XML document to specify the required elements for the toast. -var images = toastXml.getElementsByTagName("image"); -images[0].setAttribute("src", "images/toastImageAndText.png"); - -var textNodes = toastXml.getElementsByTagName("text"); -textNodes.forEach(function (value, index) { - var textNumber = index + 1; - var text = ""; - for (var j = 0; j < 10; j++) { - text += "Text input " + /*@static_cast(String)*/textNumber + " "; - } - value.appendChild(toastXml.createTextNode(text)); -}); - -// Create a toast notification from the XML, then create a ToastNotifier object -// to send the toast. -var toast = new notifications.ToastNotification(toastXml); - -notificationManager.createToastNotifier().show(toast); -``` - - - -## -see-also -[CreateToastNotifier(String)](toastnotificationmanager_createtoastnotifier_163337301.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier + +## -description +Creates and initializes a new instance of the [ToastNotification](toastnotification.md), bound to the calling application, that lets you raise a toast notification to that app. + +## -returns +The object you will use to send the toast notification to the app. + +## -remarks +Do not use this overload when creating a toast notifier for a desktop app. Use [CreateToastNotifier(appID)](toastnotificationmanager_createtoastnotifier_163337301.md) to supply the required [AppUserModelID](http://msdn.microsoft.com/library/ebce2d99-6f20-4545-9f12-d79cd8d0828f). + +If your app uses a [background voice-over-Internet protocol (VOIP) agent](XREF:TODO:405cff28-3276-49d8-ab73-87c01ce0258d), it must specify the app ID to show a toast. Use the [CreateToastNotifier(appID)](toastnotificationmanager_createtoastnotifier_163337301.md) method overload. + +## -examples +The following example shows how to create and send a toast notification that includes text and images, including the use of the [CreateToastNotifier](toastnotificationmanager_createtoastnotifier_1346219381.md) method. + +```javascript + +var notifications = Windows.UI.Notifications; + +// Get the toast notification manager for the current app. +var notificationManager = notifications.ToastNotificationManager; + +// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object +// that contains the toast notification XML content. +var template = notifications.toastTemplateType.toastImageAndText01; +var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); + +// You can use the methods from the XML document to specify the required elements for the toast. +var images = toastXml.getElementsByTagName("image"); +images[0].setAttribute("src", "images/toastImageAndText.png"); + +var textNodes = toastXml.getElementsByTagName("text"); +textNodes.forEach(function (value, index) { + var textNumber = index + 1; + var text = ""; + for (var j = 0; j < 10; j++) { + text += "Text input " + /*@static_cast(String)*/textNumber + " "; + } + value.appendChild(toastXml.createTextNode(text)); +}); + +// Create a toast notification from the XML, then create a ToastNotifier object +// to send the toast. +var toast = new notifications.ToastNotification(toastXml); + +notificationManager.createToastNotifier().show(toast); +``` + + + +## -see-also +[CreateToastNotifier(String)](toastnotificationmanager_createtoastnotifier_163337301.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_163337301.md b/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_163337301.md index 3c0d7c2a2a..9371f1097b 100644 --- a/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_163337301.md +++ b/windows.ui.notifications/toastnotificationmanager_createtoastnotifier_163337301.md @@ -1,46 +1,46 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier(System.String) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier - -## -description -Creates and initializes a new instance of the [ToastNotification](toastnotification.md), bound to a specified app, usually another app in the same package. - -## -parameters -### -param applicationId -The unique ID of the app. - -> [!NOTE] -> You can't send a toast notification to a secondary tile, so this must be the ID of an app tile. - -## -returns -The object you will use to send the toast notification to the tile. - -## -remarks -The app identified by *applicationId* must belong to the same package as the caller. - -Use this form of the method if your app uses a [background voice-over-Internet protocol (VOIP) agent](XREF:TODO:405cff28-3276-49d8-ab73-87c01ce0258d), to specify the app ID required to show a toast in that case. - -### Sending toast notifications from desktop apps - -Generally, sending a toast notification from a desktop app is the same as sending it from a Windows Store app. However, you should be aware of these differences and requirements: -+ For a desktop app to display a toast, the app must have a shortcut on the Start screen. -+ The shortcut must have an [AppUserModelID](http://msdn.microsoft.com/library/ebce2d99-6f20-4545-9f12-d79cd8d0828f). -+ Desktop apps cannot schedule a toast. - - -For more information, see these topics: -+ [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314) -+ [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e) - - -## -examples - -## -see-also -[CreateToastNotifier](toastnotificationmanager_createtoastnotifier_1346219381.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier + +## -description +Creates and initializes a new instance of the [ToastNotification](toastnotification.md), bound to a specified app, usually another app in the same package. + +## -parameters +### -param applicationId +The unique ID of the app. + +> [!NOTE] +> You can't send a toast notification to a secondary tile, so this must be the ID of an app tile. + +## -returns +The object you will use to send the toast notification to the tile. + +## -remarks +The app identified by *applicationId* must belong to the same package as the caller. + +Use this form of the method if your app uses a [background voice-over-Internet protocol (VOIP) agent](XREF:TODO:405cff28-3276-49d8-ab73-87c01ce0258d), to specify the app ID required to show a toast in that case. + +### Sending toast notifications from desktop apps + +Generally, sending a toast notification from a desktop app is the same as sending it from a Windows Store app. However, you should be aware of these differences and requirements: ++ For a desktop app to display a toast, the app must have a shortcut on the Start screen. ++ The shortcut must have an [AppUserModelID](http://msdn.microsoft.com/library/ebce2d99-6f20-4545-9f12-d79cd8d0828f). ++ Desktop apps cannot schedule a toast. + + +For more information, see these topics: ++ [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314) ++ [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e) + + +## -examples + +## -see-also +[CreateToastNotifier](toastnotificationmanager_createtoastnotifier_1346219381.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotificationmanager_getdefault_846721868.md b/windows.ui.notifications/toastnotificationmanager_getdefault_846721868.md new file mode 100644 index 0000000000..e5f3d89fd8 --- /dev/null +++ b/windows.ui.notifications/toastnotificationmanager_getdefault_846721868.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManager.GetDefault + +## -description + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotificationmanager_gettemplatecontent_687642458.md b/windows.ui.notifications/toastnotificationmanager_gettemplatecontent_687642458.md index 2e941fd9fd..be53dbdba3 100644 --- a/windows.ui.notifications/toastnotificationmanager_gettemplatecontent_687642458.md +++ b/windows.ui.notifications/toastnotificationmanager_gettemplatecontent_687642458.md @@ -1,66 +1,66 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotificationManager.GetTemplateContent(Windows.UI.Notifications.ToastTemplateType) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotificationManager.GetTemplateContent - -## -description -Gets the XML content of one of the predefined toast templates so that you can customize it for use in your notification. - -## -parameters -### -param type -One of the system-provided toast templates. - -## -returns -The object that contains the template XML. - -## -remarks -Instead of creating the full XML payload yourself, you can get a template and then use Document Object Model (DOM) manipulation functions to customize the part of the content that you want to change. You package this XML in a [ToastNotification](toastnotification.md) and send it to the tile through the [ToastNotifier](toastnotifier.md) that you create through the other methods of this class. - -See [tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes. - -## -examples -The following example shows how to create and send a toast notification that includes text and images, including the use of the [GetTemplateContent](toastnotificationmanager_gettemplatecontent.md) method. - -```javascript - -var notifications = Windows.UI.Notifications; - -// Get the toast notification manager for the current app. -var notificationManager = notifications.ToastNotificationManager; - -// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object -// that contains the toast notification XML content. -var template = notifications.toastTemplateType.toastImageAndText01; -var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); - -// You can use the methods from the XML document to specify the required elements for the toast. -var images = toastXml.getElementsByTagName("image"); -images[0].setAttribute("src", "images/toastImageAndText.png"); - -var textNodes = toastXml.getElementsByTagName("text"); -textNodes.forEach(function (value, index) { - var textNumber = index + 1; - var text = ""; - for (var j = 0; j < 10; j++) { - text += "Text input " + /*@static_cast(String)*/textNumber + " "; - } - value.appendChild(toastXml.createTextNode(text)); -}); - -// Create a toast notification from the XML, then create a ToastNotifier object -// to send the toast. -var toast = new notifications.ToastNotification(toastXml); - -notificationManager.createToastNotifier().show(toast); -``` - - - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManager.GetTemplateContent(Windows.UI.Notifications.ToastTemplateType) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManager.GetTemplateContent + +## -description +Gets the XML content of one of the predefined toast templates so that you can customize it for use in your notification. + +## -parameters +### -param type +One of the system-provided toast templates. + +## -returns +The object that contains the template XML. + +## -remarks +Instead of creating the full XML payload yourself, you can get a template and then use Document Object Model (DOM) manipulation functions to customize the part of the content that you want to change. You package this XML in a [ToastNotification](toastnotification.md) and send it to the tile through the [ToastNotifier](toastnotifier.md) that you create through the other methods of this class. + +See [tile schema](XREF:TODO:tile.Schema_Root) for an explanation of tile elements and attributes. + +## -examples +The following example shows how to create and send a toast notification that includes text and images, including the use of the [GetTemplateContent](toastnotificationmanager_gettemplatecontent.md) method. + +```javascript + +var notifications = Windows.UI.Notifications; + +// Get the toast notification manager for the current app. +var notificationManager = notifications.ToastNotificationManager; + +// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object +// that contains the toast notification XML content. +var template = notifications.toastTemplateType.toastImageAndText01; +var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); + +// You can use the methods from the XML document to specify the required elements for the toast. +var images = toastXml.getElementsByTagName("image"); +images[0].setAttribute("src", "images/toastImageAndText.png"); + +var textNodes = toastXml.getElementsByTagName("text"); +textNodes.forEach(function (value, index) { + var textNumber = index + 1; + var text = ""; + for (var j = 0; j < 10; j++) { + text += "Text input " + /*@static_cast(String)*/textNumber + " "; + } + value.appendChild(toastXml.createTextNode(text)); +}); + +// Create a toast notification from the XML, then create a ToastNotifier object +// to send the toast. +var toast = new notifications.ToastNotification(toastXml); + +notificationManager.createToastNotifier().show(toast); +``` + + + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotificationmanagerforuser_gethistoryfortoastcollectionidasync_2061078699.md b/windows.ui.notifications/toastnotificationmanagerforuser_gethistoryfortoastcollectionidasync_2061078699.md new file mode 100644 index 0000000000..b2a8b1c456 --- /dev/null +++ b/windows.ui.notifications/toastnotificationmanagerforuser_gethistoryfortoastcollectionidasync_2061078699.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManagerForUser.GetHistoryForToastCollectionIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManagerForUser.GetHistoryForToastCollectionIdAsync + +## -description + +## -parameters + +### -param collectionId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotificationmanagerforuser_gettoastcollectionmanager_1041520590.md b/windows.ui.notifications/toastnotificationmanagerforuser_gettoastcollectionmanager_1041520590.md new file mode 100644 index 0000000000..237d3a871a --- /dev/null +++ b/windows.ui.notifications/toastnotificationmanagerforuser_gettoastcollectionmanager_1041520590.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManagerForUser.GetToastCollectionManager +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManagerForUser.GetToastCollectionManager + +## -description + +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotificationmanagerforuser_gettoastcollectionmanager_1737862894.md b/windows.ui.notifications/toastnotificationmanagerforuser_gettoastcollectionmanager_1737862894.md new file mode 100644 index 0000000000..99a1256e4b --- /dev/null +++ b/windows.ui.notifications/toastnotificationmanagerforuser_gettoastcollectionmanager_1737862894.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManagerForUser.GetToastCollectionManager(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManagerForUser.GetToastCollectionManager + +## -description + +## -parameters + +### -param appId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotificationmanagerforuser_gettoastnotifierfortoastcollectionidasync_1381199205.md b/windows.ui.notifications/toastnotificationmanagerforuser_gettoastnotifierfortoastcollectionidasync_1381199205.md new file mode 100644 index 0000000000..ca1d4e3ede --- /dev/null +++ b/windows.ui.notifications/toastnotificationmanagerforuser_gettoastnotifierfortoastcollectionidasync_1381199205.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastNotificationManagerForUser.GetToastNotifierForToastCollectionIdAsync(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotificationManagerForUser.GetToastNotifierForToastCollectionIdAsync + +## -description + +## -parameters + +### -param collectionId + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotifier.md b/windows.ui.notifications/toastnotifier.md index 842be26d52..6ed4c3a285 100644 --- a/windows.ui.notifications/toastnotifier.md +++ b/windows.ui.notifications/toastnotifier.md @@ -73,4 +73,4 @@ for (var i = 0, len = scheduled.length; i < len; i++) { ## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotifier_addtoschedule_1355516744.md b/windows.ui.notifications/toastnotifier_addtoschedule_1355516744.md index 599a3749c5..f066750b98 100644 --- a/windows.ui.notifications/toastnotifier_addtoschedule_1355516744.md +++ b/windows.ui.notifications/toastnotifier_addtoschedule_1355516744.md @@ -1,37 +1,37 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotifier.AddToSchedule(Windows.UI.Notifications.ScheduledToastNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotifier.AddToSchedule - -## -description -Adds a [ScheduledToastNotification](scheduledtoastnotification.md) for later display by Windows. - -> [!IMPORTANT] -> This method cannot be used by desktop callers. - -## -parameters -### -param scheduledToast -The scheduled toast notification, which includes its content and timing instructions. - -## -remarks -This method passes the toast notification to the schedule but doesn't specify the time the toast should display. That information is included in the [ScheduledToastNotification](scheduledtoastnotification.md). - -If your call to this method returns a failure code, examine these possible causes: -+ **Possible cause**: You've exceeded the maximum allowed number of scheduled notifications. - -**Fix**: [ToastNotifier.addToSchedule](toastnotifier_addtoschedule.md) will fail if you attempt to schedule more than 4096 notifications. Reduce your number of scheduled notifications. -+ **Possible cause**: Your notification is scheduled for a time in the past relative to the current system clock time. - -**Fix**: Make sure that the scheduled notification time specified in your [ScheduledToastNotification](scheduledtoastnotification.md) is in the future. Examine the system clock time. - - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotifier.AddToSchedule(Windows.UI.Notifications.ScheduledToastNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotifier.AddToSchedule + +## -description +Adds a [ScheduledToastNotification](scheduledtoastnotification.md) for later display by Windows. + +> [!IMPORTANT] +> This method cannot be used by desktop callers. + +## -parameters +### -param scheduledToast +The scheduled toast notification, which includes its content and timing instructions. + +## -remarks +This method passes the toast notification to the schedule but doesn't specify the time the toast should display. That information is included in the [ScheduledToastNotification](scheduledtoastnotification.md). + +If your call to this method returns a failure code, examine these possible causes: ++ **Possible cause**: You've exceeded the maximum allowed number of scheduled notifications. + +**Fix**: [ToastNotifier.addToSchedule](toastnotifier_addtoschedule.md) will fail if you attempt to schedule more than 4096 notifications. Reduce your number of scheduled notifications. ++ **Possible cause**: Your notification is scheduled for a time in the past relative to the current system clock time. + +**Fix**: Make sure that the scheduled notification time specified in your [ScheduledToastNotification](scheduledtoastnotification.md) is in the future. Examine the system clock time. + + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotifier_getscheduledtoastnotifications_1959697028.md b/windows.ui.notifications/toastnotifier_getscheduledtoastnotifications_1959697028.md index a157c4496d..77d425be58 100644 --- a/windows.ui.notifications/toastnotifier_getscheduledtoastnotifications_1959697028.md +++ b/windows.ui.notifications/toastnotifier_getscheduledtoastnotifications_1959697028.md @@ -1,44 +1,44 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotifier.GetScheduledToastNotifications --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotifier.GetScheduledToastNotifications - -## -description -Gets the collection of [ScheduledToastNotification](scheduledtoastnotification.md) objects that this app has scheduled for display. - -> [!IMPORTANT] -> This method cannot be used by desktop callers. - -## -returns -The collection of scheduled toast notifications that the app bound to this notifier has scheduled for timed display. - -## -remarks - -## -examples -The following example shows the use of the [GetScheduledToastNotifications](toastnotifier_getscheduledtoastnotifications.md) method. - -```javascript - -var notifier = Notifications.ToastNotificationManager.createToastNotifier(); -var scheduled = notifier.getScheduledToastNotifications(); - -for (var i = 0, len = scheduled.length; i < len; i++) { - - // The itemId value is the unique ScheduledTileNotification.Id assigned to the - // notification when it was created. - if (scheduled[i].id === itemId) { - notifier.removeFromSchedule(scheduled[i]); - } -} -``` - - - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotifier.GetScheduledToastNotifications +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotifier.GetScheduledToastNotifications + +## -description +Gets the collection of [ScheduledToastNotification](scheduledtoastnotification.md) objects that this app has scheduled for display. + +> [!IMPORTANT] +> This method cannot be used by desktop callers. + +## -returns +The collection of scheduled toast notifications that the app bound to this notifier has scheduled for timed display. + +## -remarks + +## -examples +The following example shows the use of the [GetScheduledToastNotifications](toastnotifier_getscheduledtoastnotifications.md) method. + +```javascript + +var notifier = Notifications.ToastNotificationManager.createToastNotifier(); +var scheduled = notifier.getScheduledToastNotifications(); + +for (var i = 0, len = scheduled.length; i < len; i++) { + + // The itemId value is the unique ScheduledTileNotification.Id assigned to the + // notification when it was created. + if (scheduled[i].id === itemId) { + notifier.removeFromSchedule(scheduled[i]); + } +} +``` + + + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotifier_hide_1807990681.md b/windows.ui.notifications/toastnotifier_hide_1807990681.md index 8623f82dd0..b118b8c156 100644 --- a/windows.ui.notifications/toastnotifier_hide_1807990681.md +++ b/windows.ui.notifications/toastnotifier_hide_1807990681.md @@ -1,27 +1,27 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotifier.Hide(Windows.UI.Notifications.ToastNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotifier.Hide - -## -description -Removes the specified toast notification from the screen. - -## -parameters -### -param notification -The object that specifies the toast to hide. - -## -remarks -Call [Hide](toastnotifier_hide.md) if the situation or action that caused the app to raise the toast is no longer an issue. This method should only be called when the app is in the foreground. - -> For Windows Phone Store app: this method also removes the toast notification from the action center. - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotifier.Hide(Windows.UI.Notifications.ToastNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotifier.Hide + +## -description +Removes the specified toast notification from the screen. + +## -parameters +### -param notification +The object that specifies the toast to hide. + +## -remarks +Call [Hide](toastnotifier_hide.md) if the situation or action that caused the app to raise the toast is no longer an issue. This method should only be called when the app is in the foreground. + +> For Windows Phone Store app: this method also removes the toast notification from the action center. + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotifier_removefromschedule_833207209.md b/windows.ui.notifications/toastnotifier_removefromschedule_833207209.md index d452d74ea3..4bfd43ccb5 100644 --- a/windows.ui.notifications/toastnotifier_removefromschedule_833207209.md +++ b/windows.ui.notifications/toastnotifier_removefromschedule_833207209.md @@ -1,45 +1,45 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotifier.RemoveFromSchedule(Windows.UI.Notifications.ScheduledToastNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotifier.RemoveFromSchedule - -## -description -Cancels the scheduled display of a specified [ScheduledToastNotification](scheduledtoastnotification.md). - -> [!IMPORTANT] -> This method cannot be used by desktop callers. - -## -parameters -### -param scheduledToast -The notification to remove from the schedule. - -## -remarks -If you want to cancel one or more scheduled toast notifications, you can use the [GetScheduledToastNotifications](toastnotifier_getscheduledtoastnotifications.md) method to get the full list. - -## -examples -The following example shows the use of the [RemoveFromSchedule](toastnotifier_removefromschedule.md) method. - -```javascript -var notifier = Notifications.ToastNotificationManager.createToastNotifier(); -var scheduled = notifier.getScheduledToastNotifications(); - -for (var i = 0, len = scheduled.length; i < len; i++) { - - // The itemId value is the unique ScheduledTileNotification.Id assigned to the - // notification when it was created. - if (scheduled[i].id === itemId) { - notifier.removeFromSchedule(scheduled[i]); - } -} -``` - - - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotifier.RemoveFromSchedule(Windows.UI.Notifications.ScheduledToastNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotifier.RemoveFromSchedule + +## -description +Cancels the scheduled display of a specified [ScheduledToastNotification](scheduledtoastnotification.md). + +> [!IMPORTANT] +> This method cannot be used by desktop callers. + +## -parameters +### -param scheduledToast +The notification to remove from the schedule. + +## -remarks +If you want to cancel one or more scheduled toast notifications, you can use the [GetScheduledToastNotifications](toastnotifier_getscheduledtoastnotifications.md) method to get the full list. + +## -examples +The following example shows the use of the [RemoveFromSchedule](toastnotifier_removefromschedule.md) method. + +```javascript +var notifier = Notifications.ToastNotificationManager.createToastNotifier(); +var scheduled = notifier.getScheduledToastNotifications(); + +for (var i = 0, len = scheduled.length; i < len; i++) { + + // The itemId value is the unique ScheduledTileNotification.Id assigned to the + // notification when it was created. + if (scheduled[i].id === itemId) { + notifier.removeFromSchedule(scheduled[i]); + } +} +``` + + + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotifier_setting.md b/windows.ui.notifications/toastnotifier_setting.md index 7b98fcbe7b..40219e89fe 100644 --- a/windows.ui.notifications/toastnotifier_setting.md +++ b/windows.ui.notifications/toastnotifier_setting.md @@ -1,29 +1,29 @@ ---- --api-id: P:Windows.UI.Notifications.ToastNotifier.Setting --api-type: winrt property ---- - - - -# Windows.UI.Notifications.ToastNotifier.Setting - -## -description -Gets a value that tells you whether there is an app, user, or system block that prevents the display of a toast notification. - -## -property-value -**Enabled** if the toast can be shown; otherwise, one or more reasons that the toast will be blocked. - -## -remarks -When toast notifications have been disabled at more than one level, this property value reflects the setting with the largest scope. Precedence is as follows, from largest scope to smallest: -1. DisabledByManifest -1. DisabledByGroupPolicy -1. DisabledForUser -1. DisabledForApplication -If toast notifications have been disabled both by the user and by group policy, this property returns DisabledByGroupPolicy. - -## -examples - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: P:Windows.UI.Notifications.ToastNotifier.Setting +-api-type: winrt property +--- + + + +# Windows.UI.Notifications.ToastNotifier.Setting + +## -description +Gets a value that tells you whether there is an app, user, or system block that prevents the display of a toast notification. + +## -property-value +**Enabled** if the toast can be shown; otherwise, one or more reasons that the toast will be blocked. + +## -remarks +When toast notifications have been disabled at more than one level, this property value reflects the setting with the largest scope. Precedence is as follows, from largest scope to smallest: +1. DisabledByManifest +1. DisabledByGroupPolicy +1. DisabledForUser +1. DisabledForApplication +If toast notifications have been disabled both by the user and by group policy, this property returns DisabledByGroupPolicy. + +## -examples + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotifier_show_184420709.md b/windows.ui.notifications/toastnotifier_show_184420709.md index ac93ecf191..5bd8c192aa 100644 --- a/windows.ui.notifications/toastnotifier_show_184420709.md +++ b/windows.ui.notifications/toastnotifier_show_184420709.md @@ -1,60 +1,60 @@ ---- --api-id: M:Windows.UI.Notifications.ToastNotifier.Show(Windows.UI.Notifications.ToastNotification) --api-type: winrt method ---- - - - -# Windows.UI.Notifications.ToastNotifier.Show - -## -description -Displays the specified toast notification. - -## -parameters -### -param notification -The object that contains the content of the toast notification to display. - -## -remarks - -## -examples -The following example shows how to create and send a toast notification that includes text and images, including use of the [Show](toastnotifier_show.md) method. - -```javascript - -var notifications = Windows.UI.Notifications; - -// Get the toast notification manager for the current app. -var notificationManager = notifications.ToastNotificationManager; - -// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object -// that contains the toast notification XML content. -var template = notifications.toastTemplateType.toastImageAndText01; -var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); - -// You can use the methods from the XML document to specify the required elements for the toast. -var images = toastXml.getElementsByTagName("image"); -images[0].setAttribute("src", "images/toastImageAndText.png"); - -var textNodes = toastXml.getElementsByTagName("text"); -textNodes.forEach(function (value, index) { - var textNumber = index + 1; - var text = ""; - for (var j = 0; j < 10; j++) { - text += "Text input " + /*@static_cast(String)*/textNumber + " "; - } - value.appendChild(toastXml.createTextNode(text)); -}); - -// Create a toast notification from the XML, then create a ToastNotifier object -// to send the toast. -var toast = new notifications.ToastNotification(toastXml); - -notificationManager.createToastNotifier().show(toast); -``` - - - -## -see-also -[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_toast), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file +--- +-api-id: M:Windows.UI.Notifications.ToastNotifier.Show(Windows.UI.Notifications.ToastNotification) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotifier.Show + +## -description +Displays the specified toast notification. + +## -parameters +### -param notification +The object that contains the content of the toast notification to display. + +## -remarks + +## -examples +The following example shows how to create and send a toast notification that includes text and images, including use of the [Show](toastnotifier_show.md) method. + +```javascript + +var notifications = Windows.UI.Notifications; + +// Get the toast notification manager for the current app. +var notificationManager = notifications.ToastNotificationManager; + +// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object +// that contains the toast notification XML content. +var template = notifications.toastTemplateType.toastImageAndText01; +var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]); + +// You can use the methods from the XML document to specify the required elements for the toast. +var images = toastXml.getElementsByTagName("image"); +images[0].setAttribute("src", "images/toastImageAndText.png"); + +var textNodes = toastXml.getElementsByTagName("text"); +textNodes.forEach(function (value, index) { + var textNumber = index + 1; + var text = ""; + for (var j = 0; j < 10; j++) { + text += "Text input " + /*@static_cast(String)*/textNumber + " "; + } + value.appendChild(toastXml.createTextNode(text)); +}); + +// Create a toast notification from the XML, then create a ToastNotifier object +// to send the toast. +var toast = new notifications.ToastNotification(toastXml); + +notificationManager.createToastNotifier().show(toast); +``` + + + +## -see-also +[Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb) \ No newline at end of file diff --git a/windows.ui.notifications/toastnotifier_update_1131715552.md b/windows.ui.notifications/toastnotifier_update_1131715552.md new file mode 100644 index 0000000000..745eef1fe8 --- /dev/null +++ b/windows.ui.notifications/toastnotifier_update_1131715552.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastNotifier.Update(Windows.UI.Notifications.NotificationData,System.String,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotifier.Update + +## -description + +## -parameters + +### -param data + +### -param tag + +### -param group + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toastnotifier_update_628326240.md b/windows.ui.notifications/toastnotifier_update_628326240.md new file mode 100644 index 0000000000..348fa0b2b6 --- /dev/null +++ b/windows.ui.notifications/toastnotifier_update_628326240.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Notifications.ToastNotifier.Update(Windows.UI.Notifications.NotificationData,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Notifications.ToastNotifier.Update + +## -description + +## -parameters + +### -param data + +### -param tag + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.notifications/toasttemplatetype.md b/windows.ui.notifications/toasttemplatetype.md index e9d2c581df..f40554f80a 100644 --- a/windows.ui.notifications/toasttemplatetype.md +++ b/windows.ui.notifications/toasttemplatetype.md @@ -44,4 +44,4 @@ One string of bold text on the first line, one string of regular text on the sec ## -examples ## -see-also -[The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [ToastNotificationManager.getTemplateContent](toastnotificationmanager_gettemplatecontent.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](XREF:TODO:m_ui_tiles.quickstart_sending_a_toast_push), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb), [Tile and toast image sizes](http://msdn.microsoft.com/library/af16123d-09dc-4f13-ba41-bca7cfff7d61) \ No newline at end of file +[The toast template catalog](http://msdn.microsoft.com/library/1a437614-4259-426b-8e3f-ca57368b2e7a), [ToastNotificationManager.getTemplateContent](toastnotificationmanager_gettemplatecontent.md), [Toast notifications sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Sending toast notifications from desktop apps sample](http://go.microsoft.com/fwlink/p/?linkid=231503), [Toast XML schema](XREF:TODO:toast.Schema_Root), [Toast notification overview](http://msdn.microsoft.com/library/14a07fce-d631-4bad-ab99-305b703713e6), [Quickstart: Sending a toast notification](http://msdn.microsoft.com/library/098df37c-4d40-4499-b809-ccb651da1cba), [Quickstart: Sending a toast push notification](http://msdn.microsoft.com/library/bb962e30-6c95-4186-8a0e-6683140e17c7), [Quickstart: Sending a toast notification from the desktop](http://msdn.microsoft.com/library/1d20ed75-e24a-4e60-91ab-cfcbe902a68e), [Guidelines and checklist for toast notifications](http://msdn.microsoft.com/library/002951e3-3d2d-454a-a0b7-daa5c1e7178a), [How to handle activation from a toast notification](http://msdn.microsoft.com/library/74ba3513-0a52-46a0-8769-ed58abe7c05a), [How to opt in for toast notifications](http://msdn.microsoft.com/library/809cdd36-6de1-4de0-88b2-62b46cafdb28), [How to schedule a toast notification](http://msdn.microsoft.com/library/18a09413-1679-4606-8175-346f4fe6a4f8), [How to enable desktop toast notifications through an AppUserModelID](http://msdn.microsoft.com/library/bb32cd0a-99e6-47dc-a913-39a7b3027314), [Toast audio options](http://msdn.microsoft.com/library/12185879-1f9b-4bdc-99e7-a6f2f62806cb), [Tile and toast image sizes](http://msdn.microsoft.com/library/af16123d-09dc-4f13-ba41-bca7cfff7d61) \ No newline at end of file diff --git a/windows.ui.popups/popupmenu.md b/windows.ui.popups/popupmenu.md index 8d9d013397..f64712b082 100644 --- a/windows.ui.popups/popupmenu.md +++ b/windows.ui.popups/popupmenu.md @@ -36,5 +36,5 @@ To customize the context menu, call [preventDefault](XREF:TODO:wwa.IDOMEvent_pre [!code-js[newcontextmenu_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetnewcontextmenu_js)] ## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md), [UICommandSeparator](uicommandseparator.md), [Context menu sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620525) +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md), [UICommandSeparator](uicommandseparator.md), [Context menu sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620525) pMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md), [UICommandSeparator](uicommandseparator.md), [Context menu sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620525) \ No newline at end of file diff --git a/windows.ui.popups/popupmenu_commands.md b/windows.ui.popups/popupmenu_commands.md index da12f6cb0f..e4da213c72 100644 --- a/windows.ui.popups/popupmenu_commands.md +++ b/windows.ui.popups/popupmenu_commands.md @@ -1,44 +1,44 @@ ---- --api-id: P:Windows.UI.Popups.PopupMenu.Commands --api-type: winrt property ---- - - - -# Windows.UI.Popups.PopupMenu.Commands - -## -description -Gets the commands for the context menu. - -## -property-value -The commands for the context menu. - -## -remarks -You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). - -## -examples -Add your commands to the context menu after you create a new [PopupMenu](popupmenu.md). Create a [UICommand](uicommand.md) object for each command and append the commands to the context menu. - -The [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) creates and appends a new [UICommand](uicommand.md) that specifies a handler function, which runs if the command is invoked. - - - -[!code-js[addcommandwithhandler_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcommandwithhandler_js)] - -The [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) also creates and appends a new [UICommand](uicommand.md) that specifies a command identifier, which can be used to determine the command that has been invoked. - - - -[!code-js[addcommandwithid_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetaddcommandwithid_js)] - -The [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) places a separator between its `"Copy"` and `"Highlight"` commands like this. - - - -[!code-js[addcommandswithidsandseparator_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetaddcommandswithidsandseparator_js)] - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [IVector(IUICommand)](../windows.foundation.collections/ivector_1.md), [PopupMenu.PopupMenu](popupmenu_popupmenu.md), [UICommand](uicommand.md), [UICommandInvokedHandler](uicommandinvokedhandler.md), [UICommandSeparator](uicommandseparator.md) +--- +-api-id: P:Windows.UI.Popups.PopupMenu.Commands +-api-type: winrt property +--- + + + +# Windows.UI.Popups.PopupMenu.Commands + +## -description +Gets the commands for the context menu. + +## -property-value +The commands for the context menu. + +## -remarks +You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). + +## -examples +Add your commands to the context menu after you create a new [PopupMenu](popupmenu.md). Create a [UICommand](uicommand.md) object for each command and append the commands to the context menu. + +The [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) creates and appends a new [UICommand](uicommand.md) that specifies a handler function, which runs if the command is invoked. + + + +[!code-js[addcommandwithhandler_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcommandwithhandler_js)] + +The [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) also creates and appends a new [UICommand](uicommand.md) that specifies a command identifier, which can be used to determine the command that has been invoked. + + + +[!code-js[addcommandwithid_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetaddcommandwithid_js)] + +The [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) places a separator between its `"Copy"` and `"Highlight"` commands like this. + + + +[!code-js[addcommandswithidsandseparator_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetaddcommandswithidsandseparator_js)] + +## -see-also +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [IUICommand](iuicommand.md), [IVector(IUICommand)](../windows.foundation.collections/ivector_1.md), [PopupMenu.PopupMenu](popupmenu_popupmenu.md), [UICommand](uicommand.md), [UICommandInvokedHandler](uicommandinvokedhandler.md), [UICommandSeparator](uicommandseparator.md) d), [PopupMenu.PopupMenu](popupmenu_popupmenu.md), [UICommand](uicommand.md), [UICommandInvokedHandler](uicommandinvokedhandler.md), [UICommandSeparator](uicommandseparator.md) \ No newline at end of file diff --git a/windows.ui.popups/popupmenu_popupmenu_1221375020.md b/windows.ui.popups/popupmenu_popupmenu_1221375020.md index b60e47d8fb..00abad26b6 100644 --- a/windows.ui.popups/popupmenu_popupmenu_1221375020.md +++ b/windows.ui.popups/popupmenu_popupmenu_1221375020.md @@ -1,28 +1,28 @@ ---- --api-id: M:Windows.UI.Popups.PopupMenu.#ctor --api-type: winrt method ---- - - - -# Windows.UI.Popups.PopupMenu.PopupMenu - -## -description -Creates a new instance of the [PopupMenu](popupmenu.md) class. - -## -remarks -You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). - -## -examples -To customize the context menu, call [preventDefault](XREF:TODO:wwa.IDOMEvent_preventDefault) on the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event (`e` in the example) to suppress the default context menu, and then create a new, empty context menu menu as shown in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891). - - - -[!code-js[contextmenu_preventdefault](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetcontextmenu_preventdefault)] - -[!code-js[newcontextmenu_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetnewcontextmenu_js)] - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [UICommand](uicommand.md), [UICommandSeparator](uicommandseparator.md) +--- +-api-id: M:Windows.UI.Popups.PopupMenu.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Popups.PopupMenu.PopupMenu + +## -description +Creates a new instance of the [PopupMenu](popupmenu.md) class. + +## -remarks +You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). + +## -examples +To customize the context menu, call [preventDefault](XREF:TODO:wwa.IDOMEvent_preventDefault) on the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event (`e` in the example) to suppress the default context menu, and then create a new, empty context menu menu as shown in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891). + + + +[!code-js[contextmenu_preventdefault](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetcontextmenu_preventdefault)] + +[!code-js[newcontextmenu_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetnewcontextmenu_js)] + +## -see-also +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [UICommand](uicommand.md), [UICommandSeparator](uicommandseparator.md) diff --git a/windows.ui.popups/popupmenu_showasync_583519687.md b/windows.ui.popups/popupmenu_showasync_583519687.md index 9547b8dbcb..47136c9a51 100644 --- a/windows.ui.popups/popupmenu_showasync_583519687.md +++ b/windows.ui.popups/popupmenu_showasync_583519687.md @@ -1,45 +1,45 @@ ---- --api-id: M:Windows.UI.Popups.PopupMenu.ShowAsync(Windows.Foundation.Point) --api-type: winrt method ---- - - - -# Windows.UI.Popups.PopupMenu.ShowAsync - -## -description -Shows the context menu at the specified client coordinates. - -## -parameters -### -param invocationPoint -The coordinates (in DIPs), relative to the window, of the user's finger or mouse pointer when the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event fired. The menu is placed above and centered on this point. - -> [!NOTE] -> For VB, C#, and C++, this window is the [CoreWindow](../windows.ui.core/corewindow.md) associated with the thread that is calling the context menu. - -## -returns -A [IUICommand](iuicommand.md) object that represents the context menu command that was invoked by the user, after the [ShowAsync](popupmenu_showasync.md) call completes. - -If no command is invoked, [ShowAsync](popupmenu_showasync.md) returns **null**. - -## -remarks -You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). - -## -examples -Before you can show a context menu, you must add an event listener for the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event. For example, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) listens for the event on specific HTML elements, and then calls the `scenario1AttachmentHandler` function. - - - -[!code-js[addcontextmenueventlistener_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcontextmenueventlistener_js)] - - - -[!code-js[addandshowwithhandlers_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddandshowwithhandlers_js)] - -Additionally, make sure you check that a command was invoked and process that case as appropriate for your app. If the [UICommand](uicommand.md) that is invoked has a callback function (`onSaveAttachment` in the example), the callback function will be executed. Otherwise, you may need to use [UICommand.Id](uicommand_id.md) to identify and process the invoked command. - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Point](../windows.foundation/point.md), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) -ng context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Point](../windows.foundation/point.md), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) \ No newline at end of file +--- +-api-id: M:Windows.UI.Popups.PopupMenu.ShowAsync(Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.UI.Popups.PopupMenu.ShowAsync + +## -description +Shows the context menu at the specified client coordinates. + +## -parameters +### -param invocationPoint +The coordinates (in DIPs), relative to the window, of the user's finger or mouse pointer when the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event fired. The menu is placed above and centered on this point. + +> [!NOTE] +> For VB, C#, and C++, this window is the [CoreWindow](../windows.ui.core/corewindow.md) associated with the thread that is calling the context menu. + +## -returns +A [IUICommand](iuicommand.md) object that represents the context menu command that was invoked by the user, after the [ShowAsync](popupmenu_showasync.md) call completes. + +If no command is invoked, [ShowAsync](popupmenu_showasync.md) returns **null**. + +## -remarks +You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). + +## -examples +Before you can show a context menu, you must add an event listener for the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event. For example, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) listens for the event on specific HTML elements, and then calls the `scenario1AttachmentHandler` function. + + + +[!code-js[addcontextmenueventlistener_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcontextmenueventlistener_js)] + + + +[!code-js[addandshowwithhandlers_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddandshowwithhandlers_js)] + +Additionally, make sure you check that a command was invoked and process that case as appropriate for your app. If the [UICommand](uicommand.md) that is invoked has a callback function (`onSaveAttachment` in the example), the callback function will be executed. Otherwise, you may need to use [UICommand.Id](uicommand_id.md) to identify and process the invoked command. + +## -see-also +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Point](../windows.foundation/point.md), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) +ng context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Point](../windows.foundation/point.md), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) \ No newline at end of file diff --git a/windows.ui.popups/popupmenu_showforselectionasync_574993385.md b/windows.ui.popups/popupmenu_showforselectionasync_574993385.md index 51bab59d61..8a1ce38549 100644 --- a/windows.ui.popups/popupmenu_showforselectionasync_574993385.md +++ b/windows.ui.popups/popupmenu_showforselectionasync_574993385.md @@ -1,52 +1,49 @@ ---- --api-id: M:Windows.UI.Popups.PopupMenu.ShowForSelectionAsync(Windows.Foundation.Rect) --api-type: winrt method ---- - - - -# Windows.UI.Popups.PopupMenu.ShowForSelectionAsync - -## -description -Shows the context menu above the specified selection. - -## -parameters -### -param selection -The coordinates (in DIPs) of the selected rectangle, relative to the window. The context menu is placed directly above and centered on this rectangle such that selection is not covered. - -> [!NOTE] -> For VB, C#, and C++, this window is the [CoreWindow](../windows.ui.core/corewindow.md) associated with the thread that is calling the context menu. - -## -returns -A [IUICommand](iuicommand.md) object that represents the context menu command invoked by the user, after the [ShowForSelectionAsync](popupmenu_showforselectionasync.md) call completes. - -If no command is invoked, [ShowForSelectionAsync](popupmenu_showforselectionasync.md) returns **null**. - -## -remarks -You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). - -## -examples -Before you can show a context menu, you must add an event listener for the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event. For example, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) listens for the event on specific HTML elements, and then calls the `scenario1AttachmentHandler` function. - - - -[!code-js[addcontextmenueventlistener_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcontextmenueventlistener_js)] - - - -[!code-js[showforselection_commandshaveids_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetshowforselection_commandshaveids_js)] - -Additionally, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) uses two helper functions (`getSelectionRect` and `getclientCoordinates`) to set the coordinates for the selection rectangle. - - - -[!code-js[selectionrect_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetselectionrect_js)] - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Rect](../windows.foundation/rect.md), [ShowForSelectionAsync(Rect, Placement)](popupmenu_showforselectionasync_655080999.md), [UICommand](uicommand.md) -tes, and those coordinates are used as the *selection*[Rect](../windows.foundation/rect.md). - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Rect](../windows.foundation/rect.md), [ShowForSelectionAsync(Rect, Placement)](popupmenu_showforselectionasync_655080999.md), [UICommand](uicommand.md) \ No newline at end of file +--- +-api-id: M:Windows.UI.Popups.PopupMenu.ShowForSelectionAsync(Windows.Foundation.Rect) +-api-type: winrt method +--- + + + +# Windows.UI.Popups.PopupMenu.ShowForSelectionAsync + +## -description +Shows the context menu above the specified selection. + +## -parameters +### -param selection +The coordinates (in DIPs) of the selected rectangle, relative to the window. The context menu is placed directly above and centered on this rectangle such that selection is not covered. + +> [!NOTE] +> For VB, C#, and C++, this window is the [CoreWindow](../windows.ui.core/corewindow.md) associated with the thread that is calling the context menu. + +## -returns +A [IUICommand](iuicommand.md) object that represents the context menu command invoked by the user, after the [ShowForSelectionAsync](popupmenu_showforselectionasync.md) call completes. + +If no command is invoked, [ShowForSelectionAsync](popupmenu_showforselectionasync.md) returns **null**. + +## -remarks +You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). + +## -examples +Before you can show a context menu, you must add an event listener for the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event. For example, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) listens for the event on specific HTML elements, and then calls the `scenario1AttachmentHandler` function. + + + +[!code-js[addcontextmenueventlistener_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcontextmenueventlistener_js)] + + + +[!code-js[showforselection_commandshaveids_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetshowforselection_commandshaveids_js)] + +Additionally, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) uses two helper functions (`getSelectionRect` and `getclientCoordinates`) to set the coordinates for the selection rectangle. + + + +[!code-js[selectionrect_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetselectionrect_js)] + + +## -see-also +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Rect](../windows.foundation/rect.md), [ShowForSelectionAsync(Rect, Placement)](popupmenu_showforselectionasync_655080999.md), [UICommand](uicommand.md) \ No newline at end of file diff --git a/windows.ui.popups/popupmenu_showforselectionasync_655080999.md b/windows.ui.popups/popupmenu_showforselectionasync_655080999.md index 3fff192f0e..c4acf2c720 100644 --- a/windows.ui.popups/popupmenu_showforselectionasync_655080999.md +++ b/windows.ui.popups/popupmenu_showforselectionasync_655080999.md @@ -1,51 +1,47 @@ ---- --api-id: M:Windows.UI.Popups.PopupMenu.ShowForSelectionAsync(Windows.Foundation.Rect,Windows.UI.Popups.Placement) --api-type: winrt method ---- - - - -# Windows.UI.Popups.PopupMenu.ShowForSelectionAsync - -## -description -Shows the context menu in the preferred placement relative to the specified selection. - -## -parameters -### -param selection -The coordinates (in DIPs) of the selected rectangle, relative to the window. - -> [!NOTE] -> For VB, C#, and C++, this window is the [CoreWindow](../windows.ui.core/corewindow.md) associated with the thread that is calling the context menu. - -### -param preferredPlacement -The preferred placement of the context menu relative to the selection rectangle. - -The context menu is positioned in the *preferredPlacement* if the menu fits in the window and does not cover the selection. If the context menu does not fit in the preferred placement, another placement that does not cover the selection is used. If the context menu does not fit anywhere else, a placement that partially or wholly covers the selection is used. - -## -returns -A [IUICommand](iuicommand.md) object that represents the context menu command invoked by the user, after the [ShowForSelectionAsync](popupmenu_showforselectionasync.md) call completes. - -If no command is invoked, [ShowForSelectionAsync](popupmenu_showforselectionasync.md) returns **null**. - -## -remarks -You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). - -## -examples -Before you can show a context menu, you must add an event listener for the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event. For example, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) listens for the event on specific HTML elements, and then calls the `scenario1AttachmentHandler` function. - - - -[!code-js[addcontextmenueventlistener_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcontextmenueventlistener_js)] - - - -[!code-js[selectionrect_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetselectionrect_js)] - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Rect](../windows.foundation/rect.md), [ShowForSelectionAsync(Rect)](popupmenu_showforselectionasync_574993385.md), [UICommand](uicommand.md) - / 96. - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Rect](../windows.foundation/rect.md), [ShowForSelectionAsync(Rect)](popupmenu_showforselectionasync_574993385.md), [UICommand](uicommand.md) \ No newline at end of file +--- +-api-id: M:Windows.UI.Popups.PopupMenu.ShowForSelectionAsync(Windows.Foundation.Rect,Windows.UI.Popups.Placement) +-api-type: winrt method +--- + + + +# Windows.UI.Popups.PopupMenu.ShowForSelectionAsync + +## -description +Shows the context menu in the preferred placement relative to the specified selection. + +## -parameters +### -param selection +The coordinates (in DIPs) of the selected rectangle, relative to the window. + +> [!NOTE] +> For VB, C#, and C++, this window is the [CoreWindow](../windows.ui.core/corewindow.md) associated with the thread that is calling the context menu. + +### -param preferredPlacement +The preferred placement of the context menu relative to the selection rectangle. + +The context menu is positioned in the *preferredPlacement* if the menu fits in the window and does not cover the selection. If the context menu does not fit in the preferred placement, another placement that does not cover the selection is used. If the context menu does not fit anywhere else, a placement that partially or wholly covers the selection is used. + +## -returns +A [IUICommand](iuicommand.md) object that represents the context menu command invoked by the user, after the [ShowForSelectionAsync](popupmenu_showforselectionasync.md) call completes. + +If no command is invoked, [ShowForSelectionAsync](popupmenu_showforselectionasync.md) returns **null**. + +## -remarks +You can see complete code examples that demonstrate how to create and customize context menu in the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) on the [ sample home page](http://go.microsoft.com/fwlink/p/?linkid=226952). + +## -examples +Before you can show a context menu, you must add an event listener for the [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event) event. For example, the [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891) listens for the event on specific HTML elements, and then calls the `scenario1AttachmentHandler` function. + + + +[!code-js[addcontextmenueventlistener_js](../windows.ui.popups/code/ContextMenu/js/js/scenario1.js#Snippetaddcontextmenueventlistener_js)] + + + +[!code-js[selectionrect_js](../windows.ui.popups/code/ContextMenu/js/js/scenario2.js#Snippetselectionrect_js)] + +## -see-also +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [IUICommand](iuicommand.md), [oncontextmenu](XREF:TODO:wwa.oncontextmenu_Event), [Rect](../windows.foundation/rect.md), [ShowForSelectionAsync(Rect)](popupmenu_showforselectionasync_574993385.md), [UICommand](uicommand.md) \ No newline at end of file diff --git a/windows.ui.popups/uicommand.md b/windows.ui.popups/uicommand.md index 8e7b45d0f8..bd29689132 100644 --- a/windows.ui.popups/uicommand.md +++ b/windows.ui.popups/uicommand.md @@ -18,4 +18,4 @@ Use the [PopupMenu.Commands](popupmenu_commands.md) property to add or modify th ## -examples ## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [PopupMenu.Commands](popupmenu_commands.md), [Context menu sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620525) \ No newline at end of file +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [PopupMenu.Commands](popupmenu_commands.md), [Context menu sample (Windows 10)](http://go.microsoft.com/fwlink/p/?LinkId=620525) \ No newline at end of file diff --git a/windows.ui.popups/uicommandseparator.md b/windows.ui.popups/uicommandseparator.md index f5754d0215..d25d5815f1 100644 --- a/windows.ui.popups/uicommandseparator.md +++ b/windows.ui.popups/uicommandseparator.md @@ -20,4 +20,4 @@ Setting properties on a [UICommandSeparator](uicommandseparator.md) object has n ## -examples ## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) \ No newline at end of file +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) \ No newline at end of file diff --git a/windows.ui.popups/uicommandseparator_uicommandseparator_1221375020.md b/windows.ui.popups/uicommandseparator_uicommandseparator_1221375020.md index f7268b0e5b..ef8fc4d346 100644 --- a/windows.ui.popups/uicommandseparator_uicommandseparator_1221375020.md +++ b/windows.ui.popups/uicommandseparator_uicommandseparator_1221375020.md @@ -1,20 +1,20 @@ ---- --api-id: M:Windows.UI.Popups.UICommandSeparator.#ctor --api-type: winrt method ---- - - - -# Windows.UI.Popups.UICommandSeparator.UICommandSeparator - -## -description -Creates a new instance of the [UICommandSeparator](uicommandseparator.md) class. - -## -remarks - -## -examples - -## -see-also -[Adding context menus](XREF:TODO:m_ui_contextmenu.adding_context_menus_portal), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](XREF:TODO:m_ui_contextmenu.guidelines_and_checklist_for_context_menus), [IUICommand](iuicommand.md), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) \ No newline at end of file +--- +-api-id: M:Windows.UI.Popups.UICommandSeparator.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Popups.UICommandSeparator.UICommandSeparator + +## -description +Creates a new instance of the [UICommandSeparator](uicommandseparator.md) class. + +## -remarks + +## -examples + +## -see-also +[Adding context menus](http://msdn.microsoft.com/library/9778aea7-c959-4b3e-bd79-9659f07095a6), [Context menu sample](http://go.microsoft.com/fwlink/p/?linkid=234891), [Guidelines and checklist for ](http://msdn.microsoft.com/library/23063edd-ed89-4a82-9857-44001fad770b), [IUICommand](iuicommand.md), [PopupMenu.Commands](popupmenu_commands.md), [UICommand](uicommand.md) \ No newline at end of file diff --git a/windows.ui.startscreen/secondarytile_lockscreenbadgelogo.md b/windows.ui.startscreen/secondarytile_lockscreenbadgelogo.md index 728bbe57d5..c5ca08472c 100644 --- a/windows.ui.startscreen/secondarytile_lockscreenbadgelogo.md +++ b/windows.ui.startscreen/secondarytile_lockscreenbadgelogo.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.UI.StartScreen.SecondaryTile.LockScreenBadgeLogo --api-type: winrt property ---- - - - -# Windows.UI.StartScreen.SecondaryTile.LockScreenBadgeLogo - -## -description -Gets or sets the location of a badge logo image to represent the secondary tile on the lock screen. By supplying this image, you declare that the secondary tile is eligible to display a badge on the lock screen. If you also want the secondary tile to be eligible for the lock screen's detailed tile slot, you must also set the [LockScreenDisplayBadgeAndTileText](secondarytile_lockscreendisplaybadgeandtiletext.md) property to **True**. - -> [!NOTE] -> Stating that your secondary tile is eligible for a lock screen presence does not guarantee that it will have one. Only the user can add an app to one of the seven lock screen slots. For more information, see the [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd). - -## -property-value -A Uniform Resource Identifier (URI) that specifies the logo image file location. - -## -remarks - -## -examples - -## -see-also -[Secondary tiles overview](http://msdn.microsoft.com/library/973391ca-a4f1-40f7-a909-5396b4a2bd18), [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd), [Secondary tiles sample](http://go.microsoft.com/fwlink/p/?linkid=231487), [Lock screen app sample](http://go.microsoft.com/fwlink/p/?linkid=239970), [Guidelines and checklist for secondary tiles](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_secondary_tiles), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [Quickstart: Showing tile and badge updates on the lock screen](XREF:TODO:m_ui_tiles.howto_optin_for_lockscreen), [How to send notifications to a secondary tile](XREF:TODO:m_ui_tiles.howto_send_notifications_to_secondary_tiles), [Quickstart: Pinning a secondary tile](XREF:TODO:m_ui_tiles.quickstart_creating_secondary_tile), [Pinning secondary tiles](http://msdn.microsoft.com/library/54a4d4d3-0430-45eb-b5fd-ee96598c216e) \ No newline at end of file +--- +-api-id: P:Windows.UI.StartScreen.SecondaryTile.LockScreenBadgeLogo +-api-type: winrt property +--- + + + +# Windows.UI.StartScreen.SecondaryTile.LockScreenBadgeLogo + +## -description +Gets or sets the location of a badge logo image to represent the secondary tile on the lock screen. By supplying this image, you declare that the secondary tile is eligible to display a badge on the lock screen. If you also want the secondary tile to be eligible for the lock screen's detailed tile slot, you must also set the [LockScreenDisplayBadgeAndTileText](secondarytile_lockscreendisplaybadgeandtiletext.md) property to **True**. + +> [!NOTE] +> Stating that your secondary tile is eligible for a lock screen presence does not guarantee that it will have one. Only the user can add an app to one of the seven lock screen slots. For more information, see the [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd). + +## -property-value +A Uniform Resource Identifier (URI) that specifies the logo image file location. + +## -remarks + +## -examples + +## -see-also +[Secondary tiles overview](http://msdn.microsoft.com/library/973391ca-a4f1-40f7-a909-5396b4a2bd18), [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd), [Secondary tiles sample](http://go.microsoft.com/fwlink/p/?linkid=231487), [Lock screen app sample](http://go.microsoft.com/fwlink/p/?linkid=239970), [Guidelines and checklist for secondary tiles](http://msdn.microsoft.com/library/8be09bc3-d052-4d61-aab9-fbbf5c70b6e0), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [Quickstart: Showing tile and badge updates on the lock screen](http://msdn.microsoft.com/library/c74688bd-7ff8-4171-8903-f44e0ad03667), [How to send notifications to a secondary tile](http://msdn.microsoft.com/library/168d2a8a-3348-48d4-9973-da4537322d27), [Quickstart: Pinning a secondary tile](http://msdn.microsoft.com/library/813ff906-3c8b-4c9f-9e3a-7315fbb9ec17), [Pinning secondary tiles](http://msdn.microsoft.com/library/54a4d4d3-0430-45eb-b5fd-ee96598c216e) \ No newline at end of file diff --git a/windows.ui.startscreen/secondarytile_lockscreendisplaybadgeandtiletext.md b/windows.ui.startscreen/secondarytile_lockscreendisplaybadgeandtiletext.md index 1a21a0a88b..859a0f2378 100644 --- a/windows.ui.startscreen/secondarytile_lockscreendisplaybadgeandtiletext.md +++ b/windows.ui.startscreen/secondarytile_lockscreendisplaybadgeandtiletext.md @@ -1,26 +1,26 @@ ---- --api-id: P:Windows.UI.StartScreen.SecondaryTile.LockScreenDisplayBadgeAndTileText --api-type: winrt property ---- - - - -# Windows.UI.StartScreen.SecondaryTile.LockScreenDisplayBadgeAndTileText - -## -description -Gets or sets whether the secondary tile is eligible to display both a badge and a detailed tile on the lock screen. If you set this property to **True**, you must also provide a badge image through the [LockScreenBadgeLogo](secondarytile_lockscreenbadgelogo.md) property. If you do not want to use the detailed tile capability, provide a badge image through the [LockScreenBadgeLogo](secondarytile_lockscreenbadgelogo.md) property and set [LockScreenDisplayBadgeAndTileText](secondarytile_lockscreendisplaybadgeandtiletext.md) to **False**. - -> [!NOTE] -> Stating that your secondary tile is eligible for a lock screen presence does not guarantee that it will have one. Only the user can add an app to one of the seven lock screen slots, as well as choosing which one of them can display detailed tile information. For more information, see the [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd). - -## -property-value -**True** if the secondary tile can have a lock screen presence; otherwise, **False**. - -## -remarks - -## -examples - -## -see-also -[Secondary tiles overview](http://msdn.microsoft.com/library/973391ca-a4f1-40f7-a909-5396b4a2bd18), [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd), [Secondary tiles sample](http://go.microsoft.com/fwlink/p/?linkid=231487), [Lock screen app sample](http://go.microsoft.com/fwlink/p/?linkid=239970), [Guidelines and checklist for secondary tiles](XREF:TODO:m_ui_tiles.guidelines_and_checklist_for_secondary_tiles), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [Quickstart: Showing tile and badge updates on the lock screen](XREF:TODO:m_ui_tiles.howto_optin_for_lockscreen), [How to send notifications to a secondary tile](XREF:TODO:m_ui_tiles.howto_send_notifications_to_secondary_tiles), [Quickstart: Pinning a secondary tile](XREF:TODO:m_ui_tiles.quickstart_creating_secondary_tile), [Pinning secondary tiles](http://msdn.microsoft.com/library/54a4d4d3-0430-45eb-b5fd-ee96598c216e) \ No newline at end of file +--- +-api-id: P:Windows.UI.StartScreen.SecondaryTile.LockScreenDisplayBadgeAndTileText +-api-type: winrt property +--- + + + +# Windows.UI.StartScreen.SecondaryTile.LockScreenDisplayBadgeAndTileText + +## -description +Gets or sets whether the secondary tile is eligible to display both a badge and a detailed tile on the lock screen. If you set this property to **True**, you must also provide a badge image through the [LockScreenBadgeLogo](secondarytile_lockscreenbadgelogo.md) property. If you do not want to use the detailed tile capability, provide a badge image through the [LockScreenBadgeLogo](secondarytile_lockscreenbadgelogo.md) property and set [LockScreenDisplayBadgeAndTileText](secondarytile_lockscreendisplaybadgeandtiletext.md) to **False**. + +> [!NOTE] +> Stating that your secondary tile is eligible for a lock screen presence does not guarantee that it will have one. Only the user can add an app to one of the seven lock screen slots, as well as choosing which one of them can display detailed tile information. For more information, see the [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd). + +## -property-value +**True** if the secondary tile can have a lock screen presence; otherwise, **False**. + +## -remarks + +## -examples + +## -see-also +[Secondary tiles overview](http://msdn.microsoft.com/library/973391ca-a4f1-40f7-a909-5396b4a2bd18), [Lock screen overview](http://msdn.microsoft.com/library/07fefb48-f55c-4ab7-8b68-a8aed11074fd), [Secondary tiles sample](http://go.microsoft.com/fwlink/p/?linkid=231487), [Lock screen app sample](http://go.microsoft.com/fwlink/p/?linkid=239970), [Guidelines and checklist for secondary tiles](http://msdn.microsoft.com/library/8be09bc3-d052-4d61-aab9-fbbf5c70b6e0), [Guidelines and checklist for tiles and badges](http://msdn.microsoft.com/library/e825f754-97dd-41c2-aff4-4dfb60eda677), [Quickstart: Showing tile and badge updates on the lock screen](http://msdn.microsoft.com/library/c74688bd-7ff8-4171-8903-f44e0ad03667), [How to send notifications to a secondary tile](http://msdn.microsoft.com/library/168d2a8a-3348-48d4-9973-da4537322d27), [Quickstart: Pinning a secondary tile](http://msdn.microsoft.com/library/813ff906-3c8b-4c9f-9e3a-7315fbb9ec17), [Pinning secondary tiles](http://msdn.microsoft.com/library/54a4d4d3-0430-45eb-b5fd-ee96598c216e) \ No newline at end of file diff --git a/windows.ui.startscreen/startscreenmanager.md b/windows.ui.startscreen/startscreenmanager.md new file mode 100644 index 0000000000..51f93167b3 --- /dev/null +++ b/windows.ui.startscreen/startscreenmanager.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.StartScreen.StartScreenManager +-api-type: winrt class +--- + + + +# Windows.UI.StartScreen.StartScreenManager + +## -description +Represents a Start screen manager object. +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.startscreen/startscreenmanager_containsapplistentryasync_2010491223.md b/windows.ui.startscreen/startscreenmanager_containsapplistentryasync_2010491223.md new file mode 100644 index 0000000000..a379f019f5 --- /dev/null +++ b/windows.ui.startscreen/startscreenmanager_containsapplistentryasync_2010491223.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.StartScreen.StartScreenManager.ContainsAppListEntryAsync(Windows.ApplicationModel.Core.AppListEntry) +-api-type: winrt method +--- + + + +# Windows.UI.StartScreen.StartScreenManager.ContainsAppListEntryAsync + +## -description +Checks if the app is currently pinned to the Start screen. +## -parameters + +### -param appListEntry + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.startscreen/startscreenmanager_getdefault_846721868.md b/windows.ui.startscreen/startscreenmanager_getdefault_846721868.md new file mode 100644 index 0000000000..dc33211fb9 --- /dev/null +++ b/windows.ui.startscreen/startscreenmanager_getdefault_846721868.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.StartScreen.StartScreenManager.GetDefault +-api-type: winrt method +--- + + + +# Windows.UI.StartScreen.StartScreenManager.GetDefault + +## -description +Gets the current Start screen manager. +## -parameters + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.startscreen/startscreenmanager_getforuser_2058550280.md b/windows.ui.startscreen/startscreenmanager_getforuser_2058550280.md new file mode 100644 index 0000000000..ec058fe465 --- /dev/null +++ b/windows.ui.startscreen/startscreenmanager_getforuser_2058550280.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.StartScreen.StartScreenManager.GetForUser(Windows.System.User) +-api-type: winrt method +--- + + + +# Windows.UI.StartScreen.StartScreenManager.GetForUser + +## -description +Gets the Start screen manager for a specific user. +## -parameters + +### -param user + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.startscreen/startscreenmanager_requestaddapplistentryasync_1088626093.md b/windows.ui.startscreen/startscreenmanager_requestaddapplistentryasync_1088626093.md new file mode 100644 index 0000000000..de1f33b77f --- /dev/null +++ b/windows.ui.startscreen/startscreenmanager_requestaddapplistentryasync_1088626093.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.StartScreen.StartScreenManager.RequestAddAppListEntryAsync(Windows.ApplicationModel.Core.AppListEntry) +-api-type: winrt method +--- + + + +# Windows.UI.StartScreen.StartScreenManager.RequestAddAppListEntryAsync + +## -description +Requests to pin the app to the current Start screen. Depending on the device family, this must be called on the UI thread, and will display a dialog asking the user to confirm they would like to pin the app. +## -parameters + +### -param appListEntry + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.startscreen/startscreenmanager_supportsapplistentry_1161203799.md b/windows.ui.startscreen/startscreenmanager_supportsapplistentry_1161203799.md new file mode 100644 index 0000000000..184fe48ea4 --- /dev/null +++ b/windows.ui.startscreen/startscreenmanager_supportsapplistentry_1161203799.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.StartScreen.StartScreenManager.SupportsAppListEntry(Windows.ApplicationModel.Core.AppListEntry) +-api-type: winrt method +--- + + + +# Windows.UI.StartScreen.StartScreenManager.SupportsAppListEntry + +## -description +Checks if the app can be pinned to the current Start screen. +## -parameters + +### -param appListEntry + +## -returns + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.startscreen/startscreenmanager_user.md b/windows.ui.startscreen/startscreenmanager_user.md new file mode 100644 index 0000000000..cd8e0594bb --- /dev/null +++ b/windows.ui.startscreen/startscreenmanager_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.StartScreen.StartScreenManager.User +-api-type: winrt property +--- + + + +# Windows.UI.StartScreen.StartScreenManager.User + +## -description +Gets the user associated with the current Start screen. +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument.md b/windows.ui.text/richedittextdocument.md new file mode 100644 index 0000000000..b90bb1ac1c --- /dev/null +++ b/windows.ui.text/richedittextdocument.md @@ -0,0 +1,20 @@ +--- +-api-id: T:Windows.UI.Text.RichEditTextDocument +-api-type: winrt class +--- + + + +# Windows.UI.Text.RichEditTextDocument + +## -description +Represents a rich text document that can be loaded, saved, and edited. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_alignmentincludestrailingwhitespace.md b/windows.ui.text/richedittextdocument_alignmentincludestrailingwhitespace.md new file mode 100644 index 0000000000..fd951d5ddd --- /dev/null +++ b/windows.ui.text/richedittextdocument_alignmentincludestrailingwhitespace.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Text.RichEditTextDocument.AlignmentIncludesTrailingWhitespace +-api-type: winrt property +--- + + + +# Windows.UI.Text.RichEditTextDocument.AlignmentIncludesTrailingWhitespace + +## -description +Gets or sets a value that indicates whether trailing white space is taken into account when text is aligned. + +## -property-value +**true** if trailing whitespace is taken into account when text is aligned; **false** if trailing whitespace is ignored. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_applydisplayupdates_1551145521.md b/windows.ui.text/richedittextdocument_applydisplayupdates_1551145521.md new file mode 100644 index 0000000000..da7465bda0 --- /dev/null +++ b/windows.ui.text/richedittextdocument_applydisplayupdates_1551145521.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.ApplyDisplayUpdates +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.ApplyDisplayUpdates + +## -description +Decrements an internal counter that controls whether text updates are displayed immediately or batched. + +## -parameters + +## -returns +The value of the internal counter. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_batchdisplayupdates_505749236.md b/windows.ui.text/richedittextdocument_batchdisplayupdates_505749236.md new file mode 100644 index 0000000000..df4c6bb2cb --- /dev/null +++ b/windows.ui.text/richedittextdocument_batchdisplayupdates_505749236.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.BatchDisplayUpdates +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.BatchDisplayUpdates + +## -description +Increments an internal counter that controls whether text updates are displayed immediately or batched. + +## -parameters + +## -returns +The value of the internal counter. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_beginundogroup_1705396921.md b/windows.ui.text/richedittextdocument_beginundogroup_1705396921.md new file mode 100644 index 0000000000..149c707d24 --- /dev/null +++ b/windows.ui.text/richedittextdocument_beginundogroup_1705396921.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.BeginUndoGroup +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.BeginUndoGroup + +## -description +Turns on undo grouping. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_cancopy_171689037.md b/windows.ui.text/richedittextdocument_cancopy_171689037.md new file mode 100644 index 0000000000..b3fd4b0956 --- /dev/null +++ b/windows.ui.text/richedittextdocument_cancopy_171689037.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.CanCopy +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.CanCopy + +## -description +Determines whether document content can be copied to the Clipboard. + +## -parameters + +## -returns +**true** if copying to the Clipboard is allowed; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_canpaste_1221588146.md b/windows.ui.text/richedittextdocument_canpaste_1221588146.md new file mode 100644 index 0000000000..b9342667ab --- /dev/null +++ b/windows.ui.text/richedittextdocument_canpaste_1221588146.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.CanPaste +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.CanPaste + +## -description +Determines whether the Clipboard has content that can be pasted into the document. + +## -parameters + +## -returns +**true** if the Clipboard has content that can be pasted into the document; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_canredo_328904111.md b/windows.ui.text/richedittextdocument_canredo_328904111.md new file mode 100644 index 0000000000..f118b588f9 --- /dev/null +++ b/windows.ui.text/richedittextdocument_canredo_328904111.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.CanRedo +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.CanRedo + +## -description +Determines whether one or more redo operations exist. + +## -parameters + +## -returns +**true** if one or more redo operations exist; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_canundo_730574244.md b/windows.ui.text/richedittextdocument_canundo_730574244.md new file mode 100644 index 0000000000..5e7abf905e --- /dev/null +++ b/windows.ui.text/richedittextdocument_canundo_730574244.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.CanUndo +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.CanUndo + +## -description +Determines whether one or more undo operations exist. + +## -parameters + +## -returns +**true** if one or more undo operations exist; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_carettype.md b/windows.ui.text/richedittextdocument_carettype.md new file mode 100644 index 0000000000..c962ae89b4 --- /dev/null +++ b/windows.ui.text/richedittextdocument_carettype.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Text.RichEditTextDocument.CaretType +-api-type: winrt property +--- + + + +# Windows.UI.Text.RichEditTextDocument.CaretType + +## -description +Gets or sets the caret type. + +## -property-value +The caret type. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_defaulttabstop.md b/windows.ui.text/richedittextdocument_defaulttabstop.md new file mode 100644 index 0000000000..df465e212d --- /dev/null +++ b/windows.ui.text/richedittextdocument_defaulttabstop.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Text.RichEditTextDocument.DefaultTabStop +-api-type: winrt property +--- + + + +# Windows.UI.Text.RichEditTextDocument.DefaultTabStop + +## -description +Gets or sets the default tab spacing. + +## -property-value +The default tab spacing. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_endundogroup_1549565818.md b/windows.ui.text/richedittextdocument_endundogroup_1549565818.md new file mode 100644 index 0000000000..b0a976ed83 --- /dev/null +++ b/windows.ui.text/richedittextdocument_endundogroup_1549565818.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.EndUndoGroup +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.EndUndoGroup + +## -description +Turns off undo grouping. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_getdefaultcharacterformat_1941781921.md b/windows.ui.text/richedittextdocument_getdefaultcharacterformat_1941781921.md new file mode 100644 index 0000000000..63c68bac48 --- /dev/null +++ b/windows.ui.text/richedittextdocument_getdefaultcharacterformat_1941781921.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.GetDefaultCharacterFormat +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.GetDefaultCharacterFormat + +## -description +Retrieves the default character formatting attributes of the document. + +## -parameters + +## -returns +The default character formatting attributes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_getdefaultparagraphformat_1054074895.md b/windows.ui.text/richedittextdocument_getdefaultparagraphformat_1054074895.md new file mode 100644 index 0000000000..e7f0325a42 --- /dev/null +++ b/windows.ui.text/richedittextdocument_getdefaultparagraphformat_1054074895.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.GetDefaultParagraphFormat +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.GetDefaultParagraphFormat + +## -description +Retrieves the default paragraph formatting attributes of the document. + +## -parameters + +## -returns +The default paragraph formatting attributes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_getrange_2138248117.md b/windows.ui.text/richedittextdocument_getrange_2138248117.md new file mode 100644 index 0000000000..896a31be08 --- /dev/null +++ b/windows.ui.text/richedittextdocument_getrange_2138248117.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.GetRange(System.Int32,System.Int32) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.GetRange + +## -description +Retrieves a new text range for the active story of the document. + +## -parameters + +### -param startPosition + +The starting position of the new text range, relative to the beginning of the story. + +### -param endPosition + +The ending position of the new text range. + +## -returns +The new text range. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_getrangefrompoint_1531333045.md b/windows.ui.text/richedittextdocument_getrangefrompoint_1531333045.md new file mode 100644 index 0000000000..c699a47e33 --- /dev/null +++ b/windows.ui.text/richedittextdocument_getrangefrompoint_1531333045.md @@ -0,0 +1,33 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.GetRangeFromPoint(Windows.Foundation.Point,Windows.UI.Text.PointOptions) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.GetRangeFromPoint + +## -description +Retrieves the degenerate (empty) text range at, or nearest to, a particular point on the screen. + +## -parameters + +### -param point + +The location of the point on the screen, in screen coordinates. + +### -param options + +The alignment type of the specified *point*. + +## -returns +The new text range. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_gettext_518428927.md b/windows.ui.text/richedittextdocument_gettext_518428927.md new file mode 100644 index 0000000000..345984de2e --- /dev/null +++ b/windows.ui.text/richedittextdocument_gettext_518428927.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.GetText(Windows.UI.Text.TextGetOptions,System.String@) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.GetText + +## -description +Gets the text in the active story (document). + +## -parameters + +### -param options + +The text retrieval options. + +### -param value + +The text in the active story. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_ignoretrailingcharacterspacing.md b/windows.ui.text/richedittextdocument_ignoretrailingcharacterspacing.md new file mode 100644 index 0000000000..21e4dc6bba --- /dev/null +++ b/windows.ui.text/richedittextdocument_ignoretrailingcharacterspacing.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Text.RichEditTextDocument.IgnoreTrailingCharacterSpacing +-api-type: winrt property +--- + + + +# Windows.UI.Text.RichEditTextDocument.IgnoreTrailingCharacterSpacing + +## -description +Gets or sets a value that indicates whether character spacing is applied to the last character in a line. + +## -property-value +**true** if spacing is applied to the last character in a line of text; otherwise, **false**. The default is **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_loadfromstream_1957374177.md b/windows.ui.text/richedittextdocument_loadfromstream_1957374177.md new file mode 100644 index 0000000000..ac47c84902 --- /dev/null +++ b/windows.ui.text/richedittextdocument_loadfromstream_1957374177.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.LoadFromStream(Windows.UI.Text.TextSetOptions,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.LoadFromStream + +## -description +Loads a document from a stream. + +## -parameters + +### -param options + +The text options to use for the loading the document. + +### -param value + +The random access stream that contains the document. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_redo_1163178780.md b/windows.ui.text/richedittextdocument_redo_1163178780.md new file mode 100644 index 0000000000..88ca7d4b0f --- /dev/null +++ b/windows.ui.text/richedittextdocument_redo_1163178780.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.Redo +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.Redo + +## -description +Reverses the most recent undo operation. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_savetostream_748724562.md b/windows.ui.text/richedittextdocument_savetostream_748724562.md new file mode 100644 index 0000000000..e542dc0673 --- /dev/null +++ b/windows.ui.text/richedittextdocument_savetostream_748724562.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.SaveToStream(Windows.UI.Text.TextGetOptions,Windows.Storage.Streams.IRandomAccessStream) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.SaveToStream + +## -description +Saves the document to a stream. + +## -parameters + +### -param options + +The text options for saving the document. + +### -param value + +The random access stream for saving the document. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_selection.md b/windows.ui.text/richedittextdocument_selection.md new file mode 100644 index 0000000000..dc01317185 --- /dev/null +++ b/windows.ui.text/richedittextdocument_selection.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Text.RichEditTextDocument.Selection +-api-type: winrt property +--- + + + +# Windows.UI.Text.RichEditTextDocument.Selection + +## -description +Gets the active text selection. + +## -property-value +The active text selection. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_setdefaultcharacterformat_6295136.md b/windows.ui.text/richedittextdocument_setdefaultcharacterformat_6295136.md new file mode 100644 index 0000000000..a403dbc4fd --- /dev/null +++ b/windows.ui.text/richedittextdocument_setdefaultcharacterformat_6295136.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.SetDefaultCharacterFormat(Windows.UI.Text.ITextCharacterFormat) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.SetDefaultCharacterFormat + +## -description +Sets the default character formatting attributes of the document. + +## -parameters + +### -param value + +The new default character formatting attributes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_setdefaultparagraphformat_1656512585.md b/windows.ui.text/richedittextdocument_setdefaultparagraphformat_1656512585.md new file mode 100644 index 0000000000..7d06e9a386 --- /dev/null +++ b/windows.ui.text/richedittextdocument_setdefaultparagraphformat_1656512585.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.SetDefaultParagraphFormat(Windows.UI.Text.ITextParagraphFormat) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.SetDefaultParagraphFormat + +## -description +Sets the default paragraph formatting attributes of the document. + +## -parameters + +### -param value + +The default paragraph formatting attributes. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_settext_522499431.md b/windows.ui.text/richedittextdocument_settext_522499431.md new file mode 100644 index 0000000000..4f54d337b3 --- /dev/null +++ b/windows.ui.text/richedittextdocument_settext_522499431.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.SetText(Windows.UI.Text.TextSetOptions,System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.SetText + +## -description +Sets the text of the document. + +## -parameters + +### -param options + +Options that control how the text is inserted into the document. + +### -param value + +The new text. + +## -remarks + +If the string is **NULL**, the text in the document is deleted. + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_undo_1162720031.md b/windows.ui.text/richedittextdocument_undo_1162720031.md new file mode 100644 index 0000000000..347a153fb8 --- /dev/null +++ b/windows.ui.text/richedittextdocument_undo_1162720031.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Text.RichEditTextDocument.Undo +-api-type: winrt method +--- + + + +# Windows.UI.Text.RichEditTextDocument.Undo + +## -description +Undoes the most recent undo group. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/richedittextdocument_undolimit.md b/windows.ui.text/richedittextdocument_undolimit.md new file mode 100644 index 0000000000..9016c62e92 --- /dev/null +++ b/windows.ui.text/richedittextdocument_undolimit.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Text.RichEditTextDocument.UndoLimit +-api-type: winrt property +--- + + + +# Windows.UI.Text.RichEditTextDocument.UndoLimit + +## -description +Gets or sets the maximum number of actions that can be stored in the undo queue. + +## -property-value +The maximum number of undo actions. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/textdecorations.md b/windows.ui.text/textdecorations.md new file mode 100644 index 0000000000..0cc78f8c70 --- /dev/null +++ b/windows.ui.text/textdecorations.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.UI.Text.TextDecorations +-api-type: winrt enum +--- + + + +# Windows.UI.Text.TextDecorations + +## -description +Defines constants that specify the decorations applied to text. + +## -enum-fields +### -field None:0 +No text decorations are applied. + +### -field Underline:1 +Underline is applied to the text. + +### -field Strikethrough:2 +Strikethrough is applied to the text. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.text/textgetoptions.md b/windows.ui.text/textgetoptions.md index 787c5c8082..3fe25245ec 100644 --- a/windows.ui.text/textgetoptions.md +++ b/windows.ui.text/textgetoptions.md @@ -37,10 +37,15 @@ Include list numbers. ### -field FormatRtf:8192 Retrieve Rich Text Format (RTF) instead of plain text. Rich Text Format (RTF) is a BYTE (8-bit) format, but because [ITextRange.GetText](itextrange_gettext.md) returns a string, the Rich Text Format (RTF) is returned as WCHARs (16-bit or UTF-16), not bytes, when you call [ITextRange.GetText](itextrange_gettext.md) with the **FormatRtf** value. When you call [ITextRange.SetText](itextrange_settext.md) with **FormatRtf**, the method accepts an string containing either bytes or WCHARs, but other Rich Text Format (RTF) readers only understand bytes. +### -field UseLf:16777216 +Use line feed (LF) in place of all carriage returns. + ## -remarks +If both UseLf and UseCrLf are used an invalid argument exception is thrown. + ## -examples ## -see-also -[ITextDocument.GetText](itextdocument_gettext.md), [ITextDocument.SaveToStream](itextdocument_savetostream.md), [ITextRange.GetTextViaStream](itextrange_gettextviastream.md), [ITextRange.SetTextViaStream](itextrange_settextviastream.md), [ITextRange.GetText](itextrange_gettext.md) \ No newline at end of file +[ITextDocument.GetText](itextdocument_gettext.md), [ITextDocument.SaveToStream](itextdocument_savetostream.md), [ITextRange.GetTextViaStream](itextrange_gettextviastream.md), [ITextRange.SetTextViaStream](itextrange_settextviastream.md), [ITextRange.GetText](itextrange_gettext.md) diff --git a/windows.ui.viewmanagement/applicationview_isviewmodesupported_1233321844.md b/windows.ui.viewmanagement/applicationview_isviewmodesupported_1233321844.md new file mode 100644 index 0000000000..f976a352a1 --- /dev/null +++ b/windows.ui.viewmanagement/applicationview_isviewmodesupported_1233321844.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.ViewManagement.ApplicationView.IsViewModeSupported(Windows.UI.ViewManagement.ApplicationViewMode) +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.ApplicationView.IsViewModeSupported + +## -description +Determines whether the specified view mode is supported on the current device. + +## -parameters + +### -param viewMode +A value of the enumeration that indicates the desired view mode. + +## -returns +**true** if the specified view mode is supported; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationview_tryconsolidateasync_451004985.md b/windows.ui.viewmanagement/applicationview_tryconsolidateasync_451004985.md new file mode 100644 index 0000000000..aab9f31be0 --- /dev/null +++ b/windows.ui.viewmanagement/applicationview_tryconsolidateasync_451004985.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.ViewManagement.ApplicationView.TryConsolidateAsync +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.ApplicationView.TryConsolidateAsync + +## -description +Closes the current view in a multi-view app. + +## -parameters + +## -returns +**true** if the app views are consolidated; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationview_tryenterviewmodeasync_1990884374.md b/windows.ui.viewmanagement/applicationview_tryenterviewmodeasync_1990884374.md new file mode 100644 index 0000000000..5c9b75021c --- /dev/null +++ b/windows.ui.viewmanagement/applicationview_tryenterviewmodeasync_1990884374.md @@ -0,0 +1,32 @@ +--- +-api-id: M:Windows.UI.ViewManagement.ApplicationView.TryEnterViewModeAsync(Windows.UI.ViewManagement.ApplicationViewMode,Windows.UI.ViewManagement.ViewModePreferences) +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.ApplicationView.TryEnterViewModeAsync + +## -description +Attempts to change the app view to the specified view mode using the specified options. + +## -parameters + +### -param viewMode +A value of the enumeration that indicates the desired view mode. + +### -param viewModePreferences +Preferred settings for the desired view mode. + +## -returns +**true** if the app view was changed to the specified view mode; otherwise, **false**. + +## -remarks +The view mode preferences are requested values only. The system might override these values when your app is changed to the new view mode. + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationview_tryenterviewmodeasync_464499518.md b/windows.ui.viewmanagement/applicationview_tryenterviewmodeasync_464499518.md new file mode 100644 index 0000000000..5aaa0b806c --- /dev/null +++ b/windows.ui.viewmanagement/applicationview_tryenterviewmodeasync_464499518.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.ViewManagement.ApplicationView.TryEnterViewModeAsync(Windows.UI.ViewManagement.ApplicationViewMode) +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.ApplicationView.TryEnterViewModeAsync + +## -description +Attempts to change the app view to the specified view mode. + +## -parameters + +### -param viewMode +A value of the enumeration that indicates the desired view mode. + +## -returns +**true** if the app view was changed to the specified view mode; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationview_viewmode.md b/windows.ui.viewmanagement/applicationview_viewmode.md new file mode 100644 index 0000000000..9128c5bf3a --- /dev/null +++ b/windows.ui.viewmanagement/applicationview_viewmode.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.ViewManagement.ApplicationView.ViewMode +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.ApplicationView.ViewMode + +## -description +Gets the app view mode for the current view. + +## -property-value +A value of the enumeration that indicates the view mode of the current view. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationviewconsolidatedeventargs_isappinitiated.md b/windows.ui.viewmanagement/applicationviewconsolidatedeventargs_isappinitiated.md new file mode 100644 index 0000000000..0242e75ae5 --- /dev/null +++ b/windows.ui.viewmanagement/applicationviewconsolidatedeventargs_isappinitiated.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.ViewManagement.ApplicationViewConsolidatedEventArgs.IsAppInitiated +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.ApplicationViewConsolidatedEventArgs.IsAppInitiated + +## -description +Gets a value that indicates whether the window consolidation was app-initiated. + +## -property-value +**true** if the window consolidation operation was app-initiated; otherwise **false**. + +## -remarks +This property is **true** if the window consolidation was due to a call to [ApplicationView.TryConsolidateAsync](./applicationview_tryconsolidateasync_451004985.md). Otherwise, window consolidation could be system-initiated or user-initiated. + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationviewconsolidatedeventargs_isuserinitiated.md b/windows.ui.viewmanagement/applicationviewconsolidatedeventargs_isuserinitiated.md index 1cc229ee47..06709d5b98 100644 --- a/windows.ui.viewmanagement/applicationviewconsolidatedeventargs_isuserinitiated.md +++ b/windows.ui.viewmanagement/applicationviewconsolidatedeventargs_isuserinitiated.md @@ -10,12 +10,13 @@ public bool IsUserInitiated { get; } # Windows.UI.ViewManagement.ApplicationViewConsolidatedEventArgs.IsUserInitiated ## -description -Indicates whether the window consolidation was user- or system-initiated. +Gets a value that indicates whether the window consolidation was user-initiated. ## -property-value -**true** if the window consolidation operation was user-initiated; **false** if it was system-initiated. +**true** if the window consolidation operation was user-initiated; otherwise, **false**. ## -remarks +This property is **true** if the window consolidation was due to the user performing a close gesture. Otherwise, windows consolidation could be system-initiated or app-initiated (by a call to [ApplicationView.TryConsolidateAsync](./applicationview_tryconsolidateasync_451004985.md)). ## -examples diff --git a/windows.ui.viewmanagement/applicationviewmode.md b/windows.ui.viewmanagement/applicationviewmode.md new file mode 100644 index 0000000000..98bbf8e683 --- /dev/null +++ b/windows.ui.viewmanagement/applicationviewmode.md @@ -0,0 +1,27 @@ +--- +-api-id: T:Windows.UI.ViewManagement.ApplicationViewMode +-api-type: winrt enum +--- + + + +# Windows.UI.ViewManagement.ApplicationViewMode + +## -description +Defines constants that specify the view mode of an app window. + +## -enum-fields +### -field Default:0 +The app window is in it's default mode. + +### -field CompactOverlay:1 +The app window is in a compact overlay (picture-in-picture) mode. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationviewswitcher_tryshowasviewmodeasync_244173756.md b/windows.ui.viewmanagement/applicationviewswitcher_tryshowasviewmodeasync_244173756.md new file mode 100644 index 0000000000..3a6da58f5c --- /dev/null +++ b/windows.ui.viewmanagement/applicationviewswitcher_tryshowasviewmodeasync_244173756.md @@ -0,0 +1,31 @@ +--- +-api-id: M:Windows.UI.ViewManagement.ApplicationViewSwitcher.TryShowAsViewModeAsync(System.Int32,Windows.UI.ViewManagement.ApplicationViewMode) +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.ApplicationViewSwitcher.TryShowAsViewModeAsync + +## -description +Displays a view as a standalone view in the desired view mode. + +## -parameters + +### -param viewId +The ID of the window to display. + +### -param viewMode +The desired view mode for the window. + +## -returns +Asynchronously returns **true** if the call succeeds; **false** if it does not. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/applicationviewswitcher_tryshowasviewmodeasync_729393684.md b/windows.ui.viewmanagement/applicationviewswitcher_tryshowasviewmodeasync_729393684.md new file mode 100644 index 0000000000..20a871b5ad --- /dev/null +++ b/windows.ui.viewmanagement/applicationviewswitcher_tryshowasviewmodeasync_729393684.md @@ -0,0 +1,34 @@ +--- +-api-id: M:Windows.UI.ViewManagement.ApplicationViewSwitcher.TryShowAsViewModeAsync(System.Int32,Windows.UI.ViewManagement.ApplicationViewMode,Windows.UI.ViewManagement.ViewModePreferences) +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.ApplicationViewSwitcher.TryShowAsViewModeAsync + +## -description +Displays a view as a standalone view in the desired view mode with the specified options. + +## -parameters + +### -param viewId +The ID of the window to display. + +### -param viewMode +The desired view mode for the window. + +### -param viewModePreferences +Preferred settings for the desired view mode. + +## -returns +Asynchronously returns **true** if the call succeeds; **false** if it does not. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/uisettings_advancedeffectsenabled.md b/windows.ui.viewmanagement/uisettings_advancedeffectsenabled.md new file mode 100644 index 0000000000..01a80c3c08 --- /dev/null +++ b/windows.ui.viewmanagement/uisettings_advancedeffectsenabled.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.ViewManagement.UISettings.AdvancedEffectsEnabled +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.UISettings.AdvancedEffectsEnabled + +## -description +Gets a value that indicates whether the system advanced UI effects setting is enabled. + +## -property-value +**true** if advanced UI effects are enabled; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/uisettings_advancedeffectsenabledchanged.md b/windows.ui.viewmanagement/uisettings_advancedeffectsenabledchanged.md new file mode 100644 index 0000000000..d17ba8b4a2 --- /dev/null +++ b/windows.ui.viewmanagement/uisettings_advancedeffectsenabledchanged.md @@ -0,0 +1,20 @@ +--- +-api-id: E:Windows.UI.ViewManagement.UISettings.AdvancedEffectsEnabledChanged +-api-type: winrt event +--- + + + +# Windows.UI.ViewManagement.UISettings.AdvancedEffectsEnabledChanged + +## -description +Occurs when the system advanced UI effects setting is enabled or disabled. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/viewmodepreferences.md b/windows.ui.viewmanagement/viewmodepreferences.md new file mode 100644 index 0000000000..fcb1ecf978 --- /dev/null +++ b/windows.ui.viewmanagement/viewmodepreferences.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.UI.ViewManagement.ViewModePreferences +-api-type: winrt class +--- + + + +# Windows.UI.ViewManagement.ViewModePreferences + +## -description +Represents the preferred settings to be applied to a view when it's changed to a new view mode. + +## -remarks +To get an instance of **ViewModePreferences**, call the [CreateDefault](viewmodepreferences_createdefault_1698970327.md) method. + +These view mode preferences are requested values only. The system might override these values when your app is changed to the new view mode. + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/viewmodepreferences_createdefault_1698970327.md b/windows.ui.viewmanagement/viewmodepreferences_createdefault_1698970327.md new file mode 100644 index 0000000000..9b4f2595c3 --- /dev/null +++ b/windows.ui.viewmanagement/viewmodepreferences_createdefault_1698970327.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.ViewManagement.ViewModePreferences.CreateDefault(Windows.UI.ViewManagement.ApplicationViewMode) +-api-type: winrt method +--- + + + +# Windows.UI.ViewManagement.ViewModePreferences.CreateDefault + +## -description +Creates a new instance of **ViewModePreferences** with default property values set for the specified view mode. + +## -parameters + +### -param mode +The view mode to set default preferences for. + +## -returns +A new instance of **ViewModePreferences** with default property values set for the specified view mode. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/viewmodepreferences_customsize.md b/windows.ui.viewmanagement/viewmodepreferences_customsize.md new file mode 100644 index 0000000000..930573db96 --- /dev/null +++ b/windows.ui.viewmanagement/viewmodepreferences_customsize.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.ViewManagement.ViewModePreferences.CustomSize +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.ViewModePreferences.CustomSize + +## -description +Gets or sets a custom preferred size for the app window. + +## -property-value +The preferred size for the app window. + +## -remarks +If you set this property, you must also set the [ViewSizePreference](viewmodepreferences_viewsizepreference.md) property value to **ViewSizePreference.Custom**. Otherwise, the custom size value set here is ignored. + + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/viewmodepreferences_viewsizepreference.md b/windows.ui.viewmanagement/viewmodepreferences_viewsizepreference.md new file mode 100644 index 0000000000..a39e134794 --- /dev/null +++ b/windows.ui.viewmanagement/viewmodepreferences_viewsizepreference.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.ViewManagement.ViewModePreferences.ViewSizePreference +-api-type: winrt property +--- + + + +# Windows.UI.ViewManagement.ViewModePreferences.ViewSizePreference + +## -description +Gets or sets the preferred size of the app window. + +## -property-value +A value of the enumeration that indicates the preferred size of the app window. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.viewmanagement/viewsizepreference.md b/windows.ui.viewmanagement/viewsizepreference.md index ea5ff914e9..e8cb0aa8d2 100644 --- a/windows.ui.viewmanagement/viewsizepreference.md +++ b/windows.ui.viewmanagement/viewsizepreference.md @@ -31,10 +31,15 @@ The window uses the minimum horizontal pixel width (either 320 or 500 pixels) sp ### -field UseNone:5 The window has no visible component. +### -field Custom:6 +The window uses a custom preferred size specifed in the app. ## -remarks An "app view" is the displayed portion of a Windows Store app, and which can be variably sized by the user. A user's screen can have up to 4 app views of variable width displayed simultaneously, with a combined horizontal pixel width equal to that of the display device's horizontal resolution. +### Custom view sizes +Set the [ViewModePreferences.ViewSizePreference](viewmodepreferences_viewsizepreference.md) property value to **Custom** when you set the [ViewModePreferences.CustomSize](viewmodepreferences_customsize.md) property. + ## -examples -## -see-also \ No newline at end of file +## -see-also diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs.md b/windows.ui.webui/webuicontactpanelactivatedeventargs.md new file mode 100644 index 0000000000..2df94cd4f8 --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs_activatedoperation.md b/windows.ui.webui/webuicontactpanelactivatedeventargs_activatedoperation.md new file mode 100644 index 0000000000..790cb73d9e --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs_activatedoperation.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.ActivatedOperation +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.ActivatedOperation + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs_contact.md b/windows.ui.webui/webuicontactpanelactivatedeventargs_contact.md new file mode 100644 index 0000000000..474a775f83 --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs_contact.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.Contact +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.Contact + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs_contactpanel.md b/windows.ui.webui/webuicontactpanelactivatedeventargs_contactpanel.md new file mode 100644 index 0000000000..b152cbce87 --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs_contactpanel.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.ContactPanel +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.ContactPanel + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs_kind.md b/windows.ui.webui/webuicontactpanelactivatedeventargs_kind.md new file mode 100644 index 0000000000..6c990d445a --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs_kind.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.Kind + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs_previousexecutionstate.md b/windows.ui.webui/webuicontactpanelactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..e9cb876a82 --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.PreviousExecutionState + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs_splashscreen.md b/windows.ui.webui/webuicontactpanelactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..873c7d4ddb --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs_splashscreen.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.SplashScreen + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuicontactpanelactivatedeventargs_user.md b/windows.ui.webui/webuicontactpanelactivatedeventargs_user.md new file mode 100644 index 0000000000..8bf2f6fb2a --- /dev/null +++ b/windows.ui.webui/webuicontactpanelactivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIContactPanelActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuidevicepairingactivatedeventargs_user.md b/windows.ui.webui/webuidevicepairingactivatedeventargs_user.md new file mode 100644 index 0000000000..58cd51f38e --- /dev/null +++ b/windows.ui.webui/webuidevicepairingactivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIDevicePairingActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIDevicePairingActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuidialreceiveractivatedeventargs_user.md b/windows.ui.webui/webuidialreceiveractivatedeventargs_user.md new file mode 100644 index 0000000000..e866add29b --- /dev/null +++ b/windows.ui.webui/webuidialreceiveractivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIDialReceiverActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIDialReceiverActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuilockscreenactivatedeventargs_user.md b/windows.ui.webui/webuilockscreenactivatedeventargs_user.md new file mode 100644 index 0000000000..2b62e5da42 --- /dev/null +++ b/windows.ui.webui/webuilockscreenactivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUILockScreenActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUILockScreenActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuilockscreencomponentactivatedeventargs.md b/windows.ui.webui/webuilockscreencomponentactivatedeventargs.md new file mode 100644 index 0000000000..1506cee0a2 --- /dev/null +++ b/windows.ui.webui/webuilockscreencomponentactivatedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuilockscreencomponentactivatedeventargs_activatedoperation.md b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_activatedoperation.md new file mode 100644 index 0000000000..5082a0eb7c --- /dev/null +++ b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_activatedoperation.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.ActivatedOperation +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.ActivatedOperation + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuilockscreencomponentactivatedeventargs_kind.md b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_kind.md new file mode 100644 index 0000000000..0631b4b891 --- /dev/null +++ b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_kind.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.Kind + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuilockscreencomponentactivatedeventargs_previousexecutionstate.md b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..61397f6a31 --- /dev/null +++ b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.PreviousExecutionState + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuilockscreencomponentactivatedeventargs_splashscreen.md b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..6ee8554425 --- /dev/null +++ b/windows.ui.webui/webuilockscreencomponentactivatedeventargs_splashscreen.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUILockScreenComponentActivatedEventArgs.SplashScreen + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs.md b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs.md new file mode 100644 index 0000000000..c1499203b5 --- /dev/null +++ b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs + +## -description + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_activatedoperation.md b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_activatedoperation.md new file mode 100644 index 0000000000..06957758b4 --- /dev/null +++ b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_activatedoperation.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.ActivatedOperation +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.ActivatedOperation + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_kind.md b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_kind.md new file mode 100644 index 0000000000..c737303142 --- /dev/null +++ b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_kind.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.Kind +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.Kind + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_previousexecutionstate.md b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_previousexecutionstate.md new file mode 100644 index 0000000000..2a7e10e868 --- /dev/null +++ b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_previousexecutionstate.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.PreviousExecutionState +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.PreviousExecutionState + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_splashscreen.md b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_splashscreen.md new file mode 100644 index 0000000000..e27d5c5194 --- /dev/null +++ b/windows.ui.webui/webuiprintworkflowforegroundtaskactivatedeventargs_splashscreen.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.SplashScreen +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIPrintWorkflowForegroundTaskActivatedEventArgs.SplashScreen + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiprotocolforresultsactivatedeventargs_user.md b/windows.ui.webui/webuiprotocolforresultsactivatedeventargs_user.md new file mode 100644 index 0000000000..373d67bdd2 --- /dev/null +++ b/windows.ui.webui/webuiprotocolforresultsactivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIProtocolForResultsActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIProtocolForResultsActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuisharetargetactivatedeventargs_shareoperation.md b/windows.ui.webui/webuisharetargetactivatedeventargs_shareoperation.md index 20d18d3f09..2aa474f460 100644 --- a/windows.ui.webui/webuisharetargetactivatedeventargs_shareoperation.md +++ b/windows.ui.webui/webuisharetargetactivatedeventargs_shareoperation.md @@ -1,23 +1,23 @@ ---- --api-id: P:Windows.UI.WebUI.WebUIShareTargetActivatedEventArgs.ShareOperation --api-type: winrt property ---- - - - -# Windows.UI.WebUI.WebUIShareTargetActivatedEventArgs.ShareOperation - -## -description -Gets information about data included in a share operation. - -## -property-value -An object that includes the data included in a send operation. - -## -remarks -You can use the [ShareOperation](XREF:TODO:w_appmod_dataxfer_share.shareoperation) object to get the data that a user wants to send. It also contains methods your app can use to track the progress of the operation. - -## -examples - -## -see-also +--- +-api-id: P:Windows.UI.WebUI.WebUIShareTargetActivatedEventArgs.ShareOperation +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIShareTargetActivatedEventArgs.ShareOperation + +## -description +Gets information about data included in a share operation. + +## -property-value +An object that includes the data included in a send operation. + +## -remarks +You can use the [ShareOperation](http://msdn.microsoft.com/library/0794ca7c-8c1f-467d-b3c7-a005d09f4a6f) object to get the data that a user wants to send. It also contains methods your app can use to track the progress of the operation. + +## -examples + +## -see-also diff --git a/windows.ui.webui/webuitoastnotificationactivatedeventargs_user.md b/windows.ui.webui/webuitoastnotificationactivatedeventargs_user.md new file mode 100644 index 0000000000..ade6f4ba63 --- /dev/null +++ b/windows.ui.webui/webuitoastnotificationactivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIToastNotificationActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIToastNotificationActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.webui/webuiwebaccountprovideractivatedeventargs_user.md b/windows.ui.webui/webuiwebaccountprovideractivatedeventargs_user.md new file mode 100644 index 0000000000..b5a992ecea --- /dev/null +++ b/windows.ui.webui/webuiwebaccountprovideractivatedeventargs_user.md @@ -0,0 +1,21 @@ +--- +-api-id: P:Windows.UI.WebUI.WebUIWebAccountProviderActivatedEventArgs.User +-api-type: winrt property +--- + + + +# Windows.UI.WebUI.WebUIWebAccountProviderActivatedEventArgs.User + +## -description + +## -property-value + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/automationpeer_automationpeer_1221375020.md b/windows.ui.xaml.automation.peers/automationpeer_automationpeer_1221375020.md new file mode 100644 index 0000000000..75ee9f3508 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_automationpeer_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.AutomationPeer + +## -description +Provides base class initialization behavior for [AutomationPeer](automationpeer.md) derived classes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getacceleratorkeycore_1091687272.md b/windows.ui.xaml.automation.peers/automationpeer_getacceleratorkeycore_1091687272.md new file mode 100644 index 0000000000..91bc798749 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getacceleratorkeycore_1091687272.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAcceleratorKeyCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAcceleratorKeyCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetAcceleratorKey](automationpeer_getacceleratorkey.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The accelerator key. + +## -remarks + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getaccesskeycore_536668621.md b/windows.ui.xaml.automation.peers/automationpeer_getaccesskeycore_536668621.md new file mode 100644 index 0000000000..8a005b0f9f --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getaccesskeycore_536668621.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAccessKeyCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAccessKeyCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetAccessKey](automationpeer_getaccesskey.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The access key. + +## -remarks + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getannotationscore_1797498085.md b/windows.ui.xaml.automation.peers/automationpeer_getannotationscore_1797498085.md new file mode 100644 index 0000000000..2b7dad5087 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getannotationscore_1797498085.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAnnotationsCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAnnotationsCore + +## -description +Provides the behavior of the peer when a Microsoft UI Automation client calls [GetAnnotations](automationpeer_getannotations.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The behavior of the peer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getautomationcontroltypecore_1718556232.md b/windows.ui.xaml.automation.peers/automationpeer_getautomationcontroltypecore_1718556232.md new file mode 100644 index 0000000000..f20a468c32 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getautomationcontroltypecore_1718556232.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationControlTypeCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationControlTypeCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetAutomationControlType](automationpeer_getautomationcontroltype.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The control type. + +## -remarks +The base implementation for [AutomationPeer](automationpeer.md) and [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) return **Custom**. If you keep this behavior, you must override [GetLocalizedControlTypeCore](automationpeer_getlocalizedcontroltypecore.md). + +The more common scenario for defining an automation peer is overriding one of the existing peer classes that pairs with the control class you are overriding. In this case each such peer class reports a practical value of [AutomationControlType](automationcontroltype.md) that makes sense for the original owner control that the peer was implemented for. Often you can leave this behavior alone. It isn't typical to derive from a control-specific peer and use its behavior but then change the **AutomationControlType**, which is probably the most basic information that a peer reports. Check the existing behavior of the peer class you are overriding, and verify that you're reporting the correct control type. Also, double-check that there isn't a more specific peer class available that could already be reporting the correct control type as well as providing other behavior that's more appropriate for your peer. For more info, see [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4). + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getautomationidcore_1946737113.md b/windows.ui.xaml.automation.peers/automationpeer_getautomationidcore_1946737113.md new file mode 100644 index 0000000000..b4ba9a9299 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getautomationidcore_1946737113.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationIdCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetAutomationIdCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetAutomationId](automationpeer_getautomationid.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The automation identifier. + +## -remarks +Providing a class-based behavior for **AutomationId** is uncommon. Typically, app authors set values for elements in the app by setting the [AutomationProperties.AutomationId](../windows.ui.xaml.automation/automationproperties_automationid.md) attached property in the XAML UI definition. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getboundingrectanglecore_304219283.md b/windows.ui.xaml.automation.peers/automationpeer_getboundingrectanglecore_304219283.md new file mode 100644 index 0000000000..35f20ee766 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getboundingrectanglecore_304219283.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetBoundingRectangleCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetBoundingRectangleCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetBoundingRectangle](automationpeer_getboundingrectangle.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The bounding rectangle. + +## -remarks + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getchildrencore_766641859.md b/windows.ui.xaml.automation.peers/automationpeer_getchildrencore_766641859.md new file mode 100644 index 0000000000..6861d6f99e --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getchildrencore_766641859.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetChildrenCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetChildrenCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetChildren](automationpeer_getchildren.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The collection of [AutomationPeer](automationpeer.md) objects for child elements. + +## -remarks +The base implementation returns null. Peers that represent controls with item collections may override this result. Test the behavior of the peer you are using or overriding and override [GetChildrenCore](automationpeer_getchildrencore.md) if you want to change that behavior. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getclassnamecore_637441696.md b/windows.ui.xaml.automation.peers/automationpeer_getclassnamecore_637441696.md new file mode 100644 index 0000000000..70f7c2174b --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getclassnamecore_637441696.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetClassNameCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetClassNameCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetClassName](automationpeer_getclassname.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The class name. + +## -remarks +You should never invoke the base behavior, and all custom peers should override [GetClassNameCore](automationpeer_getclassnamecore.md) to report the class name that is unique to that peer class. For more info, see [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4). + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [GetLocalizedControlTypeCore](automationpeer_getlocalizedcontroltypecore.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getclickablepointcore_2058405946.md b/windows.ui.xaml.automation.peers/automationpeer_getclickablepointcore_2058405946.md new file mode 100644 index 0000000000..6bdcde2711 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getclickablepointcore_2058405946.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetClickablePointCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetClickablePointCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetClickablePoint](automationpeer_getclickablepoint.md) or an equivalent Microsoft UI Automation client API. + +## -returns +A point within the clickable area of the element. + +## -remarks +The base implementation returns a default [Point](../windows.foundation/point.md) (coordinates 0,0). Peers that represent items defer to the container. [ScrollBarAutomationPeer](scrollbarautomationpeer.md) and [SliderAutomationPeer](sliderautomationpeer.md) both have behavior that can't adequately express one point for the purposes of [GetClickablePoint](automationpeer_getclickablepoint.md) scenarios, so these return a [Point](../windows.foundation/point.md) where the coordinate values are [Double.NaN](https://msdn.microsoft.com/library/system.double.nan.aspx). + +> [!NOTE] +> Visual C++ component extensions (C++/CX) doesn't have a constant for **NaN**, it uses a value, which appears as "-1.#IND" followed by zeros. Automation clients using languages other than C# or Visual C++ component extensions (C++/CX) may see **NaN** represented in a different form. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getcontrolledpeerscore_1181675240.md b/windows.ui.xaml.automation.peers/automationpeer_getcontrolledpeerscore_1181675240.md new file mode 100644 index 0000000000..5ffd0eb00c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getcontrolledpeerscore_1181675240.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetControlledPeersCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetControlledPeersCore + +## -description +Gets a list of the controlled peers for the current automation peer. + +## -returns +A list of the controlled peers for the current automation peer. + +## -remarks +Examining controlled peers is an advanced scenario that most peer implementations won't need to use. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getculture_2096331283.md b/windows.ui.xaml.automation.peers/automationpeer_getculture_2096331283.md new file mode 100644 index 0000000000..a45a631c17 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getculture_2096331283.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetCulture +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetCulture + +## -description +Calls [GetCultureCore](automationpeer_getculturecore_562664259.md) to get the culture value for the element that is associated with the automation peer. + +## -parameters + +## -returns +The value of the culture property for the element that is associated with the automation peer. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/automationpeer_getculturecore_562664259.md b/windows.ui.xaml.automation.peers/automationpeer_getculturecore_562664259.md new file mode 100644 index 0000000000..aab7d265b0 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getculturecore_562664259.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetCultureCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetCultureCore + +## -description +Gets the culture value for the element that is associated with the automation peer. + +## -returns +The value of the culture property for the element that is associated with the automation peer. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/automationpeer_getdescribedbycore_658314794.md b/windows.ui.xaml.automation.peers/automationpeer_getdescribedbycore_658314794.md new file mode 100644 index 0000000000..db4a13fb04 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getdescribedbycore_658314794.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetDescribedByCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetDescribedByCore + +## -description +Gets a collection of elements that provide more information about the automation element. + +## -returns +A collection of elements that provide more information about the automation element. + +## -remarks +[GetDescribedBy](automationpeer_getdescribedbycore.md) is used when an automation element is explained by another segment of the application UI. For example, the collection can point to a text element of "2,529 items in 85 groups, 10 items selected" from a complex custom list object. Instead of using the object model for clients to digest similar information, the collection returned by [GetDescribedBy](automationpeer_getdescribedbycore.md) can offer quick access to UI elements that may already offer useful end-user information that describes the UI element. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getelementfrompointcore_277430650.md b/windows.ui.xaml.automation.peers/automationpeer_getelementfrompointcore_277430650.md new file mode 100644 index 0000000000..e318ff66b3 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getelementfrompointcore_277430650.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetElementFromPointCore(Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetElementFromPointCore + +## -description +Provides the behavior of the peer when a Microsoft UI Automation client calls [GetElementFromPoint](automationpeer_getelementfrompoint.md) or an equivalent Microsoft UI Automation client API. + +## -parameters +### -param pointInWindowCoordinates +The specified point. + +## -returns +The behavior of the peer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getflowsfromcore_1529497421.md b/windows.ui.xaml.automation.peers/automationpeer_getflowsfromcore_1529497421.md new file mode 100644 index 0000000000..a164c6f8cf --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getflowsfromcore_1529497421.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFlowsFromCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFlowsFromCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetFlowsFrom](../windows.ui.xaml.automation/automationproperties_getflowsfrom.md) or an equivalent Microsoft UI Automation client API. + +## -returns +A list of automation elements that suggests the reading order before the current automation element. + +## -remarks +The "Core" methods are the standard implementations that perform the default action of an associated UI Automation client-callable method. You can override any of the "Core" methods to return alternative values in a custom automation peer. In this case, [GetFlowsFromCore](automationpeer_getflowsfromcore.md) is invoked any time that [GetFlowsFrom](../windows.ui.xaml.automation/automationproperties_getflowsfrom.md) is called. + +The base implementation for [AutomationPeer](automationpeer.md) returns null. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getflowstocore_1266863981.md b/windows.ui.xaml.automation.peers/automationpeer_getflowstocore_1266863981.md new file mode 100644 index 0000000000..fd9ab50663 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getflowstocore_1266863981.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFlowsToCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFlowsToCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetFlowsTo](../windows.ui.xaml.automation/automationproperties_getflowsto.md) or an equivalent Microsoft UI Automation client API. + +## -returns +A list of automation elements that suggests the reading order after the current automation element. + +## -remarks +The "Core" methods are the standard implementations that perform the default action of an associated UI Automation client-callable method. You can override any of the "Core" methods to return alternative values in a custom automation peer. In this case, [GetFlowsToCore](automationpeer_getflowstocore.md) is invoked any time that [GetFlowsTo](../windows.ui.xaml.automation/automationproperties_getflowsto.md) is called. + +The base implementation for [AutomationPeer](automationpeer.md) returns null. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getfocusedelementcore_1410074383.md b/windows.ui.xaml.automation.peers/automationpeer_getfocusedelementcore_1410074383.md new file mode 100644 index 0000000000..e42b1fe1df --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getfocusedelementcore_1410074383.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFocusedElementCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFocusedElementCore + +## -description +Provides the behavior of the peer when a Microsoft UI Automation client calls [GetFocusedElement](automationpeer_getfocusedelement.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The behavior of the peer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getfulldescriptioncore_467477679.md b/windows.ui.xaml.automation.peers/automationpeer_getfulldescriptioncore_467477679.md new file mode 100644 index 0000000000..f471ba923a --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getfulldescriptioncore_467477679.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFullDescriptionCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetFullDescriptionCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetFullDescription](automationpeer_getfulldescription.md) or an equivalent Microsoft UI Automation client API. + +## -returns +A localized string that describes the actual visual appearance or contents of something such as an image or image control. + +## -remarks +You should never invoke the base behavior, and all custom peers should override [GetFullDescriptionCore](automationpeer_getfulldescriptioncore.md) to report the full description of this [AutomationPeer](automationpeer.md). For more info, see [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4). + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_gethelptextcore_1515335276.md b/windows.ui.xaml.automation.peers/automationpeer_gethelptextcore_1515335276.md new file mode 100644 index 0000000000..53c443bb6d --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_gethelptextcore_1515335276.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetHelpTextCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetHelpTextCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetHelpText](automationpeer_gethelptext.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The help text. + +## -remarks +Specifying a control behavior for help text is uncommon. In most cases, apps that need it will establish help text information in the UI by applying the [AutomationProperties.HelpText](../windows.ui.xaml.automation/automationproperties_helptext.md) attached property to the UI definition XAML. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [AutomationProperties.HelpText](../windows.ui.xaml.automation/automationproperties_helptext.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getitemstatuscore_2079441640.md b/windows.ui.xaml.automation.peers/automationpeer_getitemstatuscore_2079441640.md new file mode 100644 index 0000000000..165a624923 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getitemstatuscore_2079441640.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetItemStatusCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetItemStatusCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetItemStatus](automationpeer_getitemstatus.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The item status. + +## -remarks + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getitemtypecore_7883200.md b/windows.ui.xaml.automation.peers/automationpeer_getitemtypecore_7883200.md new file mode 100644 index 0000000000..64ba38037c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getitemtypecore_7883200.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetItemTypeCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetItemTypeCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetItemType](automationpeer_getitemtype.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The kind of item. + +## -remarks + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getlabeledbycore_899978507.md b/windows.ui.xaml.automation.peers/automationpeer_getlabeledbycore_899978507.md new file mode 100644 index 0000000000..5f161d6c86 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getlabeledbycore_899978507.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLabeledByCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLabeledByCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetLabeledBy](automationpeer_getlabeledby.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The [AutomationPeer](automationpeer.md) for the element that is targeted by the [UIElement](XREF:TODO:tsf.ienumtfuielements). + +## -remarks +Specifying a control behavior for labeling is uncommon except for composite data presentation controls that use headers or similar metaphors. In most cases apps establish labeling information between the elements in an app-specific UI by applying the [AutomationProperties.LabeledBy](../windows.ui.xaml.automation/automationproperties_labeledby.md) attached property to the UI definition XAML. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getlandmarktypecore_966013733.md b/windows.ui.xaml.automation.peers/automationpeer_getlandmarktypecore_966013733.md new file mode 100644 index 0000000000..45f161a977 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getlandmarktypecore_966013733.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLandmarkTypeCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLandmarkTypeCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetLandmarkType](automationpeer_getlandmarktype.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The landmark type. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getlevelcore_1204953173.md b/windows.ui.xaml.automation.peers/automationpeer_getlevelcore_1204953173.md new file mode 100644 index 0000000000..76fb4e5276 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getlevelcore_1204953173.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLevelCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLevelCore + +## -description +Provides the behavior of the peer when a Microsoft UI Automation client calls [GetLevel](automationpeer_getlevel.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The behavior of the peer. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getlivesettingcore_2008424374.md b/windows.ui.xaml.automation.peers/automationpeer_getlivesettingcore_2008424374.md new file mode 100644 index 0000000000..3520afadb5 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getlivesettingcore_2008424374.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLiveSettingCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLiveSettingCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetLiveSetting](automationpeer_getlivesetting.md) or an equivalent Microsoft UI Automation client API. + +## -returns +A value of the enumeration that reports the live setting notification behavior for a peer implementation. + +## -remarks + +## -examples + +## -see-also +[AutomationProperties.LiveSetting](../windows.ui.xaml.automation/automationproperties_livesetting.md), [GetLiveSetting](automationpeer_getlivesetting.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getlocalizedcontroltypecore_1799576178.md b/windows.ui.xaml.automation.peers/automationpeer_getlocalizedcontroltypecore_1799576178.md new file mode 100644 index 0000000000..d8a2553887 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getlocalizedcontroltypecore_1799576178.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedControlTypeCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedControlTypeCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetLocalizedControlType](automationpeer_getlocalizedcontroltype_677460473.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The type of the control, as a string that is localized to be suitable for direct presentation to users by assistive technology. + +## -remarks +This method is very rarely overridden by peers. So long as you provide a value for [GetAutomationControlTypeCore](automationpeer_getautomationcontroltypecore.md), all the enumerated constant names from [AutomationControlType](automationcontroltype.md) are already available in localized form to Microsoft UI Automation clients. The necessary translated strings are part of the Microsoft UI Automation support in every Microsoft Windows client. However, if you specify [Custom](automationcontroltype.md) as the control type, you must support a localized control type string that represents the role of the element (for example, "color picker" for a custom control that enables users to choose and specify colors). + +## -examples + +## -see-also +[Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getlocalizedlandmarktypecore_551730277.md b/windows.ui.xaml.automation.peers/automationpeer_getlocalizedlandmarktypecore_551730277.md new file mode 100644 index 0000000000..8262d68018 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getlocalizedlandmarktypecore_551730277.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedLandmarkTypeCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetLocalizedLandmarkTypeCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetLocalizedLandmarkType](automationpeer_getlocalizedlandmarktype.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The landmark type of the peer, as a string that is localized to be suitable for direct presentation to users by assistive technology. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getnamecore_2066192858.md b/windows.ui.xaml.automation.peers/automationpeer_getnamecore_2066192858.md new file mode 100644 index 0000000000..8a9346401c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getnamecore_2066192858.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetNameCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetNameCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetName](automationpeer_getname.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The name as used by assistive technology and other Microsoft UI Automation clients. + +## -remarks +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) introduces behavior to [GetName](automationpeer_getname.md) by providing an intermediate [GetNameCore](automationpeer_getnamecore.md) implementation. If an element has a value for the **LabeledBy**Microsoft UI Automation property, the labeling element's **Name** value is used as the **Name**. + +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) also introduces behavior through an internal **GetPlainText** method that other default peer classes may override in order to access the content model of that control and return a useful default for **Name**. For example, any [ContentControl](../windows.ui.xaml.controls/contentcontrol.md) derived class will use a string representation of its [Content](../windows.ui.xaml.controls/contentcontrol_content.md) value as the default **Name**. This is enabled because internally [ContentControl](../windows.ui.xaml.controls/contentcontrol.md) implements **GetPlainText** and imparts that behavior to all [ContentControl](../windows.ui.xaml.controls/contentcontrol.md) derived classes. This is how you get a useful **Name** default from the string value of a [Button](../windows.ui.xaml.controls/button.md), for example. + +Other specific peers also may have an intermediate [GetNameCore](automationpeer_getnamecore.md) implementation that provides a useful way for that particular Windows Runtime control to provide built-in values for **Name**. The source of these values comes from other UI properties that are typically set in XAML or as app user code. For example, [TextBoxAutomationPeer](textboxautomationpeer.md) implements behavior that uses the value of the [Text](../windows.ui.xaml.controls/textbox_text.md) property from the owner [TextBox](../windows.ui.xaml.controls/textbox.md) as the default **Name**. From the user code perspective, the default behavior can be overridden by applying a different [AutomationProperties.Name](../windows.ui.xaml.automation/automationproperties_name.md) value. From the peer implementer / provider perspective, the default behavior of the peer can be changed by deriving a new peer class from the existing peer, overriding [GetNameCore](automationpeer_getnamecore.md), and giving it a new implementation that wouldn't call the base implementation in at least some cases. + +To learn more about the possible default behavior of specific peer classes for default Windows Runtime controls, see the reference topic for that particular peer class and look for implementation notes in the Remarks section. + +## -examples + +## -see-also +[GetName](automationpeer_getname.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getorientationcore_1299541826.md b/windows.ui.xaml.automation.peers/automationpeer_getorientationcore_1299541826.md new file mode 100644 index 0000000000..5f8a3fcca2 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getorientationcore_1299541826.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetOrientationCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetOrientationCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetOrientation](automationpeer_getorientation.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The orientation of the control. + +## -remarks +The base [AutomationPeer](automationpeer.md) implementation returns **None**. Peers that represent items may modify this to report information from their container. [ScrollBarAutomationPeer](scrollbarautomationpeer.md) and [SliderAutomationPeer](sliderautomationpeer.md) both have a pattern they can access that knows about orientation, so these peers can return a determined value. Test the existing return value in the peer that you are using or overriding and then override that behavior if necessary. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getpatterncore_1167667011.md b/windows.ui.xaml.automation.peers/automationpeer_getpatterncore_1167667011.md new file mode 100644 index 0000000000..d74fb6073d --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getpatterncore_1167667011.md @@ -0,0 +1,40 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetPatternCore(Windows.UI.Xaml.Automation.Peers.PatternInterface) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetPatternCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetPattern](automationpeer_getpattern.md) or an equivalent Microsoft UI Automation client API. + +## -parameters +### -param patternInterface +A value from the [PatternInterface](patterninterface.md) enumeration. + +## -returns +The object that implements the pattern interface; **null** if the peer does not support this interface. + +## -remarks +The standard implementation at the [AutomationPeer](automationpeer.md) level returns **null**, because the basic peer class doesn't support any patterns. The majority of existing Windows Runtime peer classes override this method to report the patterns that a particular peer supports. + +Overriding this method to return the implementation of patterns that your peer class supports is one of the most common scenarios for implementing an automation peer. You can see sample code for this in the [XAML accessibility sample](http://go.microsoft.com/fwlink/p/?linkid=238570) (Scenario 3). You should also read the [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4) topic. + + + +### Windows 8 behavior + +Windows 8 peer-selection behavior is potentially impacted by whether the control is intended to display data as items. The automation logic for Windows 8 might select a dedicated data peer and use its patterns, even if there is a peer indicated for the overall control and that peer overrides [GetPatternCore](automationpeer_getpatterncore.md). For example, you might have the [ListViewAutomationPeer](listviewautomationpeer.md) override for patterns, but in Windows 8 the acting patterns for data items might take precedence, for example the default implementation of [ListViewItemDataAutomationPeer](listviewitemdataautomationpeer.md) might be used and will handle the scrolling pattern when UI Automation looks for patterns in items. This is different starting with Windows 8.1; if there is pattern support indicated in a [GetPatternCore](automationpeer_getpatterncore.md) implementation for the overall control, that implementation is used instead of internal item data peers. + +If you migrate your app code from Windows 8 to Windows 8.1 you may want to account for this behavior change, because it means that your items control pattern support may be used for data items too, and you might have to add behavior for item scrolling, for instance. + +Apps that were compiled for Windows 8 but running on Windows 8.1 continue to use the Windows 8 behavior. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Control patterns and interfaces](http://msdn.microsoft.com/library/2091883c-5d0c-44ed-936a-709022926a42), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd), [XAML accessibility sample](http://go.microsoft.com/fwlink/p/?linkid=238570) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getpeerfrompointcore_311422816.md b/windows.ui.xaml.automation.peers/automationpeer_getpeerfrompointcore_311422816.md new file mode 100644 index 0000000000..7755ac609c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getpeerfrompointcore_311422816.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetPeerFromPointCore(Windows.Foundation.Point) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetPeerFromPointCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [GetPeerFromPoint](automationpeer_getpeerfrompoint.md) or an equivalent Microsoft UI Automation client API. + +## -parameters +### -param point +The relative position of the target UI element in the UI. + +## -returns +The [AutomationPeer](automationpeer.md) for the UI element at the specified point. + +## -remarks + +Test the existing return value in the peer that you are using or overriding and then override that behavior if necessary. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_getpositioninsetcore_369213829.md b/windows.ui.xaml.automation.peers/automationpeer_getpositioninsetcore_369213829.md new file mode 100644 index 0000000000..695593cd3f --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getpositioninsetcore_369213829.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetPositionInSetCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetPositionInSetCore + +## -description +Provides the peer’s behavior when a Microsoft UI Automation client calls [GetPositionInSet](automationpeer_getpositioninset.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The peer’s behavior. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_getsizeofsetcore_1819537108.md b/windows.ui.xaml.automation.peers/automationpeer_getsizeofsetcore_1819537108.md new file mode 100644 index 0000000000..bf75276ad1 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_getsizeofsetcore_1819537108.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetSizeOfSetCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.GetSizeOfSetCore + +## -description +Provides the peer’s behavior when a Microsoft UI Automation client calls [GetSizeOfSet](automationpeer_getsizeofset.md) or an equivalent Microsoft UI Automation client API. + +## -returns +The peer’s behavior. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_haskeyboardfocuscore_1501023026.md b/windows.ui.xaml.automation.peers/automationpeer_haskeyboardfocuscore_1501023026.md new file mode 100644 index 0000000000..e4c78f7e3a --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_haskeyboardfocuscore_1501023026.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.HasKeyboardFocusCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.HasKeyboardFocusCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [HasKeyboardFocus](automationpeer_haskeyboardfocus.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element has keyboard focus; otherwise, **false**. + +## -remarks +The standard implementation at the [AutomationPeer](automationpeer.md) level checks whether the owner has focus, and always returns **false** if the owner isn't focusable. [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) expands this behavior somewhat because it adds awareness of owner characteristics that rely on the owner being a [Control](../windows.ui.xaml.controls/control.md) subclass. Test the existing return value in the peer that you are using or overriding and then override that behavior if necessary. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_iscontentelementcore_1434359348.md b/windows.ui.xaml.automation.peers/automationpeer_iscontentelementcore_1434359348.md new file mode 100644 index 0000000000..58aa4edc9c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_iscontentelementcore_1434359348.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsContentElementCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsContentElementCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [IsContentElement](automationpeer_iscontentelement.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element is a content element; otherwise, **false**. + +## -remarks +The standard implementation at the [AutomationPeer](automationpeer.md) level returns **false**. However, [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) adds behavior that changes the default to **true**. Other specific peers also may affect this behavior; for example [ItemAutomationPeer](itemautomationpeer.md) defers to its container. Test the existing return value in the peer that you are using or overriding and then override that behavior if necessary. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_iscontrolelementcore_241886730.md b/windows.ui.xaml.automation.peers/automationpeer_iscontrolelementcore_241886730.md new file mode 100644 index 0000000000..32462ee552 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_iscontrolelementcore_241886730.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsControlElementCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsControlElementCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [IsControlElement](automationpeer_iscontrolelement.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element is a control; otherwise, **false**. + +## -remarks +The standard implementation at the [AutomationPeer](automationpeer.md) level returns **false**. However, [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) adds behavior that changes the default to **true**. Other specific peers also may affect this behavior; for example many peers return different values depending on whether the owner is created from a control template. Test the existing return value in the peer that you are using or overriding and then override that behavior if necessary. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_isdatavalidforformcore_2014468645.md b/windows.ui.xaml.automation.peers/automationpeer_isdatavalidforformcore_2014468645.md new file mode 100644 index 0000000000..32b7d5f89d --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_isdatavalidforformcore_2014468645.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsDataValidForFormCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsDataValidForFormCore + +## -description +Provides the peer’s behavior when a Microsoft UI Automation client accesses [IsDataValidForForm](automationpeer_isdatavalidforform.md) or an equivalent Microsoft UI Automation client API. + +## -returns +A Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the automation element. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_isenabledcore_1703249466.md b/windows.ui.xaml.automation.peers/automationpeer_isenabledcore_1703249466.md new file mode 100644 index 0000000000..d58a1885ee --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_isenabledcore_1703249466.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsEnabledCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsEnabledCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [IsEnabled](automationpeer_isenabled.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element can be interacted with; otherwise, **false**. + +## -remarks +The standard implementation at the [AutomationPeer](automationpeer.md) level returns **true**. However, [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) adds behavior that checks whether the owner is a [Control](../windows.ui.xaml.controls/control.md) and forwards owner information from [Control.IsEnabled](../windows.ui.xaml.controls/control_isenabled.md). For cases where the owner is not a control but does have a peer, such as for a [TextBlock](../windows.ui.xaml.controls/textblock.md), the [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) implementation returns **true**. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_iskeyboardfocusablecore_357934921.md b/windows.ui.xaml.automation.peers/automationpeer_iskeyboardfocusablecore_357934921.md new file mode 100644 index 0000000000..0375885cf6 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_iskeyboardfocusablecore_357934921.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsKeyboardFocusableCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsKeyboardFocusableCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [IsKeyboardFocusable](automationpeer_iskeyboardfocusable.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element can accept keyboard focus; otherwise, **false**. + +## -remarks +The standard implementation at the [AutomationPeer](automationpeer.md) level returns **false**. However, [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) adds behavior that checks whether the owner is a [Control](../windows.ui.xaml.controls/control.md) or otherwise focusable, and whether the owner is enabled. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_isoffscreencore_1566999434.md b/windows.ui.xaml.automation.peers/automationpeer_isoffscreencore_1566999434.md new file mode 100644 index 0000000000..62f39b5a35 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_isoffscreencore_1566999434.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsOffscreenCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsOffscreenCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [IsOffscreen](automationpeer_isoffscreen.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element is not on the screen; otherwise, **false**. + +## -remarks +The standard implementation returns a result that is based on the owner's [Visibility](../windows.ui.xaml/uielement_visibility.md) value. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [UIElement.Visibility](../windows.ui.xaml/uielement_visibility.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_ispasswordcore_989431979.md b/windows.ui.xaml.automation.peers/automationpeer_ispasswordcore_989431979.md new file mode 100644 index 0000000000..511ad9b2b4 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_ispasswordcore_989431979.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsPasswordCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsPasswordCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [IsPassword](automationpeer_ispassword.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element contains sensitive content; otherwise, **false**. + +## -remarks +The standard implementation returns **false**. [PasswordBoxAutomationPeer](passwordboxautomationpeer.md) provides an implementation that returns **true**. If the peer being returned by your control is [PasswordBoxAutomationPeer](passwordboxautomationpeer.md) or derived from it, you will inherit that behavior. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [PasswordBox](../windows.ui.xaml.controls/passwordbox.md), [PasswordBoxAutomationPeer](passwordboxautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_isperipheralcore_1870555052.md b/windows.ui.xaml.automation.peers/automationpeer_isperipheralcore_1870555052.md new file mode 100644 index 0000000000..a7ab96ee7c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_isperipheralcore_1870555052.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsPeripheralCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsPeripheralCore + +## -description +Provides the peer’s behavior when a Microsoft UI Automation client accesses [IsPeripheral](automationpeer_isperipheral.md) or an equivalent Microsoft UI Automation client API. + +## -returns +A Boolean value that indicates whether the automation element represents peripheral UI. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_isrequiredforformcore_655884228.md b/windows.ui.xaml.automation.peers/automationpeer_isrequiredforformcore_655884228.md new file mode 100644 index 0000000000..4539906724 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_isrequiredforformcore_655884228.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsRequiredForFormCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.IsRequiredForFormCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [IsRequiredForForm](automationpeer_isrequiredforform.md) or an equivalent Microsoft UI Automation client API. + +## -returns +**true** if the element must be completed; otherwise, **false**. + +## -remarks +The standard implementation returns false. Overriding this value at the peer level to return true is probably an uncommon scenario, because you are implying that every instance of your control has a required-for-form behavior no matter what app or UI situation it is used for. It's more typical for apps to specify a required-for-form behavior that is declared in the app's XAML UI definitions, by setting [AutomationProperties.IsRequiredForForm](../windows.ui.xaml.automation/automationproperties_isrequiredforform.md). + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_navigatecore_649092127.md b/windows.ui.xaml.automation.peers/automationpeer_navigatecore_649092127.md new file mode 100644 index 0000000000..1a7a151a41 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_navigatecore_649092127.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.NavigateCore(Windows.UI.Xaml.Automation.Peers.AutomationNavigationDirection) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.NavigateCore + +## -description +Provides the peer’s behavior when a Microsoft UI Automation client calls [Navigate](automationpeer_navigate.md) or an equivalent Microsoft UI Automation client API. + +## -parameters +### -param direction +The specified direction. + +## -returns +The element in the specified direction within the UI automation tree. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_peerfromprovider_53987488.md b/windows.ui.xaml.automation.peers/automationpeer_peerfromprovider_53987488.md new file mode 100644 index 0000000000..5c45da23cd --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_peerfromprovider_53987488.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.PeerFromProvider(Windows.UI.Xaml.Automation.Provider.IRawElementProviderSimple) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.PeerFromProvider + +## -description +Gets an [AutomationPeer](automationpeer.md) for the specified [IRawElementProviderSimple](http://msdn.microsoft.com/library/f0ec6185-acd0-4df7-88f4-fd00747f98bf) proxy. + +## -parameters +### -param provider +The class that implements [IRawElementProviderSimple](http://msdn.microsoft.com/library/f0ec6185-acd0-4df7-88f4-fd00747f98bf). + +## -returns +The [AutomationPeer](automationpeer.md). + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_providerfrompeer_988427079.md b/windows.ui.xaml.automation.peers/automationpeer_providerfrompeer_988427079.md new file mode 100644 index 0000000000..8a7f9e3da4 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_providerfrompeer_988427079.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.ProviderFromPeer(Windows.UI.Xaml.Automation.Peers.AutomationPeer) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.ProviderFromPeer + +## -description +Gets the [IRawElementProviderSimple](http://msdn.microsoft.com/library/f0ec6185-acd0-4df7-88f4-fd00747f98bf) proxy for the specified [AutomationPeer](automationpeer.md). + +## -parameters +### -param peer +The automation peer. + +## -returns +The proxy. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/automationpeer_setfocuscore_295682071.md b/windows.ui.xaml.automation.peers/automationpeer_setfocuscore_295682071.md new file mode 100644 index 0000000000..5f7dcf3d4c --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_setfocuscore_295682071.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.SetFocusCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.SetFocusCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [SetFocus](automationpeer_setfocus.md) or an equivalent Microsoft UI Automation client API. + +## -remarks +The standard implementation uses [IsKeyboardFocusable](automationpeer_iskeyboardfocusable.md) to determine whether the peer reports that the owner can be focused. [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) adds behavior that performs the actual focus operation if it is possible. + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Control.Focus](../windows.ui.xaml.controls/control_focus.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4), [Accessibility](http://msdn.microsoft.com/library/c89d79c2-b830-493d-b020-f3ff8eb5ffdd) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/automationpeer_showcontextmenucore_377126138.md b/windows.ui.xaml.automation.peers/automationpeer_showcontextmenucore_377126138.md new file mode 100644 index 0000000000..567e3b2072 --- /dev/null +++ b/windows.ui.xaml.automation.peers/automationpeer_showcontextmenucore_377126138.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.AutomationPeer.ShowContextMenuCore +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.AutomationPeer.ShowContextMenuCore + +## -description +Provides the peer's behavior when a Microsoft UI Automation client calls [ShowContextMenu](automationpeer_showcontextmenu.md) or an equivalent Microsoft UI Automation client API. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/buttonautomationpeer_invoke_1893356988.md b/windows.ui.xaml.automation.peers/buttonautomationpeer_invoke_1893356988.md new file mode 100644 index 0000000000..1b8a9e24fe --- /dev/null +++ b/windows.ui.xaml.automation.peers/buttonautomationpeer_invoke_1893356988.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.ButtonAutomationPeer.Invoke +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.ButtonAutomationPeer.Invoke + +## -description +Sends a request to click the button associated with the automation peer. + +## -parameters + +## -remarks +Calls to **Invoke** should return immediately without blocking. However, this behavior is entirely dependent on the Microsoft UI Automation provider implementation. In scenarios where calling **Invoke** causes a blocking issue, such as a modal dialog, a separate helper thread may be required to call the method. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/buttonbaseautomationpeer.md b/windows.ui.xaml.automation.peers/buttonbaseautomationpeer.md new file mode 100644 index 0000000000..751d3446d7 --- /dev/null +++ b/windows.ui.xaml.automation.peers/buttonbaseautomationpeer.md @@ -0,0 +1,51 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.ButtonBaseAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.ButtonBaseAutomationPeer + +## -description +Represents a base class for exposing classes derived from [ButtonBase](../windows.ui.xaml.controls.primitives/buttonbase.md) to Microsoft UI Automation. + +## -remarks + [ButtonBaseAutomationPeer](buttonbaseautomationpeer.md) has a protected constructor, so you won't be able to use it directly for an [OnCreateAutomationPeer](../windows.ui.xaml/uielement_oncreateautomationpeer.md) definition. Derive your automation peer from [ButtonBaseAutomationPeer](buttonbaseautomationpeer.md) if you are deriving a custom class from [ButtonBase](../windows.ui.xaml.controls.primitives/buttonbase.md) and want to add automation support for additional features that you enabled in your custom class. Then override [OnCreateAutomationPeer](../windows.ui.xaml/uielement_oncreateautomationpeer.md) so that it returns your custom peer. Note that [ButtonBase](../windows.ui.xaml.controls.primitives/buttonbase.md) already has derived classes, each of which also has a derived peer, so make sure that you really want to derive from this base class rather than use one of the existing XAML-enabled derived button classes. + +### Default peer implementation and overrides in **ButtonBaseAutomationPeer** + +[ButtonAutomationPeer](buttonautomationpeer.md) has overrides of **Core** methods such that the associated [AutomationPeer](automationpeer.md) methods provide peer-specific information to a Microsoft UI Automation client. + ++ [GetName](automationpeer_getname.md) returns a string value based on examining the current **Content**. This is implemented so that consumers of the control don't always need to provide an [AutomationProperties.Name](../windows.ui.xaml.automation/automationproperties_name.md) value in app code, and can use a generated-from-content value for the automation **Name** directly from the UI definition. For more info on how this works, see [Basic accessibility information](http://msdn.microsoft.com/library/9641c926-68c9-4842-8b55-c38c39a9e5c5). ++ Other normally required values such as [GetClassName](automationpeer_getclassname.md) and [GetAutomationControlType](automationpeer_getautomationcontroltype.md) should be implemented on the derived peer classes. +The peer also has other behaviors that are provided by the base [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) class. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4). + +There is no "ControlAutomationPeer" class. [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) serves as implementation for all basic [Control](../windows.ui.xaml.controls/control.md) class scenarios that involve Microsoft UI Automation. This includes behavior that does not necessarily appear as a public API exposure, such as the practical implementations of many of the **Core** methods from [AutomationPeer](automationpeer.md). + +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) includes extensive base implementation of peer behavior that other peers can use to report information that comes from owner classes at the [UIElement](../windows.ui.xaml/uielement.md) and [FrameworkElement](../windows.ui.xaml/frameworkelement.md) level. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4). + + +In addition to the **Core** overrides, [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) has two static utility methods that are useful for getting a peer handle from within control code, or for generating items peers from an item container peer for Microsoft UI Automation support. These are: ++ [CreatePeerForElement](frameworkelementautomationpeer_createpeerforelement.md) ++ [FromElement](frameworkelementautomationpeer_fromelement.md) + + +If you have a need to define a custom automation peer and can't identify a more derived peer class that pairs up with the control or base class you are deriving the owner class from, you should base your peer on [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md). Even if the owner class isn't necessarily a [FrameworkElement](../windows.ui.xaml/frameworkelement.md), you can't practically derive peers from [AutomationPeer](automationpeer.md) directly because [FrameworkElementAutomationPeer](frameworkelementautomationpeer.md) has many overrides that provide the expected behavior for layout, automation and UI interactions. You do need to derive your owner class from [UIElement](../windows.ui.xaml/uielement.md) at least, otherwise there is no way to create the peer on automation tree load with [OnCreateAutomationPeer](../windows.ui.xaml/uielement_oncreateautomationpeer.md). + +### **ButtonBaseAutomationPeer** derived classes + +[ButtonBaseAutomationPeer](buttonbaseautomationpeer.md) is the parent class for several immediately derived classes that implement peer support for Windows Runtime controls. Here is the list of classes that directly derive from [ButtonBaseAutomationPeer](buttonbaseautomationpeer.md): + ++ [ButtonAutomationPeer](buttonautomationpeer.md) ++ [HyperlinkButtonAutomationPeer](hyperlinkbuttonautomationpeer.md) ++ [RepeatButtonAutomationPeer](repeatbuttonautomationpeer.md) ++ [ToggleButtonAutomationPeer](togglebuttonautomationpeer.md) + + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [ButtonAutomationPeer](buttonautomationpeer.md), [Button](../windows.ui.xaml.controls/button.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/buttonbaseautomationpeer_buttonbaseautomationpeer_1813867588.md b/windows.ui.xaml.automation.peers/buttonbaseautomationpeer_buttonbaseautomationpeer_1813867588.md new file mode 100644 index 0000000000..292389e1f2 --- /dev/null +++ b/windows.ui.xaml.automation.peers/buttonbaseautomationpeer_buttonbaseautomationpeer_1813867588.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.ButtonBaseAutomationPeer.#ctor(Windows.UI.Xaml.Controls.Primitives.ButtonBase) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.ButtonBaseAutomationPeer.ButtonBaseAutomationPeer + +## -description +Provides base class initialization behavior for [ButtonBase](../windows.ui.xaml.controls.primitives/buttonbase.md) derived classes. + +## -parameters +### -param owner +The owner element to create for. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/hyperlinkbuttonautomationpeer_invoke_1893356988.md b/windows.ui.xaml.automation.peers/hyperlinkbuttonautomationpeer_invoke_1893356988.md new file mode 100644 index 0000000000..8425ba192e --- /dev/null +++ b/windows.ui.xaml.automation.peers/hyperlinkbuttonautomationpeer_invoke_1893356988.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.HyperlinkButtonAutomationPeer.Invoke +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.HyperlinkButtonAutomationPeer.Invoke + +## -description +Sends a request to click the hyperlink button associated with the automation peer. + +## -parameters + +## -remarks +Calls to **Invoke** should return immediately without blocking. However, this behavior is entirely dependent on the Microsoft UI Automation provider implementation. In scenarios where calling **Invoke** causes a blocking issue, such as a modal dialog, a separate helper thread may be required to call the method. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/itemscontrolautomationpeer_oncreateitemautomationpeer_1507723118.md b/windows.ui.xaml.automation.peers/itemscontrolautomationpeer_oncreateitemautomationpeer_1507723118.md new file mode 100644 index 0000000000..9502b779a1 --- /dev/null +++ b/windows.ui.xaml.automation.peers/itemscontrolautomationpeer_oncreateitemautomationpeer_1507723118.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.ItemsControlAutomationPeer.OnCreateItemAutomationPeer(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.ItemsControlAutomationPeer.OnCreateItemAutomationPeer + +## -description +Invoked whenever a new instance of the [ItemAutomationPeer](itemautomationpeer.md) is created for a data item in the [Items](../windows.ui.xaml.controls/itemscontrol_items.md) collection of this [ItemsControl](../windows.ui.xaml.controls/itemscontrol.md). + +## -parameters +### -param item +The data item that is associated with this [ItemAutomationPeer](itemautomationpeer.md). + +## -returns +The new [ItemAutomationPeer](itemautomationpeer.md) created. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/listviewbaseheaderitemautomationpeer.md b/windows.ui.xaml.automation.peers/listviewbaseheaderitemautomationpeer.md new file mode 100644 index 0000000000..ba5b7fb5d0 --- /dev/null +++ b/windows.ui.xaml.automation.peers/listviewbaseheaderitemautomationpeer.md @@ -0,0 +1,23 @@ +--- +-api-id: T:Windows.UI.Xaml.Automation.Peers.ListViewBaseHeaderItemAutomationPeer +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Automation.Peers.ListViewBaseHeaderItemAutomationPeer + +## -description +Exposes [ListViewBaseHeaderItem](../windows.ui.xaml.controls/listviewbaseheaderitem.md) types to Microsoft UI Automation. + +## -remarks +### **ListViewBaseHeaderItemAutomationPeer** derived classes + +[ListViewBaseHeaderItemAutomationPeer](listviewbaseheaderitemautomationpeer.md) is the parent class for [GridViewHeaderItemAutomationPeer](gridviewheaderitemautomationpeer.md) and [ListViewHeaderItemAutomationPeer](listviewheaderitemautomationpeer.md). + +## -examples + +## -see-also +[FrameworkElementAutomationPeer](frameworkelementautomationpeer.md), [Custom automation peers](http://msdn.microsoft.com/library/aa8da53b-fe6e-40ac-9f0a-cb09637c87b4) \ No newline at end of file diff --git a/windows.ui.xaml.automation.peers/listviewbaseheaderitemautomationpeer_listviewbaseheaderitemautomationpeer_166134085.md b/windows.ui.xaml.automation.peers/listviewbaseheaderitemautomationpeer_listviewbaseheaderitemautomationpeer_166134085.md new file mode 100644 index 0000000000..e5e6cdcfa2 --- /dev/null +++ b/windows.ui.xaml.automation.peers/listviewbaseheaderitemautomationpeer_listviewbaseheaderitemautomationpeer_166134085.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.ListViewBaseHeaderItemAutomationPeer.#ctor(Windows.UI.Xaml.Controls.ListViewBaseHeaderItem) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.ListViewBaseHeaderItemAutomationPeer.ListViewBaseHeaderItemAutomationPeer + +## -description +Initializes a new instance of the [ListViewBaseHeaderItemAutomationPeer](listviewbaseheaderitemautomationpeer.md) class. + +## -parameters +### -param owner +The [ListViewBaseHeaderItem](../windows.ui.xaml.controls/listviewbaseheaderitem.md) to create the peer for. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canmove.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canmove.md new file mode 100644 index 0000000000..e96e2d1971 --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canmove.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanMove +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanMove + +## -description +Gets a Boolean value indicating if the associated map can be repositioned. + +## -property-value +A Boolean value indicating if the associated map can be repositioned. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canresize.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canresize.md new file mode 100644 index 0000000000..bde677215e --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canresize.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanResize +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanResize + +## -description +Gets a Boolean value indicating if the associated map can be resized. + +## -property-value +A Boolean value indicating if the associated map can be resized. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canrotate.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canrotate.md new file mode 100644 index 0000000000..609d8a38d2 --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canrotate.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanRotate +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanRotate + +## -description +Gets a Boolean value indicating if the associated map can be rotated. + +## -property-value +A Boolean value indicating if the associated map can be rotated. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canzoom.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canzoom.md new file mode 100644 index 0000000000..e9949d6cd2 --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_canzoom.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanZoom +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.CanZoom + +## -description +Get a Boolean value indicating if the associated map can be zoomed. + +## -property-value +A Boolean value indicating if the associated map can be zoomed. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_maxzoom.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_maxzoom.md new file mode 100644 index 0000000000..9ab6631fc4 --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_maxzoom.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.MaxZoom +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.MaxZoom + +## -description +Gets the maximum zoom level for the associated map. + +## -property-value +The maximum zoom level for the associated map. + +## -remarks +See the remarks section of the [MaxZoomLevel](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.maps.mapcontrol#Windows_UI_Xaml_Controls_Maps_MapControl_MaxZoomLevel) property. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_minzoom.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_minzoom.md new file mode 100644 index 0000000000..15ae090780 --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_minzoom.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.MinZoom +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.MinZoom + +## -description +Gets the minimum zoom level for the associated map. + +## -property-value +The minimum zoom level for the associated map. + +## -remarks +See the remarks section of the [MaxZoomLevel](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.maps.mapcontrol#Windows_UI_Xaml_Controls_Maps_MapControl_MaxZoomLevel) property. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_move_2108364599.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_move_2108364599.md new file mode 100644 index 0000000000..9fd97ddf97 --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_move_2108364599.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Move(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Move + +## -description +Moves the map by the specified horizontal and vertical amounts. + +## -parameters + +### -param x +The amount to move the map horizontally. + +### -param y +The amount to move the map vertically. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_resize_103134973.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_resize_103134973.md new file mode 100644 index 0000000000..7bf5adc28e --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_resize_103134973.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Resize(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Resize + +## -description +Resizes the associated map to the specified width and height. + +## -parameters + +### -param width +The new width for the associated map. + +### -param height +The new height for the associated map. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_rotate_1018445388.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_rotate_1018445388.md new file mode 100644 index 0000000000..e497d48806 --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_rotate_1018445388.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Rotate(System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Rotate + +## -description +Rotates the map's camera from its current position. + +## -parameters + +### -param degrees +The degrees that the map's camera rotates in a horizontal clockwise direction. + +## -remarks +Values greater than 360 degrees are normalized to their equivalent 0-360 degree value. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoom_1427900009.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoom_1427900009.md new file mode 100644 index 0000000000..38fc183ebe --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoom_1427900009.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Zoom(System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.Zoom + +## -description +Zooms the associated map to the specified [ZoomLevel](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.maps.mapcontrol#Windows_UI_Xaml_Controls_Maps_MapControl_ZoomLevel). + +## -parameters + +### -param zoom +The [ZoomLevel](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.maps.mapcontrol#Windows_UI_Xaml_Controls_Maps_MapControl_ZoomLevel) to which to set the associated map. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoombyunit_1744877203.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoombyunit_1744877203.md new file mode 100644 index 0000000000..9534371a0b --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoombyunit_1744877203.md @@ -0,0 +1,25 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.ZoomByUnit(Windows.UI.Xaml.Automation.ZoomUnit) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.ZoomByUnit + +## -description +Zooms the viewport of the associated map by the specified [ZoomUnit](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.automation.zoomunit). + +## -parameters + +### -param zoomUnit +The amount to zoom the viewport of the associated map. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoomlevel.md b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoomlevel.md new file mode 100644 index 0000000000..459604366c --- /dev/null +++ b/windows.ui.xaml.automation.peers/mapcontrolautomationpeer_zoomlevel.md @@ -0,0 +1,24 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.ZoomLevel +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.Peers.MapControlAutomationPeer.ZoomLevel + +## -description +Gets the zoom level of the associated map, which is a value between 1 and 20 in 2D views. + +## -property-value +The zoom level of the associated map. + +## -remarks +See the remarks section of the [TryZoomInAsync](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.maps.mapcontrol#Windows_UI_Xaml_Controls_Maps_MapControl_TryZoomInAsync) method. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/menuflyoutitemautomationpeer_invoke_1893356988.md b/windows.ui.xaml.automation.peers/menuflyoutitemautomationpeer_invoke_1893356988.md new file mode 100644 index 0000000000..49d3ec53d3 --- /dev/null +++ b/windows.ui.xaml.automation.peers/menuflyoutitemautomationpeer_invoke_1893356988.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.MenuFlyoutItemAutomationPeer.Invoke +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.MenuFlyoutItemAutomationPeer.Invoke + +## -description +Sends a request to invoke the menu flyout associated with the automation peer. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.peers/repeatbuttonautomationpeer_invoke_1893356988.md b/windows.ui.xaml.automation.peers/repeatbuttonautomationpeer_invoke_1893356988.md new file mode 100644 index 0000000000..bbe89a3a40 --- /dev/null +++ b/windows.ui.xaml.automation.peers/repeatbuttonautomationpeer_invoke_1893356988.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Peers.RepeatButtonAutomationPeer.Invoke +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Peers.RepeatButtonAutomationPeer.Invoke + +## -description +Sends a request to click the repeat button associated with the automation peer. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation.provider/iinvokeprovider_invoke_1893356988.md b/windows.ui.xaml.automation.provider/iinvokeprovider_invoke_1893356988.md new file mode 100644 index 0000000000..5d09e25ad1 --- /dev/null +++ b/windows.ui.xaml.automation.provider/iinvokeprovider_invoke_1893356988.md @@ -0,0 +1,22 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.Provider.IInvokeProvider.Invoke +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.Provider.IInvokeProvider.Invoke + +## -description +Sends a request to initiate or perform the single, unambiguous action of the provider control. For example, the invoke action for a [Button](../windows.ui.xaml.controls/button.md) is click. + +## -parameters + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation/automationelementidentifiers.md b/windows.ui.xaml.automation/automationelementidentifiers.md index f888b49aa3..4de261cdb6 100644 --- a/windows.ui.xaml.automation/automationelementidentifiers.md +++ b/windows.ui.xaml.automation/automationelementidentifiers.md @@ -13,7 +13,7 @@ public class AutomationElementIdentifiers : Windows.UI.Xaml.Automation.IAutomati Contains values used as automation property identifiers by UI Automation providers and UI Automation clients. ## -remarks -Classes such as [AutomationElementIdentifiers](automationelementidentifiers.md) are the identifiers for the Windows Runtime implementation of a common provider pattern for Microsoft UI Automation. [AutomationElementIdentifiers](automationelementidentifiers.md) identifies the general automation peer properties that are part of the basic peer functionality, as opposed to being related to a specific automation control pattern. You might use these identifiers if you are implementing a Windows Runtime custom automation peer based on [AutomationPeer](../windows.ui.xaml.automation.peers/automationpeer.md) or [FrameworkElementAutomationPeer](../windows.ui.xaml.automation.peers/frameworkelementautomationpeer.md). These identifiers are needed for the [RaisePropertyChangedEvent](../windows.ui.xaml.automation.peers/automationpeer_raisepropertychangedevent.md) calls that you make from control code that references your own peer, or for [FindItemByProperty](../windows.ui.xaml.automation.provider/iitemcontainerprovider_finditembyproperty.md) in an items container peer. +Classes such as **AutomationElementIdentifiers** are the identifiers for the Windows Runtime implementation of a common provider pattern for Microsoft UI Automation. **AutomationElementIdentifiers** identifies the general automation peer properties that are part of the basic peer functionality, as opposed to being related to a specific automation control pattern. You might use these identifiers if you are implementing a Windows Runtime custom automation peer based on [AutomationPeer](../windows.ui.xaml.automation.peers/automationpeer.md) or [FrameworkElementAutomationPeer](../windows.ui.xaml.automation.peers/frameworkelementautomationpeer.md). These identifiers are needed for the [RaisePropertyChangedEvent](../windows.ui.xaml.automation.peers/automationpeer_raisepropertychangedevent.md) calls that you make from control code that references your own peer, or for [FindItemByProperty](../windows.ui.xaml.automation.provider/iitemcontainerprovider_finditembyproperty.md) in an items container peer. This same set of property identifiers is usually exposed to clients in a different way, depending on which technology they use to implement the client and examine the Microsoft UI Automation tree. One such property identifier list for clients is documented in the topic [Automation Element Property Identifiers](http://msdn.microsoft.com/library/f7613ad1-0b75-46fb-b9ac-b1ae9eea4193). diff --git a/windows.ui.xaml.automation/automationelementidentifiers_cultureproperty.md b/windows.ui.xaml.automation/automationelementidentifiers_cultureproperty.md new file mode 100644 index 0000000000..c44d5465f0 --- /dev/null +++ b/windows.ui.xaml.automation/automationelementidentifiers_cultureproperty.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.AutomationElementIdentifiers.CultureProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.AutomationElementIdentifiers.CultureProperty + +## -description +Identifies the Culture property, which contains a locale identifier for the automation element (for example, 0x0409 for "en-US" or English (United States)). + +## -property-value +The culture property identifier. + +## -remarks +Each locale has a unique identifier, a 32-bit value that consists of a language identifier and a sort order identifier. The locale identifier is a standard international numeric abbreviation and has the components necessary to uniquely identify one of the installed operating system-defined locales. For more information, see [Language Identifier Constants and Strings](https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693.aspx). + +This property may exist on a per-control basis, but typically is only available on an application level. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation/automationproperties_acceleratorkeyproperty.md b/windows.ui.xaml.automation/automationproperties_acceleratorkeyproperty.md index b91dd55f22..b3de2763ab 100644 --- a/windows.ui.xaml.automation/automationproperties_acceleratorkeyproperty.md +++ b/windows.ui.xaml.automation/automationproperties_acceleratorkeyproperty.md @@ -16,7 +16,7 @@ Identifies the [AutomationProperties.AcceleratorKey](automationproperties_accele The identifier for the [AutomationProperties.AcceleratorKey](automationproperties_acceleratorkey.md) attached property. ## -remarks -Shortcut key combinations invoke an action. For example, CTRL+O is often used to invoke the Open file common dialog box. An automation element that has the [AcceleratorKey](automationproperties_acceleratorkey.md) property can implement the [Invoke](XREF:TODO:automat.idispatch_invoke) control pattern for the action that is equivalent to the shortcut command. +Shortcut key combinations invoke an action. For example, CTRL+O is often used to invoke the Open file common dialog box. An automation element that has the [AcceleratorKey](automationproperties_acceleratorkey.md) property can implement the [Invoke](https://msdn.microsoft.com/library/windows/desktop/ms221479) control pattern for the action that is equivalent to the shortcut command. ## -examples diff --git a/windows.ui.xaml.automation/automationproperties_cultureproperty.md b/windows.ui.xaml.automation/automationproperties_cultureproperty.md new file mode 100644 index 0000000000..ddf9cfa6ec --- /dev/null +++ b/windows.ui.xaml.automation/automationproperties_cultureproperty.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Xaml.Automation.AutomationProperties.CultureProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Automation.AutomationProperties.CultureProperty + +## -description +Gets the identifier for the culture attached property which contains a locale identifier for the automation element (for example, 0x0409 for "en-US" or English (United States)). + +## -property-value +The identifier for the culture attached property. + +## -remarks +Each locale has a unique identifier, a 32-bit value that consists of a language identifier and a sort order identifier. The locale identifier is a standard international numeric abbreviation and has the components necessary to uniquely identify one of the installed operating system-defined locales. For more information, see [Language Identifier Constants and Strings](https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693.aspx). + +This property may exist on a per-control basis, but typically is only available on an application level. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation/automationproperties_getculture_499540936.md b/windows.ui.xaml.automation/automationproperties_getculture_499540936.md new file mode 100644 index 0000000000..29263b555a --- /dev/null +++ b/windows.ui.xaml.automation/automationproperties_getculture_499540936.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.AutomationProperties.GetCulture(Windows.UI.Xaml.DependencyObject) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.AutomationProperties.GetCulture + +## -description +Gets the value of the [CultureProperty](automationproperties_cultureproperty.md) attached property for the specified [DependencyObject](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.dependencyobject). + +## -parameters + +### -param element +The [DependencyObject](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.dependencyobject) to check. + +## -returns +The value of the culture property for the specified *element*. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.automation/automationproperties_nameproperty.md b/windows.ui.xaml.automation/automationproperties_nameproperty.md index ba6058e3f8..4dd199b328 100644 --- a/windows.ui.xaml.automation/automationproperties_nameproperty.md +++ b/windows.ui.xaml.automation/automationproperties_nameproperty.md @@ -18,7 +18,7 @@ The identifier for the [AutomationProperties.Name](automationproperties_name.md) ## -remarks The [Name](automationproperties_name.md) property should be the same as the label text on screen. For example, [Name](automationproperties_name.md) should be "Browse" for a button element with the label "Browse". The [Name](automationproperties_name.md) property must not include the mnemonic character for the access keys (that is, "&"), which is underlined in the UI text presentation. Also, the [Name](automationproperties_name.md) property should not be an extended or modified version of the on-screen label because the inconsistency between the name and the label can cause confusion among client applications and users. -When the corresponding label text is not visible on screen, or when it is replaced by graphics, alternative text should be chosen. The alternative text should be concise, intuitive, and localized to the application UI language, or to the operating system default UI language. The alternative text should not be a detailed description of the visual details, but a concise description of the UI function or feature as if it were labeled by simple text. For example, the Windows Start menu button is named "Start" (button) instead of "Windows Logo on blue round sphere graphics" (button). For more information, see [Creating Text Equivalents for Images](XREF:TODO:dnacc.creating_text_equivalents_for_images). +When the corresponding label text is not visible on screen, or when it is replaced by graphics, alternative text should be chosen. The alternative text should be concise, intuitive, and localized to the application UI language, or to the operating system default UI language. The alternative text should not be a detailed description of the visual details, but a concise description of the UI function or feature as if it were labeled by simple text. For example, the Windows Start menu button is named "Start" (button) instead of "Windows Logo on blue round sphere graphics" (button). For more information, see [Creating Text Equivalents for Images](https://msdn.microsoft.com/library/ms971334). When a UI label uses text graphics (for example, using ">>" for a button that adds an item from left to right), the [Name](automationproperties_name.md) property should be overridden by an appropriate text alternative (for example, "Add"). However the practice of using text graphics as a UI label is discouraged due to both localization and accessibility concerns. diff --git a/windows.ui.xaml.automation/automationproperties_setculture_726213772.md b/windows.ui.xaml.automation/automationproperties_setculture_726213772.md new file mode 100644 index 0000000000..f7cc699fe9 --- /dev/null +++ b/windows.ui.xaml.automation/automationproperties_setculture_726213772.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Xaml.Automation.AutomationProperties.SetCulture(Windows.UI.Xaml.DependencyObject,System.Int32) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Automation.AutomationProperties.SetCulture + +## -description +Sets the value of the [CultureProperty](automationproperties_cultureproperty.md) attached property for the specified [DependencyObject](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.dependencyobject). + +## -parameters + +### -param element +The [DependencyObject](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.dependencyobject) for which to set the culture property. + +### -param value +The value of the culture property to set for the specified *element*. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.maps/mapbillboard.md b/windows.ui.xaml.controls.maps/mapbillboard.md new file mode 100644 index 0000000000..949d0164ca --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard.md @@ -0,0 +1,24 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapBillboard +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard + +## -description +Displays an image such as a pushpin that scales and fades in relation to its distance from the [ReferenceCamera](mapbillboard_referencecamera.md) of the [MapBillboard](mapbillboard.md). + +## -remarks +A [MapBillboard](mapbillboard.md) is very similar to a [MapIcon](mapicon.md). Add one onto a [MapControl](mapcontrol.md) by adding it to the map control's [MapElements](mapcontrol_mapelements.md) collection. + +> > [!TIP] +> When you display a [MapBillboard](mapbillboard.md) image that points to a specific location on the map - for example, a pushpin or an arrow - consider setting the value of the [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) property to the approximate location of the pointer on the image. For example, if the image is an arrow pointing down, set the [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) value to (0.5, 1.0) so the center bottom of the image is exactly at the specified map location. If you leave the value of [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) at its default value of (0.5, 1.0), which represents the bottom center of the image, changes in the [ZoomLevel](mapcontrol_zoomlevel.md) of the map may leave the image pointing to a different location. + +## -see-also +[MapIcon](mapicon.md) + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_collisionbehaviordesired.md b/windows.ui.xaml.controls.maps/mapbillboard_collisionbehaviordesired.md new file mode 100644 index 0000000000..e921ccbfb1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_collisionbehaviordesired.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.CollisionBehaviorDesired +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.CollisionBehaviorDesired + +## -description +Gets or sets the behavior of a [MapBillboard](mapbillboard.md) when it collides with other map features due to zoom level. + +## -property-value +The behavior of a [MapBillboard](mapbillboard.md) when it collides with other map features due to zoom level. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_collisionbehaviordesiredproperty.md b/windows.ui.xaml.controls.maps/mapbillboard_collisionbehaviordesiredproperty.md new file mode 100644 index 0000000000..1322ca2073 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_collisionbehaviordesiredproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.CollisionBehaviorDesiredProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.CollisionBehaviorDesiredProperty + +## -description +Identifies the [CollisionBehaviorDesired](mapbillboard_collisionbehaviordesired.md) dependency property. + +## -property-value +Identifier for the [CollisionBehaviorDesired](mapbillboard_collisionbehaviordesired.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_image.md b/windows.ui.xaml.controls.maps/mapbillboard_image.md new file mode 100644 index 0000000000..b3062507d3 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_image.md @@ -0,0 +1,26 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.Image +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.Image + +## -description +Gets or sets the image for the [MapBillboard](mapbillboard.md). Provide an optional custom image to replace the default image. + +## -property-value +The image for the [MapBillboard](mapbillboard.md). + +## -remarks +The following line of code displays the [MapBillboard](mapbillboard.md) with a custom image saved in the Assets folder of the project. +```csharp +MapBillboard1.Image = RandomAccessStreamReference.CreateFromUri(new Uri("ms-appx:///Assets/customicon.png")); +``` + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_location.md b/windows.ui.xaml.controls.maps/mapbillboard_location.md new file mode 100644 index 0000000000..332336b395 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_location.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.Location +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.Location + +## -description +Gets or sets the geographic location of the [MapBillboard](mapbillboard.md) on the [MapControl](mapcontrol.md). The location is the geographic location on the [MapControl](mapcontrol.md) at which the [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) of the [MapBillboard](mapbillboard.md) is positioned. + +## -property-value +The geographic location of the [MapBillboard](mapbillboard.md) on the [MapControl](mapcontrol.md). + +## -remarks +If you provide an Altitude and AltitudeReferenceSystem in 3D views, then [MapBillboard](mapbillboard.md) elements added to the [MapControl](mapcontrol.md) end up being placed underground or floating in space. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_locationproperty.md b/windows.ui.xaml.controls.maps/mapbillboard_locationproperty.md new file mode 100644 index 0000000000..41cabe67c1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_locationproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.LocationProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.LocationProperty + +## -description +Identifies the [Location](mapbillboard_location.md) dependency property. + +## -property-value +The identifier for the [Location](mapbillboard_location.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_mapbillboard_789238629.md b/windows.ui.xaml.controls.maps/mapbillboard_mapbillboard_789238629.md new file mode 100644 index 0000000000..d06ba7adb8 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_mapbillboard_789238629.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapBillboard.#ctor(Windows.UI.Xaml.Controls.Maps.MapCamera) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.MapBillboard + +## -description +Initializes a new instance of the [MapBillboard](mapbillboard.md) class. + +## -params + +## -param camera +The [MapCamera](mapcamera.md) settings that define the current position of the reference camera. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_normalizedanchorpoint.md b/windows.ui.xaml.controls.maps/mapbillboard_normalizedanchorpoint.md new file mode 100644 index 0000000000..e3dcd6b652 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_normalizedanchorpoint.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.NormalizedAnchorPoint +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.NormalizedAnchorPoint + +## -description +Gets or sets the anchor point of the [MapBillboard](mapbillboard.md). The anchor point is the point on the [MapBillboard](mapbillboard.md) that is positioned at the point on the [MapControl](mapcontrol.md) specified by the Location property. + +## -property-value +The anchor point of the [MapBillboard](mapbillboard.md). + +## -remarks +When you display a [MapBillboard](mapbillboard.md) image that points to a specific location on the map - for example, a pushpin or an arrow - consider setting the value of the [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) property to the approximate location of the pointer on the image. If you leave the value of [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) at its default value of (0.5, 1), which represents the bottom center of the image, changes in the [ZoomLevel](mapcontrol_zoomlevel.md) of the map may leave the image pointing to a different location. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_normalizedanchorpointproperty.md b/windows.ui.xaml.controls.maps/mapbillboard_normalizedanchorpointproperty.md new file mode 100644 index 0000000000..037c231d97 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_normalizedanchorpointproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.NormalizedAnchorPointProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.NormalizedAnchorPointProperty + +## -description +Identifies the [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) dependency property. + +## -property-value +The identifier for the [NormalizedAnchorPoint](mapbillboard_normalizedanchorpoint.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapbillboard_referencecamera.md b/windows.ui.xaml.controls.maps/mapbillboard_referencecamera.md new file mode 100644 index 0000000000..241cdfbeb3 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapbillboard_referencecamera.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapBillboard.ReferenceCamera +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapBillboard.ReferenceCamera + +## -description +Gets the [MapCamera](mapcamera.md) settings that define the current position of the reference camera. + +## -property-value +The [MapCamera](mapcamera.md) settings that define the current position of the reference camera. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs.md b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs.md new file mode 100644 index 0000000000..2b99b476e1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs + +## -description +Provides event data for the [MapContextRequested](mapcontrol_mapcontextrequested.md) event. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_location.md b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_location.md new file mode 100644 index 0000000000..20d9443aba --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_location.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.Location +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.Location + +## -description +Gets a geolocation on the map of a context input gesture, such as a right-click. + +## -property-value +The geolocation on the map of a context input gesture, such as a right-click. + +## -remarks +To get the x- and y-coordinate values that define the point on the map of a context input gesture, use the [Position](mapcontextrequestedeventargs_position.md) property. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_mapcontextrequestedeventargs_1221375020.md b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_mapcontextrequestedeventargs_1221375020.md new file mode 100644 index 0000000000..eba194ea87 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_mapcontextrequestedeventargs_1221375020.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.MapContextRequestedEventArgs + +## -description +Initializes a new instance of the [MapContextRequestedEventArgs](mapcontextrequestedeventargs.md) class. + +## -params + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_mapelements.md b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_mapelements.md new file mode 100644 index 0000000000..cc6959ad14 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_mapelements.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.MapElements +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.MapElements + +## -description +Gets a collection of [MapElement](mapcontrol_mapelements.md) objects at the point on the map specified by the [Location](mapcontextrequestedeventargs_location.md) property. + +## -property-value +A collection of [MapElement](mapcontrol_mapelements.md) objects at the point on the map specified by the [Location](mapcontextrequestedeventargs_location.md) property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_position.md b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_position.md new file mode 100644 index 0000000000..0c0f9d2b15 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontextrequestedeventargs_position.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.Position +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapContextRequestedEventArgs.Position + +## -description +Gets the x- and y-coordinate values that define the point on the map of a context input gesture, such as a right-click. + +## -property-value +The x- and y-coordinate values that define the point on the map of a context input gesture, such as a right-click. + +## -remarks +To get the geolocation point on the map of a context input gesture, use the [Location](mapcontextrequestedeventargs_location.md) property. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_findmapelementsatoffset_861880289.md b/windows.ui.xaml.controls.maps/mapcontrol_findmapelementsatoffset_861880289.md new file mode 100644 index 0000000000..bf63fdb30c --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_findmapelementsatoffset_861880289.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.FindMapElementsAtOffset(Windows.Foundation.Point,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.FindMapElementsAtOffset + +## -description +Retrieves the collection of [MapElement](mapcontrol_mapelements.md) objects within the specified radius. + +## -params + +## -param offset +The point on the map that marks the center of a radius from which to retrieve the collection of [MapElement](mapelement.md) objects. + +## -param radius +A number that's added to the offset to mark the edge of the radius. + +## -returns +The collection of [MapElement](mapcontrol_mapelements.md) objects within the specified radius. + +## -remarks + +## -see-also +[Display maps with 2D, 3D, and Streetside views](http://msdn.microsoft.com/library/3839e00b-2c1e-4627-a45f-6dda98d7077f) +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1281571330.md b/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1281571330.md new file mode 100644 index 0000000000..93df933c9f --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_getlocationfromoffset_1281571330.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.GetLocationFromOffset(Windows.Foundation.Point,Windows.Devices.Geolocation.AltitudeReferenceSystem,Windows.Devices.Geolocation.Geopoint@) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.GetLocationFromOffset + +## -description +Converts a point on the map to a geographic location. +## -params + +## -param offset +A point on the map to convert to a geographic location. + +## -param desiredReferenceSystem +The altitude reference system of the geographic point. + +## -param location +When this method returns, contains the corresponding geographic location. + +## -remarks +Compare the [GetOffsetFromLocation](mapcontrol_getoffsetfromlocation.md) method. This method will throw an exception if the point is invalid. + +## -see-also +[Display maps with 2D, 3D, and Streetside views](http://msdn.microsoft.com/library/3839e00b-2c1e-4627-a45f-6dda98d7077f). +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_mapcontextrequested.md b/windows.ui.xaml.controls.maps/mapcontrol_mapcontextrequested.md new file mode 100644 index 0000000000..ba4f333cb1 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_mapcontextrequested.md @@ -0,0 +1,19 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.Maps.MapControl.MapContextRequested +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.MapContextRequested + +## -description +Occurs when the user has completed a context input gesture on a map, such as a right-click. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_mapprojection.md b/windows.ui.xaml.controls.maps/mapcontrol_mapprojection.md new file mode 100644 index 0000000000..44bf63a6a3 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_mapprojection.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.MapProjection +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.MapProjection + +## -description +Gets or sets an object that specifies how to transform the latitudes and longitudes of the map. + +## -property-value +An object that specifies how to transform the latitudes and longitudes of the map. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_mapprojectionproperty.md b/windows.ui.xaml.controls.maps/mapcontrol_mapprojectionproperty.md new file mode 100644 index 0000000000..174ccc7e8d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_mapprojectionproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.MapProjectionProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.MapProjectionProperty + +## -description +Identifies the [MapProjection](mapcontrol_mapprojection.md) dependency property. + +## -property-value +The identifier for the [MapProjection](mapcontrol_mapprojection.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_startcontinuouspan_1380943306.md b/windows.ui.xaml.controls.maps/mapcontrol_startcontinuouspan_1380943306.md new file mode 100644 index 0000000000..ec6f136785 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_startcontinuouspan_1380943306.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.StartContinuousPan(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.StartContinuousPan + +## -description +Starts an asynchronous operation to pan the map continuously from its current position. + +## -params + +## -param horizontalPixelsPerSecond +The pixels per second to pan horizontally. + +## -param verticalPixelsPerSecond +The pixels per second to pan vertically. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_stopcontinuouspan_414668336.md b/windows.ui.xaml.controls.maps/mapcontrol_stopcontinuouspan_414668336.md new file mode 100644 index 0000000000..3e5c83c9e9 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_stopcontinuouspan_414668336.md @@ -0,0 +1,21 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.StopContinuousPan +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.StopContinuousPan + +## -description +Stops an asynchronous operation to pan the map continuously from its current position. + +## -params + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_stylesheet.md b/windows.ui.xaml.controls.maps/mapcontrol_stylesheet.md new file mode 100644 index 0000000000..5c0edaae85 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_stylesheet.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.StyleSheet +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.StyleSheet + +## -description +Gets or sets an object that defines the style of the map control. + +## -property-value +An object that defines the style of the map control. + +## -remarks + +## -see-also + +## -examples +The following example sets the [StyleSheet](mapcontrol_stylesheet.md) property by using the static [MapControl.RoadDark](mapstylesheet_roaddark_376470101.md) method. + +```csharp + myMap.StyleSheet = MapStyleSheet.RoadDark(); +``` diff --git a/windows.ui.xaml.controls.maps/mapcontrol_stylesheetproperty.md b/windows.ui.xaml.controls.maps/mapcontrol_stylesheetproperty.md new file mode 100644 index 0000000000..51b49dea7a --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_stylesheetproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.StyleSheetProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.StyleSheetProperty + +## -description +Identifies the [StyleSheet](mapcontrol_stylesheet.md) dependency property. + +## -property-value +The identifier for the [StyleSheet](mapcontrol_stylesheet.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_trypanasync_1536571079.md b/windows.ui.xaml.controls.maps/mapcontrol_trypanasync_1536571079.md new file mode 100644 index 0000000000..e45f83b793 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_trypanasync_1536571079.md @@ -0,0 +1,30 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.TryPanAsync(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.TryPanAsync + +## -description +Starts an asynchronous operation to pan the map from its current position. + +## -params + +## -param horizontalPixels +The pixels to pan horizontally. + +## -param verticalPixels +The pixels to pan vertically. + +## -returns +Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_trypantoasync_1583165298.md b/windows.ui.xaml.controls.maps/mapcontrol_trypantoasync_1583165298.md new file mode 100644 index 0000000000..07b2789474 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_trypantoasync_1583165298.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapControl.TryPanToAsync(Windows.Devices.Geolocation.Geopoint) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.TryPanToAsync + +## -description +Starts an asynchronous operation to pan the map to a specific location. + +## -params + +## -param location +The coordinates of a geographic location to which you want to pan the map. + +## -returns +Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_viewpadding.md b/windows.ui.xaml.controls.maps/mapcontrol_viewpadding.md new file mode 100644 index 0000000000..fb7b7263d9 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_viewpadding.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.ViewPadding +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.ViewPadding + +## -description +Gets or sets the padding inside a map control. + +## -property-value +The amount of space between the content of a [MapControl](mapcontrol.md) and its [Margin](../windows.ui.xaml/frameworkelement_margin.md) or [Border](../windows.ui.xaml.controls/border.md). The default is a [Thickness](../windows.ui.xaml/thickness.md) with values of 0 on all four sides. + +## -remarks +For more information about how this property behaves, see the [Control.Padding](../windows.ui.xaml.controls/control_padding.md) property. + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapcontrol_viewpaddingproperty.md b/windows.ui.xaml.controls.maps/mapcontrol_viewpaddingproperty.md new file mode 100644 index 0000000000..e0a0e34bb4 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapcontrol_viewpaddingproperty.md @@ -0,0 +1,22 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Maps.MapControl.ViewPaddingProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapControl.ViewPaddingProperty + +## -description +Identifies the [ViewPadding](mapcontrol_viewpadding.md) dependency property. + +## -property-value +The identifier for the [ViewPadding](mapcontrol_viewpadding.md) dependency property. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapprojection.md b/windows.ui.xaml.controls.maps/mapprojection.md new file mode 100644 index 0000000000..af775a1b4b --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapprojection.md @@ -0,0 +1,30 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapProjection +-api-type: winrt enumeration +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapProjection + +## -description +Specifies how to transform the latitudes and longitudes of the map + +## -enum-fields + +## -field WebMercator:0 +The Web Mercator projection. World map appears as a flat surface. + +## -field Globe:1 +Globe projection. World map appears as a globe that can be rotated. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet.md b/windows.ui.xaml.controls.maps/mapstylesheet.md new file mode 100644 index 0000000000..bb361589fb --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet.md @@ -0,0 +1,19 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.Maps.MapStyleSheet +-api-type: winrt class +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet + +## -description +Represents a set of rules that define the style of a map control. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_aerial_1207293702.md b/windows.ui.xaml.controls.maps/mapstylesheet_aerial_1207293702.md new file mode 100644 index 0000000000..76cdf13004 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_aerial_1207293702.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.Aerial +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.Aerial + +## -description +Gets a [MapStyleSheet](mapstylesheet.md) presents an areal view of the map. + +## -params + +## -returns +A [MapStyleSheet](mapstylesheet.md) that presents an areal view of the map. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_aerialwithoverlay_1755798688.md b/windows.ui.xaml.controls.maps/mapstylesheet_aerialwithoverlay_1755798688.md new file mode 100644 index 0000000000..3050d574d2 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_aerialwithoverlay_1755798688.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.AerialWithOverlay +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.AerialWithOverlay + +## -description +Gets a [MapStyleSheet](mapstylesheet.md) that presents a hybrid map that combines an aerial map with roads. + +## -params + +## -returns +A [MapStyleSheet](mapstylesheet.md) that presents a hybrid map that combines an aerial map with roads. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_combine_123662630.md b/windows.ui.xaml.controls.maps/mapstylesheet_combine_123662630.md new file mode 100644 index 0000000000..0bfb2995fe --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_combine_123662630.md @@ -0,0 +1,64 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.Combine(Windows.Foundation.Collections.IIterable{Windows.UI.Xaml.Controls.Maps.MapStyleSheet}) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.Combine + +## -description +Combines the rules defined in two custom [MapStyleSheet](mapstylesheet.md) instances. + +## -params + +## -param styleSheets +The custom [MapStyleSheet](mapstylesheet.md) instances that you want to combine. + +## -returns +A [MapStyleSheet](mapstylesheet.md) instance that contains the combined rules defined in each [MapStyleSheet](mapstylesheet.md) instance that you passed to the *styleSheets* parameter. + +## -remarks + +## -see-also + +## -examples +The following example combines rules from two [MapStyleSheet](mapstylesheet.md) instances into one [MapStyleSheet](mapstylesheet.md) instance. + +```csharp +string jsonString = @"{ +""settings"": { + ""rasterRegionsVisible"":true, + ""spaceColor"":""#000000"" + }, +""elements"": + { + ""majorRoad"": { + ""labelColor"":""#490B7D"", + ""labelScale"":1.5, + ""font"": ""Comic Sans MS"" + } + } +}"; + + string jsonString2 = @"{ +""settings"": { + ""landColor"":""#FFC8DD"" + }, +""elements"": + { + } +}"; + +MapStyleSheet myCustomStyleSheet = MapStyleSheet.ParseFromJson(jsonString); +MapStyleSheet myCustomStyleSheet2 = MapStyleSheet.ParseFromJson(jsonString2); + +List myList = new List(); +myList.Add(myCustomStyleSheet); +myList.Add(myCustomStyleSheet2); + +myMap.StyleSheet = MapStyleSheet.Combine(myList); + +``` diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_parsefromjson_1626148147.md b/windows.ui.xaml.controls.maps/mapstylesheet_parsefromjson_1626148147.md new file mode 100644 index 0000000000..13c13d8d0f --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_parsefromjson_1626148147.md @@ -0,0 +1,50 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.ParseFromJson(System.String) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.ParseFromJson + +## -description +Creates a stylesheet by parsing a JSON markup string that defines a set of custom rules. + +## -params + +## -param styleAsJson +A JSON markup string that defines a set of custom rules. + +## -returns +A [MapStyleSheet](mapstylesheet.md) that represents the rules defined in JSON markup string. + +## -remarks + +## -see-also + +## -examples +The following example uses the [ParseFromJson](mapstylesheet_parsefromjson_1626148147.md) method to create a [MapStyleSheet](mapstylesheet.md) and then applies that style sheet to the map control. + +```csharp + +string jsonString = @"{ +""settings"": { +""rasterRegionsVisible"":true, +""spaceColor"":""#000000"" + }, +""elements"": + { + ""majorRoad"": { + ""labelColor"":""#490B7D"", + ""labelScale"":1.5, + ""font"": ""Comic Sans MS"" + } +} +}"; + +MapStyleSheet myCustomStyleSheet = MapStyleSheet.ParseFromJson(jsonString); +myMap.StyleSheet = myCustomStyleSheet; + +``` diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_roaddark_376470101.md b/windows.ui.xaml.controls.maps/mapstylesheet_roaddark_376470101.md new file mode 100644 index 0000000000..72516769f8 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_roaddark_376470101.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadDark +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadDark + +## -description +Gets a [MapStyleSheet](mapstylesheet.md) presents a road map with a dark theme. + +## -params + +## -returns +A [MapStyleSheet](mapstylesheet.md) presents a road map with a dark theme. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_roadhighcontrastdark_1393038991.md b/windows.ui.xaml.controls.maps/mapstylesheet_roadhighcontrastdark_1393038991.md new file mode 100644 index 0000000000..5a5c6eeabb --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_roadhighcontrastdark_1393038991.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadHighContrastDark +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadHighContrastDark + +## -description +Gets a [MapStyleSheet](mapstylesheet.md) styles the map with a black background with white lines that represent roads. + +## -params + +## -returns +A [MapStyleSheet](mapstylesheet.md) styles the map with a black background with white lines that represent roads. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_roadhighcontrastlight_1199122929.md b/windows.ui.xaml.controls.maps/mapstylesheet_roadhighcontrastlight_1199122929.md new file mode 100644 index 0000000000..51caf5e65d --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_roadhighcontrastlight_1199122929.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadHighContrastLight +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadHighContrastLight + +## -description +Gets a [MapStyleSheet](mapstylesheet.md) styles the map with a white background with black lines that represent roads. + +## -params + +## -returns +A [MapStyleSheet](mapstylesheet.md) styles the map with a white background with black lines that represent roads. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_roadlight_907749223.md b/windows.ui.xaml.controls.maps/mapstylesheet_roadlight_907749223.md new file mode 100644 index 0000000000..3bf65ffe1e --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_roadlight_907749223.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadLight +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.RoadLight + +## -description +Gets a [MapStyleSheet](mapstylesheet.md) presents a road map with a light theme. + +## -params + +## -returns +A [MapStyleSheet](mapstylesheet.md) presents a road map with a light theme. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.maps/mapstylesheet_tryparsefromjson_599503431.md b/windows.ui.xaml.controls.maps/mapstylesheet_tryparsefromjson_599503431.md new file mode 100644 index 0000000000..e8feaaef03 --- /dev/null +++ b/windows.ui.xaml.controls.maps/mapstylesheet_tryparsefromjson_599503431.md @@ -0,0 +1,29 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Maps.MapStyleSheet.TryParseFromJson(System.String,Windows.UI.Xaml.Controls.Maps.MapStyleSheet@) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Maps.MapStyleSheet.TryParseFromJson + +## -description +Starts an asynchronous operation to create a stylesheet by parsing a JSON markup string that defines a set of custom rules. +## -params + +## -param styleAsJson +A JSON markup string that defines a set of custom rules. + +## -param styleSheet +The [MapStyleSheet](mapstylesheet.md) that will represent the rules defined in JSON markup string. + +## -returns +Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**. + +## -remarks + +## -see-also + +## -examples diff --git a/windows.ui.xaml.controls.primitives/buttonbase.md b/windows.ui.xaml.controls.primitives/buttonbase.md index 1555f2de7a..0e522cde20 100644 --- a/windows.ui.xaml.controls.primitives/buttonbase.md +++ b/windows.ui.xaml.controls.primitives/buttonbase.md @@ -37,3 +37,5 @@ The following example demonstrates handling the [Click](buttonbase_click.md) eve ## -see-also [ContentControl](../windows.ui.xaml.controls/contentcontrol.md) +lso +[ContentControl](../windows.ui.xaml.controls/contentcontrol.md) diff --git a/windows.ui.xaml.controls.primitives/buttonbase_buttonbase_1221375020.md b/windows.ui.xaml.controls.primitives/buttonbase_buttonbase_1221375020.md new file mode 100644 index 0000000000..4788223597 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/buttonbase_buttonbase_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.ButtonBase.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ButtonBase.ButtonBase + +## -description +Provides base class initialization behavior for [ButtonBase](buttonbase.md) derived classes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/buttonbase_click.md b/windows.ui.xaml.controls.primitives/buttonbase_click.md index 5fd6160818..9366c23f1c 100644 --- a/windows.ui.xaml.controls.primitives/buttonbase_click.md +++ b/windows.ui.xaml.controls.primitives/buttonbase_click.md @@ -1,36 +1,36 @@ ---- --api-id: E:Windows.UI.Xaml.Controls.Primitives.ButtonBase.Click --api-type: winrt event ---- - - - -# Windows.UI.Xaml.Controls.Primitives.ButtonBase.Click - -## -description -Occurs when a button control is clicked. - -## -xaml-syntax -```xaml - -``` - - -## -remarks - -## -examples -The following example demonstrates handling the [Click](buttonbase_click.md) event and setting the [IsEnabled](../windows.ui.xaml.controls/control_isenabled.md) property of a [Button](../windows.ui.xaml.controls/button.md), which inherits from [ButtonBase](buttonbase.md). - - - -[!code-xml[4](../windows.ui.xaml/code/System.Windows.Controls.ButtonClickEx/csharp/Page.xaml#Snippet4)] - - -[!code-csharp[41](../windows.ui.xaml/code/System.Windows.Controls.ButtonClickEx/csharp/Page.xaml.cs#Snippet41)] - -[!code-vb[41](../windows.ui.xaml/code/System.Windows.Controls.ButtonClickEx/vbnet/Page.xaml.vb#Snippet41)] - -## -see-also -[Button](../windows.ui.xaml.controls/button.md) +--- +-api-id: E:Windows.UI.Xaml.Controls.Primitives.ButtonBase.Click +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ButtonBase.Click + +## -description +Occurs when a button control is clicked. + +## -xaml-syntax +```xaml + +``` + + +## -remarks + +## -examples +The following example demonstrates handling the [Click](buttonbase_click.md) event and setting the [IsEnabled](../windows.ui.xaml.controls/control_isenabled.md) property of a [Button](../windows.ui.xaml.controls/button.md), which inherits from [ButtonBase](buttonbase.md). + + + +[!code-xml[4](../windows.ui.xaml/code/System.Windows.Controls.ButtonClickEx/csharp/Page.xaml#Snippet4)] + + +[!code-csharp[41](../windows.ui.xaml/code/System.Windows.Controls.ButtonClickEx/csharp/Page.xaml.cs#Snippet41)] + +[!code-vb[41](../windows.ui.xaml/code/System.Windows.Controls.ButtonClickEx/vbnet/Page.xaml.vb#Snippet41)] + +## -see-also +[Button](../windows.ui.xaml.controls/button.md) diff --git a/windows.ui.xaml.controls.primitives/buttonbase_clickmode.md b/windows.ui.xaml.controls.primitives/buttonbase_clickmode.md index 9b69c744e5..042ec81a13 100644 --- a/windows.ui.xaml.controls.primitives/buttonbase_clickmode.md +++ b/windows.ui.xaml.controls.primitives/buttonbase_clickmode.md @@ -1,50 +1,51 @@ ---- --api-id: P:Windows.UI.Xaml.Controls.Primitives.ButtonBase.ClickMode --api-type: winrt property ---- - - - -# Windows.UI.Xaml.Controls.Primitives.ButtonBase.ClickMode - -## -description -Gets or sets a value that indicates when the [Click](buttonbase_click.md) event occurs, in terms of device behavior. - -## -xaml-syntax -```xaml - - -``` - - -## -xaml-values -
clickModeMemberName
clickModeMemberNameA named constant of the ClickMode enumeration, such as Hover.
-
-## -property-value -A value of the enumeration that indicates when the [Click](buttonbase_click.md) event occurs. - - -## -remarks - -## -examples -The following example shows three buttons that respond to clicks in three different ways based on their [ClickMode](buttonbase_clickmode.md) property value. - - -+ Hover - When the mouse pointer hovers over the first button, the foreground color of the button changes. -+ Press - When the left mouse button is pressed while over the second button, the foreground color of the button changes. -+ Release - When the mouse button is pressed and released while over the third button, the button resets the foreground color of the other two buttons to their original color. - - - - -[!code-xml[1](../windows.ui.xaml.data/code/System.Windows.Controls.ButtonClickModeSL/csharp/Page.xaml#Snippet1)] - - -[!code-csharp[11](../windows.ui.xaml.data/code/System.Windows.Controls.ButtonClickModeSL/csharp/Page.xaml.cs#Snippet11)] - -[!code-vb[11](../windows.ui.xaml.data/code/System.Windows.Controls.ButtonClickModeSL/vbnet/Page.xaml.vb#Snippet11)] - -## -see-also -[Button](../windows.ui.xaml.controls/button.md) +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.ButtonBase.ClickMode +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ButtonBase.ClickMode + +## -description +Gets or sets a value that indicates when the [Click](buttonbase_click.md) event occurs, in terms of device behavior. + +## -xaml-syntax +```xaml + + +``` + + +## -xaml-values +
clickModeMemberName
clickModeMemberNameA named constant of the ClickMode enumeration, such as Hover.
+
+## -property-value +A value of the enumeration that indicates when the [Click](buttonbase_click.md) event occurs. + + +## -remarks + +## -examples +The following example shows three buttons that respond to clicks in three different ways based on their [ClickMode](buttonbase_clickmode.md) property value. + + ++ Hover - When the mouse pointer hovers over the first button, the foreground color of the button changes. ++ Press - When the left mouse button is pressed while over the second button, the foreground color of the button changes. ++ Release - When the mouse button is pressed and released while over the third button, the button resets the foreground color of the other two buttons to their original color. + + + + +[!code-xml[1](../windows.ui.xaml.data/code/System.Windows.Controls.ButtonClickModeSL/csharp/Page.xaml#Snippet1)] + + +[!code-csharp[11](../windows.ui.xaml.data/code/System.Windows.Controls.ButtonClickModeSL/csharp/Page.xaml.cs#Snippet11)] + +[!code-vb[11](../windows.ui.xaml.data/code/System.Windows.Controls.ButtonClickModeSL/vbnet/Page.xaml.vb#Snippet11)] + +## -see-also +[Button](../windows.ui.xaml.controls/button.md) + diff --git a/windows.ui.xaml.controls.primitives/flyoutbase_createpresenter_1386499243.md b/windows.ui.xaml.controls.primitives/flyoutbase_createpresenter_1386499243.md new file mode 100644 index 0000000000..a2c5d0b581 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/flyoutbase_createpresenter_1386499243.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.FlyoutBase.CreatePresenter +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.FlyoutBase.CreatePresenter + +## -description +When overridden in a derived class, initializes a control to show the flyout content as appropriate for the derived control. Note: This method has no base class implementation and must be overridden in a derived class. + +## -returns +The control that displays the content of the flyout. + +## -remarks +This method has no base class implementation and must be overridden in a derived class. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/flyoutbase_flyoutbase_1221375020.md b/windows.ui.xaml.controls.primitives/flyoutbase_flyoutbase_1221375020.md new file mode 100644 index 0000000000..6b803f2620 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/flyoutbase_flyoutbase_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.FlyoutBase.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.FlyoutBase.FlyoutBase + +## -description +Provides base class initialization behavior for [FlyoutBase](flyoutbase.md) derived classes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/flyoutbase_overlayinputpassthroughelement.md b/windows.ui.xaml.controls.primitives/flyoutbase_overlayinputpassthroughelement.md new file mode 100644 index 0000000000..89ef82ff3f --- /dev/null +++ b/windows.ui.xaml.controls.primitives/flyoutbase_overlayinputpassthroughelement.md @@ -0,0 +1,25 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.FlyoutBase.OverlayInputPassThroughElement +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.FlyoutBase.OverlayInputPassThroughElement + +## -description + +Gets or sets an element that should receive pointer input events even when underneath the flyout's overlay. + +## -property-value + +The element that should receive pointer input events even when underneath the flyout's overlay. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/flyoutbase_overlayinputpassthroughelementproperty.md b/windows.ui.xaml.controls.primitives/flyoutbase_overlayinputpassthroughelementproperty.md new file mode 100644 index 0000000000..97dab4561f --- /dev/null +++ b/windows.ui.xaml.controls.primitives/flyoutbase_overlayinputpassthroughelementproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Primitives.FlyoutBase.OverlayInputPassThroughElementProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Primitives.FlyoutBase.OverlayInputPassThroughElementProperty + +## -description +Identifies the **OverlayInputPassThroughElement** dependency property. + +## -property-value +The identifier for the **OverlayInputPassThroughElement** dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls.primitives/layoutinformation.md b/windows.ui.xaml.controls.primitives/layoutinformation.md index d452f6819a..48b00ee016 100644 --- a/windows.ui.xaml.controls.primitives/layoutinformation.md +++ b/windows.ui.xaml.controls.primitives/layoutinformation.md @@ -25,4 +25,5 @@ The following example shows how to use [GetLayoutSlot](layoutinformation_getlayo [!code-vb[2](../windows.ui.xaml.controls.primitives/code/GetLayoutInfo/vbnet/Page.xaml.vb#Snippet2)] + ## -see-also diff --git a/windows.ui.xaml.controls.primitives/pickerflyoutbase_onconfirmed_650896860.md b/windows.ui.xaml.controls.primitives/pickerflyoutbase_onconfirmed_650896860.md new file mode 100644 index 0000000000..b71f71c37c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/pickerflyoutbase_onconfirmed_650896860.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.PickerFlyoutBase.OnConfirmed +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.PickerFlyoutBase.OnConfirmed + +## -description +Notifies [PickerFlyoutBase](pickerflyoutbase.md) subclasses when a user has confirmed a selection. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/pickerflyoutbase_pickerflyoutbase_1221375020.md b/windows.ui.xaml.controls.primitives/pickerflyoutbase_pickerflyoutbase_1221375020.md new file mode 100644 index 0000000000..2e029015d0 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/pickerflyoutbase_pickerflyoutbase_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.PickerFlyoutBase.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.PickerFlyoutBase.PickerFlyoutBase + +## -description +Provides base-class initialization behavior for classes that are derived from the [PickerFlyoutBase](pickerflyoutbase.md) class. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/pickerflyoutbase_shouldshowconfirmationbuttons_1775481006.md b/windows.ui.xaml.controls.primitives/pickerflyoutbase_shouldshowconfirmationbuttons_1775481006.md new file mode 100644 index 0000000000..f4888bc17c --- /dev/null +++ b/windows.ui.xaml.controls.primitives/pickerflyoutbase_shouldshowconfirmationbuttons_1775481006.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.PickerFlyoutBase.ShouldShowConfirmationButtons +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.PickerFlyoutBase.ShouldShowConfirmationButtons + +## -description +Gets or sets whether confirmation buttons should be shown in the picker. Note: This method has no base class implementation and must be overridden in a derived class. + +## -returns +True if confirmation buttons should be shown in the picker; Otherwise, false. + +## -remarks +This method has no base class implementation and must be overridden in a derived class. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/rangebase_onmaximumchanged_1402699285.md b/windows.ui.xaml.controls.primitives/rangebase_onmaximumchanged_1402699285.md new file mode 100644 index 0000000000..21462ee7da --- /dev/null +++ b/windows.ui.xaml.controls.primitives/rangebase_onmaximumchanged_1402699285.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.RangeBase.OnMaximumChanged(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.RangeBase.OnMaximumChanged + +## -description +Called when the [Maximum](rangebase_maximum.md) property changes. + +## -parameters +### -param oldMaximum +Old value of the [Maximum](rangebase_maximum.md) property. + +### -param newMaximum +New value of the [Maximum](rangebase_maximum.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/rangebase_onminimumchanged_734096255.md b/windows.ui.xaml.controls.primitives/rangebase_onminimumchanged_734096255.md new file mode 100644 index 0000000000..23f997d494 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/rangebase_onminimumchanged_734096255.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.RangeBase.OnMinimumChanged(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.RangeBase.OnMinimumChanged + +## -description +Called when the [Minimum](rangebase_minimum.md) property changes. + +## -parameters +### -param oldMinimum +Old value of the [Minimum](rangebase_minimum.md) property. + +### -param newMinimum +New value of the [Minimum](rangebase_minimum.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/rangebase_onvaluechanged_1525876838.md b/windows.ui.xaml.controls.primitives/rangebase_onvaluechanged_1525876838.md new file mode 100644 index 0000000000..728dbccbe9 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/rangebase_onvaluechanged_1525876838.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.RangeBase.OnValueChanged(System.Double,System.Double) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.RangeBase.OnValueChanged + +## -description +Fires the [ValueChanged](rangebase_valuechanged.md) routed event. + +## -parameters +### -param oldValue +Old value of the [Value](rangebase_value.md) property. + +### -param newValue +New value of the [Value](rangebase_value.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/rangebase_rangebase_1221375020.md b/windows.ui.xaml.controls.primitives/rangebase_rangebase_1221375020.md new file mode 100644 index 0000000000..56943c1ecf --- /dev/null +++ b/windows.ui.xaml.controls.primitives/rangebase_rangebase_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.RangeBase.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.RangeBase.RangeBase + +## -description +Provides base class initialization behavior for [RangeBase](rangebase.md)-derived classes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/selectoritem_selectoritem_1221375020.md b/windows.ui.xaml.controls.primitives/selectoritem_selectoritem_1221375020.md new file mode 100644 index 0000000000..e61f81ba5d --- /dev/null +++ b/windows.ui.xaml.controls.primitives/selectoritem_selectoritem_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.SelectorItem.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.SelectorItem.SelectorItem + +## -description +Provides base class initialization behavior for [SelectorItem](selectoritem.md)-derived classes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls.primitives/togglebutton_ontoggle_1178641326.md b/windows.ui.xaml.controls.primitives/togglebutton_ontoggle_1178641326.md new file mode 100644 index 0000000000..ec142f8388 --- /dev/null +++ b/windows.ui.xaml.controls.primitives/togglebutton_ontoggle_1178641326.md @@ -0,0 +1,20 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Primitives.ToggleButton.OnToggle +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Primitives.ToggleButton.OnToggle + +## -description +Called when the [ToggleButton](togglebutton.md) receives toggle stimulus. + +## -remarks +The default implementation raises a [Click](buttonbase_click.md) event in response to the stimulus. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/appbar_onclosed_256608481.md b/windows.ui.xaml.controls/appbar_onclosed_256608481.md new file mode 100644 index 0000000000..693a7a4133 --- /dev/null +++ b/windows.ui.xaml.controls/appbar_onclosed_256608481.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.AppBar.OnClosed(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.AppBar.OnClosed + +## -description +Invoked when the [AppBar](appbar.md) changes from visible to hidden. + +## -parameters +### -param e +Event data for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/appbar_onclosing_2045883829.md b/windows.ui.xaml.controls/appbar_onclosing_2045883829.md new file mode 100644 index 0000000000..f19cb76f89 --- /dev/null +++ b/windows.ui.xaml.controls/appbar_onclosing_2045883829.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.AppBar.OnClosing(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.AppBar.OnClosing + +## -description +Invoked when the [AppBar](appbar.md) starts to change from visible to hidden. + +## -parameters +### -param e +Event data for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/appbar_onopened_1824256529.md b/windows.ui.xaml.controls/appbar_onopened_1824256529.md new file mode 100644 index 0000000000..4b50b1af35 --- /dev/null +++ b/windows.ui.xaml.controls/appbar_onopened_1824256529.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.AppBar.OnOpened(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.AppBar.OnOpened + +## -description +Invoked when the [AppBar](appbar.md) changes from hidden to visible, or is first displayed. + +## -parameters +### -param e +Event data for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/appbar_onopening_1984013329.md b/windows.ui.xaml.controls/appbar_onopening_1984013329.md new file mode 100644 index 0000000000..92973e9801 --- /dev/null +++ b/windows.ui.xaml.controls/appbar_onopening_1984013329.md @@ -0,0 +1,23 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.AppBar.OnOpening(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.AppBar.OnOpening + +## -description +Invoked when the [AppBar](appbar.md) starts to change from hidden to visible, or starts to be first displayed. + +## -parameters +### -param e +Event data for the event. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/bitmapicon_showasmonochrome.md b/windows.ui.xaml.controls/bitmapicon_showasmonochrome.md new file mode 100644 index 0000000000..3a9f63f727 --- /dev/null +++ b/windows.ui.xaml.controls/bitmapicon_showasmonochrome.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.BitmapIcon.ShowAsMonochrome +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.BitmapIcon.ShowAsMonochrome + +## -description +Gets or sets a value that indicates whether the bitmap is shown in a single color. + +## -property-value +**true** to show the bitmap in a single color; **false** to show the bitmap in full color. The default is **true.** + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/bitmapicon_showasmonochromeproperty.md b/windows.ui.xaml.controls/bitmapicon_showasmonochromeproperty.md new file mode 100644 index 0000000000..b3d6ff91af --- /dev/null +++ b/windows.ui.xaml.controls/bitmapicon_showasmonochromeproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.BitmapIcon.ShowAsMonochromeProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.BitmapIcon.ShowAsMonochromeProperty + +## -description +Identifies the [ShowAsMonochrome](bitmapicon_showasmonochrome.md) dependency property. + +## -property-value +The identifier for the **ShowAsMonochrome** dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/button.md b/windows.ui.xaml.controls/button.md index 58cef95b1d..40f9794783 100644 --- a/windows.ui.xaml.controls/button.md +++ b/windows.ui.xaml.controls/button.md @@ -88,3 +88,4 @@ The following example shows three buttons that respond to clicks in three differ ## -see-also [ButtonBase](../windows.ui.xaml.controls.primitives/buttonbase.md), [Button styles and templates](http://msdn.microsoft.com/library/05f2b757-6a25-42a7-824a-45776e76c2d2), [AppBarButton](appbarbutton.md), [CheckBox](checkbox.md), [HyperlinkButton](hyperlinkbutton.md), [RepeatButton](../windows.ui.xaml.controls.primitives/repeatbutton.md), [RadioButton](radiobutton.md), [ToggleSwitch](toggleswitch.md), [Controls list](http://msdn.microsoft.com/library/11172840-a63d-4f48-9db4-7baca06308ee), [Controls by function](http://msdn.microsoft.com/library/8db4347b-91d6-4659-91f2-80ecf7bbb596) +p://msdn.microsoft.com/library/8db4347b-91d6-4659-91f2-80ecf7bbb596) diff --git a/windows.ui.xaml.controls/checkbox.md b/windows.ui.xaml.controls/checkbox.md index 7f06da61d4..136a64f08e 100644 --- a/windows.ui.xaml.controls/checkbox.md +++ b/windows.ui.xaml.controls/checkbox.md @@ -220,3 +220,4 @@ private void Option_Unchecked(object sender, RoutedEventArgs e) ## -see-also [ToggleButton](../windows.ui.xaml.controls.primitives/togglebutton.md), [CheckBox styles and templates](http://msdn.microsoft.com/library/d0f9240d-1165-4fc2-b76c-6eaa9e173e86), [RadioButton](radiobutton.md), [ToggleSwitch](toggleswitch.md), [Controls list](http://msdn.microsoft.com/library/11172840-a63d-4f48-9db4-7baca06308ee), [Controls by function](http://msdn.microsoft.com/library/8db4347b-91d6-4659-91f2-80ecf7bbb596) +p://msdn.microsoft.com/library/8db4347b-91d6-4659-91f2-80ecf7bbb596) diff --git a/windows.ui.xaml.controls/combobox_ondropdownclosed_1323648524.md b/windows.ui.xaml.controls/combobox_ondropdownclosed_1323648524.md new file mode 100644 index 0000000000..f0ece7824a --- /dev/null +++ b/windows.ui.xaml.controls/combobox_ondropdownclosed_1323648524.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ComboBox.OnDropDownClosed(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ComboBox.OnDropDownClosed + +## -description +Invoked when the [DropDownClosed](combobox_dropdownclosed.md) event is raised. + +## -parameters +### -param e +Event data for the event. + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/combobox_ondropdownopened_1178078030.md b/windows.ui.xaml.controls/combobox_ondropdownopened_1178078030.md new file mode 100644 index 0000000000..f90b59da61 --- /dev/null +++ b/windows.ui.xaml.controls/combobox_ondropdownopened_1178078030.md @@ -0,0 +1,24 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ComboBox.OnDropDownOpened(System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ComboBox.OnDropDownOpened + +## -description +Invoked when the [DropDownOpened](combobox_dropdownopened.md) event is raised. + +## -parameters +### -param e +Event data for the event. + + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/combobox_selectionchangedtrigger.md b/windows.ui.xaml.controls/combobox_selectionchangedtrigger.md new file mode 100644 index 0000000000..70356eb341 --- /dev/null +++ b/windows.ui.xaml.controls/combobox_selectionchangedtrigger.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ComboBox.SelectionChangedTrigger +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ComboBox.SelectionChangedTrigger + +## -description +Gets or sets a value that indicates what action causes a SelectionChanged event to occur. + +## -property-value +A value of the enumeration. The default is **Committed**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/combobox_selectionchangedtriggerproperty.md b/windows.ui.xaml.controls/combobox_selectionchangedtriggerproperty.md new file mode 100644 index 0000000000..edb394a2a2 --- /dev/null +++ b/windows.ui.xaml.controls/combobox_selectionchangedtriggerproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ComboBox.SelectionChangedTriggerProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ComboBox.SelectionChangedTriggerProperty + +## -description +Identifies the [SelectionChangedTrigger](combobox_selectionchangedtrigger.md) dependency property. + +## -property-value +The identifier for the **SelectionChangedTrigger** dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/comboboxselectionchangedtrigger.md b/windows.ui.xaml.controls/comboboxselectionchangedtrigger.md new file mode 100644 index 0000000000..a32999ac88 --- /dev/null +++ b/windows.ui.xaml.controls/comboboxselectionchangedtrigger.md @@ -0,0 +1,32 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.ComboBoxSelectionChangedTrigger +-api-type: winrt enumeration +--- + + + +# Windows.UI.Xaml.Controls.ComboBoxSelectionChangedTrigger + +## -description +Defines constants that specify what action causes a [SelectionChanged](combobox_selectionchanged.md) event to occur. + +## -enum-fields + +### -field Committed:0 +A change event occurs when the user commits a selection in the combo box. + +### -field Always:1 +A change event occurs each time the user navigates to a new selection in the combo box. + +## -remarks +This enumeration is used by the [ComboBox.SelectionChangedTrigger](combobox_selectionchangedtrigger.md) property. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentcontrol_oncontentchanged_282204174.md b/windows.ui.xaml.controls/contentcontrol_oncontentchanged_282204174.md new file mode 100644 index 0000000000..996e15a33a --- /dev/null +++ b/windows.ui.xaml.controls/contentcontrol_oncontentchanged_282204174.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ContentControl.OnContentChanged(System.Object,System.Object) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ContentControl.OnContentChanged + +## -description +Invoked when the value of the [Content](contentcontrol_content.md) property changes. + +## -parameters +### -param oldContent +The old value of the [Content](contentcontrol_content.md) property. + +### -param newContent +The new value of the [Content](contentcontrol_content.md) property. + +## -remarks +If a value for [ContentTemplateSelector](contentcontrol_contenttemplateselector.md) exists, then the default implementation calls [SelectTemplate](datatemplateselector_selecttemplate.md) on the implemented [DataTemplateSelector](datatemplateselector.md), passing the *newContent* value as *item*, and the calling [ContentControl](contentcontrol.md) as *container*. The return value then sets [ContentTemplate](contentcontrol_contenttemplate.md) automatically on the caller. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/contentcontrol_oncontenttemplatechanged_626619471.md b/windows.ui.xaml.controls/contentcontrol_oncontenttemplatechanged_626619471.md new file mode 100644 index 0000000000..184408d7bb --- /dev/null +++ b/windows.ui.xaml.controls/contentcontrol_oncontenttemplatechanged_626619471.md @@ -0,0 +1,28 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ContentControl.OnContentTemplateChanged(Windows.UI.Xaml.DataTemplate,Windows.UI.Xaml.DataTemplate) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ContentControl.OnContentTemplateChanged + +## -description +Invoked when the value of the [ContentTemplate](contentcontrol_contenttemplate.md) property changes. + +## -parameters +### -param oldContentTemplate +The old value of the [ContentTemplate](contentcontrol_contenttemplate.md) property. + +### -param newContentTemplate +The new value of the [ContentTemplate](contentcontrol_contenttemplate.md) property. + +## -remarks +Classes that derive from [ContentControl](contentcontrol.md) can override this method in order to perform any custom logic that should apply, in cases where the [DataTemplate](../windows.ui.xaml/datatemplate.md) that presents the content changes. + + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/contentcontrol_oncontenttemplateselectorchanged_1048057462.md b/windows.ui.xaml.controls/contentcontrol_oncontenttemplateselectorchanged_1048057462.md new file mode 100644 index 0000000000..b6a0b08db5 --- /dev/null +++ b/windows.ui.xaml.controls/contentcontrol_oncontenttemplateselectorchanged_1048057462.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ContentControl.OnContentTemplateSelectorChanged(Windows.UI.Xaml.Controls.DataTemplateSelector,Windows.UI.Xaml.Controls.DataTemplateSelector) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ContentControl.OnContentTemplateSelectorChanged + +## -description +Invoked when the value of the [ContentTemplateSelector](contentcontrol_contenttemplateselector.md) property changes. + +## -parameters +### -param oldContentTemplateSelector +The old value of the [ContentTemplateSelector](contentcontrol_contenttemplateselector.md) property. + +### -param newContentTemplateSelector +The new value of the [ContentTemplateSelector](contentcontrol_contenttemplateselector.md) property. + +## -remarks +Classes that derive from [ContentControl](contentcontrol.md) can override this method in order to perform any custom logic that should apply, in cases where the selector logic that automatically chooses the [DataTemplate](../windows.ui.xaml/datatemplate.md) based on context changes. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/contentdialog_closebuttonclick.md b/windows.ui.xaml.controls/contentdialog_closebuttonclick.md new file mode 100644 index 0000000000..c90aec70d7 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttonclick.md @@ -0,0 +1,27 @@ +--- +-api-id: E:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonClick +-api-type: winrt event +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonClick + +## -description +Occurs after the close button has been tapped. + +## -xaml-syntax +```xaml + +``` + + +## -remarks + +## -examples + +## -see-also + + diff --git a/windows.ui.xaml.controls/contentdialog_closebuttoncommand.md b/windows.ui.xaml.controls/contentdialog_closebuttoncommand.md new file mode 100644 index 0000000000..8688e34663 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttoncommand.md @@ -0,0 +1,33 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommand +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommand + +## -description +Gets or sets the command to invoke when the close button is tapped. + +## -xaml-syntax +```xaml + +``` + +## -xaml-values +
commandReference
commandReferenceA reference to an ICommand implementation that describes the command logic. Typically this is done through a {Binding} markup extension reference to a data source, when using model-view-view model designs.
+
+ +## -property-value +The command to invoke when the primary button is tapped. + +## -remarks + +## -examples + +## -see-also + + diff --git a/windows.ui.xaml.controls/contentdialog_closebuttoncommandparameter.md b/windows.ui.xaml.controls/contentdialog_closebuttoncommandparameter.md new file mode 100644 index 0000000000..c31fa4dd81 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttoncommandparameter.md @@ -0,0 +1,37 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommandParameter +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommandParameter + +## -description +Gets or sets the parameter to pass to the command for the close button. + +## -xaml-syntax +```xaml + + + object + + +``` + +```xaml + +``` + +## -property-value +The parameter to pass to the command for the close button. The default is **null.** + +## -remarks + +## -examples + +## -see-also + + diff --git a/windows.ui.xaml.controls/contentdialog_closebuttoncommandparameterproperty.md b/windows.ui.xaml.controls/contentdialog_closebuttoncommandparameterproperty.md new file mode 100644 index 0000000000..59a4ed9ed4 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttoncommandparameterproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommandParameterProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommandParameterProperty + +## -description +Gets the identifier of the CloseButtonCommandParameter dependency property. + +## -property-value +The identifier of the CloseButtonCommandParameter dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_closebuttoncommandproperty.md b/windows.ui.xaml.controls/contentdialog_closebuttoncommandproperty.md new file mode 100644 index 0000000000..8a7c2a8d0e --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttoncommandproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommandProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonCommandProperty + +## -description +Gets the identifier of the CloseButtonCommand dependency property. + +## -property-value +The identifier of the CloseButtonCommand dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_closebuttonstyle.md b/windows.ui.xaml.controls/contentdialog_closebuttonstyle.md new file mode 100644 index 0000000000..c0452bfb73 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttonstyle.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonStyle +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonStyle + +## -description +Gets or sets the [Style](./../windows.ui.xaml/style.md) to apply to the dialog's close button. + +## -xaml-syntax +```xaml + +``` + +## -xaml-values +
styleResourceKey
styleResourceKeyThe key that identifies the style being requested. The key refers to an existing resource in a ResourceDictionary.
+
+ +## -property-value +The applied style for the button, if present; otherwise, **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_closebuttonstyleproperty.md b/windows.ui.xaml.controls/contentdialog_closebuttonstyleproperty.md new file mode 100644 index 0000000000..5503d2f712 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttonstyleproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonStyleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonStyleProperty + +## -description +Gets the identifier of the CloseButtonStyle dependency property. + +## -property-value +The identifier of the CloseButtonStyle dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_closebuttontext.md b/windows.ui.xaml.controls/contentdialog_closebuttontext.md new file mode 100644 index 0000000000..4dae17eea5 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttontext.md @@ -0,0 +1,27 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonText +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonText + +## -description +Gets or sets the text to display on the close button. + +## -xaml-syntax +```xaml + +``` + +## -property-value +The text to display on the close button. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/contentdialog_closebuttontextproperty.md b/windows.ui.xaml.controls/contentdialog_closebuttontextproperty.md new file mode 100644 index 0000000000..5272ea6d00 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_closebuttontextproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.CloseButtonTextProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.CloseButtonTextProperty + +## -description +Gets the identifier of the CloseButtonText dependency property. + +## -property-value +The identifier of the CloseButtonText dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_defaultbutton.md b/windows.ui.xaml.controls/contentdialog_defaultbutton.md new file mode 100644 index 0000000000..70bfaaa0c8 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_defaultbutton.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.DefaultButton +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.DefaultButton + +## -description +Gets or sets a value that indicates which button on the dialog is the default action. + +## -property-value +A value of the enumeration. The default is **None.** + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_defaultbuttonproperty.md b/windows.ui.xaml.controls/contentdialog_defaultbuttonproperty.md new file mode 100644 index 0000000000..c0cdb49f48 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_defaultbuttonproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.DefaultButtonProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.DefaultButtonProperty + +## -description +Gets the identifier of the DefaultButton dependency property. + +## -property-value +The identifier of the DefaultButton dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_primarybuttonstyle.md b/windows.ui.xaml.controls/contentdialog_primarybuttonstyle.md new file mode 100644 index 0000000000..42e32cfc09 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_primarybuttonstyle.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.PrimaryButtonStyle +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.PrimaryButtonStyle + +## -description +Gets or sets the [Style](./../windows.ui.xaml/style.md) to apply to the dialog's primary button. + +## -xaml-syntax +```xaml + +``` + +## -xaml-values +
styleResourceKey
styleResourceKeyThe key that identifies the style being requested. The key refers to an existing resource in a ResourceDictionary.
+
+ +## -property-value +The applied style for the button, if present; otherwise, **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_primarybuttonstyleproperty.md b/windows.ui.xaml.controls/contentdialog_primarybuttonstyleproperty.md new file mode 100644 index 0000000000..30b65ec7e3 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_primarybuttonstyleproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.PrimaryButtonStyleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.PrimaryButtonStyleProperty + +## -description +Gets the identifier of the PrimaryButtonStyle dependency property. + +## -property-value +The identifier of the PrimaryButtonStyle dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_secondarybuttonstyle.md b/windows.ui.xaml.controls/contentdialog_secondarybuttonstyle.md new file mode 100644 index 0000000000..1ddf1f95a2 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_secondarybuttonstyle.md @@ -0,0 +1,32 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.SecondaryButtonStyle +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.SecondaryButtonStyle + +## -description +Gets or sets the [Style](./../windows.ui.xaml/style.md) to apply to the dialog's secondary button. + +## -xaml-syntax +```xaml + +``` + +## -xaml-values +
styleResourceKey
styleResourceKeyThe key that identifies the style being requested. The key refers to an existing resource in a ResourceDictionary.
+
+ +## -property-value +The applied style for the button, if present; otherwise, **null**. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialog_secondarybuttonstyleproperty.md b/windows.ui.xaml.controls/contentdialog_secondarybuttonstyleproperty.md new file mode 100644 index 0000000000..0a8abd8a14 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialog_secondarybuttonstyleproperty.md @@ -0,0 +1,23 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.ContentDialog.SecondaryButtonStyleProperty +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.ContentDialog.SecondaryButtonStyleProperty + +## -description +Gets the identifier of the SecondaryButtonStyle dependency property. + +## -property-value +The identifier of the SecondaryButtonStyle dependency property. + +## -remarks + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentdialogbutton.md b/windows.ui.xaml.controls/contentdialogbutton.md new file mode 100644 index 0000000000..6e3d459ae6 --- /dev/null +++ b/windows.ui.xaml.controls/contentdialogbutton.md @@ -0,0 +1,41 @@ +--- +-api-id: T:Windows.UI.Xaml.Controls.ContentDialogButton +-api-type: winrt enumeration +--- + + + +# Windows.UI.Xaml.Controls.ContentDialogButton + +## -description +Defines constants that specify the default button on a content dialog. + +## -enum-fields + +### -field None:0 +No button is specified as the default. + +### -field Primary:1 +The primary button is the default. + +### -field Secondary:2 +The secondary button is the default. + +### -field Close:3 +The close button is the default. + +## -remarks +This enumeration is used by the [ContentDialog.DefaultButton](contentdialog_defaultbutton.md) property. +The default button responds to the Enter key and has a different visual style. + +## -see-also + +## -examples + diff --git a/windows.ui.xaml.controls/contentpresenter_oncontenttemplatechanged_626619471.md b/windows.ui.xaml.controls/contentpresenter_oncontenttemplatechanged_626619471.md new file mode 100644 index 0000000000..39a15e90a1 --- /dev/null +++ b/windows.ui.xaml.controls/contentpresenter_oncontenttemplatechanged_626619471.md @@ -0,0 +1,26 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ContentPresenter.OnContentTemplateChanged(Windows.UI.Xaml.DataTemplate,Windows.UI.Xaml.DataTemplate) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ContentPresenter.OnContentTemplateChanged + +## -description +Invoked when the value of the [ContentTemplate](contentpresenter_contenttemplate.md) property changes. + +## -parameters +### -param oldContentTemplate +The old value of the [ContentTemplate](contentpresenter_contenttemplate.md) property. + +### -param newContentTemplate +The new value of the [ContentTemplate](contentpresenter_contenttemplate.md) property. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/contentpresenter_oncontenttemplateselectorchanged_1048057462.md b/windows.ui.xaml.controls/contentpresenter_oncontenttemplateselectorchanged_1048057462.md new file mode 100644 index 0000000000..2b67295673 --- /dev/null +++ b/windows.ui.xaml.controls/contentpresenter_oncontenttemplateselectorchanged_1048057462.md @@ -0,0 +1,27 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.ContentPresenter.OnContentTemplateSelectorChanged(Windows.UI.Xaml.Controls.DataTemplateSelector,Windows.UI.Xaml.Controls.DataTemplateSelector) +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.ContentPresenter.OnContentTemplateSelectorChanged + +## -description +Invoked when the value of the [ContentTemplateSelector](contentpresenter_contenttemplateselector.md) property changes. + +## -parameters +### -param oldContentTemplateSelector +The old value of the [ContentTemplateSelector](contentpresenter_contenttemplateselector.md) property. + +### -param newContentTemplateSelector +The new value of the [ContentTemplateSelector](contentpresenter_contenttemplateselector.md) property. + +## -remarks +Classes that derive from [ContentPresenter](contentpresenter.md) can override this method in order to perform any custom logic that should apply, in cases where the selector logic that automatically chooses the [DataTemplate](../windows.ui.xaml/datatemplate.md) based on context changes. + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/control_control_1221375020.md b/windows.ui.xaml.controls/control_control_1221375020.md new file mode 100644 index 0000000000..5a93350b09 --- /dev/null +++ b/windows.ui.xaml.controls/control_control_1221375020.md @@ -0,0 +1,19 @@ +--- +-api-id: M:Windows.UI.Xaml.Controls.Control.#ctor +-api-type: winrt method +--- + + + +# Windows.UI.Xaml.Controls.Control.Control + +## -description +Provides base class initialization behavior for [Control](control.md) derived classes. + +## -remarks + +## -examples + +## -see-also diff --git a/windows.ui.xaml.controls/control_defaultstylekey.md b/windows.ui.xaml.controls/control_defaultstylekey.md new file mode 100644 index 0000000000..385727c7fd --- /dev/null +++ b/windows.ui.xaml.controls/control_defaultstylekey.md @@ -0,0 +1,64 @@ +--- +-api-id: P:Windows.UI.Xaml.Controls.Control.DefaultStyleKey +-api-type: winrt property +--- + + + +# Windows.UI.Xaml.Controls.Control.DefaultStyleKey + +## -description +Gets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses. + +## -property-value +The key that references the default style for the control. To work correctly as part of theme style lookup, this value is expected to be a [System.Type](https://msdn.microsoft.com/library/system.type.aspx) value. + +> [!NOTE] +> Visual C++ component extensions (C++/CX) uses a string that is the qualified name of the type. But this relies on generated code that produces a [TypeName](../windows.ui.xaml.interop/typename.md) once accessed by a XAML compiler; see Remarks. +## -remarks + [DefaultStyleKey](control_defaultstylekey.md) is one of the very few protected properties in the Windows Runtime API. It's intended only for use by control authors, who will be subclassing some existing control class and therefore have the necessary access to set this property. For many custom control scenarios where you'll be setting [DefaultStyleKey](control_defaultstylekey.md), you'll also be overriding [OnApplyTemplate](../windows.ui.xaml/frameworkelement_onapplytemplate.md). + +The return type of [DefaultStyleKey](control_defaultstylekey.md) is loosely typed as **Object** in the syntax, but the XAML style system will expect the value to provide a type reference: ++ For a control that has its logic written in C#, the value of [DefaultStyleKey](control_defaultstylekey.md) should be an instance of [System.Type](https://msdn.microsoft.com/library/system.type.aspx). Typically you set this value in the default constructor:```csharp +public CustomControl1() +{ + this.DefaultStyleKey = typeof(CustomControl1); +} +``` + + ++ For a control that has its logic written in Microsoft Visual Basic, the value of [DefaultStyleKey](control_defaultstylekey.md) should be an instance of [System.Type](https://msdn.microsoft.com/library/system.type.aspx). Typically you set this value in the default constructor:```vbnet +Public Sub New() + Me.DefaultStyleKey = GetType(CustomControl1) +End Sub +``` + + ++ For a control that has its logic written in Visual C++ component extensions (C++/CX), the value of [DefaultStyleKey](control_defaultstylekey.md) should be a namespace-qualified string that is the name of the custom control class. Typically you set this value in the default constructor:```vbnet +CustomControl1::CustomControl1() //public: in the header +{ + DefaultStyleKey = "App1.CustomControl1"; +} +``` + +> [!NOTE] +> Ultimately the string alone isn't enough to support a Visual C++ component extensions (C++/CX) type reference. If you use the **Add / New Item / Templated Control** options in Solution Explorer, the templates and support for Visual C++ component extensions (C++/CX) and XAML generates classes that give [IXamlMetadataProvider](../windows.ui.xaml.markup/ixamlmetadataprovider.md) info. The XAML compiler can access this code when the XAML is loaded, and uses it to validate and create types and members and join the partial classes. As far as what you define in your own app code, the string is all you need. But if you're curious you can have a look at the XamlTypeInfo.g.h and XamlTypeInfo.g.cpp files that are generated. + + +Control authors could choose to not provide a value for [DefaultStyleKey](control_defaultstylekey.md), but that's uncommon. The result would be that the default style is the one as defined by the base class. In some cases (like for [ContentControl](contentcontrol.md)) the value is **null**. Even if you choose to not redefine the value, make sure that the original default style is useful for rendering your control. + +When a XAML control is loaded, the rendering process starts, and the system is looking for the correct template to apply, what's being loaded is the XAML default style for the control, including its template. Included in the Windows Runtime is an internal copy of all the default styles for all the XAML controls that the Windows Runtime defines. The type reference in [DefaultStyleKey](control_defaultstylekey.md) tells the system which named XAML resource to load as this style. In XAML form, the styles really are keyed by type even though there's no mechanism in Windows Runtime XAML that defines a type reference explicitly. But for any [TargetType](../windows.ui.xaml/style_targettype.md) value, which is the attribute that holds the key for lookup, it's implicitly assumed to represent a type reference in the form of a string. For example, [DefaultStyleKey](control_defaultstylekey.md) from a [Button](button.md) is a [System.Type](https://msdn.microsoft.com/library/system.type.aspx) instance where the **Name** is "Button", **FullName** is "Windows.UI.Xaml.Controls.Button". The system uses this info to know to load the [Style](../windows.ui.xaml/style.md) from the internal resources that has `TargetType="Button"`. + +Custom controls usually aren't in the default XAML namespace. Instead, they're in a XAML namespace that has a **using:** statement to reference the app's code namespace. By default, projects create a prefix "local:" that maps this namespace for you. You could also map other XAML namespaces to refer to additional code namespaces for controls or other code that your app defines. + +The "local:" prefix (or some other namespace that maps to your app's code and namespaces) should precede the name of your custom control, when it's in XAML as the [TargetType](../windows.ui.xaml/style_targettype.md) value. This is also already done for you by the starting templates; when you add a new control, you'll see a generic.xaml file that contains just one style. That style will have [TargetType](../windows.ui.xaml/style_targettype.md) value that is a string starting with "local:" and completed by the name you chose for your custom control class. To match previous examples that set [DefaultStyleKey](control_defaultstylekey.md) in a `CustomControl1` definition, you'd see an element for `