swcs/ReadSharp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme with ReadOptions

Browse Source
This commit is contained in:
Tobias Klika
2014-01-24 00:25:10 +01:00
parent 582ed84182
commit 94340e5cf5
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11
View File
@@ -45,6 +45,8 @@ catch (ReadException exc)
## Options ## Options
### HttpOptions
You can pass `HttpOptions` to the `Reader` constructor, which count for all requests: You can pass `HttpOptions` to the `Reader` constructor, which count for all requests:
- `HttpMessageHandler` **CustomHttpHandler**<br>Use your own HTTP handler - `HttpMessageHandler` **CustomHttpHandler**<br>Use your own HTTP handler
@@ -52,6 +54,15 @@ You can pass `HttpOptions` to the `Reader` constructor, which count for all requ
- `string` **UserAgent**<br>Override the user agent, which is passed to the destination server - `string` **UserAgent**<br>Override the user agent, which is passed to the destination server
- `bool` **UseMobileUserAgent**<br>There are desktop and mobile default user agents. By enabling this property, the mobile user agent is used. _If you pass a custom user agent, this property is ignored!_ - `bool` **UseMobileUserAgent**<br>There are desktop and mobile default user agents. By enabling this property, the mobile user agent is used. _If you pass a custom user agent, this property is ignored!_
### ReadOptions
There are also `ReadOptions` available, which are passed on every request:
- `bool` **HasHeaderTags**<br>Return complete HTML document or just the body part
- `bool` **HasNoHeadline**<br>Removes `<h1>` title from the article
- `bool` **UseDeepLinks**<br>If you check this option, deep-links (containing hashes, e.g. `href="#article"`) are not transformed into absolute URIs
- `bool` **PrettyPrint**<br>Determines whether the HTML output will be formatted
## Article Model ## Article Model
The `Article` contains following fields: The `Article` contains following fields: