ArcGISCredential

Namespace: Esri::GameEngine::Authentication
Class: Esri/GameEngine/Authentication/ArcGISCredential
Since: 1.1.0

Summary

A base class for types of ArcGIS credentials used to access secured resources.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

The referer used to generate a token.

No
Yes

The URL by which the root of a server is accessed.

No
Yes

The user associated with the credential.

Referer

FString GetReferer() const

The referer used to generate a token.

  • TokenCredential - The referer is app://arcgis-maps/<application identifier>.
  • PregeneratedTokenCredential - The referer passed to the constructor should match the referer used to generate the token, or empty string if none was used.
  • ArcGISOAuthUserCredential and OAuthApplicationCredential - The referer is an empty string.

ServerContext

FString GetServerContext() const

The URL by which the root of a server is accessed.

This is the URL against which rest endpoints are resolved. For example, "https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer/0" would have a server context of "https://sampleserver3.arcgisonline.com/ArcGIS", on which we could add "/rest/info" or "/rest" to fetch the server information.

Username

FString GetUsername() const

The user associated with the credential.

Methods

SignatureReturn TypeSummary

Equals(const ArcGISCredential&)

bool

Tests if the two ArcGISCredential objects are equal.

Equals

bool Equals(const ArcGISCredential& other) const

Tests if the two ArcGISCredential objects are equal.

Since 1.1.0

Arguments
NameTypeConstSummary
other
Yes

The credential to compare to.

Returns bool

True if the comparison succeeds and the objects are equal, false otherwise.

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