XFlow.Pdf.Client
0.0.11
dotnet add package XFlow.Pdf.Client --version 0.0.11
NuGet\Install-Package XFlow.Pdf.Client -Version 0.0.11
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XFlow.Pdf.Client" Version="0.0.11" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XFlow.Pdf.Client" Version="0.0.11" />
<PackageReference Include="XFlow.Pdf.Client" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XFlow.Pdf.Client --version 0.0.11
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: XFlow.Pdf.Client, 0.0.11"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package XFlow.Pdf.Client@0.0.11
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XFlow.Pdf.Client&version=0.0.11
#tool nuget:?package=XFlow.Pdf.Client&version=0.0.11
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
XFlow.PDF Api.Client
A .NET client library for the XFlow PDF generation API.
Installation
dotnet add package XFlow.Pdf.Client
Usage
Register the client with dependency injection using HttpClientFactory:
builder.Services.AddHttpClient<IPdfClient, PdfClient>(client =>
{
client.BaseAddress = new Uri("https://your-api-url/");
});
The client targets the latest API version by default.
To pin an API version, create the typed client with an explicit PdfApiVersion:
builder.Services.AddHttpClient<IPdfClient>(client =>
{
client.BaseAddress = new Uri("https://your-api-url/");
})
.AddTypedClient(client => new PdfClient(client, PdfApiVersion.V1));
Only supported enum values can be used.
Then inject IPdfClient and call Generate:
public class MyService(IPdfClient pdfClient)
{
public async Task<Stream> GeneratePdf(CancellationToken ct)
{
var request = new Pdf
{
MetaData = new MetaData
{
Culture = "da-DK",
Title = "My PDF",
Author = "John Doe"
},
Settings = new Settings
{
ShowTitle = true
},
Elements =
[
new Group
{
Title = "Section",
Elements =
[
new TextField { Label = "Foo", Value = "Bar" }
]
}
]
};
return await pdfClient.Generate(request, ct);
}
}
The Generate method returns a Stream, allowing you to stream the PDF directly to the caller without buffering the entire file in memory.
| 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 was computed. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.