ArcGISCredentialStore class final
A store for instances of the subclasses of ArcGISCredential.
The credential provided while handling an authentication challenge is placed in the ArcGIS credential store of the ArcGISEnvironment.authenticationManager and used by all subsequent requests that have a matching server context.
- Implemented types
Constructors
- ArcGISCredentialStore()
-
Creates an instance of an ArcGISCredentialStore.
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
add(
{required ArcGISCredential credential}) → void - Adds the specified credential to the ArcGISCredentialStore. The credential's server context is used to determine what services the credential can be shared with.
-
addForUri(
{required ArcGISCredential credential, required Uri uri}) → void - Adds a specified credential to the store for a given URL. The URL must be shareable with the server context of the credential. Otherwise, this method throws an ArcGISExceptionType.authenticationCredentialCannotBeShared. When the credential is added to the store with this function, for the credential to be shared with a secured service endpoint, the service endpoint must begin with the specified URL passed to this function call. For example, if you were to specify a store URL of https://www.server.net/arcgis/rest/services/service1/ when calling this function, then the specified credential would be shared with an endpoint such as https://www.server.net/arcgis/rest/services/service1/query, but not for https://www.server.net/arcgis/rest/services/service2/query.
-
getCredential(
{required Uri uri}) → ArcGISCredential? - Returns the best matched credential in the ArcGISCredentialStore for the given URL.
-
getCredentials(
) → List< ArcGISCredential> - Returns an array of unique credentials contained in the ArcGISCredentialStore.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
remove(
{required ArcGISCredential credential}) → bool - Removes the credential from ArcGISCredentialStore if present.
-
removeAll(
) → void - Removes all credentials from the ArcGISCredentialStore.
-
removeCredentials(
{required Uri uri}) → List< ArcGISCredential> - Removes any credentials from the ArcGISCredentialStore that would be shared with a service endpoint represented by the provided URL.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited