Skip to content

OAuthUserTokenInfo Class

  • OAuthUserTokenInfo
  • class Esri::ArcGISRuntime::Authentication::OAuthUserTokenInfo

    The OAuth user token information that can be used by clients, in exchange for user credentials, to access OAuth token-secured ArcGIS content and services. More...

    Header: #include <Authentication/OAuthUserTokenInfo.h>
    Since: Esri::ArcGISRuntime 200.8
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~OAuthUserTokenInfo() override
    QString accessToken() const
    QDateTime expirationDate() const
    bool isSslRequired() const
    QString refreshToken() const
    QDateTime refreshTokenExchangeDate() const
    QDateTime refreshTokenExpirationDate() const
    bool operator!=(Esri::ArcGISRuntime::Authentication::OAuthUserTokenInfo *other) const
    bool operator==(Esri::ArcGISRuntime::Authentication::OAuthUserTokenInfo *other) const

    Detailed Description

    Member Function Documentation

    [override virtual noexcept] OAuthUserTokenInfo::~OAuthUserTokenInfo()

    Destructor.

    QString OAuthUserTokenInfo::accessToken() const

    Returns the access token to be used to make an authenticated request.

    QDateTime OAuthUserTokenInfo::expirationDate() const

    Returns the access token expiration date.

    bool OAuthUserTokenInfo::isSslRequired() const

    Returns a boolean value indicating whether the token must be passed over HTTPS.

    QString OAuthUserTokenInfo::refreshToken() const

    Returns the refresh token to be used to refresh the access token.

    QDateTime OAuthUserTokenInfo::refreshTokenExchangeDate() const

    Returns the date that the refresh token should be exchanged.

    QDateTime OAuthUserTokenInfo::refreshTokenExpirationDate() const

    Returns the date that the refresh token expires.

    This is available only for ArcGIS.com and ArcGIS Enterprise version 10.9.1 and above.

    bool OAuthUserTokenInfo::operator!=(Esri::ArcGISRuntime::Authentication::OAuthUserTokenInfo *other) const

    Tests and returns true if the two OAuthUserTokenInfo objects are not equal.

    • other - The token information to compare to.

    bool OAuthUserTokenInfo::operator==(Esri::ArcGISRuntime::Authentication::OAuthUserTokenInfo *other) const

    Tests and returns true if the two OAuthUserTokenInfo objects are equal.

    • other - The token information to compare to.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.