Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ReaderWebOptions

OfficeIMO.Reader.Web

Namespace
OfficeIMO.Reader.Web
Assembly
OfficeIMO.Reader.Web
Source revision
ba882f6b0d07 with working tree changes
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

Constructors

public ReaderWebOptions() #

Properties

public long MaxResponseBytes { get; set; } #

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

public TimeSpan RequestTimeout { get; set; } #

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

public int MaxConcurrentRequests { get; set; } #

Gets or sets the maximum concurrent web read operations on one OfficeDocumentWebReader. Default: 4.

public IReadOnlyList<string> AllowedHosts { get; set; } #

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; } #

Gets or sets whether subdomains of entries in ReaderWebOptions.AllowedHosts are permitted.

public bool AllowPrivateNetworkAddresses { get; set; } #

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; } #

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; } #

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 #

Default maximum downloaded response size: 64 MiB.

Value: 67108864
public const long MaximumResponseBytes #

Maximum supported response bound: 1 GiB.

Value: 1073741824