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