Namespace: GameEngine.Authentication
Class: GameEngine/Authentication/ArcGISCredentialStore
Since: 1.1.0
Summary
A store for instances of the subclasses of ArcGISCredential.
Constructors
Methods
Signature | Return Type | Summary |
---|---|---|
Adds the specified credential to the ArcGISCredentialStore. The credential's server context is used to determine what services the credential can be shared with. | ||
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 ArcGISErrorType.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. | ||
Returns the best matched credential in the ArcGISCredentialStore for the given URL. | ||
ArcGISImmutableArray<ArcGISCredential> | Returns an array of unique credentials contained in the ArcGISCredentialStore. | |
Removes the credential from ArcGISCredentialStore if present. | ||
Removes all credentials from the ArcGISCredentialStore. | ||
ArcGISImmutableArray<ArcGISCredential> | Removes any credentials from the ArcGISCredentialStore that would be shared with a service endpoint represented by the provided URL. |
Add
void Add(ArcGISCredential arcGISCredential)
Adds the specified credential to the ArcGISCredentialStore. The credential's server context is used to determine what services the credential can be shared with.
Since 1.1.0
Arguments
Name | Type | Summary |
---|---|---|
arc | ArcGISCredential | The credential to be stored within ArcGISCredentialStore. |
Returns void
Add
void Add(ArcGISCredential arcGISCredential, string URL)
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 ArcGISErrorType.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.
Since 1.1.0
Arguments
Name | Type | Summary |
---|---|---|
arc | ArcGISCredential | The credential to be stored within ArcGISCredentialStore. |
URL | string | The URL to associate the credential with. |
Returns void
GetCredential
ArcGISCredential GetCredential(string URL)
Returns the best matched credential in the ArcGISCredentialStore for the given URL.
Since 1.1.0
Arguments
Name | Type | Summary |
---|---|---|
URL | string | The URL of an ArcGIS secured resource. |
Returns ArcGISCredential
An ArcGISCredential in the ArcGISCredentialStore that best matches the given URL.
GetCredentials
ArcGISImmutableArray<ArcGISCredential> GetCredentials()
Returns an array of unique credentials contained in the ArcGISCredentialStore.
Since 1.2.0
Returns ArcGISImmutableArray<ArcGISCredential>
Every ArcGISCredential within the ArcGISCredentialStore.
Remove
bool Remove(ArcGISCredential arcGISCredential)
Removes the credential from ArcGISCredentialStore if present.
Since 1.1.0
Arguments
Name | Type | Summary |
---|---|---|
arc | ArcGISCredential | The credential to be removed from ArcGISCredentialStore. |
Returns bool
True if the credential was found and removed from the store, otherwise false.
RemoveAll
void RemoveAll()
Removes all credentials from the ArcGISCredentialStore.
Since 1.1.0
Returns void
RemoveCredentials
ArcGISImmutableArray<ArcGISCredential> RemoveCredentials(string URL)
Removes any credentials from the ArcGISCredentialStore that would be shared with a service endpoint represented by the provided URL.
Since 1.1.0
Arguments
Name | Type | Summary |
---|---|---|
URL | string | The URL to search for and remove credentials from the store. |
Returns ArcGISImmutableArray<ArcGISCredential>
An array of credentials that were removed.