WebResourceResponseCompat

Kotlin |Java

class WebResourceResponseCompat

Compatibility version of WebResourceResponse. This class can be used as a direct replacement of the framework class.

See also
`WebResourceResponse`

Summary

Public constructors
`WebResourceResponseCompat( mimeType: String, encoding: String?, data: InputStream? )` Constructor matching `WebResourceResponse`
`WebResourceResponseCompat( mimeType: String, encoding: String?, statusCode: Int, reasonPhrase: String, responseHeaders: (Mutable)Map<String!, String!>?, data: InputStream? )` Constructor matching `WebResourceResponse`

Public functions
`(Mutable)List<String!>`	`@RequiresFeature(name = WebViewFeature.COOKIE_INTERCEPT, enforcement = "androidx.webkit" + ".WebViewFeature#isFeatureSupported") getCookies()` Get the list of cookies set by `setCookies` or an empty list.
`InputStream?`	`getData()`
`String?`	`getEncoding()`
`String`	`getMimeType()`
`String?`	`getReasonPhrase()`
`(Mutable)Map<String!, String!>`	`getResponseHeaders()`
`Int`	`getStatusCode()`
`Unit`	`@RequiresFeature(name = WebViewFeature.COOKIE_INTERCEPT, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") setCookies(cookies: (Mutable)List<String!>)` Set the list of `Set-Cookie` header values applicable to this response.
`Unit`	`setData(data: InputStream?)`
`Unit`	`setEncoding(encoding: String?)`
`Unit`	`setMimeType(mimeType: String)`
`Unit`	`setResponseHeaders(headers: (Mutable)Map<String!, String!>)`
`Unit`	`setStatusCodeAndReasonPhrase(statusCode: Int, reasonPhrase: String)`
`WebResourceResponse`	`toWebResourceResponse()` Convert this object to a `WebResourceResponse` that can be used as return value in `shouldInterceptRequest` and `shouldInterceptRequest`.
`java-static WebResourceResponseCompat`	`toWebResourceResponseCompat(response: WebResourceResponse)` Convert a `WebResourceResponse` to the compat version.

Public constructors

WebResourceResponseCompat

Added in 1.15.0-alpha01

WebResourceResponseCompat(
    mimeType: String,
    encoding: String?,
    data: InputStream?
)

Constructor matching WebResourceResponse

WebResourceResponseCompat

Added in 1.15.0-alpha01

WebResourceResponseCompat(
    mimeType: String,
    encoding: String?,
    statusCode: Int,
    reasonPhrase: String,
    responseHeaders: (Mutable)Map<String!, String!>?,
    data: InputStream?
)

Constructor matching WebResourceResponse

Public functions

getCookies

Added in 1.15.0-alpha01

@RequiresFeature(name = WebViewFeature.COOKIE_INTERCEPT, enforcement = "androidx.webkit"
            + ".WebViewFeature#isFeatureSupported")
fun getCookies(): (Mutable)List<String!>

Get the list of cookies set by setCookies or an empty list.

getData

Added in 1.15.0-alpha01

fun getData(): InputStream?

See also
`getData`

getEncoding

Added in 1.15.0-alpha01

fun getEncoding(): String?

See also
`getEncoding`

getMimeType

Added in 1.15.0-alpha01

fun getMimeType(): String

See also
`getMimeType`

getReasonPhrase

Added in 1.15.0-alpha01

fun getReasonPhrase(): String?

See also
`getReasonPhrase`

getResponseHeaders

Added in 1.15.0-alpha01

fun getResponseHeaders(): (Mutable)Map<String!, String!>

See also
`getResponseHeaders`

getStatusCode

Added in 1.15.0-alpha01

fun getStatusCode(): Int

See also
`getStatusCode`

setCookies

Added in 1.15.0-alpha01

@RequiresFeature(name = WebViewFeature.COOKIE_INTERCEPT, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun setCookies(cookies: (Mutable)List<String!>): Unit

Set the list of Set-Cookie header values applicable to this response.

Note that these values will only be used by WebView if isIncludeCookiesOnShouldInterceptRequestEnabled is true, and by service workers if isIncludeCookiesOnShouldInterceptRequestEnabled is true. Otherwise the values will be ignored.

It is safe to use this method even if the map of response headers provided in the constructor or through setResponseHeaders already contains a Set-Cookie value. In such cases, all values will be applied. However, it is recommended to only use this method to supply Set-Cookie header values. A Set-Cookie value in the header map will also only be used according to the restrictions mentioned above.

This method should only be called if isFeatureSupported returns true for COOKIE_INTERCEPT.

Parameters
`cookies: (Mutable)List<String!>`	List of valid `Set-Cookie` header values

setData

Added in 1.15.0-alpha01

fun setData(data: InputStream?): Unit

See also
`setData`

setEncoding

Added in 1.15.0-alpha01

fun setEncoding(encoding: String?): Unit

See also
`setEncoding`

setMimeType

Added in 1.15.0-alpha01

fun setMimeType(mimeType: String): Unit

See also
`setMimeType`

setResponseHeaders

Added in 1.15.0-alpha01

fun setResponseHeaders(headers: (Mutable)Map<String!, String!>): Unit

See also
`setResponseHeaders`

setStatusCodeAndReasonPhrase

Added in 1.15.0-alpha01

fun setStatusCodeAndReasonPhrase(statusCode: Int, reasonPhrase: String): Unit

See also
`setStatusCodeAndReasonPhrase`

toWebResourceResponse

Added in 1.15.0-alpha01

fun toWebResourceResponse(): WebResourceResponse

Convert this object to a WebResourceResponse that can be used as return value in shouldInterceptRequest and shouldInterceptRequest.

The cookie headers set through setCookies will be encoded as part of the getResponseHeaders header map to use by the WebView implementation.

toWebResourceResponseCompat

Added in 1.15.0-alpha01

java-static fun toWebResourceResponseCompat(response: WebResourceResponse): WebResourceResponseCompat

Convert a WebResourceResponse to the compat version.