summaryrefslogtreecommitdiff
path: root/include/ucbhelper/authenticationfallback.hxx
blob: 171ebb7fe15f382443cf109f45510f3b36b72376 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX
#define INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX

#include <rtl/ref.hxx>
#include <ucbhelper/interactionrequest.hxx>
#include <ucbhelper/ucbhelperdllapi.h>


namespace ucbhelper {

/**
  * This class implements a simple authentication interaction request used
  * when programmatically authentication cannot succeed.
  *
  * Read-only values : instructions, url
  * Read-write values: code
  */
class UCBHELPER_DLLPUBLIC AuthenticationFallbackRequest final : public ucbhelper::InteractionRequest
{
private:
    rtl::Reference< ucbhelper::InteractionAuthFallback > m_xAuthFallback;

public:
    /**
      * Constructor.
      *
      * @param rInstructions instructions to be followed by the user
      * @param rURL contains a URL for which authentication is requested.
      */
    AuthenticationFallbackRequest( const OUString & rInstructions,
                                 const OUString & rURL );

    const rtl::Reference< ucbhelper::InteractionAuthFallback >&
        getAuthFallbackInter( ) const { return m_xAuthFallback; }

};

} // namespace ucbhelper

#endif /* ! INCLUDED_UCBHELPER_AUTHENTICATIONFALLBACK_HXX*/

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */