You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ This repository contains the C# source code for the .NET clients to the PDFinch
5
5
6
6
You need to have an account with enough credits and an active set of API keys. You can [register an account or log in here](https://www.pdfinch.com/account/login).
7
7
# Basic usage
8
-
Our API currently supports one thing: generating PDFs from HTML. You can do so by calling `IPdfClient.GeneratePdfFromHtmlAsync()`:
8
+
Our API currently supports one thing: generating PDFs from HTML, with some variations. The most simple way is available by calling `IPdfClient.GeneratePdfFromHtmlAsync()`:
9
9
10
10
```C#
11
11
IPdfClientpdfClient=... // see chapter "Obtaining an IPdfClient" below
`PDFinch.Client.Common.IPdfClient.GeneratePdfFromHtmlAsync()`returns a `Task<PdfResult<Stream>>`. This means the call should be `await`ed, and the return value must be checked for success.
56
+
The `PDFinch.Client.Common.IPdfClient.Generate...Async()`methods return a `Task<PdfResult<Stream>>`. This means the call should be `await`ed, and the return value must be checked for success.
36
57
37
58
If `PdfResult<Stream>.Success` is `false`, `.Data` will be `null` and `.StatusMessage` will contain a machine-readable (JSON) error message returned by the API.
0 commit comments