include/windows.security.credentials.ui.idl

   1 /*
   2  * Copyright (C) 2023 Mohamad Al-Jaf
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifdef __WIDL__
  20 #pragma winrt ns_prefix
  21 #endif
  22
  23 import "inspectable.idl";
  24 import "asyncinfo.idl";
  25 import "eventtoken.idl";
  26 import "windowscontracts.idl";
  27 import "windows.foundation.idl";
  28 import "windows.storage.streams.idl";
  29
  30 namespace Windows.Security.Credentials.UI {
  31     typedef enum UserConsentVerificationResult UserConsentVerificationResult;
  32     typedef enum UserConsentVerifierAvailability UserConsentVerifierAvailability;
  33
  34     interface IUserConsentVerifierStatics;
  35
  36     runtimeclass UserConsentVerifier;
  37
  38     declare {
  39         interface Windows.Foundation.AsyncOperationCompletedHandler<Windows.Security.Credentials.UI.UserConsentVerificationResult>;
  40         interface Windows.Foundation.AsyncOperationCompletedHandler<Windows.Security.Credentials.UI.UserConsentVerifierAvailability>;
  41         interface Windows.Foundation.IAsyncOperation<Windows.Security.Credentials.UI.UserConsentVerificationResult>;
  42         interface Windows.Foundation.IAsyncOperation<Windows.Security.Credentials.UI.UserConsentVerifierAvailability>;
  43     }
  44
  45     [
  46         contract(Windows.Foundation.UniversalApiContract, 1.0)
  47     ]
  48     enum UserConsentVerificationResult
  49     {
  50         Verified             = 0,
  51         DeviceNotPresent     = 1,
  52         NotConfiguredForUser = 2,
  53         DisabledByPolicy     = 3,
  54         DeviceBusy           = 4,
  55         RetriesExhausted     = 5,
  56         Canceled             = 6,
  57     };
  58
  59     [
  60         contract(Windows.Foundation.UniversalApiContract, 1.0)
  61     ]
  62     enum UserConsentVerifierAvailability
  63     {
  64         Available            = 0,
  65         DeviceNotPresent     = 1,
  66         NotConfiguredForUser = 2,
  67         DisabledByPolicy     = 3,
  68         DeviceBusy           = 4,
  69     };
  70
  71     [
  72         contract(Windows.Foundation.UniversalApiContract, 1.0),
  73         exclusiveto(Windows.Security.Credentials.UI.UserConsentVerifier),
  74         uuid(af4f3f91-564c-4ddc-b8b5-973447627c65)
  75     ]
  76     interface IUserConsentVerifierStatics : IInspectable
  77     {
  78         HRESULT CheckAvailabilityAsync([out, retval] Windows.Foundation.IAsyncOperation<Windows.Security.Credentials.UI.UserConsentVerifierAvailability> **result);
  79         HRESULT RequestVerificationAsync([in] HSTRING message, [out, retval] Windows.Foundation.IAsyncOperation<Windows.Security.Credentials.UI.UserConsentVerificationResult> **result);
  80     }
  81
  82     [
  83         contract(Windows.Foundation.UniversalApiContract, 1.0),
  84         marshaling_behavior(agile),
  85         static(Windows.Security.Credentials.UI.IUserConsentVerifierStatics, Windows.Foundation.UniversalApiContract, 1.0),
  86         threading(both)
  87     ]
  88     runtimeclass UserConsentVerifier
  89     {
  90     }
  91 }