Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: roll fully-qualified option links #1533

Merged
merged 1 commit into from
Sep 26, 2024
Merged

docs: roll fully-qualified option links #1533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions dotnet/docs/api/class-apirequestcontext.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ await ApiRequestContext.DeleteAsync(url, options);

Target URL.
- `options` `ApiRequestContextDeleteOptions?` *(optional)*
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)* <font size="2">Added in: v1.17</font><a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-delete-option-data-data-byte-data-object"/><a href="#api-request-context-delete-option-data-data-byte-data-object" class="list-anchor">#</a>
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)* <font size="2">Added in: v1.17</font><a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-delete-option-data"/><a href="#api-request-context-delete-option-data" class="list-anchor">#</a>

Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set.
- `FailOnStatusCode` [bool]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-delete-option-fail-on-status-code"/><a href="#api-request-context-delete-option-fail-on-status-code" class="list-anchor">#</a>
Expand Down Expand Up @@ -140,7 +140,7 @@ var data = new Dictionary<string, object>() {
await Request.FetchAsync("https://example.com/api/createBook", new() { Method = "post", DataObject = data });
```

The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data` encoding. Use [FormData] to construct request body and pass it to the request as `multipart` parameter:
The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data` encoding, by specifiying the `multipart` parameter:

```csharp
var file = new FilePayload()
Expand All @@ -159,7 +159,7 @@ await Request.FetchAsync("https://example.com/api/uploadScript", new() { Method

Target URL or Request to get all parameters from.
- `options` `ApiRequestContextFetchOptions?` *(optional)*
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-fetch-option-data-data-byte-data-object"/><a href="#api-request-context-fetch-option-data-data-byte-data-object" class="list-anchor">#</a>
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-fetch-option-data"/><a href="#api-request-context-fetch-option-data" class="list-anchor">#</a>

Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set.
- `FailOnStatusCode` [bool]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-fetch-option-fail-on-status-code"/><a href="#api-request-context-fetch-option-fail-on-status-code" class="list-anchor">#</a>
Expand Down Expand Up @@ -229,7 +229,7 @@ await request.GetAsync("https://example.com/api/getText", new() { Params = query

Target URL.
- `options` `ApiRequestContextGetOptions?` *(optional)*
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)* <font size="2">Added in: v1.26</font><a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-get-option-data-data-byte-data-object"/><a href="#api-request-context-get-option-data-data-byte-data-object" class="list-anchor">#</a>
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)* <font size="2">Added in: v1.26</font><a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-get-option-data"/><a href="#api-request-context-get-option-data" class="list-anchor">#</a>

Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set.
- `FailOnStatusCode` [bool]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-get-option-fail-on-status-code"/><a href="#api-request-context-get-option-fail-on-status-code" class="list-anchor">#</a>
Expand Down Expand Up @@ -289,7 +289,7 @@ await ApiRequestContext.HeadAsync(url, options);

Target URL.
- `options` `ApiRequestContextHeadOptions?` *(optional)*
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)* <font size="2">Added in: v1.26</font><a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-head-option-data-data-byte-data-object"/><a href="#api-request-context-head-option-data-data-byte-data-object" class="list-anchor">#</a>
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)* <font size="2">Added in: v1.26</font><a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-head-option-data"/><a href="#api-request-context-head-option-data" class="list-anchor">#</a>

Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set.
- `FailOnStatusCode` [bool]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-head-option-fail-on-status-code"/><a href="#api-request-context-head-option-fail-on-status-code" class="list-anchor">#</a>
Expand Down Expand Up @@ -349,7 +349,7 @@ await ApiRequestContext.PatchAsync(url, options);

Target URL.
- `options` `ApiRequestContextPatchOptions?` *(optional)*
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-patch-option-data-data-byte-data-object"/><a href="#api-request-context-patch-option-data-data-byte-data-object" class="list-anchor">#</a>
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-patch-option-data"/><a href="#api-request-context-patch-option-data" class="list-anchor">#</a>

Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set.
- `FailOnStatusCode` [bool]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-patch-option-fail-on-status-code"/><a href="#api-request-context-patch-option-fail-on-status-code" class="list-anchor">#</a>
Expand Down Expand Up @@ -438,7 +438,7 @@ await request.PostAsync("https://example.com/api/uploadScript", new() { Multipar

Target URL.
- `options` `ApiRequestContextPostOptions?` *(optional)*
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-post-option-data-data-byte-data-object"/><a href="#api-request-context-post-option-data-data-byte-data-object" class="list-anchor">#</a>
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-post-option-data"/><a href="#api-request-context-post-option-data" class="list-anchor">#</a>

Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set.
- `FailOnStatusCode` [bool]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-post-option-fail-on-status-code"/><a href="#api-request-context-post-option-fail-on-status-code" class="list-anchor">#</a>
Expand Down Expand Up @@ -498,7 +498,7 @@ await ApiRequestContext.PutAsync(url, options);

Target URL.
- `options` `ApiRequestContextPutOptions?` *(optional)*
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-put-option-data-data-byte-data-object"/><a href="#api-request-context-put-option-data-data-byte-data-object" class="list-anchor">#</a>
- `Data|DataByte|DataObject` [string]? | [byte]&#91;&#93;? | [object]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-put-option-data"/><a href="#api-request-context-put-option-data" class="list-anchor">#</a>

Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type` header will be set to `application/octet-stream` if not explicitly set.
- `FailOnStatusCode` [bool]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="api-request-context-put-option-fail-on-status-code"/><a href="#api-request-context-put-option-fail-on-status-code" class="list-anchor">#</a>
Expand Down
8 changes: 4 additions & 4 deletions dotnet/docs/api/class-browser.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ await browser.CloseAsync();
- `RecordHarPath` [string]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-context-option-record-har-path"/><a href="#browser-new-context-option-record-har-path" class="list-anchor">#</a>

Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call [BrowserContext.CloseAsync()](/api/class-browsercontext.mdx#browser-context-close) for the HAR to be saved.
- `RecordHarUrlFilter|RecordHarUrlFilterRegex` [string]? | [Regex]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-context-option-record-har-url-filter-record-har-url-filter-regex"/><a href="#browser-new-context-option-record-har-url-filter-record-har-url-filter-regex" class="list-anchor">#</a>
- `RecordHarUrlFilter|RecordHarUrlFilterRegex` [string]? | [Regex]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-context-option-record-har-url-filter"/><a href="#browser-new-context-option-record-har-url-filter" class="list-anchor">#</a>
- `RecordVideoDir` [string]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-context-option-record-video-dir"/><a href="#browser-new-context-option-record-video-dir" class="list-anchor">#</a>

Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call [BrowserContext.CloseAsync()](/api/class-browsercontext.mdx#browser-context-close) for videos to be saved.
Expand All @@ -317,7 +317,7 @@ await browser.CloseAsync();

page height in pixels.

Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport` is set.
Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewportSize` is set.
- `ServiceWorkers` `enum ServiceWorkerPolicy { Allow, Block }?` *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-context-option-service-workers"/><a href="#browser-new-context-option-service-workers" class="list-anchor">#</a>

Whether to allow sites to register Service workers. Defaults to `'allow'`.
Expand Down Expand Up @@ -506,7 +506,7 @@ await Browser.NewPageAsync(options);
- `RecordHarPath` [string]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-page-option-record-har-path"/><a href="#browser-new-page-option-record-har-path" class="list-anchor">#</a>

Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call [BrowserContext.CloseAsync()](/api/class-browsercontext.mdx#browser-context-close) for the HAR to be saved.
- `RecordHarUrlFilter|RecordHarUrlFilterRegex` [string]? | [Regex]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-page-option-record-har-url-filter-record-har-url-filter-regex"/><a href="#browser-new-page-option-record-har-url-filter-record-har-url-filter-regex" class="list-anchor">#</a>
- `RecordHarUrlFilter|RecordHarUrlFilterRegex` [string]? | [Regex]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-page-option-record-har-url-filter"/><a href="#browser-new-page-option-record-har-url-filter" class="list-anchor">#</a>
- `RecordVideoDir` [string]? *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-page-option-record-video-dir"/><a href="#browser-new-page-option-record-video-dir" class="list-anchor">#</a>

Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call [BrowserContext.CloseAsync()](/api/class-browsercontext.mdx#browser-context-close) for videos to be saved.
Expand All @@ -530,7 +530,7 @@ await Browser.NewPageAsync(options);

page height in pixels.

Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewport` is set.
Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the `viewportSize` is set.
- `ServiceWorkers` `enum ServiceWorkerPolicy { Allow, Block }?` *(optional)*<a aria-hidden="true" tabIndex="-1" class="list-anchor-link" id="browser-new-page-option-service-workers"/><a href="#browser-new-page-option-service-workers" class="list-anchor">#</a>

Whether to allow sites to register Service workers. Defaults to `'allow'`.
Expand Down
Loading