arcgis-maps-kotlin/com.arcgismaps.httpcore.authentication/NetworkCredentialStore

NetworkCredentialStore

class NetworkCredentialStore : Closeable

Stores credentials of type NetworkCredential for use in network-secured requests.

Since

200.0.0

Constructors

constructor()

Creates an empty NetworkCredentialStore for in-memory credential storage. For persistent credential storage across application sessions see createWithPersistence.

Types

Companion

object Companion

Key

@Serializable

data class Key : JsonSerializable

The key used to look up a NetworkCredential in a NetworkCredentialStore.

StoreChangedEvent

data class StoreChangedEvent

Represents a change in the NetworkCredentialStore.

Properties

credentialStoreChanged

val credentialStoreChanged: SharedFlow<NetworkCredentialStore.StoreChangedEvent>

A SharedFlow which emits StoreChangedEvent when a credential is added, updated or all credentials are removed from the store.

Functions

open override fun close()

getCredentials

suspend fun getCredentials(hostname: String): Result<List<NetworkCredential>>

Retrieves a list of NetworkCredentials from the store, using the provided host name. Multiple NetworkCredentials can be stored for the same hostname, but different NetworkAuthenticationTypes.

removeAll

suspend fun removeAll(): Result<Unit>

Clears all credentials from the NetworkCredentialStore. This function suspends until all credentials have been removed from the store.