SecondaryAuthenticationFactorRegistration.RequestStartRegisteringDeviceAsync 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.
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); static IAsyncOperation<SecondaryAuthenticationFactorRegistrationResult> RequestStartRegisteringDeviceAsync(winrt::hstring const& deviceId, SecondaryAuthenticationFactorDeviceCapabilities const& capabilities, winrt::hstring const& deviceFriendlyName, winrt::hstring const& deviceModelNumber, IBuffer const& deviceKey, IBuffer const& mutualAuthenticationKey);/// [Windows.Foundation.Metadata.Deprecated("SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 655360, "Windows.Foundation.UniversalApiContract")]
static IAsyncOperation<SecondaryAuthenticationFactorRegistrationResult> RequestStartRegisteringDeviceAsync(winrt::hstring const& deviceId, SecondaryAuthenticationFactorDeviceCapabilities const& capabilities, winrt::hstring const& deviceFriendlyName, winrt::hstring const& deviceModelNumber, IBuffer const& deviceKey, IBuffer const& mutualAuthenticationKey);public static IAsyncOperation<SecondaryAuthenticationFactorRegistrationResult> RequestStartRegisteringDeviceAsync(string deviceId, SecondaryAuthenticationFactorDeviceCapabilities capabilities, string deviceFriendlyName, string deviceModelNumber, IBuffer deviceKey, IBuffer mutualAuthenticationKey);[Windows.Foundation.Metadata.Deprecated("SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 655360, "Windows.Foundation.UniversalApiContract")]
public static IAsyncOperation<SecondaryAuthenticationFactorRegistrationResult> RequestStartRegisteringDeviceAsync(string deviceId, SecondaryAuthenticationFactorDeviceCapabilities capabilities, string deviceFriendlyName, string deviceModelNumber, IBuffer deviceKey, IBuffer mutualAuthenticationKey);function requestStartRegisteringDeviceAsync(deviceId, capabilities, deviceFriendlyName, deviceModelNumber, deviceKey, mutualAuthenticationKey)Public Shared Function RequestStartRegisteringDeviceAsync (deviceId As String, capabilities As SecondaryAuthenticationFactorDeviceCapabilities, deviceFriendlyName As String, deviceModelNumber As String, deviceKey As IBuffer, mutualAuthenticationKey As IBuffer) As IAsyncOperation(Of SecondaryAuthenticationFactorRegistrationResult)Parameters
- deviceId
-
String
Platform::String
winrt::hstring
The Id of the device.
- capabilities
- SecondaryAuthenticationFactorDeviceCapabilities
The device capabilities.
- deviceFriendlyName
-
String
Platform::String
winrt::hstring
The device friendly name.
- deviceModelNumber
-
String
Platform::String
winrt::hstring
The device model number.
- deviceKey
- IBuffer
The device key.
- mutualAuthenticationKey
- IBuffer
The mutual authentication key.
Returns
An asynchronous operation with a registration result instance.
- Attributes
Remarks
A companion device must be registered for secondary authentication before it is optionally registered for device presence monitoring.