SecondaryAuthenticationFactorAuthentication
SecondaryAuthenticationFactorAuthentication
SecondaryAuthenticationFactorAuthentication
SecondaryAuthenticationFactorAuthentication
Class
Definition
Contains core methods for authenticating with 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 SecondaryAuthenticationFactorAuthentication : ISecondaryAuthenticationFactorAuthenticationpublic sealed class SecondaryAuthenticationFactorAuthentication : ISecondaryAuthenticationFactorAuthenticationPublic NotInheritable Class SecondaryAuthenticationFactorAuthentication Implements ISecondaryAuthenticationFactorAuthentication// 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
DeviceNonce DeviceNonce DeviceNonce DeviceNonce
Gets the device nonce.
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 DeviceNonce { get; }public IBuffer DeviceNonce { get; }Public ReadOnly Property DeviceNonce As IBuffer// You can use this property in JavaScript.
- See Also
ServiceAuthenticationHmac ServiceAuthenticationHmac ServiceAuthenticationHmac ServiceAuthenticationHmac
Gets the service authentication HMAC.
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 ServiceAuthenticationHmac { get; }public IBuffer ServiceAuthenticationHmac { get; }Public ReadOnly Property ServiceAuthenticationHmac As IBuffer// You can use this property in JavaScript.
- See Also
SessionNonce SessionNonce SessionNonce SessionNonce
Gets the session nonce.
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 SessionNonce { get; }public IBuffer SessionNonce { get; }Public ReadOnly Property SessionNonce As IBuffer// You can use this property in JavaScript.
- See Also
Methods
AbortAuthenticationAsync(String) AbortAuthenticationAsync(String) AbortAuthenticationAsync(String) AbortAuthenticationAsync(String)
Aborts an authentication.
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 AbortAuthenticationAsync(PlatForm::String errorLogMessage)public IAsyncAction AbortAuthenticationAsync(String errorLogMessage)Public Function AbortAuthenticationAsync(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
FinishAuthenticationAsync(IBuffer, IBuffer) FinishAuthenticationAsync(IBuffer, IBuffer) FinishAuthenticationAsync(IBuffer, IBuffer) FinishAuthenticationAsync(IBuffer, IBuffer)
Finishes an authentication with 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 : IAsyncOperation<SecondaryAuthenticationFactorFinishAuthenticationStatus> FinishAuthenticationAsync(IBuffer deviceHmac, IBuffer sessionHmac)public IAsyncOperation<SecondaryAuthenticationFactorFinishAuthenticationStatus> FinishAuthenticationAsync(IBuffer deviceHmac, IBuffer sessionHmac)Public Function FinishAuthenticationAsync(deviceHmac As IBuffer, sessionHmac As IBuffer) As IAsyncOperation( Of SecondaryAuthenticationFactorFinishAuthenticationStatus )// You can use this method in JavaScript.
When this method completes, it returns the status of the operation finishing.
- See Also
GetAuthenticationStageInfoAsync() GetAuthenticationStageInfoAsync() GetAuthenticationStageInfoAsync() GetAuthenticationStageInfoAsync()
Gets info on the authentication stage.
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<SecondaryAuthenticationFactorAuthenticationStageInfo> GetAuthenticationStageInfoAsync()public static IAsyncOperation<SecondaryAuthenticationFactorAuthenticationStageInfo> GetAuthenticationStageInfoAsync()Public Static Function GetAuthenticationStageInfoAsync() As IAsyncOperation( Of SecondaryAuthenticationFactorAuthenticationStageInfo )// You can use this method in JavaScript.
When this method completes, it returns info on the authentication stage.
- See Also
ShowNotificationMessageAsync(String, SecondaryAuthenticationFactorAuthenticationMessage) ShowNotificationMessageAsync(String, SecondaryAuthenticationFactorAuthenticationMessage) ShowNotificationMessageAsync(String, SecondaryAuthenticationFactorAuthenticationMessage) ShowNotificationMessageAsync(String, SecondaryAuthenticationFactorAuthenticationMessage)
Shows a message above the lock screen or within the companion device sign in option tile.
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 ShowNotificationMessageAsync(PlatForm::String deviceName, SecondaryAuthenticationFactorAuthenticationMessage message)public static IAsyncAction ShowNotificationMessageAsync(String deviceName, SecondaryAuthenticationFactorAuthenticationMessage message)Public Static Function ShowNotificationMessageAsync(deviceName As String, message As SecondaryAuthenticationFactorAuthenticationMessage) As IAsyncAction// You can use this method in JavaScript.
- deviceName
- PlatForm::String String String String
The name of device to display as part of the notification message (set using the message parameter).
- message
- SecondaryAuthenticationFactorAuthenticationMessage SecondaryAuthenticationFactorAuthenticationMessage SecondaryAuthenticationFactorAuthenticationMessage SecondaryAuthenticationFactorAuthenticationMessage
The message to show.
This method does not return a value.
- See Also
StartAuthenticationAsync(String, IBuffer) StartAuthenticationAsync(String, IBuffer) StartAuthenticationAsync(String, IBuffer) StartAuthenticationAsync(String, IBuffer)
Start an authentication with 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<SecondaryAuthenticationFactorAuthenticationResult> StartAuthenticationAsync(PlatForm::String deviceId, IBuffer serviceAuthenticationNonce)public static IAsyncOperation<SecondaryAuthenticationFactorAuthenticationResult> StartAuthenticationAsync(String deviceId, IBuffer serviceAuthenticationNonce)Public Static Function StartAuthenticationAsync(deviceId As String, serviceAuthenticationNonce As IBuffer) As IAsyncOperation( Of SecondaryAuthenticationFactorAuthenticationResult )// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The Id of the device to authenticate with.
When this method completes, it returns the results of the authentication.
- See Also
Events
AuthenticationStageChanged AuthenticationStageChanged AuthenticationStageChanged AuthenticationStageChanged
Fires when the authentication stage changes.
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 event EventHandler AuthenticationStageChanged<SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs>public static event EventHandler AuthenticationStageChanged<SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs>Public Static Event AuthenticationStageChanged<SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs>// You can use this event in JavaScript.
- See Also