Cutelyst  1.5.0
statusmessage.h
1 /*
2  * Copyright (C) 2016 Daniel Nicoletti <dantti12@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB. If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 #ifndef CUTELYST_PLUGIN_STATUSMESSAGE
20 #define CUTELYST_PLUGIN_STATUSMESSAGE
21 
22 #include <Cutelyst/plugin.h>
23 #include <Cutelyst/cutelyst_global.h>
24 #include <Cutelyst/context.h>
25 
26 namespace Cutelyst {
27 
28 class StatusMessagePrivate;
29 class CUTELYST_PLUGIN_STATUSMESSAGE_EXPORT StatusMessage : public Plugin
30 {
31  Q_OBJECT
32  Q_DECLARE_PRIVATE(StatusMessage)
33 public:
34  StatusMessage(Application *parent);
35  virtual ~StatusMessage();
36 
40  QString sessionPrefix() const;
41  void setSessionPrefix(const QString &sessionPrefix);
42 
46  QString tokenParam() const;
47  void setTokenParam(const QString &tokenParam);
48 
52  QString statusMsgStashKey() const;
53  void setStatusMsgStashKey(const QString &statusMsgStashKey);
54 
58  QString errorMgStashKey() const;
59  void setErrorMgStashKey(const QString &errorMgStashKey);
60 
64  static void load(Context *c);
65 
69  static QString error(Context *c, const QString &msg);
70 
74  static ParamsMultiMap errorQuery(Context *c, const QString &msg, ParamsMultiMap query = ParamsMultiMap());
75 
79  static QString status(Context *c, const QString &msg);
80 
84  static ParamsMultiMap statusQuery(Context *c, const QString &msg, ParamsMultiMap query = ParamsMultiMap());
85 
89  static Q_DECL_DEPRECATED QString setError(Context *c, const QString &msg);
90 
94  static Q_DECL_DEPRECATED QString setStatus(Context *c, const QString &msg);
95 
96 protected:
97  StatusMessagePrivate *d_ptr;
98 };
99 
100 }
101 
102 #endif // CUTELYST_PLUGIN_STATUSMESSAGE
QMap< QString, QString > ParamsMultiMap
The Cutelyst Context.
Definition: context.h:52
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
The Cutelyst Application.
Definition: application.h:55