include/ucbhelper/authenticationfallback.hxx

   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
  10 #ifndef INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX
  11 #define INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX
  12
  13 #include <rtl/ref.hxx>
  14 #include <ucbhelper/interactionrequest.hxx>
  15 #include <ucbhelper/ucbhelperdllapi.h>
  16
  17
  18 namespace ucbhelper {
  19
  20 /**
  21   * This class implements a simple authentication interaction request used
  22   * when programmatically authentication cannot succeed.
  23   *
  24   * Read-only values : instructions, url
  25   * Read-write values: code
  26   */
  27 class UCBHELPER_DLLPUBLIC AuthenticationFallbackRequest final : public ucbhelper::InteractionRequest
  28 {
  29 private:
  30     rtl::Reference< ucbhelper::InteractionAuthFallback > m_xAuthFallback;
  31
  32 public:
  33     /**
  34       * Constructor.
  35       *
  36       * @param rInstructions instructions to be followed by the user
  37       * @param rURL contains a URL for which authentication is requested.
  38       */
  39     AuthenticationFallbackRequest( const OUString & rInstructions,
  40                                  const OUString & rURL );
  41
  42     const rtl::Reference< ucbhelper::InteractionAuthFallback >&
  43         getAuthFallbackInter( ) const { return m_xAuthFallback; }
  44
  45 };
  46
  47 } // namespace ucbhelper
  48
  49 #endif /* ! INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX*/
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */