AurorisNet.Pressroom.Client
1.1.2
See the version list below for details.
dotnet add package AurorisNet.Pressroom.Client --version 1.1.2
NuGet\Install-Package AurorisNet.Pressroom.Client -Version 1.1.2
<PackageReference Include="AurorisNet.Pressroom.Client" Version="1.1.2" />
<PackageVersion Include="AurorisNet.Pressroom.Client" Version="1.1.2" />
<PackageReference Include="AurorisNet.Pressroom.Client" />
paket add AurorisNet.Pressroom.Client --version 1.1.2
#r "nuget: AurorisNet.Pressroom.Client, 1.1.2"
#:package AurorisNet.Pressroom.Client@1.1.2
#addin nuget:?package=AurorisNet.Pressroom.Client&version=1.1.2
#tool nuget:?package=AurorisNet.Pressroom.Client&version=1.1.2
AurorisNet.Pressroom.Client
Pressroom is a self-hosted HTML-to-PDF service for Windows, IIS, Linux, and containers. Send a complete HTML document to its HTTP API to receive a PDF or submit it to a configured Windows or Linux printer.
This package is the .NET client for Pressroom. It lets .NET 8 and .NET 10
applications call a running Pressroom server. It includes the Pressroom.Client
and Pressroom.Contracts assemblies, with no browser dependencies. It does not
include the server or render PDFs locally.
Looking for the server? Visit the Pressroom GitHub repository for the full project and deployment guides, or download a server release. The repository covers Windows/IIS, Linux, and container deployments. Set up a server before using this client; the getting started guide walks through configuration and your first render.
Installation
For versions published to NuGet.org:
dotnet add package AurorisNet.Pressroom.Client --version <version>
For builds distributed through GitHub, download and extract nuget-packages from
the Packages workflow, or download AurorisNet.Pressroom.Client.<version>.nupkg
from a release into a local feed directory. Add --source ./packages to the
command above. A separate Contracts package is not needed. When migrating from
the old packages, remove the Pressroom.Client and Pressroom.Contracts package
references; the C# namespaces stay the same.
Usage
Use your server's URL and API key in your application:
using Pressroom.Client;
using Pressroom.Contracts;
using var http = new HttpClient { BaseAddress = new Uri("https://pressroom.example/") };
http.DefaultRequestHeaders.Add("X-Api-Key", apiKey);
var pressroom = new PressroomClient(http);
var pdf = await pressroom.RenderAsync(new RenderRequest
{
Html = "<!doctype html><html><body><h1>Hello</h1></body></html>",
FileName = "hello.pdf"
});
await File.WriteAllBytesAsync(pdf.FileName, pdf.Bytes);
Reuse a caller-owned HttpClient or register a typed client with AddHttpClient.
RenderStreamAsync returns a disposable PdfRenderResult for streaming; PrintAsync
submits to a configured Windows or Linux printer. Errors include HTTP status, problem
details, and Retry-After. Retry policy belongs to the caller.
With jobs enabled on the server, use SubmitAsync to create a durable job,
GetJobAsync to read its status, and WaitAsync to wait for completion.
DownloadAsync and DownloadStreamAsync collect results; CancelAsync cancels work
or removes a result. RenderManyAsync bounds batch submission and yields PDFs or
typed failures.
See the client guide for configuration, validation, streaming, and printing.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- No dependencies.
-
net8.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on AurorisNet.Pressroom.Client:
| Package | Downloads |
|---|---|
|
AurorisNet.Umbraco.AppBlocks.Documents
Generate templated HTML and PDF documents from AppBlocks data sources. PDF conversion optionally uses Pressroom. |
GitHub repositories
This package is not used by any popular GitHub repositories.