offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.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_XInteractionSupplyAuthentication_idl__
  20 #define __com_sun_star_ucb_XInteractionSupplyAuthentication_idl__
  21
  22 #include <com/sun/star/task/XInteractionContinuation.idl>
  23 #include <com/sun/star/ucb/RememberAuthentication.idl>
  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 published interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionContinuation
  35 {
  36     /** Specifies if a new "realm" value can be handed back.
  37     */
  38     boolean canSetRealm();
  39
  40     /** Set a new "realm" value to hand back.
  41
  42         <p>This method should be called before
  43         com::sun::star::task::XInteractionContinuation::select(),
  44         and should only be called if
  45         XInteractionSupplyAuthentication::canSetRealm() returned
  46         `TRUE`.</p>
  47     */
  48     void setRealm( [in] string Realm );
  49
  50     /** Specifies if a "user name" value can be handed back.
  51     */
  52     boolean canSetUserName();
  53
  54     /** Set a new "user name" value to hand back.
  55
  56         <p>This method should be called before
  57         com::sun::star::task::XInteractionContinuation::select(),
  58         and should only be called if
  59         XInteractionSupplyAuthentication::canSetUserName()
  60         returned `TRUE`.</p>
  61     */
  62     void setUserName( [in] string UserName );
  63
  64     /** Specifies if a "password" value can be handed back.
  65     */
  66     boolean canSetPassword();
  67
  68     /** Set a new "password" value to hand back.
  69
  70         <p>This method should be called before
  71         com::sun::star::task::XInteractionContinuation::select(),
  72         and should only be called if
  73         XInteractionSupplyAuthentication::canSetPassword()
  74         returned `TRUE`.</p>
  75     */
  76     void setPassword( [in] string Password );
  77
  78     /** Specifies the available modes of how long to remember the password.
  79
  80         @param Default
  81         Returns the default mode (to be initially displayed to the user).
  82
  83         @returns
  84         A sequence of available modes to hand back.  Each individual mode
  85         should appear at most once in the sequence.  If the sequence is empty,
  86         a new mode cannot be handed back.
  87     */
  88     sequence<com::sun::star::ucb::RememberAuthentication> getRememberPasswordModes( [out] com::sun::star::ucb::RememberAuthentication Default );
  89
  90     /** Set a new mode of how long to remember the password.
  91
  92         <p>This method should be called before
  93         com::sun::star::task::XInteractionContinuation::select(),
  94         and should only be called if
  95         XInteractionSupplyAuthentication::setPassword()
  96         is also called.</p>
  97
  98         @param Remember
  99         The mode to hand back, should be contained in the sequence returned by
 100         XInteractionSupplyAuthentication::getRememberPasswordModes().
 101     */
 102     void setRememberPassword( [in] com::sun::star::ucb::RememberAuthentication Remember );
 103
 104     /** Specifies if an "account" value can be handed back.
 105     */
 106     boolean canSetAccount();
 107
 108     /** Set a new "account" value to hand back.
 109
 110         <p>This method should be called before
 111         com::sun::star::task::XInteractionContinuation::select(),
 112         and should only be called if
 113         XInteractionSupplyAuthentication::canSetAccount()
 114         returned `TRUE`.</p>
 115
 116     */
 117     void setAccount( [in] string Account );
 118
 119     /** Specifies the available modes of how long to remember the account.
 120
 121         @param Default  Returns the default mode (to be initially displayed to
 122         the user).
 123
 124         @returns  A sequence of available modes to hand back.  Each individual
 125         mode should appear at most once in the sequence.  If the sequence is
 126         empty, a new mode cannot be handed back.
 127      */
 128     sequence<com::sun::star::ucb::RememberAuthentication> getRememberAccountModes( [out] com::sun::star::ucb::RememberAuthentication Default );
 129
 130     /** Set a new mode of how long to remember the account.
 131
 132         <p>This method should be called before
 133         com::sun::star::task::XInteractionContinuation::select(),
 134         and should only be called if
 135         XInteractionSupplyAuthentication::setAccount()
 136         is also called.</p>
 137
 138         @param Remember  The mode to hand back, should be contained in the
 139         sequence returned by
 140         XInteractionSupplyAuthentication::getRememberAccountModes().
 141     */
 142     void setRememberAccount( [in] com::sun::star::ucb::RememberAuthentication Remember );
 143
 144 };
 145
 146
 147 }; }; }; };
 148
 149 #endif
 150
 151 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */