Skip to content

//okhttp/okhttp3/Challenge

Challenge

[common]\ expect class Challenge(scheme: String, authParams: Map<String?, String>)

An RFC 7235 challenge.

[jvm, nonJvm]\ actual class Challenge(val scheme: String, authParams: Map<String?, String>)

Constructors

Challenge [common]
expect fun Challenge(scheme: String, realm: String)
[jvm, nonJvm]
actual fun Challenge(scheme: String, realm: String)
Challenge [common]
expect fun Challenge(scheme: String, authParams: Map<String?, String>)
[jvm, nonJvm]
actual fun Challenge(scheme: String, authParams: Map<String?, String>)

Functions

Name Summary
equals [common, jvm, nonJvm]
[common]
expect open operator override fun equals(other: Any?): Boolean
[jvm, nonJvm]
actual open operator override fun equals(other: Any?): Boolean
hashCode [common, jvm, nonJvm]
[common]
expect open override fun hashCode(): Int
[jvm, nonJvm]
actual open override fun hashCode(): Int
toString [common, jvm, nonJvm]
[common]
expect open override fun toString(): String
[jvm, nonJvm]
actual open override fun toString(): String
withCharset [jvm]
fun withCharset(charset: Charset): Challenge
Returns a copy of this charset that expects a credential encoded with charset.

Properties

Name Summary
authParams [common]
expect val authParams: Map<String?, String>
Returns the auth params, including realm and charset if present, but as strings. The map’s keys are lowercase and should be treated case-insensitively.
[jvm]
@get:JvmName(name = "authParams")
actual val authParams: Map<String?, String>
[nonJvm]
actual val authParams: Map<String?, String>
charset [jvm]
@get:JvmName(name = "charset")
val charset: Charset
The charset that should be used to encode the credentials.
realm [common]
expect val realm: String?
Returns the protection space.
[jvm]
@get:JvmName(name = "realm")
actual val realm: String?
[nonJvm]
actual val realm: String?
scheme [common]
expect val scheme: String
Returns the authentication scheme, like Basic.
[jvm]
@get:JvmName(name = "scheme")
actual val scheme: String
[nonJvm]
actual val scheme: String