QEverCloud
6.1.0
Unofficial Evernote Cloud API for Qt
|
#include <Types.h>
Public Member Functions | |
virtual void | print (QTextStream &strm) const override |
bool | operator== (const AuthenticationResult &other) const |
bool | operator!= (const AuthenticationResult &other) const |
![]() | |
Printable ()=default | |
virtual | ~Printable ()=default |
virtual QString | toString () const |
Public Attributes | |
EverCloudLocalData | localData |
Timestamp | currentTime |
QString | authenticationToken |
Timestamp | expiration |
Optional< User > | user |
Optional< PublicUserInfo > | publicUserInfo |
Optional< QString > | noteStoreUrl |
Optional< QString > | webApiUrlPrefix |
Optional< bool > | secondFactorRequired |
Optional< QString > | secondFactorDeliveryHint |
Optional< UserUrls > | urls |
When an authentication (or re-authentication) is performed, this structure provides the result to the client.
|
inline |
|
inline |
|
overridevirtual |
Implements qevercloud::Printable.
QString qevercloud::AuthenticationResult::authenticationToken |
Holds an opaque, ASCII-encoded token that can be used by the client to perform actions on a NoteStore.
Timestamp qevercloud::AuthenticationResult::currentTime |
The server-side date and time when this result was generated.
Timestamp qevercloud::AuthenticationResult::expiration |
Holds the server-side date and time when the authentication token will expire. This time can be compared to "currentTime" to produce an expiration time that can be reconciled with the client's local clock.
EverCloudLocalData qevercloud::AuthenticationResult::localData |
See the declaration of EverCloudLocalData for details
Optional< QString > qevercloud::AuthenticationResult::noteStoreUrl |
DEPRECATED - Client applications should use urls.noteStoreUrl.
Optional< PublicUserInfo > qevercloud::AuthenticationResult::publicUserInfo |
If this authentication result was achieved without full permissions to access the full User structure, this field may be set to give back a more limited public set of data.
Optional< QString > qevercloud::AuthenticationResult::secondFactorDeliveryHint |
When secondFactorRequired is set to true, this field may contain a string describing the second factor delivery method that the user has configured. This will typically be an obfuscated mobile device number, such as "(xxx) xxx-x095". This string can be displayed to the user to remind them how to obtain the required second factor.
Optional< bool > qevercloud::AuthenticationResult::secondFactorRequired |
If set to true, this field indicates that the user has enabled two-factor authentication and must enter their second factor in order to complete authentication. In this case the value of authenticationResult will be a short-lived authentication token that may only be used to make a subsequent call to completeTwoFactorAuthentication.
This structure will contain all of the URLs that clients need to make requests to the Evernote service on behalf of the authenticated User.
Holds the information about the account which was authenticated if this was a full authentication. May be absent if this particular authentication did not require user information.
Optional< QString > qevercloud::AuthenticationResult::webApiUrlPrefix |
DEPRECATED - Client applications should use urls.webApiUrlPrefix.