# CustomHeader

Artifact: [androidx.webkit:webkit](https://developer.android.com/jetpack/androidx/releases/webkit) [View Source](https://cs.android.com/search?q=file:androidx/webkit/CustomHeader.java+class:androidx.webkit.CustomHeader) Added in [1.15.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.15.0)

*** ** * ** ***


```
public class CustomHeader
```

<br />

*** ** * ** ***

An HTTP header name-value pair that will be sent on requests to origins that match the given origin rules.

For document-initiated requests, custom headers take effect on document load. See `https://developer.android.com/reference/androidx/webkit/Profile#addCustomHeader(androidx.webkit.CustomHeader)` for details.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/webkit/Profile#addCustomHeader(androidx.webkit.CustomHeader)` |   |
| `https://developer.android.com/reference/androidx/webkit/Profile#getCustomHeaders()` |   |

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/webkit/CustomHeader#CustomHeader(java.lang.String,java.lang.String,java.util.Set<java.lang.String>)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html name, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html value, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Set.html<https://developer.android.com/reference/java/lang/String.html> originRules )` Create a new custom header for the given name and value, to be added to requests that match the given origin originRules |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/webkit/CustomHeader#equals(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html obj)` Two instances of `https://developer.android.com/reference/androidx/webkit/CustomHeader` are equal if the header name and value, and rule set are equal. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/webkit/CustomHeader#getName()()` HTTP Header name |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Set.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/webkit/CustomHeader#getRules()()` Origin patterns where this header is being sent. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/webkit/CustomHeader#getValue()()` HTTP Header value |
| `int` | `https://developer.android.com/reference/androidx/webkit/CustomHeader#hashCode()()` HashCode for `https://developer.android.com/reference/androidx/webkit/CustomHeader` is derived from the individual fields.- |

## Public constructors

### CustomHeader

Added in [1.15.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.15.0)

```
public CustomHeader(
    @NonNull String name,
    @NonNull String value,
    @NonNull Set<String> originRules
)
```

Create a new custom header for the given name and value, to be added to requests that match the given origin originRules

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html name` | A [valid HTTP header name string](https://datatracker.ietf.org/doc/html/rfc7230#section-3.2) |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html value` | A [valid HTTP value name string](https://datatracker.ietf.org/doc/html/rfc7230#section-3.2) |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Set.html<https://developer.android.com/reference/java/lang/String.html> originRules` | a set of origin originRules following the same format as `https://developer.android.com/reference/androidx/webkit/WebViewCompat#addWebMessageListener(android.webkit.WebView,java.lang.String,java.util.Set<java.lang.String>,androidx.webkit.WebViewCompat.WebMessageListener)` |

## Public methods

### equals

```
public boolean equals(@Nullable Object obj)
```

Two instances of `https://developer.android.com/reference/androidx/webkit/CustomHeader` are equal if the header name and value, and rule set are equal.

### getName

Added in [1.15.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.15.0)

```
public @NonNull String getName()
```

HTTP Header name

### getRules

Added in [1.15.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.15.0)

```
public @NonNull Set<String> getRules()
```

Origin patterns where this header is being sent.

The rules use the format described in the documentation for `https://developer.android.com/reference/androidx/webkit/WebViewCompat#addWebMessageListener(android.webkit.WebView,java.lang.String,java.util.Set<java.lang.String>,androidx.webkit.WebViewCompat.WebMessageListener)`.

### getValue

Added in [1.15.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.15.0)

```
public @NonNull String getValue()
```

HTTP Header value

### hashCode

```
public int hashCode()
```

HashCode for `https://developer.android.com/reference/androidx/webkit/CustomHeader` is derived from the individual fields.-