QEverCloud  4.0.0
Unofficial Evernote Cloud API for Qt
Public Member Functions | Public Attributes | List of all members
qevercloud::AuthenticationResult Struct Reference

#include <types.h>

Public Member Functions

bool operator== (const AuthenticationResult &other) const
 
bool operator!= (const AuthenticationResult &other) const
 

Public Attributes

Timestamp currentTime
 
QString authenticationToken
 
Timestamp expiration
 
Optional< Useruser
 
Optional< PublicUserInfopublicUserInfo
 
Optional< QString > noteStoreUrl
 
Optional< QString > webApiUrlPrefix
 
Optional< bool > secondFactorRequired
 
Optional< QString > secondFactorDeliveryHint
 
Optional< UserUrlsurls
 

Detailed Description

When an authentication (or re-authentication) is performed, this structure provides the result to the client.

Member Function Documentation

◆ operator!=()

bool qevercloud::AuthenticationResult::operator!= ( const AuthenticationResult other) const
inline

◆ operator==()

bool qevercloud::AuthenticationResult::operator== ( const AuthenticationResult other) const
inline

Member Data Documentation

◆ authenticationToken

QString qevercloud::AuthenticationResult::authenticationToken

Holds an opaque, ASCII-encoded token that can be used by the client to perform actions on a NoteStore.

◆ currentTime

Timestamp qevercloud::AuthenticationResult::currentTime

The server-side date and time when this result was generated.

◆ expiration

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.

◆ noteStoreUrl

Optional< QString > qevercloud::AuthenticationResult::noteStoreUrl

DEPRECATED - Client applications should use urls.noteStoreUrl.

◆ publicUserInfo

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.

◆ secondFactorDeliveryHint

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.

◆ secondFactorRequired

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.

◆ urls

Optional< UserUrls > qevercloud::AuthenticationResult::urls

This structure will contain all of the URLs that clients need to make requests to the Evernote service on behalf of the authenticated User.

◆ user

Optional< User > qevercloud::AuthenticationResult::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.

◆ webApiUrlPrefix

Optional< QString > qevercloud::AuthenticationResult::webApiUrlPrefix

DEPRECATED - Client applications should use urls.webApiUrlPrefix.