TekH
189622c476
Renamed methods across multiple client classes for consistency, shortening and aligning naming conventions (e.g., `CheckAttachmentsAsync` → `CheckAsync`, `ValidatePdfAsync` → `ValidateAsync`). Updated corresponding interfaces, unit tests, and documentation to reflect the new method names. Standardized method signatures to support both `Stream` and `byte[]` overloads consistently. Improved error handling in tests and updated examples in the README for batch processing and validation scenarios. Enhanced API endpoint overview for clarity.
50 lines
2.2 KiB
C#
50 lines
2.2 KiB
C#
namespace DocumentService.Client.Interfaces;
|
|
|
|
/// <summary>
|
|
/// Client for PDF conversion operations (PDF ? PDF/A).
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// All methods on this interface are marked obsolete because the corresponding
|
|
/// API endpoints are not yet implemented.
|
|
/// </remarks>
|
|
public interface IPdfConversionClient
|
|
{
|
|
/// <summary>
|
|
/// Converts a standard PDF to PDF/A format (multipart).
|
|
/// </summary>
|
|
/// <param name="pdfStream">Source PDF stream</param>
|
|
/// <param name="pdfALevel">Target PDF/A level (e.g., "PDF/A-3b")</param>
|
|
/// <param name="cancellationToken">Cancellation token</param>
|
|
/// <returns>PDF/A document as stream</returns>
|
|
[Obsolete("API endpoint not implemented yet")]
|
|
Task<Stream> ToPdfAAsync(Stream pdfStream, string pdfALevel = "PDF/A-3b", CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Converts a standard PDF to PDF/A format (Base64).
|
|
/// </summary>
|
|
/// <param name="pdfBytes">Source PDF as byte array</param>
|
|
/// <param name="pdfALevel">Target PDF/A level (e.g., "PDF/A-3b")</param>
|
|
/// <param name="cancellationToken">Cancellation token</param>
|
|
/// <returns>PDF/A document as stream</returns>
|
|
[Obsolete("API endpoint not implemented yet")]
|
|
Task<Stream> ToPdfAAsync(byte[] pdfBytes, string pdfALevel = "PDF/A-3b", CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Converts a PDF/A document to standard PDF (multipart).
|
|
/// </summary>
|
|
/// <param name="pdfStream">Source PDF/A stream</param>
|
|
/// <param name="cancellationToken">Cancellation token</param>
|
|
/// <returns>Standard PDF as stream</returns>
|
|
[Obsolete("API endpoint not implemented yet")]
|
|
Task<Stream> FromPdfAAsync(Stream pdfStream, CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Converts a PDF/A document to standard PDF (Base64).
|
|
/// </summary>
|
|
/// <param name="pdfBytes">Source PDF/A as byte array</param>
|
|
/// <param name="cancellationToken">Cancellation token</param>
|
|
/// <returns>Standard PDF as stream</returns>
|
|
[Obsolete("API endpoint not implemented yet")]
|
|
Task<Stream> FromPdfAAsync(byte[] pdfBytes, CancellationToken cancellationToken = default);
|
|
}
|