Sailfish Secrets
API DocumentationInteractionView Class
(Sailfish::Secrets::InteractionView)Interface for implementing in-app authentication More...
Header: | #include <Secrets/interactionview.h> |
Public Functions
InteractionView() | |
InteractionView(const InteractionView &other) | |
virtual | ~InteractionView() |
Protected Functions
virtual void | cancelRequest() = 0 |
virtual void | continueRequest(const Sailfish::Secrets::InteractionParameters &request) = 0 |
virtual void | finishRequest() = 0 |
virtual void | performRequest(const Sailfish::Secrets::InteractionParameters &request) = 0 |
void | registerWithSecretManager(SecretManager *manager) |
SecretManager * | registeredWithSecretManager() const |
void | sendResponse(const Sailfish::Secrets::InteractionResponse &response) |
Detailed Description
Interface for implementing in-app authentication
If a client application wishes to use in-app authentication, they must instantiate an InteractionView and register it via a SecretManager.
Subsequent flows which specify in-app interaction will be routed to the application's InteractionView.
Note: A concrete implementation of InteractionView is provided as ApplicationInteractionView
in the Sailfish.Secrets
QML import.
Member Function Documentation
InteractionView::InteractionView()
Constructs a new InteractionView instance
InteractionView::InteractionView(const InteractionView &other)
Constructs a copy of the other InteractionView instance
[virtual]
InteractionView::~InteractionView()
Destroys the interaction view
[pure virtual protected]
void InteractionView::cancelRequest()
[pure virtual protected]
void InteractionView::continueRequest(const Sailfish::Secrets::InteractionParameters &request)
[pure virtual protected]
void InteractionView::finishRequest()
[pure virtual protected]
void InteractionView::performRequest(const Sailfish::Secrets::InteractionParameters &request)
[protected]
void InteractionView::registerWithSecretManager(SecretManager *manager)
Register this view as the in-app interaction view to service in-app authentication flows with the manager.
[protected]
SecretManager *InteractionView::registeredWithSecretManager() const
Returns a pointer to the SecretManager that this InteractionView was registered with.