SecondaryAuthenticationFactorRegistration.RegisterDevicePresenceMonitoringAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode) |
Deprecated. Registers a companion device for presence monitoring by the main 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. For more information on capabilities, see App capability declarations. For an overview of the Companion Device Framework, see the Windows Unlock with companion (IoT) devices overview. |
| RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode, String, String, IBuffer) |
Deprecated. Registers a companion device for presence monitoring by the main device. Includes additional information about the 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. For more information on capabilities, see App capability declarations. For an overview of the Companion Device Framework, see the Windows Unlock with companion (IoT) devices overview. |
RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode)
Deprecated. Registers a companion device for presence monitoring by the main 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. For more information on capabilities, see App capability declarations. For an overview of the Companion Device Framework, see the Windows Unlock with companion (IoT) devices overview.
public:
static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> ^ RegisterDevicePresenceMonitoringAsync(Platform::String ^ deviceId, Platform::String ^ deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode);/// [Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(winrt::hstring const& deviceId, winrt::hstring const& deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode const& monitoringMode);/// [Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
/// [Windows.Foundation.Metadata.Deprecated("RegisterDevicePresenceMonitoringAsync is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 458752, "Windows.Foundation.UniversalApiContract")]
static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(winrt::hstring const& deviceId, winrt::hstring const& deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode const& monitoringMode);[Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(string deviceId, string deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode);[Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
[Windows.Foundation.Metadata.Deprecated("RegisterDevicePresenceMonitoringAsync is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 458752, "Windows.Foundation.UniversalApiContract")]
public static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(string deviceId, string deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode);function registerDevicePresenceMonitoringAsync(deviceId, deviceInstancePath, monitoringMode)Public Shared Function RegisterDevicePresenceMonitoringAsync (deviceId As String, deviceInstancePath As String, monitoringMode As SecondaryAuthenticationFactorDevicePresenceMonitoringMode) As IAsyncOperation(Of SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus)Parameters
- deviceId
-
String
Platform::String
winrt::hstring
The unique identifier for the companion device.
- deviceInstancePath
-
String
Platform::String
winrt::hstring
The device instance path string.
- monitoringMode
- SecondaryAuthenticationFactorDevicePresenceMonitoringMode
A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode type that will be used.
Returns
An asynchronous operation with the status of the registration.
- Attributes
Windows requirements
| Device family |
Windows 10 Creators Update (introduced in 10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v4.0)
|
Remarks
A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring.
Applies to
RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode, String, String, IBuffer)
Deprecated. Registers a companion device for presence monitoring by the main device. Includes additional information about the 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. For more information on capabilities, see App capability declarations. For an overview of the Companion Device Framework, see the Windows Unlock with companion (IoT) devices overview.
public:
static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> ^ RegisterDevicePresenceMonitoringAsync(Platform::String ^ deviceId, Platform::String ^ deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode, Platform::String ^ deviceFriendlyName, Platform::String ^ deviceModelNumber, IBuffer ^ deviceConfigurationData);/// [Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringWithNewDeviceAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(winrt::hstring const& deviceId, winrt::hstring const& deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode const& monitoringMode, winrt::hstring const& deviceFriendlyName, winrt::hstring const& deviceModelNumber, IBuffer const& deviceConfigurationData);/// [Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringWithNewDeviceAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
/// [Windows.Foundation.Metadata.Deprecated("RegisterDevicePresenceMonitoringWithNewDeviceAsync is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 458752, "Windows.Foundation.UniversalApiContract")]
static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(winrt::hstring const& deviceId, winrt::hstring const& deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode const& monitoringMode, winrt::hstring const& deviceFriendlyName, winrt::hstring const& deviceModelNumber, IBuffer const& deviceConfigurationData);[Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringWithNewDeviceAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(string deviceId, string deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode, string deviceFriendlyName, string deviceModelNumber, IBuffer deviceConfigurationData);[Windows.Foundation.Metadata.Overload("RegisterDevicePresenceMonitoringWithNewDeviceAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
[Windows.Foundation.Metadata.Deprecated("RegisterDevicePresenceMonitoringWithNewDeviceAsync is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 458752, "Windows.Foundation.UniversalApiContract")]
public static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(string deviceId, string deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode, string deviceFriendlyName, string deviceModelNumber, IBuffer deviceConfigurationData);function registerDevicePresenceMonitoringAsync(deviceId, deviceInstancePath, monitoringMode, deviceFriendlyName, deviceModelNumber, deviceConfigurationData)Public Shared Function RegisterDevicePresenceMonitoringAsync (deviceId As String, deviceInstancePath As String, monitoringMode As SecondaryAuthenticationFactorDevicePresenceMonitoringMode, deviceFriendlyName As String, deviceModelNumber As String, deviceConfigurationData As IBuffer) As IAsyncOperation(Of SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus)Parameters
- deviceId
-
String
Platform::String
winrt::hstring
The unique identifier for the companion device.
- deviceInstancePath
-
String
Platform::String
winrt::hstring
The device instance path string.
- monitoringMode
- SecondaryAuthenticationFactorDevicePresenceMonitoringMode
A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode type that will be used.
- deviceFriendlyName
-
String
Platform::String
winrt::hstring
The friendly name of the device.
- deviceModelNumber
-
String
Platform::String
winrt::hstring
The model number of the device.
- deviceConfigurationData
- IBuffer
The device configuration data. This data is capped at 4KB.
Returns
An asynchronous operation with the status of the registration.
- Attributes
Windows requirements
| Device family |
Windows 10 Creators Update (introduced in 10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v4.0)
|
Remarks
A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring.