PdfStatus¶
PdfStatus is the lifecycle status of a tracked PDF operation, assigned to PdfResult.Status according to which PdfResult constructor is used and carried on PdfTrackingInfo. (BR-45)
Purpose¶
- Represents where a tracked PDF operation stands in its lifecycle, from not yet tracked through terminal success or failure states.
Context¶
- Namespace:
PdfAPI.Core - Assembly/package:
PdfAPI.Core
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| NotTracked | PdfStatus.NotTracked |
The operation is not being tracked. |
| Failed | PdfStatus.Failed |
The operation failed. |
| Scheduled | PdfStatus.Scheduled |
The operation is scheduled but not yet started. |
| Succeeded | PdfStatus.Succeeded |
The operation completed successfully. (BR-45) |
| Aborted | PdfStatus.Aborted |
The operation was aborted before completion. |
| Cancelled | PdfStatus.Cancelled |
The operation was cancelled. |
| Processing | PdfStatus.Processing |
The operation is currently in progress. |
Behavioral notes¶
PdfResult's success constructor setsStatustoSucceeded; its failure constructor sets a failure-oriented status; the specific constructor invoked determines which value is assigned. (BR-45)
Constraints and usage notes¶
- None beyond selecting the constructor or value appropriate to the operation's actual outcome.
Related documentation¶
- Index
- Overview
- Architecture
- Dependencies
- Operations and processes
- Business rules
- Security and authorization
- API reference
Sources¶
PdfAPI.Core\PdfStatus.cs