Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
AuthRequest.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
6#include <PhosphorServicePolkit/phosphorservicepolkit_export.h>
7
8#include <QObject>
9#include <QString>
10#include <QStringList>
11#include <QVariantMap>
12
14
15class ListenerImpl;
16class PolkitAgent;
17
32class PHOSPHORSERVICEPOLKIT_EXPORT AuthRequest : public QObject
33{
34 Q_OBJECT
35 Q_PROPERTY(QString actionId READ actionId CONSTANT)
36 Q_PROPERTY(QString message READ message CONSTANT)
37 Q_PROPERTY(QString iconName READ iconName CONSTANT)
38 Q_PROPERTY(QVariantMap details READ details CONSTANT)
39 Q_PROPERTY(QString cookie READ cookie CONSTANT)
40 Q_PROPERTY(QStringList identities READ identities CONSTANT)
42 Q_PROPERTY(QString prompt READ prompt NOTIFY promptChanged)
43 Q_PROPERTY(bool echo READ echo NOTIFY echoChanged)
44
45public:
46 [[nodiscard]] QString actionId() const
47 {
48 return m_actionId;
49 }
50 [[nodiscard]] QString message() const
51 {
52 return m_message;
53 }
54 [[nodiscard]] QString iconName() const
55 {
56 return m_iconName;
57 }
58 [[nodiscard]] QVariantMap details() const
59 {
60 return m_details;
61 }
62
63 [[nodiscard]] QString cookie() const
64 {
65 return m_cookie;
66 }
67
68 [[nodiscard]] QStringList identities() const
69 {
70 return m_identities;
71 }
72
74 [[nodiscard]] int selectedIdentity() const
75 {
76 return m_selectedIdentity;
77 }
78
79 void setSelectedIdentity(int index);
80
84 [[nodiscard]] QString prompt() const
85 {
86 return m_prompt;
87 }
88
89 [[nodiscard]] bool echo() const
90 {
91 return m_echo;
92 }
93
94Q_SIGNALS:
98
99private:
100 Q_DISABLE_COPY_MOVE(AuthRequest)
101 friend class ListenerImpl;
102 friend class PolkitAgent;
103
104 AuthRequest(QString actionId, QString message, QString iconName, QVariantMap details, QString cookie,
105 QStringList identities, QObject* parent);
106
107 QString m_actionId;
108 QString m_message;
109 QString m_iconName;
110 QVariantMap m_details;
111 QString m_cookie;
112 QStringList m_identities;
113 int m_selectedIdentity = 0;
114 QString m_prompt;
115 bool m_echo = false;
116};
117
118} // namespace PhosphorServicePolkit
void setSelectedIdentity(int index)
Out-of-range indices are ignored (the current selection is kept).
QVariantMap details() const
Definition AuthRequest.h:58
friend class ListenerImpl
Definition AuthRequest.h:101
QString message() const
Definition AuthRequest.h:50
int selectedIdentity() const
Index into identities of the identity the user will authenticate as (default 0).
Definition AuthRequest.h:74
QStringList identities() const
Display strings for the identities the user may authenticate as.
Definition AuthRequest.h:68
friend class PolkitAgent
Definition AuthRequest.h:102
bool echo() const
Whether the response to prompt should be echoed (false for passwords).
Definition AuthRequest.h:89
QString actionId() const
Definition AuthRequest.h:46
QString cookie() const
The opaque polkit cookie that ties this request to its authentication.
Definition AuthRequest.h:63
QString iconName() const
Definition AuthRequest.h:54
QString prompt() const
The current PAM prompt to show the user (e.g.
Definition AuthRequest.h:84
A PolicyKit authentication agent for Phosphor-based desktop shells.
Definition PolkitAgent.h:53
Definition AuthRequest.h:13