ExtractPagesRequest¶
ExtractPagesRequest is the page-extraction request, extending PdfRequest with a single DocumentRange identifying the source document and the pages to extract via Extract pages.
Purpose¶
- Carries the single
DocumentRange(document + page selection) that a page-extraction operation should act on.
Context¶
- Namespace:
PdfAPI.Core - Assembly/package:
PdfAPI.Core
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| DocumentRange | DocumentRange DocumentRange { get; set; } |
The document and page selection to extract. |
Inherited public members¶
Members in this section are inherited from PdfRequest in PdfAPI.Core. They are available on this type through inheritance.
| Member | Signature | Purpose | Origin |
|---|---|---|---|
| Id | Guid Id |
Public field identifying this request instance. | PdfAPI.Core — PdfRequest |
| TrackingEnabled | bool TrackingEnabled { get; set; } |
Whether the platform should record tracking metadata for this request. | PdfAPI.Core — PdfRequest |
| PdfConversionType | PdfConversionType PdfConversionType { get; } |
Fixed to Extract for this request type. |
PdfAPI.Core — PdfRequest |
| SourceSystemId | string SourceSystemId { get; set; } |
Caller-supplied identifier correlating this request back to an originating system. | PdfAPI.Core — PdfRequest |
| SendHeatEmailOnFailure | bool SendHeatEmailOnFailure { get; set; } |
Whether a failure-notification email should be sent when this request fails. | PdfAPI.Core — PdfRequest |
| Options | PdfOptions Options { get; set; } |
Output and cleanup options applied to this request. | PdfAPI.Core — PdfRequest |
| SaveOutputPdf | bool SaveOutputPdf { get; set; } (default true) |
Whether the produced output PDF should be persisted. | PdfAPI.Core — PdfRequest |
| TrackingData | PdfTrackingMetadata TrackingData { get; set; } |
Tracking metadata associated with this request. | PdfAPI.Core — PdfRequest |
| Name | [Obsolete] string Name |
Legacy request-name field retained for backward compatibility.* | PdfAPI.Core — PdfRequest |
| RetryIntervalMilliseconds | [Obsolete] int RetryIntervalMilliseconds |
Legacy retry-interval field retained for backward compatibility.* | PdfAPI.Core — PdfRequest |
| RetryCount | [Obsolete] int RetryCount |
Legacy retry-count field retained for backward compatibility.* | PdfAPI.Core — PdfRequest |
Behavioral notes¶
DocumentRangedefaults to all pages when constructed without an explicit page selection. (BR-30)
Constraints and usage notes¶
- Consumers translate this request into a call to
PdfClientService.ExtractPages(DocumentRange).*
Note: Statements marked with
*were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts.
Related documentation¶
- Index
- Overview
- Architecture
- Dependencies
- Operations and processes
- Business rules
- Security and authorization
- API reference
Sources¶
PdfAPI.Core\Request\ExtractPagesRequest.cs