Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeDocumentWebReader

Namespace OfficeIMO.Reader.Web
Assembly OfficeIMO.Reader.Web
Modifiers sealed

Bounded, thread-safe HTTP transport over a caller-configured OfficeDocumentReader.

Inheritance

  • Object
  • OfficeDocumentWebReader

Remarks

The caller owns the Reader and HttpClient lifetimes. This type does not mutate or dispose either. URI validation provides defense in depth for schemes, allowlists, credentials, and non-public IP literals; it is not an SSRF isolation boundary. When reading an untrusted URI, configure the caller-owned HTTP handler to validate resolved addresses at connection time and validate each redirect before sending it.

Usage

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

Constructors

public OfficeDocumentWebReader(OfficeDocumentReader reader, HttpClient httpClient, ReaderWebOptions options = null) #

Creates a bounded web reader over existing Reader and HTTP client instances.

Parameters

reader OfficeIMO.Reader.OfficeDocumentReader requiredposition: 0
httpClient System.Net.Http.HttpClient requiredposition: 1
options OfficeIMO.Reader.Web.ReaderWebOptions = null optionalposition: 2

Methods

public async Task<String> ConvertToMarkdownAsync(Uri uri, String sourceName = null, ReaderOptions readerOptions = null, CancellationToken cancellationToken = default) #
Returns: Task<String>

Downloads one bounded HTTP(S) response and returns the Markdown emitted by the same rich Reader pipeline.

Parameters

uri System.Uri requiredposition: 0
sourceName System.String = null optionalposition: 1
readerOptions OfficeIMO.Reader.ReaderOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public async Task<OfficeDocumentReadResult> ReadDocumentAsync(Uri uri, String sourceName = null, ReaderOptions readerOptions = null, CancellationToken cancellationToken = default) #
Returns: Task<OfficeDocumentReadResult>

Downloads one bounded HTTP(S) response and routes its body through the configured Reader instance.

Parameters

uri System.Uri requiredposition: 0
sourceName System.String = null optionalposition: 1
readerOptions OfficeIMO.Reader.ReaderOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3