SecondaryAuthenticationFactorInfo
SecondaryAuthenticationFactorInfo
SecondaryAuthenticationFactorInfo
SecondaryAuthenticationFactorInfo
Class
Definition
Contains properties that provide information about 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 : sealed class SecondaryAuthenticationFactorInfo : ISecondaryAuthenticationFactorInfo, ISecondaryAuthenticationFactorInfo2public sealed class SecondaryAuthenticationFactorInfo : ISecondaryAuthenticationFactorInfo, ISecondaryAuthenticationFactorInfo2Public NotInheritable Class SecondaryAuthenticationFactorInfo Implements ISecondaryAuthenticationFactorInfo, ISecondaryAuthenticationFactorInfo2// 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)
|
Properties
DeviceConfigurationData DeviceConfigurationData DeviceConfigurationData DeviceConfigurationData
Gets the device configuration data.
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 : IBuffer DeviceConfigurationData { get; }public IBuffer DeviceConfigurationData { get; }Public ReadOnly Property DeviceConfigurationData As IBuffer// You can use this property in JavaScript.
- See Also
DeviceFriendlyName DeviceFriendlyName DeviceFriendlyName DeviceFriendlyName
Gets the device friendly name.
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 : PlatForm::String DeviceFriendlyName { get; }public string DeviceFriendlyName { get; }Public ReadOnly Property DeviceFriendlyName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The device friendly name.
- See Also
DeviceId DeviceId DeviceId DeviceId
Gets the device Id.
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 : PlatForm::String DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The device Id.
- See Also
DeviceModelNumber DeviceModelNumber DeviceModelNumber DeviceModelNumber
Gets the device model number.
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 : PlatForm::String DeviceModelNumber { get; }public string DeviceModelNumber { get; }Public ReadOnly Property DeviceModelNumber As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The device model number.
- See Also
IsAuthenticationSupported IsAuthenticationSupported IsAuthenticationSupported IsAuthenticationSupported
Checks whether the companion device supports some kind of user authentication function.
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 : PlatForm::Boolean IsAuthenticationSupported { get; }public bool IsAuthenticationSupported { get; }Public ReadOnly Property IsAuthenticationSupported As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the device supports authentication, otherwise false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
PresenceMonitoringMode PresenceMonitoringMode PresenceMonitoringMode PresenceMonitoringMode
Gets the presence monitoring mode of the companion device (the mechanism by which the main device checks the presence of 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 : SecondaryAuthenticationFactorDevicePresenceMonitoringMode PresenceMonitoringMode { get; }public SecondaryAuthenticationFactorDevicePresenceMonitoringMode PresenceMonitoringMode { get; }Public ReadOnly Property PresenceMonitoringMode As SecondaryAuthenticationFactorDevicePresenceMonitoringMode// You can use this property in JavaScript.
- Value
- SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode
A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Methods
UpdateDevicePresenceAsync(SecondaryAuthenticationFactorDevicePresence) UpdateDevicePresenceAsync(SecondaryAuthenticationFactorDevicePresence) UpdateDevicePresenceAsync(SecondaryAuthenticationFactorDevicePresence) UpdateDevicePresenceAsync(SecondaryAuthenticationFactorDevicePresence)
Manually assigns a presence state to a 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 UpdateDevicePresenceAsync(SecondaryAuthenticationFactorDevicePresence presenceState)public IAsyncAction UpdateDevicePresenceAsync(SecondaryAuthenticationFactorDevicePresence presenceState)Public Function UpdateDevicePresenceAsync(presenceState As SecondaryAuthenticationFactorDevicePresence) As IAsyncAction// You can use this method in JavaScript.
- presenceState
- SecondaryAuthenticationFactorDevicePresence SecondaryAuthenticationFactorDevicePresence SecondaryAuthenticationFactorDevicePresence SecondaryAuthenticationFactorDevicePresence
A SecondaryAuthenticationFactorDevicePresence value indicating the device's presence state.
An asynchronous action for the operation.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Remarks
This method should only be used when a companion device's monitoring mode is set to SecondaryAuthenticationFactorDevicePresenceMonitoringMode.AppManaged. 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 value according to the result.