SecondaryAuthenticationFactorRegistration
SecondaryAuthenticationFactorRegistration
SecondaryAuthenticationFactorRegistration
SecondaryAuthenticationFactorRegistration
Class
Definition
Contains methods for registering companion devices.
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 : sealed class SecondaryAuthenticationFactorRegistration : ISecondaryAuthenticationFactorRegistrationpublic sealed class SecondaryAuthenticationFactorRegistration : ISecondaryAuthenticationFactorRegistrationPublic NotInheritable Class SecondaryAuthenticationFactorRegistration Implements ISecondaryAuthenticationFactorRegistration// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Methods
AbortRegisteringDeviceAsync(String) AbortRegisteringDeviceAsync(String) AbortRegisteringDeviceAsync(String) AbortRegisteringDeviceAsync(String)
Aborts registering 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 : IAsyncAction AbortRegisteringDeviceAsync(PlatForm::String errorLogMessage)public IAsyncAction AbortRegisteringDeviceAsync(String errorLogMessage)Public Function AbortRegisteringDeviceAsync(errorLogMessage As String) As IAsyncAction// You can use this method in JavaScript.
- errorLogMessage
- PlatForm::String String String String
An error message to log.
This method does not return a value.
- See Also
FindAllRegisteredDeviceInfoAsync(SecondaryAuthenticationFactorDeviceFindScope) FindAllRegisteredDeviceInfoAsync(SecondaryAuthenticationFactorDeviceFindScope) FindAllRegisteredDeviceInfoAsync(SecondaryAuthenticationFactorDeviceFindScope) FindAllRegisteredDeviceInfoAsync(SecondaryAuthenticationFactorDeviceFindScope)
Returns info on found registered devices.
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<IVectorView<SecondaryAuthenticationFactorInfo>> FindAllRegisteredDeviceInfoAsync(SecondaryAuthenticationFactorDeviceFindScope queryType)public static IAsyncOperation<IReadOnlyList<SecondaryAuthenticationFactorInfo>> FindAllRegisteredDeviceInfoAsync(SecondaryAuthenticationFactorDeviceFindScope queryType)Public Static Function FindAllRegisteredDeviceInfoAsync(queryType As SecondaryAuthenticationFactorDeviceFindScope) As IAsyncOperation( Of IReadOnlyListSecondaryAuthenticationFactorInfo )// You can use this method in JavaScript.
- queryType
- SecondaryAuthenticationFactorDeviceFindScope SecondaryAuthenticationFactorDeviceFindScope SecondaryAuthenticationFactorDeviceFindScope SecondaryAuthenticationFactorDeviceFindScope
The scope of devices to find.
When this method completes, it returns device info for the found registered devices.
- See Also
FinishRegisteringDeviceAsync(IBuffer) FinishRegisteringDeviceAsync(IBuffer) FinishRegisteringDeviceAsync(IBuffer) FinishRegisteringDeviceAsync(IBuffer)
Finishes registering a 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 : IAsyncAction FinishRegisteringDeviceAsync(IBuffer deviceConfigurationData)public IAsyncAction FinishRegisteringDeviceAsync(IBuffer deviceConfigurationData)Public Function FinishRegisteringDeviceAsync(deviceConfigurationData As IBuffer) As IAsyncAction// You can use this method in JavaScript.
Configuration data for the device. This data is capped at 4KB.
This method does not return a value.
- See Also
IsDevicePresenceMonitoringSupported() IsDevicePresenceMonitoringSupported() IsDevicePresenceMonitoringSupported() IsDevicePresenceMonitoringSupported()
Checks whether the main device is able to monitor for the presence of companion devices.
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 PlatForm::Boolean IsDevicePresenceMonitoringSupported()public static bool IsDevicePresenceMonitoringSupported()Public Static Function IsDevicePresenceMonitoringSupported() As bool// You can use this method in JavaScript.
A value of true if the device can monitor companion devices, otherwise false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode) RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode) RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode) RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode)
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)public static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(String deviceId, String deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode)Public Static Function RegisterDevicePresenceMonitoringAsync(deviceId As String, deviceInstancePath As String, monitoringMode As SecondaryAuthenticationFactorDevicePresenceMonitoringMode) As IAsyncOperation( Of SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus )// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The unique identifier for the companion device.
- deviceInstancePath
- PlatForm::String String String String
The device instance path string.
- monitoringMode
- SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode
A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode type that will be used.
An asynchronous operation with the status of the registration.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Remarks
A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring.
RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode, String, String, IBuffer) RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode, String, String, IBuffer) RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode, String, String, IBuffer) RegisterDevicePresenceMonitoringAsync(String, String, SecondaryAuthenticationFactorDevicePresenceMonitoringMode, String, String, IBuffer)
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)public static IAsyncOperation<SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus> RegisterDevicePresenceMonitoringAsync(String deviceId, String deviceInstancePath, SecondaryAuthenticationFactorDevicePresenceMonitoringMode monitoringMode, String deviceFriendlyName, String deviceModelNumber, IBuffer deviceConfigurationData)Public Static Function RegisterDevicePresenceMonitoringAsync(deviceId As String, deviceInstancePath As String, monitoringMode As SecondaryAuthenticationFactorDevicePresenceMonitoringMode, deviceFriendlyName As String, deviceModelNumber As String, deviceConfigurationData As IBuffer) As IAsyncOperation( Of SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus )// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The unique identifier for the companion device.
- deviceInstancePath
- PlatForm::String String String String
The device instance path string.
- monitoringMode
- SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode
A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode type that will be used.
- deviceFriendlyName
- PlatForm::String String String String
The friendly name of the device.
- deviceModelNumber
- PlatForm::String String String String
The model number of the device.
The device configuration data. This data is capped at 4KB.
An asynchronous operation with the status of the registration.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Remarks
A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring.
RequestStartRegisteringDeviceAsync(String, SecondaryAuthenticationFactorDeviceCapabilities, String, String, IBuffer, IBuffer) RequestStartRegisteringDeviceAsync(String, SecondaryAuthenticationFactorDeviceCapabilities, String, String, IBuffer, IBuffer) RequestStartRegisteringDeviceAsync(String, SecondaryAuthenticationFactorDeviceCapabilities, String, String, IBuffer, IBuffer) RequestStartRegisteringDeviceAsync(String, SecondaryAuthenticationFactorDeviceCapabilities, String, String, IBuffer, IBuffer)
Starts registering a 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<SecondaryAuthenticationFactorRegistrationResult> RequestStartRegisteringDeviceAsync(PlatForm::String deviceId, SecondaryAuthenticationFactorDeviceCapabilities capabilities, PlatForm::String deviceFriendlyName, PlatForm::String deviceModelNumber, IBuffer deviceKey, IBuffer mutualAuthenticationKey)public static IAsyncOperation<SecondaryAuthenticationFactorRegistrationResult> RequestStartRegisteringDeviceAsync(String deviceId, SecondaryAuthenticationFactorDeviceCapabilities capabilities, String deviceFriendlyName, String deviceModelNumber, IBuffer deviceKey, IBuffer mutualAuthenticationKey)Public Static Function RequestStartRegisteringDeviceAsync(deviceId As String, capabilities As SecondaryAuthenticationFactorDeviceCapabilities, deviceFriendlyName As String, deviceModelNumber As String, deviceKey As IBuffer, mutualAuthenticationKey As IBuffer) As IAsyncOperation( Of SecondaryAuthenticationFactorRegistrationResult )// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The Id of the device.
- capabilities
- SecondaryAuthenticationFactorDeviceCapabilities SecondaryAuthenticationFactorDeviceCapabilities SecondaryAuthenticationFactorDeviceCapabilities SecondaryAuthenticationFactorDeviceCapabilities
The device capabilities.
- deviceFriendlyName
- PlatForm::String String String String
The device friendly name.
- deviceModelNumber
- PlatForm::String String String String
The device model number.
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.
- See Also
UnregisterDeviceAsync(String) UnregisterDeviceAsync(String) UnregisterDeviceAsync(String) UnregisterDeviceAsync(String)
Unregisters a 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 IAsyncAction UnregisterDeviceAsync(PlatForm::String deviceId)public static IAsyncAction UnregisterDeviceAsync(String deviceId)Public Static Function UnregisterDeviceAsync(deviceId As String) As IAsyncAction// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The Id of the device to unregister.
This method does not return a value.
- See Also
UnregisterDevicePresenceMonitoringAsync(String) UnregisterDevicePresenceMonitoringAsync(String) UnregisterDevicePresenceMonitoringAsync(String) UnregisterDevicePresenceMonitoringAsync(String)
Unregisters a companion device from presence monitoring.
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 IAsyncAction UnregisterDevicePresenceMonitoringAsync(PlatForm::String deviceId)public static IAsyncAction UnregisterDevicePresenceMonitoringAsync(String deviceId)Public Static Function UnregisterDevicePresenceMonitoringAsync(deviceId As String) As IAsyncAction// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The unique identifier for the device.
This method does not return a value.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
UpdateDeviceConfigurationDataAsync(String, IBuffer) UpdateDeviceConfigurationDataAsync(String, IBuffer) UpdateDeviceConfigurationDataAsync(String, IBuffer) UpdateDeviceConfigurationDataAsync(String, IBuffer)
Updates the configuration data of a 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 IAsyncAction UpdateDeviceConfigurationDataAsync(PlatForm::String deviceId, IBuffer deviceConfigurationData)public static IAsyncAction UpdateDeviceConfigurationDataAsync(String deviceId, IBuffer deviceConfigurationData)Public Static Function UpdateDeviceConfigurationDataAsync(deviceId As String, deviceConfigurationData As IBuffer) As IAsyncAction// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The Id of the device to update.
The updated configuration data. This data is capped at 4KB.
This method does not return a value.
- See Also