# ReaderWebOptions

Controls bounded HTTP retrieval before content enters an existing Reader pipeline.

Class 

`OfficeIMO.Reader.Web`

**Namespace**

`OfficeIMO.Reader.Web`

**Assembly**

`OfficeIMO.Reader.Web`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ReaderWebOptions.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L12)

**Modifiers**

sealed

Controls bounded HTTP retrieval before content enters an existing Reader pipeline.

## Inheritance

- object
- ReaderWebOptions

## Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Accepted by parameters 2

- Method [OfficeDocumentReaderWebExtensions.CreateWebReader](/api/reader-web/officeimo-reader-web-officedocumentreaderwebextensions/#method-createwebreader-officeimo-reader-officedocumentreader-officeimo-reader-web-readerweboptions) parameter `options`
- Constructor [OfficeDocumentWebReader.OfficeDocumentWebReader](/api/reader-web/officeimo-reader-web-officedocumentwebreader/#constructor-ctor-officeimo-reader-officedocumentreader-officeimo-reader-web-readerweboptions) parameter `options`

Filter members 

Show inherited

## Constructors

`public ReaderWebOptions()` [#](#constructor-ctor)

[ReaderWebOptions.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L12)

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public long MaxResponseBytes { get; set; }` [#](#property-maxresponsebytes)

[ReaderWebOptions.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L12)

Gets or sets the maximum downloaded response bytes. Default: 64 MiB.

`public TimeSpan RequestTimeout { get; set; }` [#](#property-requesttimeout)

[ReaderWebOptions.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L15)

Gets or sets the timeout covering response headers and body download. Default: two minutes.

`public int MaxConcurrentRequests { get; set; }` [#](#property-maxconcurrentrequests)

[ReaderWebOptions.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L21)

Gets or sets the maximum concurrent web read operations on one [OfficeDocumentWebReader](/api/reader-web/officeimo-reader-web-officedocumentwebreader/). Default: 4.

`public IReadOnlyList<string> AllowedHosts { get; set; }` [#](#property-allowedhosts)

[ReaderWebOptions.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L27)

Gets or sets an optional exact host allowlist. An empty list permits any host that passes the scheme and network address checks.

`public bool AllowSubdomains { get; set; }` [#](#property-allowsubdomains)

[ReaderWebOptions.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L30)

Gets or sets whether subdomains of entries in [ReaderWebOptions.AllowedHosts](/api/reader-web/officeimo-reader-web-readerweboptions/) are permitted.

`public bool AllowPrivateNetworkAddresses { get; set; }` [#](#property-allowprivatenetworkaddresses)

[ReaderWebOptions.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L42)

Gets or sets whether loopback, private, link-local and other non-public network addresses may be read. Default: false. Enable it only for trusted internal sources.

`public bool IncludeQueryInMetadata { get; set; }` [#](#property-includequeryinmetadata)

[ReaderWebOptions.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L48)

Gets or sets whether query strings are retained in transport metadata. Default: false. Keep disabled when URLs may contain signed tokens or other secrets.

`public Func<Uri, string>? SourceKeySelector { get; set; }` [#](#property-sourcekeyselector)

[ReaderWebOptions.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L56)

Optional stable identity key for the final response URI. By default the complete URI, including its query, identifies the resource. Supply a canonical key for signed URLs whose changing query credentials refer to the same document. Keys are hashed, not emitted. The delegate must be thread-safe when the web reader is used concurrently.

## Fields

`public const long DefaultMaxResponseBytes` [#](#field-defaultmaxresponsebytes)

[ReaderWebOptions.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L6)

Default maximum downloaded response size: 64 MiB.

Value: `67108864`

`public const long MaximumResponseBytes` [#](#field-maximumresponsebytes)

[ReaderWebOptions.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Web/ReaderWebOptions.cs#L9)

Maximum supported response bound: 1 GiB.

Value: `1073741824`

<!-- PowerForge markdown artifact sha256:CCE9D6B8925BCE16818A0D3CC9726ADC983FFD455D11EAD0239088EB7FC26E62 -->
