This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Http.
Summary
Contains functionality related to HTTP settings.
- Assembly
- Cake
.Http .dll - Namespace
- Cake
.Http - Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["HttpSettingsExtensions"]
class Type type-node
Syntax
public static class HttpSettingsExtensionsMethods
| Name | Value | Summary |
|---|---|---|
| AppendCookie |
HttpSettings |
Appends the cookie to the settings cookie collection
static
|
| AppendHeader |
HttpSettings |
Appends the header to the settings header collection
static
|
| Ensure |
HttpSettings |
Sets the EnsureSuccessStatusCode to true. This makes the httpclient throw an error if it does not return a 200 range status.
static
|
| SetAccept |
HttpSettings |
Sets the accept header of the request.
static
|
| SetAcceptLanguage |
HttpSettings |
Sets the "Accept-Language" header of the request.
static
|
| SetAuthorization |
HttpSettings |
Adds a Authorization Header to the request.
static
|
| SetContentType |
HttpSettings |
Sets the content-type of the request
static
|
| Set |
HttpSettings |
Sets the request body as form url encoded.
Only valid for Http Methods that allow a request body.
Any existing content in the RequestBody is overridden.
static
|
| Set |
HttpSettings |
Sets the request body as form url encoded.
Only valid for Http Methods that allow a request body.
Any existing content in the RequestBody is overridden.
Accepts multiple parameters with the same key.
static
|
| SetJsonRequestBody |
HttpSettings |
Sets the request body from an object. Serialized as JSON
static
|
| Set |
HttpSettings |
Sets the request body as form url encoded.
Only valid for Http Methods that allow a request body.
Any existing content in the RequestBody is overridden.
Accepts multiple parameters with the same key.
This can be used to post files to a remote URL
static
|
| Set |
HttpSettings |
Sets the request body as form url encoded.
Only valid for Http Methods that allow a request body.
Any existing content in the RequestBody is overridden.
Accepts multiple parameters with the same key.
This can be used to post files to a remote URL
static
|
| SetNoCache |
HttpSettings |
Appends a Cache-Control header with no-store
static
|
| SetOrigin |
HttpSettings |
Sets the origin header to initiate a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response field).
static
|
| SetReferer |
HttpSettings |
Sets the "Referer" header of the address of the previous web page from which a link to the currently requested page was followed.
static
|
| SetRequestBody |
HttpSettings |
Sets the request body from a string input
static
|
| SetTimeout |
HttpSettings |
Sets the timeout for the http request
static
|
| Suppress |
HttpSettings |
Supresses logging to the console
static
|
| Use |
HttpSettings |
Adds a "Basic" Authorization Header to the request.
static
|
| Use |
HttpSettings |
Adds a "Bearer" Token Authorization Header to the request.
Used when authorization against a resource that uses OAUTH2
static
|
| Use |
HttpSettings |
Adds client certificate(s) to the http handler.
static
|
| Use |
HttpSettings |
Adds client certificate(s) to the http handler.
static
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|