PdfRequest

PdfRequest is the base request contract inherited by ConvertRequest, MergeRequest, and ExtractPagesRequest. It carries the identity, tracking, and output-option fields common to every PDF operation exposed by the platform, and several members are marked obsolete, indicating a prior request shape that later requests no longer rely on.*

Purpose

• Establishes the common request identity (Id), tracking configuration, and output options shared by every concrete request type.
• Retains several obsolete members (Name, RetryIntervalMilliseconds, RetryCount) for backward compatibility with older callers.*

Context

• Namespace: PdfAPI.Core
• Assembly/package: PdfAPI.Core

Public members

Member	Signature	Purpose
Id	Guid Id	Public field identifying this request instance.
TrackingEnabled	bool TrackingEnabled { get; set; }	Whether the platform should record tracking metadata for this request.
PdfConversionType	PdfConversionType PdfConversionType { get; }	The kind of operation this request represents (Convert, Merge, or Extract), fixed by the concrete request type.
SourceSystemId	string SourceSystemId { get; set; }	Caller-supplied identifier correlating this request back to an originating system.
SendHeatEmailOnFailure	bool SendHeatEmailOnFailure { get; set; }	Whether a failure-notification email should be sent when this request fails.
Options	PdfOptions Options { get; set; }	Output and cleanup options applied to this request.
SaveOutputPdf	bool SaveOutputPdf { get; set; } (default true)	Whether the produced output PDF should be persisted.
TrackingData	PdfTrackingMetadata TrackingData { get; set; }	Tracking metadata associated with this request.
Name	[Obsolete] string Name	Legacy request-name field retained for backward compatibility.*
RetryIntervalMilliseconds	[Obsolete] int RetryIntervalMilliseconds	Legacy retry-interval field retained for backward compatibility.*
RetryCount	[Obsolete] int RetryCount	Legacy retry-count field retained for backward compatibility.*

Behavioral notes

• PdfConversionType is read-only on the base type and is fixed by each concrete subclass, so callers cannot retarget a request's operation kind after construction.*

Constraints and usage notes

• Prefer the concrete request types (ConvertRequest, MergeRequest, ExtractPagesRequest) over instantiating behavior directly against PdfRequest.

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\PdfRequest.cs