cutelyst 3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
authenticationuser.h
1/*
2 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5#ifndef AUTHENTICATIONUSER_H
6#define AUTHENTICATIONUSER_H
7
8#include <Cutelyst/cutelyst_global.h>
9#include <Cutelyst/paramsmultimap.h>
10#include <Cutelyst/plugin.h>
11
12#include <QDataStream>
13#include <QVariantMap>
14
15namespace Cutelyst {
16
18class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT AuthenticationUser
19{
20 Q_GADGET
21public:
26
31 virtual ~AuthenticationUser();
32
36 QVariant id() const;
37
41 void setId(const QVariant &id);
42
46 bool isNull() const;
47
52
56 void setAuthRealm(const QString &authRealm);
57
58 inline QVariantMap data() const;
59
60 inline void setData(const QVariantMap &data);
61
62 inline void insert(const QString &key, const QVariant &value);
63
64 inline QVariant value(const QString &key, const QVariant &defaultValue = QVariant()) const;
65
66 inline operator QVariant() const { return QVariant::fromValue(m_data); }
67
68protected:
69 QVariantMap m_data;
70};
71
72QVariantMap AuthenticationUser::data() const
73{
74 return m_data;
75}
76
77void AuthenticationUser::setData(const QVariantMap &data)
78{
79 m_data = data;
80}
81
82void AuthenticationUser::insert(const QString &key, const QVariant &value)
83{
84 m_data.insert(key, value);
85}
86
87QVariant AuthenticationUser::value(const QString &key, const QVariant &defaultValue) const
88{
89 return m_data.value(key, defaultValue);
90}
91
92} // namespace Cutelyst
93
94Q_DECLARE_METATYPE(Cutelyst::AuthenticationUser)
95QDataStream &operator<<(QDataStream &out, const Cutelyst::AuthenticationUser &myObj);
97
98QDebug CUTELYST_PLUGIN_AUTHENTICATION_EXPORT operator<<(QDebug dbg,
100
101#endif // AUTHENTICATIONUSER_H
QString authRealm()
Returns the authentication realm from which this user was retrieved.
AuthenticationUser()
Constructs a new AuthenticationUser object.
void setAuthRealm(const QString &authRealm)
Sets the authentication realm from which this user was retrieved.
bool isNull() const
Returns true if the object is null.
void setId(const QVariant &id)
Sets the unique user id restored from the store.
The Cutelyst namespace holds all public Cutelyst API.
Definition Mainpage.dox:8
QVariant fromValue(const T &value)