offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XInteractionSupplyAuthentication2_idl__
  20 #define __com_sun_star_ucb_XInteractionSupplyAuthentication2_idl__
  21
  22 #include <com/sun/star/ucb/XInteractionSupplyAuthentication.idl>
  23
  24
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** An interaction continuation handing back some authentication data.
  30
  31     <p> This continuation is typically used in conjunction with
  32     AuthenticationRequest. </p>
  33
  34     @since OOo 3.2
  35 */
  36 interface XInteractionSupplyAuthentication2 : XInteractionSupplyAuthentication
  37 {
  38     /** Specifies if "system credentials" can be obtained and used by the issuer
  39         of the authentication request.
  40
  41         @param Default
  42         Returns the default behavior for system credentials handling (to be
  43         initially displayed to the user).
  44
  45         @returns
  46         `TRUE` if the issuer is able to obtain and use system credentials.
  47         `FALSE` otherwise.
  48     */
  49     boolean canUseSystemCredentials( [out] boolean Default );
  50
  51     /** Set a new "use system credentials" value to hand back.
  52
  53         @param UseSystemCredentials
  54         `TRUE` means the request issuer shall obtain and use system credentials.
  55      */
  56     void setUseSystemCredentials( [in] boolean UseSystemCredentials );
  57
  58 };
  59
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */