Sailfish Secrets
API DocumentationInteractionResponse Class
(Sailfish::Secrets::InteractionResponse)Encapsulates a user-input response from an authentication plugin More...
| Header: | #include <Secrets/interactionresponse.h> |
Properties
- responseData : QByteArray
- result : Sailfish::Secrets::Result
Public Functions
| InteractionResponse() | |
| InteractionResponse(const InteractionResponse &other) | |
| ~InteractionResponse() | |
| QByteArray | responseData() const |
| Sailfish::Secrets::Result | result() const |
| void | setResponseData(const QByteArray &data) |
| void | setResult(const Sailfish::Secrets::Result &result) |
| InteractionResponse & | operator=(const InteractionResponse &other) |
Detailed Description
Encapsulates a user-input response from an authentication plugin
Whenever an authentication (verifying the identity of the user) or input (requesting data or confirmation from the user) request is processed by an authentication plugin, the response will be encapsulated in an instance of this type.
Note that client applications should never have to use this type, as only authentication plugin implementations return instances of this type, and such responses are consumed by the secrets service.
Property Documentation
responseData : QByteArray
Access functions:
| QByteArray | responseData() const |
| void | setResponseData(const QByteArray &data) |
result : Sailfish::Secrets::Result
Access functions:
| Sailfish::Secrets::Result | result() const |
| void | setResult(const Sailfish::Secrets::Result &result) |
Member Function Documentation
InteractionResponse::InteractionResponse()
Constructs a new InteractionResponse instance
InteractionResponse::InteractionResponse(const InteractionResponse &other)
Constructs a copy of the other InteractionResponse instance
InteractionResponse::~InteractionResponse()
Destroys the InteractionResponse instance
QByteArray InteractionResponse::responseData() const
Returns the data which was retrieved from the user
Note: Getter function for property responseData.
See also setResponseData().
Sailfish::Secrets::Result InteractionResponse::result() const
Returns the result of the request
Note: Getter function for property result.
See also setResult().
void InteractionResponse::setResponseData(const QByteArray &data)
Sets the data which was retrieved from the user to data
Note: Setter function for property responseData.
See also responseData().
InteractionResponse &InteractionResponse::operator=(const InteractionResponse &other)
Assigns this InteractionResponse to be equal to the other