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